Merge branch 'vim'
[MacVim.git] / src / fileio.c
blobe7e14595c1f51ca7606a08ac3cdb45eb701fac5d
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
11 * fileio.c: read from and write to a file
14 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
15 # include "vimio.h" /* for lseek(), must be before vim.h */
16 #endif
18 #if defined __EMX__
19 # include "vimio.h" /* for mktemp(), CJW 1997-12-03 */
20 #endif
22 #include "vim.h"
24 #ifdef __TANDEM
25 # include <limits.h> /* for SSIZE_MAX */
26 #endif
28 #if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
29 # include <utime.h> /* for struct utimbuf */
30 #endif
32 #define BUFSIZE 8192 /* size of normal write buffer */
33 #define SMBUFSIZE 256 /* size of emergency write buffer */
35 #ifdef FEAT_CRYPT
36 # define CRYPT_MAGIC "VimCrypt~01!" /* "01" is the version nr */
37 # define CRYPT_MAGIC_LEN 12 /* must be multiple of 4! */
38 #endif
40 /* Is there any system that doesn't have access()? */
41 #define USE_MCH_ACCESS
43 #if defined(sun) && defined(S_ISCHR)
44 # define OPEN_CHR_FILES
45 static int is_dev_fd_file(char_u *fname);
46 #endif
47 #ifdef FEAT_MBYTE
48 static char_u *next_fenc __ARGS((char_u **pp));
49 # ifdef FEAT_EVAL
50 static char_u *readfile_charconvert __ARGS((char_u *fname, char_u *fenc, int *fdp));
51 # endif
52 #endif
53 #ifdef FEAT_VIMINFO
54 static void check_marks_read __ARGS((void));
55 #endif
56 #ifdef FEAT_CRYPT
57 static char_u *check_for_cryptkey __ARGS((char_u *cryptkey, char_u *ptr, long *sizep, long *filesizep, int newfile));
58 #endif
59 #ifdef UNIX
60 static void set_file_time __ARGS((char_u *fname, time_t atime, time_t mtime));
61 #endif
62 static int set_rw_fname __ARGS((char_u *fname, char_u *sfname));
63 static int msg_add_fileformat __ARGS((int eol_type));
64 static void msg_add_eol __ARGS((void));
65 static int check_mtime __ARGS((buf_T *buf, struct stat *s));
66 static int time_differs __ARGS((long t1, long t2));
67 #ifdef FEAT_AUTOCMD
68 static int apply_autocmds_exarg __ARGS((event_T event, char_u *fname, char_u *fname_io, int force, buf_T *buf, exarg_T *eap));
69 static int au_find_group __ARGS((char_u *name));
71 # define AUGROUP_DEFAULT -1 /* default autocmd group */
72 # define AUGROUP_ERROR -2 /* erroneous autocmd group */
73 # define AUGROUP_ALL -3 /* all autocmd groups */
74 #endif
76 #if defined(FEAT_CRYPT) || defined(FEAT_MBYTE)
77 # define HAS_BW_FLAGS
78 # define FIO_LATIN1 0x01 /* convert Latin1 */
79 # define FIO_UTF8 0x02 /* convert UTF-8 */
80 # define FIO_UCS2 0x04 /* convert UCS-2 */
81 # define FIO_UCS4 0x08 /* convert UCS-4 */
82 # define FIO_UTF16 0x10 /* convert UTF-16 */
83 # ifdef WIN3264
84 # define FIO_CODEPAGE 0x20 /* convert MS-Windows codepage */
85 # define FIO_PUT_CP(x) (((x) & 0xffff) << 16) /* put codepage in top word */
86 # define FIO_GET_CP(x) (((x)>>16) & 0xffff) /* get codepage from top word */
87 # endif
88 # ifdef MACOS_X
89 # define FIO_MACROMAN 0x20 /* convert MacRoman */
90 # endif
91 # define FIO_ENDIAN_L 0x80 /* little endian */
92 # define FIO_ENCRYPTED 0x1000 /* encrypt written bytes */
93 # define FIO_NOCONVERT 0x2000 /* skip encoding conversion */
94 # define FIO_UCSBOM 0x4000 /* check for BOM at start of file */
95 # define FIO_ALL -1 /* allow all formats */
96 #endif
98 /* When converting, a read() or write() may leave some bytes to be converted
99 * for the next call. The value is guessed... */
100 #define CONV_RESTLEN 30
102 /* We have to guess how much a sequence of bytes may expand when converting
103 * with iconv() to be able to allocate a buffer. */
104 #define ICONV_MULT 8
107 * Structure to pass arguments from buf_write() to buf_write_bytes().
109 struct bw_info
111 int bw_fd; /* file descriptor */
112 char_u *bw_buf; /* buffer with data to be written */
113 int bw_len; /* length of data */
114 #ifdef HAS_BW_FLAGS
115 int bw_flags; /* FIO_ flags */
116 #endif
117 #ifdef FEAT_MBYTE
118 char_u bw_rest[CONV_RESTLEN]; /* not converted bytes */
119 int bw_restlen; /* nr of bytes in bw_rest[] */
120 int bw_first; /* first write call */
121 char_u *bw_conv_buf; /* buffer for writing converted chars */
122 int bw_conv_buflen; /* size of bw_conv_buf */
123 int bw_conv_error; /* set for conversion error */
124 linenr_T bw_conv_error_lnum; /* first line with error or zero */
125 linenr_T bw_start_lnum; /* line number at start of buffer */
126 # ifdef USE_ICONV
127 iconv_t bw_iconv_fd; /* descriptor for iconv() or -1 */
128 # endif
129 #endif
132 static int buf_write_bytes __ARGS((struct bw_info *ip));
134 #ifdef FEAT_MBYTE
135 static linenr_T readfile_linenr __ARGS((linenr_T linecnt, char_u *p, char_u *endp));
136 static int ucs2bytes __ARGS((unsigned c, char_u **pp, int flags));
137 static int need_conversion __ARGS((char_u *fenc));
138 static int get_fio_flags __ARGS((char_u *ptr));
139 static char_u *check_for_bom __ARGS((char_u *p, long size, int *lenp, int flags));
140 static int make_bom __ARGS((char_u *buf, char_u *name));
141 # ifdef WIN3264
142 static int get_win_fio_flags __ARGS((char_u *ptr));
143 # endif
144 # ifdef MACOS_X
145 static int get_mac_fio_flags __ARGS((char_u *ptr));
146 # endif
147 #endif
148 static int move_lines __ARGS((buf_T *frombuf, buf_T *tobuf));
149 #ifdef TEMPDIRNAMES
150 static void vim_settempdir __ARGS((char_u *tempdir));
151 #endif
152 #ifdef FEAT_AUTOCMD
153 static char *e_auchangedbuf = N_("E812: Autocommands changed buffer or buffer name");
154 #endif
156 void
157 filemess(buf, name, s, attr)
158 buf_T *buf;
159 char_u *name;
160 char_u *s;
161 int attr;
163 int msg_scroll_save;
165 if (msg_silent != 0)
166 return;
167 msg_add_fname(buf, name); /* put file name in IObuff with quotes */
168 /* If it's extremely long, truncate it. */
169 if (STRLEN(IObuff) > IOSIZE - 80)
170 IObuff[IOSIZE - 80] = NUL;
171 STRCAT(IObuff, s);
173 * For the first message may have to start a new line.
174 * For further ones overwrite the previous one, reset msg_scroll before
175 * calling filemess().
177 msg_scroll_save = msg_scroll;
178 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
179 msg_scroll = FALSE;
180 if (!msg_scroll) /* wait a bit when overwriting an error msg */
181 check_for_delay(FALSE);
182 msg_start();
183 msg_scroll = msg_scroll_save;
184 msg_scrolled_ign = TRUE;
185 /* may truncate the message to avoid a hit-return prompt */
186 msg_outtrans_attr(msg_may_trunc(FALSE, IObuff), attr);
187 msg_clr_eos();
188 out_flush();
189 msg_scrolled_ign = FALSE;
193 * Read lines from file "fname" into the buffer after line "from".
195 * 1. We allocate blocks with lalloc, as big as possible.
196 * 2. Each block is filled with characters from the file with a single read().
197 * 3. The lines are inserted in the buffer with ml_append().
199 * (caller must check that fname != NULL, unless READ_STDIN is used)
201 * "lines_to_skip" is the number of lines that must be skipped
202 * "lines_to_read" is the number of lines that are appended
203 * When not recovering lines_to_skip is 0 and lines_to_read MAXLNUM.
205 * flags:
206 * READ_NEW starting to edit a new buffer
207 * READ_FILTER reading filter output
208 * READ_STDIN read from stdin instead of a file
209 * READ_BUFFER read from curbuf instead of a file (converting after reading
210 * stdin)
211 * READ_DUMMY read into a dummy buffer (to check if file contents changed)
213 * return FAIL for failure, OK otherwise
216 readfile(fname, sfname, from, lines_to_skip, lines_to_read, eap, flags)
217 char_u *fname;
218 char_u *sfname;
219 linenr_T from;
220 linenr_T lines_to_skip;
221 linenr_T lines_to_read;
222 exarg_T *eap; /* can be NULL! */
223 int flags;
225 int fd = 0;
226 int newfile = (flags & READ_NEW);
227 int check_readonly;
228 int filtering = (flags & READ_FILTER);
229 int read_stdin = (flags & READ_STDIN);
230 int read_buffer = (flags & READ_BUFFER);
231 int set_options = newfile || read_buffer
232 || (eap != NULL && eap->read_edit);
233 linenr_T read_buf_lnum = 1; /* next line to read from curbuf */
234 colnr_T read_buf_col = 0; /* next char to read from this line */
235 char_u c;
236 linenr_T lnum = from;
237 char_u *ptr = NULL; /* pointer into read buffer */
238 char_u *buffer = NULL; /* read buffer */
239 char_u *new_buffer = NULL; /* init to shut up gcc */
240 char_u *line_start = NULL; /* init to shut up gcc */
241 int wasempty; /* buffer was empty before reading */
242 colnr_T len;
243 long size = 0;
244 char_u *p;
245 long filesize = 0;
246 int skip_read = FALSE;
247 #ifdef FEAT_CRYPT
248 char_u *cryptkey = NULL;
249 #endif
250 int split = 0; /* number of split lines */
251 #define UNKNOWN 0x0fffffff /* file size is unknown */
252 linenr_T linecnt;
253 int error = FALSE; /* errors encountered */
254 int ff_error = EOL_UNKNOWN; /* file format with errors */
255 long linerest = 0; /* remaining chars in line */
256 #ifdef UNIX
257 int perm = 0;
258 int swap_mode = -1; /* protection bits for swap file */
259 #else
260 int perm;
261 #endif
262 int fileformat = 0; /* end-of-line format */
263 int keep_fileformat = FALSE;
264 struct stat st;
265 int file_readonly;
266 linenr_T skip_count = 0;
267 linenr_T read_count = 0;
268 int msg_save = msg_scroll;
269 linenr_T read_no_eol_lnum = 0; /* non-zero lnum when last line of
270 * last read was missing the eol */
271 int try_mac = (vim_strchr(p_ffs, 'm') != NULL);
272 int try_dos = (vim_strchr(p_ffs, 'd') != NULL);
273 int try_unix = (vim_strchr(p_ffs, 'x') != NULL);
274 int file_rewind = FALSE;
275 #ifdef FEAT_MBYTE
276 int can_retry;
277 linenr_T conv_error = 0; /* line nr with conversion error */
278 linenr_T illegal_byte = 0; /* line nr with illegal byte */
279 int keep_dest_enc = FALSE; /* don't retry when char doesn't fit
280 in destination encoding */
281 int bad_char_behavior = BAD_REPLACE;
282 /* BAD_KEEP, BAD_DROP or character to
283 * replace with */
284 char_u *tmpname = NULL; /* name of 'charconvert' output file */
285 int fio_flags = 0;
286 char_u *fenc; /* fileencoding to use */
287 int fenc_alloced; /* fenc_next is in allocated memory */
288 char_u *fenc_next = NULL; /* next item in 'fencs' or NULL */
289 int advance_fenc = FALSE;
290 long real_size = 0;
291 # ifdef USE_ICONV
292 iconv_t iconv_fd = (iconv_t)-1; /* descriptor for iconv() or -1 */
293 # ifdef FEAT_EVAL
294 int did_iconv = FALSE; /* TRUE when iconv() failed and trying
295 'charconvert' next */
296 # endif
297 # endif
298 int converted = FALSE; /* TRUE if conversion done */
299 int notconverted = FALSE; /* TRUE if conversion wanted but it
300 wasn't possible */
301 char_u conv_rest[CONV_RESTLEN];
302 int conv_restlen = 0; /* nr of bytes in conv_rest[] */
303 #endif
305 #ifdef FEAT_AUTOCMD
306 /* Remember the initial values of curbuf, curbuf->b_ffname and
307 * curbuf->b_fname to detect whether they are altered as a result of
308 * executing nasty autocommands. Also check if "fname" and "sfname"
309 * point to one of these values. */
310 buf_T *old_curbuf = curbuf;
311 char_u *old_b_ffname = curbuf->b_ffname;
312 char_u *old_b_fname = curbuf->b_fname;
313 int using_b_ffname = (fname == curbuf->b_ffname)
314 || (sfname == curbuf->b_ffname);
315 int using_b_fname = (fname == curbuf->b_fname)
316 || (sfname == curbuf->b_fname);
317 #endif
318 write_no_eol_lnum = 0; /* in case it was set by the previous read */
321 * If there is no file name yet, use the one for the read file.
322 * BF_NOTEDITED is set to reflect this.
323 * Don't do this for a read from a filter.
324 * Only do this when 'cpoptions' contains the 'f' flag.
326 if (curbuf->b_ffname == NULL
327 && !filtering
328 && fname != NULL
329 && vim_strchr(p_cpo, CPO_FNAMER) != NULL
330 && !(flags & READ_DUMMY))
332 if (set_rw_fname(fname, sfname) == FAIL)
333 return FAIL;
336 /* After reading a file the cursor line changes but we don't want to
337 * display the line. */
338 ex_no_reprint = TRUE;
340 /* don't display the file info for another buffer now */
341 need_fileinfo = FALSE;
344 * For Unix: Use the short file name whenever possible.
345 * Avoids problems with networks and when directory names are changed.
346 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
347 * another directory, which we don't detect.
349 if (sfname == NULL)
350 sfname = fname;
351 #if defined(UNIX) || defined(__EMX__)
352 fname = sfname;
353 #endif
355 #ifdef FEAT_AUTOCMD
357 * The BufReadCmd and FileReadCmd events intercept the reading process by
358 * executing the associated commands instead.
360 if (!filtering && !read_stdin && !read_buffer)
362 pos_T pos;
364 pos = curbuf->b_op_start;
366 /* Set '[ mark to the line above where the lines go (line 1 if zero). */
367 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
368 curbuf->b_op_start.col = 0;
370 if (newfile)
372 if (apply_autocmds_exarg(EVENT_BUFREADCMD, NULL, sfname,
373 FALSE, curbuf, eap))
374 #ifdef FEAT_EVAL
375 return aborting() ? FAIL : OK;
376 #else
377 return OK;
378 #endif
380 else if (apply_autocmds_exarg(EVENT_FILEREADCMD, sfname, sfname,
381 FALSE, NULL, eap))
382 #ifdef FEAT_EVAL
383 return aborting() ? FAIL : OK;
384 #else
385 return OK;
386 #endif
388 curbuf->b_op_start = pos;
390 #endif
392 if ((shortmess(SHM_OVER) || curbuf->b_help) && p_verbose == 0)
393 msg_scroll = FALSE; /* overwrite previous file message */
394 else
395 msg_scroll = TRUE; /* don't overwrite previous file message */
398 * If the name ends in a path separator, we can't open it. Check here,
399 * because reading the file may actually work, but then creating the swap
400 * file may destroy it! Reported on MS-DOS and Win 95.
401 * If the name is too long we might crash further on, quit here.
403 if (fname != NULL && *fname != NUL)
405 p = fname + STRLEN(fname);
406 if (after_pathsep(fname, p) || STRLEN(fname) >= MAXPATHL)
408 filemess(curbuf, fname, (char_u *)_("Illegal file name"), 0);
409 msg_end();
410 msg_scroll = msg_save;
411 return FAIL;
415 #ifdef UNIX
417 * On Unix it is possible to read a directory, so we have to
418 * check for it before the mch_open().
420 if (!read_stdin && !read_buffer)
422 perm = mch_getperm(fname);
423 if (perm >= 0 && !S_ISREG(perm) /* not a regular file ... */
424 # ifdef S_ISFIFO
425 && !S_ISFIFO(perm) /* ... or fifo */
426 # endif
427 # ifdef S_ISSOCK
428 && !S_ISSOCK(perm) /* ... or socket */
429 # endif
430 # ifdef OPEN_CHR_FILES
431 && !(S_ISCHR(perm) && is_dev_fd_file(fname))
432 /* ... or a character special file named /dev/fd/<n> */
433 # endif
436 if (S_ISDIR(perm))
437 filemess(curbuf, fname, (char_u *)_("is a directory"), 0);
438 else
439 filemess(curbuf, fname, (char_u *)_("is not a file"), 0);
440 msg_end();
441 msg_scroll = msg_save;
442 return FAIL;
445 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
447 * MS-Windows allows opening a device, but we will probably get stuck
448 * trying to read it.
450 if (!p_odev && mch_nodetype(fname) == NODE_WRITABLE)
452 filemess(curbuf, fname, (char_u *)_("is a device (disabled with 'opendevice' option)"), 0);
453 msg_end();
454 msg_scroll = msg_save;
455 return FAIL;
457 # endif
459 #endif
461 /* set default 'fileformat' */
462 if (set_options)
464 if (eap != NULL && eap->force_ff != 0)
465 set_fileformat(get_fileformat_force(curbuf, eap), OPT_LOCAL);
466 else if (*p_ffs != NUL)
467 set_fileformat(default_fileformat(), OPT_LOCAL);
470 /* set or reset 'binary' */
471 if (eap != NULL && eap->force_bin != 0)
473 int oldval = curbuf->b_p_bin;
475 curbuf->b_p_bin = (eap->force_bin == FORCE_BIN);
476 set_options_bin(oldval, curbuf->b_p_bin, OPT_LOCAL);
480 * When opening a new file we take the readonly flag from the file.
481 * Default is r/w, can be set to r/o below.
482 * Don't reset it when in readonly mode
483 * Only set/reset b_p_ro when BF_CHECK_RO is set.
485 check_readonly = (newfile && (curbuf->b_flags & BF_CHECK_RO));
486 if (check_readonly && !readonlymode)
487 curbuf->b_p_ro = FALSE;
489 if (newfile && !read_stdin && !read_buffer)
491 /* Remember time of file.
492 * For RISCOS, also remember the filetype.
494 if (mch_stat((char *)fname, &st) >= 0)
496 buf_store_time(curbuf, &st, fname);
497 curbuf->b_mtime_read = curbuf->b_mtime;
499 #if defined(RISCOS) && defined(FEAT_OSFILETYPE)
500 /* Read the filetype into the buffer local filetype option. */
501 mch_read_filetype(fname);
502 #endif
503 #ifdef UNIX
505 * Use the protection bits of the original file for the swap file.
506 * This makes it possible for others to read the name of the
507 * edited file from the swapfile, but only if they can read the
508 * edited file.
509 * Remove the "write" and "execute" bits for group and others
510 * (they must not write the swapfile).
511 * Add the "read" and "write" bits for the user, otherwise we may
512 * not be able to write to the file ourselves.
513 * Setting the bits is done below, after creating the swap file.
515 swap_mode = (st.st_mode & 0644) | 0600;
516 #endif
517 #ifdef FEAT_CW_EDITOR
518 /* Get the FSSpec on MacOS
519 * TODO: Update it properly when the buffer name changes
521 (void)GetFSSpecFromPath(curbuf->b_ffname, &curbuf->b_FSSpec);
522 #endif
523 #ifdef VMS
524 curbuf->b_fab_rfm = st.st_fab_rfm;
525 curbuf->b_fab_rat = st.st_fab_rat;
526 curbuf->b_fab_mrs = st.st_fab_mrs;
527 #endif
529 else
531 curbuf->b_mtime = 0;
532 curbuf->b_mtime_read = 0;
533 curbuf->b_orig_size = 0;
534 curbuf->b_orig_mode = 0;
537 /* Reset the "new file" flag. It will be set again below when the
538 * file doesn't exist. */
539 curbuf->b_flags &= ~(BF_NEW | BF_NEW_W);
543 * for UNIX: check readonly with perm and mch_access()
544 * for RISCOS: same as Unix, otherwise file gets re-datestamped!
545 * for MSDOS and Amiga: check readonly by trying to open the file for writing
547 file_readonly = FALSE;
548 if (read_stdin)
550 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
551 /* Force binary I/O on stdin to avoid CR-LF -> LF conversion. */
552 setmode(0, O_BINARY);
553 #endif
555 else if (!read_buffer)
557 #ifdef USE_MCH_ACCESS
558 if (
559 # ifdef UNIX
560 !(perm & 0222) ||
561 # endif
562 mch_access((char *)fname, W_OK))
563 file_readonly = TRUE;
564 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
565 #else
566 if (!newfile
567 || readonlymode
568 || (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0)
570 file_readonly = TRUE;
571 /* try to open ro */
572 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
574 #endif
577 if (fd < 0) /* cannot open at all */
579 #ifndef UNIX
580 int isdir_f;
581 #endif
582 msg_scroll = msg_save;
583 #ifndef UNIX
585 * On MSDOS and Amiga we can't open a directory, check here.
587 isdir_f = (mch_isdir(fname));
588 perm = mch_getperm(fname); /* check if the file exists */
589 if (isdir_f)
591 filemess(curbuf, sfname, (char_u *)_("is a directory"), 0);
592 curbuf->b_p_ro = TRUE; /* must use "w!" now */
594 else
595 #endif
596 if (newfile)
598 if (perm < 0)
601 * Set the 'new-file' flag, so that when the file has
602 * been created by someone else, a ":w" will complain.
604 curbuf->b_flags |= BF_NEW;
606 /* Create a swap file now, so that other Vims are warned
607 * that we are editing this file. Don't do this for a
608 * "nofile" or "nowrite" buffer type. */
609 #ifdef FEAT_QUICKFIX
610 if (!bt_dontwrite(curbuf))
611 #endif
613 check_need_swap(newfile);
614 #ifdef FEAT_AUTOCMD
615 /* SwapExists autocommand may mess things up */
616 if (curbuf != old_curbuf
617 || (using_b_ffname
618 && (old_b_ffname != curbuf->b_ffname))
619 || (using_b_fname
620 && (old_b_fname != curbuf->b_fname)))
622 EMSG(_(e_auchangedbuf));
623 return FAIL;
625 #endif
627 if (dir_of_file_exists(fname))
628 filemess(curbuf, sfname, (char_u *)_("[New File]"), 0);
629 else
630 filemess(curbuf, sfname,
631 (char_u *)_("[New DIRECTORY]"), 0);
632 #ifdef FEAT_VIMINFO
633 /* Even though this is a new file, it might have been
634 * edited before and deleted. Get the old marks. */
635 check_marks_read();
636 #endif
637 #ifdef FEAT_MBYTE
638 if (eap != NULL && eap->force_enc != 0)
640 /* set forced 'fileencoding' */
641 fenc = enc_canonize(eap->cmd + eap->force_enc);
642 if (fenc != NULL)
643 set_string_option_direct((char_u *)"fenc", -1,
644 fenc, OPT_FREE|OPT_LOCAL, 0);
645 vim_free(fenc);
647 #endif
648 #ifdef FEAT_AUTOCMD
649 apply_autocmds_exarg(EVENT_BUFNEWFILE, sfname, sfname,
650 FALSE, curbuf, eap);
651 #endif
652 /* remember the current fileformat */
653 save_file_ff(curbuf);
655 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
656 if (aborting()) /* autocmds may abort script processing */
657 return FAIL;
658 #endif
659 return OK; /* a new file is not an error */
661 else
663 filemess(curbuf, sfname, (char_u *)(
664 # ifdef EFBIG
665 (errno == EFBIG) ? _("[File too big]") :
666 # endif
667 _("[Permission Denied]")), 0);
668 curbuf->b_p_ro = TRUE; /* must use "w!" now */
672 return FAIL;
676 * Only set the 'ro' flag for readonly files the first time they are
677 * loaded. Help files always get readonly mode
679 if ((check_readonly && file_readonly) || curbuf->b_help)
680 curbuf->b_p_ro = TRUE;
682 if (set_options)
684 /* Don't change 'eol' if reading from buffer as it will already be
685 * correctly set when reading stdin. */
686 if (!read_buffer)
688 curbuf->b_p_eol = TRUE;
689 curbuf->b_start_eol = TRUE;
691 #ifdef FEAT_MBYTE
692 curbuf->b_p_bomb = FALSE;
693 curbuf->b_start_bomb = FALSE;
694 #endif
697 /* Create a swap file now, so that other Vims are warned that we are
698 * editing this file.
699 * Don't do this for a "nofile" or "nowrite" buffer type. */
700 #ifdef FEAT_QUICKFIX
701 if (!bt_dontwrite(curbuf))
702 #endif
704 check_need_swap(newfile);
705 #ifdef FEAT_AUTOCMD
706 if (!read_stdin && (curbuf != old_curbuf
707 || (using_b_ffname && (old_b_ffname != curbuf->b_ffname))
708 || (using_b_fname && (old_b_fname != curbuf->b_fname))))
710 EMSG(_(e_auchangedbuf));
711 if (!read_buffer)
712 close(fd);
713 return FAIL;
715 #endif
716 #ifdef UNIX
717 /* Set swap file protection bits after creating it. */
718 if (swap_mode > 0 && curbuf->b_ml.ml_mfp != NULL
719 && curbuf->b_ml.ml_mfp->mf_fname != NULL)
720 (void)mch_setperm(curbuf->b_ml.ml_mfp->mf_fname, (long)swap_mode);
721 #endif
724 #if defined(HAS_SWAP_EXISTS_ACTION)
725 /* If "Quit" selected at ATTENTION dialog, don't load the file */
726 if (swap_exists_action == SEA_QUIT)
728 if (!read_buffer && !read_stdin)
729 close(fd);
730 return FAIL;
732 #endif
734 ++no_wait_return; /* don't wait for return yet */
737 * Set '[ mark to the line above where the lines go (line 1 if zero).
739 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
740 curbuf->b_op_start.col = 0;
742 #ifdef FEAT_AUTOCMD
743 if (!read_buffer)
745 int m = msg_scroll;
746 int n = msg_scrolled;
749 * The file must be closed again, the autocommands may want to change
750 * the file before reading it.
752 if (!read_stdin)
753 close(fd); /* ignore errors */
756 * The output from the autocommands should not overwrite anything and
757 * should not be overwritten: Set msg_scroll, restore its value if no
758 * output was done.
760 msg_scroll = TRUE;
761 if (filtering)
762 apply_autocmds_exarg(EVENT_FILTERREADPRE, NULL, sfname,
763 FALSE, curbuf, eap);
764 else if (read_stdin)
765 apply_autocmds_exarg(EVENT_STDINREADPRE, NULL, sfname,
766 FALSE, curbuf, eap);
767 else if (newfile)
768 apply_autocmds_exarg(EVENT_BUFREADPRE, NULL, sfname,
769 FALSE, curbuf, eap);
770 else
771 apply_autocmds_exarg(EVENT_FILEREADPRE, sfname, sfname,
772 FALSE, NULL, eap);
773 if (msg_scrolled == n)
774 msg_scroll = m;
776 #ifdef FEAT_EVAL
777 if (aborting()) /* autocmds may abort script processing */
779 --no_wait_return;
780 msg_scroll = msg_save;
781 curbuf->b_p_ro = TRUE; /* must use "w!" now */
782 return FAIL;
784 #endif
786 * Don't allow the autocommands to change the current buffer.
787 * Try to re-open the file.
789 * Don't allow the autocommands to change the buffer name either
790 * (cd for example) if it invalidates fname or sfname.
792 if (!read_stdin && (curbuf != old_curbuf
793 || (using_b_ffname && (old_b_ffname != curbuf->b_ffname))
794 || (using_b_fname && (old_b_fname != curbuf->b_fname))
795 || (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) < 0))
797 --no_wait_return;
798 msg_scroll = msg_save;
799 if (fd < 0)
800 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
801 else
802 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
803 curbuf->b_p_ro = TRUE; /* must use "w!" now */
804 return FAIL;
807 #endif /* FEAT_AUTOCMD */
809 /* Autocommands may add lines to the file, need to check if it is empty */
810 wasempty = (curbuf->b_ml.ml_flags & ML_EMPTY);
812 if (!recoverymode && !filtering && !(flags & READ_DUMMY))
815 * Show the user that we are busy reading the input. Sometimes this
816 * may take a while. When reading from stdin another program may
817 * still be running, don't move the cursor to the last line, unless
818 * always using the GUI.
820 if (read_stdin)
822 #ifndef ALWAYS_USE_GUI
823 mch_msg(_("Vim: Reading from stdin...\n"));
824 #endif
825 #ifdef FEAT_GUI
826 /* Also write a message in the GUI window, if there is one. */
827 if (gui.in_use && !gui.dying && !gui.starting)
829 p = (char_u *)_("Reading from stdin...");
830 gui_write(p, (int)STRLEN(p));
832 #endif
834 else if (!read_buffer)
835 filemess(curbuf, sfname, (char_u *)"", 0);
838 msg_scroll = FALSE; /* overwrite the file message */
841 * Set linecnt now, before the "retry" caused by a wrong guess for
842 * fileformat, and after the autocommands, which may change them.
844 linecnt = curbuf->b_ml.ml_line_count;
846 #ifdef FEAT_MBYTE
847 /* "++bad=" argument. */
848 if (eap != NULL && eap->bad_char != 0)
850 bad_char_behavior = eap->bad_char;
851 if (set_options)
852 curbuf->b_bad_char = eap->bad_char;
854 else
855 curbuf->b_bad_char = 0;
858 * Decide which 'encoding' to use or use first.
860 if (eap != NULL && eap->force_enc != 0)
862 fenc = enc_canonize(eap->cmd + eap->force_enc);
863 fenc_alloced = TRUE;
864 keep_dest_enc = TRUE;
866 else if (curbuf->b_p_bin)
868 fenc = (char_u *)""; /* binary: don't convert */
869 fenc_alloced = FALSE;
871 else if (curbuf->b_help)
873 char_u firstline[80];
874 int fc;
876 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
877 * fails it must be latin1.
878 * Always do this when 'encoding' is "utf-8". Otherwise only do
879 * this when needed to avoid [converted] remarks all the time.
880 * It is needed when the first line contains non-ASCII characters.
881 * That is only in *.??x files. */
882 fenc = (char_u *)"latin1";
883 c = enc_utf8;
884 if (!c && !read_stdin)
886 fc = fname[STRLEN(fname) - 1];
887 if (TOLOWER_ASC(fc) == 'x')
889 /* Read the first line (and a bit more). Immediately rewind to
890 * the start of the file. If the read() fails "len" is -1. */
891 len = vim_read(fd, firstline, 80);
892 lseek(fd, (off_t)0L, SEEK_SET);
893 for (p = firstline; p < firstline + len; ++p)
894 if (*p >= 0x80)
896 c = TRUE;
897 break;
902 if (c)
904 fenc_next = fenc;
905 fenc = (char_u *)"utf-8";
907 /* When the file is utf-8 but a character doesn't fit in
908 * 'encoding' don't retry. In help text editing utf-8 bytes
909 * doesn't make sense. */
910 if (!enc_utf8)
911 keep_dest_enc = TRUE;
913 fenc_alloced = FALSE;
915 else if (*p_fencs == NUL)
917 fenc = curbuf->b_p_fenc; /* use format from buffer */
918 fenc_alloced = FALSE;
920 else
922 fenc_next = p_fencs; /* try items in 'fileencodings' */
923 fenc = next_fenc(&fenc_next);
924 fenc_alloced = TRUE;
926 #endif
929 * Jump back here to retry reading the file in different ways.
930 * Reasons to retry:
931 * - encoding conversion failed: try another one from "fenc_next"
932 * - BOM detected and fenc was set, need to setup conversion
933 * - "fileformat" check failed: try another
935 * Variables set for special retry actions:
936 * "file_rewind" Rewind the file to start reading it again.
937 * "advance_fenc" Advance "fenc" using "fenc_next".
938 * "skip_read" Re-use already read bytes (BOM detected).
939 * "did_iconv" iconv() conversion failed, try 'charconvert'.
940 * "keep_fileformat" Don't reset "fileformat".
942 * Other status indicators:
943 * "tmpname" When != NULL did conversion with 'charconvert'.
944 * Output file has to be deleted afterwards.
945 * "iconv_fd" When != -1 did conversion with iconv().
947 retry:
949 if (file_rewind)
951 if (read_buffer)
953 read_buf_lnum = 1;
954 read_buf_col = 0;
956 else if (read_stdin || lseek(fd, (off_t)0L, SEEK_SET) != 0)
958 /* Can't rewind the file, give up. */
959 error = TRUE;
960 goto failed;
962 /* Delete the previously read lines. */
963 while (lnum > from)
964 ml_delete(lnum--, FALSE);
965 file_rewind = FALSE;
966 #ifdef FEAT_MBYTE
967 if (set_options)
969 curbuf->b_p_bomb = FALSE;
970 curbuf->b_start_bomb = FALSE;
972 conv_error = 0;
973 #endif
977 * When retrying with another "fenc" and the first time "fileformat"
978 * will be reset.
980 if (keep_fileformat)
981 keep_fileformat = FALSE;
982 else
984 if (eap != NULL && eap->force_ff != 0)
986 fileformat = get_fileformat_force(curbuf, eap);
987 try_unix = try_dos = try_mac = FALSE;
989 else if (curbuf->b_p_bin)
990 fileformat = EOL_UNIX; /* binary: use Unix format */
991 else if (*p_ffs == NUL)
992 fileformat = get_fileformat(curbuf);/* use format from buffer */
993 else
994 fileformat = EOL_UNKNOWN; /* detect from file */
997 #ifdef FEAT_MBYTE
998 # ifdef USE_ICONV
999 if (iconv_fd != (iconv_t)-1)
1001 /* aborted conversion with iconv(), close the descriptor */
1002 iconv_close(iconv_fd);
1003 iconv_fd = (iconv_t)-1;
1005 # endif
1007 if (advance_fenc)
1010 * Try the next entry in 'fileencodings'.
1012 advance_fenc = FALSE;
1014 if (eap != NULL && eap->force_enc != 0)
1016 /* Conversion given with "++cc=" wasn't possible, read
1017 * without conversion. */
1018 notconverted = TRUE;
1019 conv_error = 0;
1020 if (fenc_alloced)
1021 vim_free(fenc);
1022 fenc = (char_u *)"";
1023 fenc_alloced = FALSE;
1025 else
1027 if (fenc_alloced)
1028 vim_free(fenc);
1029 if (fenc_next != NULL)
1031 fenc = next_fenc(&fenc_next);
1032 fenc_alloced = (fenc_next != NULL);
1034 else
1036 fenc = (char_u *)"";
1037 fenc_alloced = FALSE;
1040 if (tmpname != NULL)
1042 mch_remove(tmpname); /* delete converted file */
1043 vim_free(tmpname);
1044 tmpname = NULL;
1049 * Conversion may be required when the encoding of the file is different
1050 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4.
1052 fio_flags = 0;
1053 converted = need_conversion(fenc);
1054 if (converted)
1057 /* "ucs-bom" means we need to check the first bytes of the file
1058 * for a BOM. */
1059 if (STRCMP(fenc, ENC_UCSBOM) == 0)
1060 fio_flags = FIO_UCSBOM;
1063 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
1064 * done. This is handled below after read(). Prepare the
1065 * fio_flags to avoid having to parse the string each time.
1066 * Also check for Unicode to Latin1 conversion, because iconv()
1067 * appears not to handle this correctly. This works just like
1068 * conversion to UTF-8 except how the resulting character is put in
1069 * the buffer.
1071 else if (enc_utf8 || STRCMP(p_enc, "latin1") == 0)
1072 fio_flags = get_fio_flags(fenc);
1074 # ifdef WIN3264
1076 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1077 * is handled with MultiByteToWideChar().
1079 if (fio_flags == 0)
1080 fio_flags = get_win_fio_flags(fenc);
1081 # endif
1083 # ifdef MACOS_X
1084 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1085 if (fio_flags == 0)
1086 fio_flags = get_mac_fio_flags(fenc);
1087 # endif
1089 # ifdef USE_ICONV
1091 * Try using iconv() if we can't convert internally.
1093 if (fio_flags == 0
1094 # ifdef FEAT_EVAL
1095 && !did_iconv
1096 # endif
1098 iconv_fd = (iconv_t)my_iconv_open(
1099 enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc);
1100 # endif
1102 # ifdef FEAT_EVAL
1104 * Use the 'charconvert' expression when conversion is required
1105 * and we can't do it internally or with iconv().
1107 if (fio_flags == 0 && !read_stdin && !read_buffer && *p_ccv != NUL
1108 # ifdef USE_ICONV
1109 && iconv_fd == (iconv_t)-1
1110 # endif
1113 # ifdef USE_ICONV
1114 did_iconv = FALSE;
1115 # endif
1116 /* Skip conversion when it's already done (retry for wrong
1117 * "fileformat"). */
1118 if (tmpname == NULL)
1120 tmpname = readfile_charconvert(fname, fenc, &fd);
1121 if (tmpname == NULL)
1123 /* Conversion failed. Try another one. */
1124 advance_fenc = TRUE;
1125 if (fd < 0)
1127 /* Re-opening the original file failed! */
1128 EMSG(_("E202: Conversion made file unreadable!"));
1129 error = TRUE;
1130 goto failed;
1132 goto retry;
1136 else
1137 # endif
1139 if (fio_flags == 0
1140 # ifdef USE_ICONV
1141 && iconv_fd == (iconv_t)-1
1142 # endif
1145 /* Conversion wanted but we can't.
1146 * Try the next conversion in 'fileencodings' */
1147 advance_fenc = TRUE;
1148 goto retry;
1153 /* Set "can_retry" when it's possible to rewind the file and try with
1154 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1155 * stdin or fixed at a specific encoding. */
1156 can_retry = (*fenc != NUL && !read_stdin && !keep_dest_enc);
1157 #endif
1159 if (!skip_read)
1161 linerest = 0;
1162 filesize = 0;
1163 skip_count = lines_to_skip;
1164 read_count = lines_to_read;
1165 #ifdef FEAT_MBYTE
1166 conv_restlen = 0;
1167 #endif
1170 while (!error && !got_int)
1173 * We allocate as much space for the file as we can get, plus
1174 * space for the old line plus room for one terminating NUL.
1175 * The amount is limited by the fact that read() only can read
1176 * upto max_unsigned characters (and other things).
1178 #if SIZEOF_INT <= 2
1179 if (linerest >= 0x7ff0)
1181 ++split;
1182 *ptr = NL; /* split line by inserting a NL */
1183 size = 1;
1185 else
1186 #endif
1188 if (!skip_read)
1190 #if SIZEOF_INT > 2
1191 # if defined(SSIZE_MAX) && (SSIZE_MAX < 0x10000L)
1192 size = SSIZE_MAX; /* use max I/O size, 52K */
1193 # else
1194 size = 0x10000L; /* use buffer >= 64K */
1195 # endif
1196 #else
1197 size = 0x7ff0L - linerest; /* limit buffer to 32K */
1198 #endif
1200 for ( ; size >= 10; size = (long)((long_u)size >> 1))
1202 if ((new_buffer = lalloc((long_u)(size + linerest + 1),
1203 FALSE)) != NULL)
1204 break;
1206 if (new_buffer == NULL)
1208 do_outofmem_msg((long_u)(size * 2 + linerest + 1));
1209 error = TRUE;
1210 break;
1212 if (linerest) /* copy characters from the previous buffer */
1213 mch_memmove(new_buffer, ptr - linerest, (size_t)linerest);
1214 vim_free(buffer);
1215 buffer = new_buffer;
1216 ptr = buffer + linerest;
1217 line_start = buffer;
1219 #ifdef FEAT_MBYTE
1220 /* May need room to translate into.
1221 * For iconv() we don't really know the required space, use a
1222 * factor ICONV_MULT.
1223 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1224 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1225 * become up to 4 bytes, size must be multiple of 2
1226 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1227 * multiple of 2
1228 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1229 * multiple of 4 */
1230 real_size = (int)size;
1231 # ifdef USE_ICONV
1232 if (iconv_fd != (iconv_t)-1)
1233 size = size / ICONV_MULT;
1234 else
1235 # endif
1236 if (fio_flags & FIO_LATIN1)
1237 size = size / 2;
1238 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1239 size = (size * 2 / 3) & ~1;
1240 else if (fio_flags & FIO_UCS4)
1241 size = (size * 2 / 3) & ~3;
1242 else if (fio_flags == FIO_UCSBOM)
1243 size = size / ICONV_MULT; /* worst case */
1244 # ifdef WIN3264
1245 else if (fio_flags & FIO_CODEPAGE)
1246 size = size / ICONV_MULT; /* also worst case */
1247 # endif
1248 # ifdef MACOS_X
1249 else if (fio_flags & FIO_MACROMAN)
1250 size = size / ICONV_MULT; /* also worst case */
1251 # endif
1252 #endif
1254 #ifdef FEAT_MBYTE
1255 if (conv_restlen > 0)
1257 /* Insert unconverted bytes from previous line. */
1258 mch_memmove(ptr, conv_rest, conv_restlen);
1259 ptr += conv_restlen;
1260 size -= conv_restlen;
1262 #endif
1264 if (read_buffer)
1267 * Read bytes from curbuf. Used for converting text read
1268 * from stdin.
1270 if (read_buf_lnum > from)
1271 size = 0;
1272 else
1274 int n, ni;
1275 long tlen;
1277 tlen = 0;
1278 for (;;)
1280 p = ml_get(read_buf_lnum) + read_buf_col;
1281 n = (int)STRLEN(p);
1282 if ((int)tlen + n + 1 > size)
1284 /* Filled up to "size", append partial line.
1285 * Change NL to NUL to reverse the effect done
1286 * below. */
1287 n = (int)(size - tlen);
1288 for (ni = 0; ni < n; ++ni)
1290 if (p[ni] == NL)
1291 ptr[tlen++] = NUL;
1292 else
1293 ptr[tlen++] = p[ni];
1295 read_buf_col += n;
1296 break;
1298 else
1300 /* Append whole line and new-line. Change NL
1301 * to NUL to reverse the effect done below. */
1302 for (ni = 0; ni < n; ++ni)
1304 if (p[ni] == NL)
1305 ptr[tlen++] = NUL;
1306 else
1307 ptr[tlen++] = p[ni];
1309 ptr[tlen++] = NL;
1310 read_buf_col = 0;
1311 if (++read_buf_lnum > from)
1313 /* When the last line didn't have an
1314 * end-of-line don't add it now either. */
1315 if (!curbuf->b_p_eol)
1316 --tlen;
1317 size = tlen;
1318 break;
1324 else
1327 * Read bytes from the file.
1329 size = vim_read(fd, ptr, size);
1332 if (size <= 0)
1334 if (size < 0) /* read error */
1335 error = TRUE;
1336 #ifdef FEAT_MBYTE
1337 else if (conv_restlen > 0)
1340 * Reached end-of-file but some trailing bytes could
1341 * not be converted. Truncated file?
1344 /* When we did a conversion report an error. */
1345 if (fio_flags != 0
1346 # ifdef USE_ICONV
1347 || iconv_fd != (iconv_t)-1
1348 # endif
1351 if (conv_error == 0)
1352 conv_error = curbuf->b_ml.ml_line_count
1353 - linecnt + 1;
1355 /* Remember the first linenr with an illegal byte */
1356 else if (illegal_byte == 0)
1357 illegal_byte = curbuf->b_ml.ml_line_count
1358 - linecnt + 1;
1359 if (bad_char_behavior == BAD_DROP)
1361 *(ptr - conv_restlen) = NUL;
1362 conv_restlen = 0;
1364 else
1366 /* Replace the trailing bytes with the replacement
1367 * character if we were converting; if we weren't,
1368 * leave the UTF8 checking code to do it, as it
1369 * works slightly differently. */
1370 if (bad_char_behavior != BAD_KEEP && (fio_flags != 0
1371 # ifdef USE_ICONV
1372 || iconv_fd != (iconv_t)-1
1373 # endif
1376 while (conv_restlen > 0)
1378 *(--ptr) = bad_char_behavior;
1379 --conv_restlen;
1382 fio_flags = 0; /* don't convert this */
1383 # ifdef USE_ICONV
1384 if (iconv_fd != (iconv_t)-1)
1386 iconv_close(iconv_fd);
1387 iconv_fd = (iconv_t)-1;
1389 # endif
1392 #endif
1395 #ifdef FEAT_CRYPT
1397 * At start of file: Check for magic number of encryption.
1399 if (filesize == 0)
1400 cryptkey = check_for_cryptkey(cryptkey, ptr, &size,
1401 &filesize, newfile);
1403 * Decrypt the read bytes.
1405 if (cryptkey != NULL && size > 0)
1406 for (p = ptr; p < ptr + size; ++p)
1407 ZDECODE(*p);
1408 #endif
1410 skip_read = FALSE;
1412 #ifdef FEAT_MBYTE
1414 * At start of file (or after crypt magic number): Check for BOM.
1415 * Also check for a BOM for other Unicode encodings, but not after
1416 * converting with 'charconvert' or when a BOM has already been
1417 * found.
1419 if ((filesize == 0
1420 # ifdef FEAT_CRYPT
1421 || (filesize == CRYPT_MAGIC_LEN && cryptkey != NULL)
1422 # endif
1424 && (fio_flags == FIO_UCSBOM
1425 || (!curbuf->b_p_bomb
1426 && tmpname == NULL
1427 && (*fenc == 'u' || (*fenc == NUL && enc_utf8)))))
1429 char_u *ccname;
1430 int blen;
1432 /* no BOM detection in a short file or in binary mode */
1433 if (size < 2 || curbuf->b_p_bin)
1434 ccname = NULL;
1435 else
1436 ccname = check_for_bom(ptr, size, &blen,
1437 fio_flags == FIO_UCSBOM ? FIO_ALL : get_fio_flags(fenc));
1438 if (ccname != NULL)
1440 /* Remove BOM from the text */
1441 filesize += blen;
1442 size -= blen;
1443 mch_memmove(ptr, ptr + blen, (size_t)size);
1444 if (set_options)
1446 curbuf->b_p_bomb = TRUE;
1447 curbuf->b_start_bomb = TRUE;
1451 if (fio_flags == FIO_UCSBOM)
1453 if (ccname == NULL)
1455 /* No BOM detected: retry with next encoding. */
1456 advance_fenc = TRUE;
1458 else
1460 /* BOM detected: set "fenc" and jump back */
1461 if (fenc_alloced)
1462 vim_free(fenc);
1463 fenc = ccname;
1464 fenc_alloced = FALSE;
1466 /* retry reading without getting new bytes or rewinding */
1467 skip_read = TRUE;
1468 goto retry;
1472 /* Include not converted bytes. */
1473 ptr -= conv_restlen;
1474 size += conv_restlen;
1475 conv_restlen = 0;
1476 #endif
1478 * Break here for a read error or end-of-file.
1480 if (size <= 0)
1481 break;
1483 #ifdef FEAT_MBYTE
1485 # ifdef USE_ICONV
1486 if (iconv_fd != (iconv_t)-1)
1489 * Attempt conversion of the read bytes to 'encoding' using
1490 * iconv().
1492 const char *fromp;
1493 char *top;
1494 size_t from_size;
1495 size_t to_size;
1497 fromp = (char *)ptr;
1498 from_size = size;
1499 ptr += size;
1500 top = (char *)ptr;
1501 to_size = real_size - size;
1504 * If there is conversion error or not enough room try using
1505 * another conversion. Except for when there is no
1506 * alternative (help files).
1508 while ((iconv(iconv_fd, (void *)&fromp, &from_size,
1509 &top, &to_size)
1510 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
1511 || from_size > CONV_RESTLEN)
1513 if (can_retry)
1514 goto rewind_retry;
1515 if (conv_error == 0)
1516 conv_error = readfile_linenr(linecnt,
1517 ptr, (char_u *)top);
1519 /* Deal with a bad byte and continue with the next. */
1520 ++fromp;
1521 --from_size;
1522 if (bad_char_behavior == BAD_KEEP)
1524 *top++ = *(fromp - 1);
1525 --to_size;
1527 else if (bad_char_behavior != BAD_DROP)
1529 *top++ = bad_char_behavior;
1530 --to_size;
1534 if (from_size > 0)
1536 /* Some remaining characters, keep them for the next
1537 * round. */
1538 mch_memmove(conv_rest, (char_u *)fromp, from_size);
1539 conv_restlen = (int)from_size;
1542 /* move the linerest to before the converted characters */
1543 line_start = ptr - linerest;
1544 mch_memmove(line_start, buffer, (size_t)linerest);
1545 size = (long)((char_u *)top - ptr);
1547 # endif
1549 # ifdef WIN3264
1550 if (fio_flags & FIO_CODEPAGE)
1552 char_u *src, *dst;
1553 WCHAR ucs2buf[3];
1554 int ucs2len;
1555 int codepage = FIO_GET_CP(fio_flags);
1556 int bytelen;
1557 int found_bad;
1558 char replstr[2];
1561 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1562 * a codepage, using standard MS-Windows functions. This
1563 * requires two steps:
1564 * 1. convert from 'fileencoding' to ucs-2
1565 * 2. convert from ucs-2 to 'encoding'
1567 * Because there may be illegal bytes AND an incomplete byte
1568 * sequence at the end, we may have to do the conversion one
1569 * character at a time to get it right.
1572 /* Replacement string for WideCharToMultiByte(). */
1573 if (bad_char_behavior > 0)
1574 replstr[0] = bad_char_behavior;
1575 else
1576 replstr[0] = '?';
1577 replstr[1] = NUL;
1580 * Move the bytes to the end of the buffer, so that we have
1581 * room to put the result at the start.
1583 src = ptr + real_size - size;
1584 mch_memmove(src, ptr, size);
1587 * Do the conversion.
1589 dst = ptr;
1590 size = size;
1591 while (size > 0)
1593 found_bad = FALSE;
1595 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1596 if (codepage == CP_UTF8)
1598 /* Handle CP_UTF8 input ourselves to be able to handle
1599 * trailing bytes properly.
1600 * Get one UTF-8 character from src. */
1601 bytelen = (int)utf_ptr2len_len(src, size);
1602 if (bytelen > size)
1604 /* Only got some bytes of a character. Normally
1605 * it's put in "conv_rest", but if it's too long
1606 * deal with it as if they were illegal bytes. */
1607 if (bytelen <= CONV_RESTLEN)
1608 break;
1610 /* weird overlong byte sequence */
1611 bytelen = size;
1612 found_bad = TRUE;
1614 else
1616 int u8c = utf_ptr2char(src);
1618 if (u8c > 0xffff || (*src >= 0x80 && bytelen == 1))
1619 found_bad = TRUE;
1620 ucs2buf[0] = u8c;
1621 ucs2len = 1;
1624 else
1625 # endif
1627 /* We don't know how long the byte sequence is, try
1628 * from one to three bytes. */
1629 for (bytelen = 1; bytelen <= size && bytelen <= 3;
1630 ++bytelen)
1632 ucs2len = MultiByteToWideChar(codepage,
1633 MB_ERR_INVALID_CHARS,
1634 (LPCSTR)src, bytelen,
1635 ucs2buf, 3);
1636 if (ucs2len > 0)
1637 break;
1639 if (ucs2len == 0)
1641 /* If we have only one byte then it's probably an
1642 * incomplete byte sequence. Otherwise discard
1643 * one byte as a bad character. */
1644 if (size == 1)
1645 break;
1646 found_bad = TRUE;
1647 bytelen = 1;
1651 if (!found_bad)
1653 int i;
1655 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1656 if (enc_utf8)
1658 /* From UCS-2 to UTF-8. Cannot fail. */
1659 for (i = 0; i < ucs2len; ++i)
1660 dst += utf_char2bytes(ucs2buf[i], dst);
1662 else
1664 BOOL bad = FALSE;
1665 int dstlen;
1667 /* From UCS-2 to "enc_codepage". If the
1668 * conversion uses the default character "?",
1669 * the data doesn't fit in this encoding. */
1670 dstlen = WideCharToMultiByte(enc_codepage, 0,
1671 (LPCWSTR)ucs2buf, ucs2len,
1672 (LPSTR)dst, (int)(src - dst),
1673 replstr, &bad);
1674 if (bad)
1675 found_bad = TRUE;
1676 else
1677 dst += dstlen;
1681 if (found_bad)
1683 /* Deal with bytes we can't convert. */
1684 if (can_retry)
1685 goto rewind_retry;
1686 if (conv_error == 0)
1687 conv_error = readfile_linenr(linecnt, ptr, dst);
1688 if (bad_char_behavior != BAD_DROP)
1690 if (bad_char_behavior == BAD_KEEP)
1692 mch_memmove(dst, src, bytelen);
1693 dst += bytelen;
1695 else
1696 *dst++ = bad_char_behavior;
1700 src += bytelen;
1701 size -= bytelen;
1704 if (size > 0)
1706 /* An incomplete byte sequence remaining. */
1707 mch_memmove(conv_rest, src, size);
1708 conv_restlen = size;
1711 /* The new size is equal to how much "dst" was advanced. */
1712 size = (long)(dst - ptr);
1714 else
1715 # endif
1716 # ifdef MACOS_CONVERT
1717 if (fio_flags & FIO_MACROMAN)
1720 * Conversion from Apple MacRoman char encoding to UTF-8 or
1721 * latin1. This is in os_mac_conv.c.
1723 if (macroman2enc(ptr, &size, real_size) == FAIL)
1724 goto rewind_retry;
1726 else
1727 # endif
1728 if (fio_flags != 0)
1730 int u8c;
1731 char_u *dest;
1732 char_u *tail = NULL;
1735 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1736 * "enc_utf8" not set: Convert Unicode to Latin1.
1737 * Go from end to start through the buffer, because the number
1738 * of bytes may increase.
1739 * "dest" points to after where the UTF-8 bytes go, "p" points
1740 * to after the next character to convert.
1742 dest = ptr + real_size;
1743 if (fio_flags == FIO_LATIN1 || fio_flags == FIO_UTF8)
1745 p = ptr + size;
1746 if (fio_flags == FIO_UTF8)
1748 /* Check for a trailing incomplete UTF-8 sequence */
1749 tail = ptr + size - 1;
1750 while (tail > ptr && (*tail & 0xc0) == 0x80)
1751 --tail;
1752 if (tail + utf_byte2len(*tail) <= ptr + size)
1753 tail = NULL;
1754 else
1755 p = tail;
1758 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1760 /* Check for a trailing byte */
1761 p = ptr + (size & ~1);
1762 if (size & 1)
1763 tail = p;
1764 if ((fio_flags & FIO_UTF16) && p > ptr)
1766 /* Check for a trailing leading word */
1767 if (fio_flags & FIO_ENDIAN_L)
1769 u8c = (*--p << 8);
1770 u8c += *--p;
1772 else
1774 u8c = *--p;
1775 u8c += (*--p << 8);
1777 if (u8c >= 0xd800 && u8c <= 0xdbff)
1778 tail = p;
1779 else
1780 p += 2;
1783 else /* FIO_UCS4 */
1785 /* Check for trailing 1, 2 or 3 bytes */
1786 p = ptr + (size & ~3);
1787 if (size & 3)
1788 tail = p;
1791 /* If there is a trailing incomplete sequence move it to
1792 * conv_rest[]. */
1793 if (tail != NULL)
1795 conv_restlen = (int)((ptr + size) - tail);
1796 mch_memmove(conv_rest, (char_u *)tail, conv_restlen);
1797 size -= conv_restlen;
1801 while (p > ptr)
1803 if (fio_flags & FIO_LATIN1)
1804 u8c = *--p;
1805 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1807 if (fio_flags & FIO_ENDIAN_L)
1809 u8c = (*--p << 8);
1810 u8c += *--p;
1812 else
1814 u8c = *--p;
1815 u8c += (*--p << 8);
1817 if ((fio_flags & FIO_UTF16)
1818 && u8c >= 0xdc00 && u8c <= 0xdfff)
1820 int u16c;
1822 if (p == ptr)
1824 /* Missing leading word. */
1825 if (can_retry)
1826 goto rewind_retry;
1827 if (conv_error == 0)
1828 conv_error = readfile_linenr(linecnt,
1829 ptr, p);
1830 if (bad_char_behavior == BAD_DROP)
1831 continue;
1832 if (bad_char_behavior != BAD_KEEP)
1833 u8c = bad_char_behavior;
1836 /* found second word of double-word, get the first
1837 * word and compute the resulting character */
1838 if (fio_flags & FIO_ENDIAN_L)
1840 u16c = (*--p << 8);
1841 u16c += *--p;
1843 else
1845 u16c = *--p;
1846 u16c += (*--p << 8);
1848 u8c = 0x10000 + ((u16c & 0x3ff) << 10)
1849 + (u8c & 0x3ff);
1851 /* Check if the word is indeed a leading word. */
1852 if (u16c < 0xd800 || u16c > 0xdbff)
1854 if (can_retry)
1855 goto rewind_retry;
1856 if (conv_error == 0)
1857 conv_error = readfile_linenr(linecnt,
1858 ptr, p);
1859 if (bad_char_behavior == BAD_DROP)
1860 continue;
1861 if (bad_char_behavior != BAD_KEEP)
1862 u8c = bad_char_behavior;
1866 else if (fio_flags & FIO_UCS4)
1868 if (fio_flags & FIO_ENDIAN_L)
1870 u8c = (*--p << 24);
1871 u8c += (*--p << 16);
1872 u8c += (*--p << 8);
1873 u8c += *--p;
1875 else /* big endian */
1877 u8c = *--p;
1878 u8c += (*--p << 8);
1879 u8c += (*--p << 16);
1880 u8c += (*--p << 24);
1883 else /* UTF-8 */
1885 if (*--p < 0x80)
1886 u8c = *p;
1887 else
1889 len = utf_head_off(ptr, p);
1890 p -= len;
1891 u8c = utf_ptr2char(p);
1892 if (len == 0)
1894 /* Not a valid UTF-8 character, retry with
1895 * another fenc when possible, otherwise just
1896 * report the error. */
1897 if (can_retry)
1898 goto rewind_retry;
1899 if (conv_error == 0)
1900 conv_error = readfile_linenr(linecnt,
1901 ptr, p);
1902 if (bad_char_behavior == BAD_DROP)
1903 continue;
1904 if (bad_char_behavior != BAD_KEEP)
1905 u8c = bad_char_behavior;
1909 if (enc_utf8) /* produce UTF-8 */
1911 dest -= utf_char2len(u8c);
1912 (void)utf_char2bytes(u8c, dest);
1914 else /* produce Latin1 */
1916 --dest;
1917 if (u8c >= 0x100)
1919 /* character doesn't fit in latin1, retry with
1920 * another fenc when possible, otherwise just
1921 * report the error. */
1922 if (can_retry)
1923 goto rewind_retry;
1924 if (conv_error == 0)
1925 conv_error = readfile_linenr(linecnt, ptr, p);
1926 if (bad_char_behavior == BAD_DROP)
1927 ++dest;
1928 else if (bad_char_behavior == BAD_KEEP)
1929 *dest = u8c;
1930 else if (eap != NULL && eap->bad_char != 0)
1931 *dest = bad_char_behavior;
1932 else
1933 *dest = 0xBF;
1935 else
1936 *dest = u8c;
1940 /* move the linerest to before the converted characters */
1941 line_start = dest - linerest;
1942 mch_memmove(line_start, buffer, (size_t)linerest);
1943 size = (long)((ptr + real_size) - dest);
1944 ptr = dest;
1946 else if (enc_utf8 && !curbuf->b_p_bin)
1948 int incomplete_tail = FALSE;
1950 /* Reading UTF-8: Check if the bytes are valid UTF-8. */
1951 for (p = ptr; ; ++p)
1953 int todo = (int)((ptr + size) - p);
1954 int l;
1956 if (todo <= 0)
1957 break;
1958 if (*p >= 0x80)
1960 /* A length of 1 means it's an illegal byte. Accept
1961 * an incomplete character at the end though, the next
1962 * read() will get the next bytes, we'll check it
1963 * then. */
1964 l = utf_ptr2len_len(p, todo);
1965 if (l > todo && !incomplete_tail)
1967 /* Avoid retrying with a different encoding when
1968 * a truncated file is more likely, or attempting
1969 * to read the rest of an incomplete sequence when
1970 * we have already done so. */
1971 if (p > ptr || filesize > 0)
1972 incomplete_tail = TRUE;
1973 /* Incomplete byte sequence, move it to conv_rest[]
1974 * and try to read the rest of it, unless we've
1975 * already done so. */
1976 if (p > ptr)
1978 conv_restlen = todo;
1979 mch_memmove(conv_rest, p, conv_restlen);
1980 size -= conv_restlen;
1981 break;
1984 if (l == 1 || l > todo)
1986 /* Illegal byte. If we can try another encoding
1987 * do that, unless at EOF where a truncated
1988 * file is more likely than a conversion error. */
1989 if (can_retry && !incomplete_tail)
1990 break;
1991 # ifdef USE_ICONV
1992 /* When we did a conversion report an error. */
1993 if (iconv_fd != (iconv_t)-1 && conv_error == 0)
1994 conv_error = readfile_linenr(linecnt, ptr, p);
1995 # endif
1996 /* Remember the first linenr with an illegal byte */
1997 if (conv_error == 0 && illegal_byte == 0)
1998 illegal_byte = readfile_linenr(linecnt, ptr, p);
2000 /* Drop, keep or replace the bad byte. */
2001 if (bad_char_behavior == BAD_DROP)
2003 mch_memmove(p, p + 1, todo - 1);
2004 --p;
2005 --size;
2007 else if (bad_char_behavior != BAD_KEEP)
2008 *p = bad_char_behavior;
2010 else
2011 p += l - 1;
2014 if (p < ptr + size && !incomplete_tail)
2016 /* Detected a UTF-8 error. */
2017 rewind_retry:
2018 /* Retry reading with another conversion. */
2019 # if defined(FEAT_EVAL) && defined(USE_ICONV)
2020 if (*p_ccv != NUL && iconv_fd != (iconv_t)-1)
2021 /* iconv() failed, try 'charconvert' */
2022 did_iconv = TRUE;
2023 else
2024 # endif
2025 /* use next item from 'fileencodings' */
2026 advance_fenc = TRUE;
2027 file_rewind = TRUE;
2028 goto retry;
2031 #endif
2033 /* count the number of characters (after conversion!) */
2034 filesize += size;
2037 * when reading the first part of a file: guess EOL type
2039 if (fileformat == EOL_UNKNOWN)
2041 /* First try finding a NL, for Dos and Unix */
2042 if (try_dos || try_unix)
2044 for (p = ptr; p < ptr + size; ++p)
2046 if (*p == NL)
2048 if (!try_unix
2049 || (try_dos && p > ptr && p[-1] == CAR))
2050 fileformat = EOL_DOS;
2051 else
2052 fileformat = EOL_UNIX;
2053 break;
2057 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
2058 if (fileformat == EOL_UNIX && try_mac)
2060 /* Need to reset the counters when retrying fenc. */
2061 try_mac = 1;
2062 try_unix = 1;
2063 for (; p >= ptr && *p != CAR; p--)
2065 if (p >= ptr)
2067 for (p = ptr; p < ptr + size; ++p)
2069 if (*p == NL)
2070 try_unix++;
2071 else if (*p == CAR)
2072 try_mac++;
2074 if (try_mac > try_unix)
2075 fileformat = EOL_MAC;
2080 /* No NL found: may use Mac format */
2081 if (fileformat == EOL_UNKNOWN && try_mac)
2082 fileformat = EOL_MAC;
2084 /* Still nothing found? Use first format in 'ffs' */
2085 if (fileformat == EOL_UNKNOWN)
2086 fileformat = default_fileformat();
2088 /* if editing a new file: may set p_tx and p_ff */
2089 if (set_options)
2090 set_fileformat(fileformat, OPT_LOCAL);
2095 * This loop is executed once for every character read.
2096 * Keep it fast!
2098 if (fileformat == EOL_MAC)
2100 --ptr;
2101 while (++ptr, --size >= 0)
2103 /* catch most common case first */
2104 if ((c = *ptr) != NUL && c != CAR && c != NL)
2105 continue;
2106 if (c == NUL)
2107 *ptr = NL; /* NULs are replaced by newlines! */
2108 else if (c == NL)
2109 *ptr = CAR; /* NLs are replaced by CRs! */
2110 else
2112 if (skip_count == 0)
2114 *ptr = NUL; /* end of line */
2115 len = (colnr_T) (ptr - line_start + 1);
2116 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2118 error = TRUE;
2119 break;
2121 ++lnum;
2122 if (--read_count == 0)
2124 error = TRUE; /* break loop */
2125 line_start = ptr; /* nothing left to write */
2126 break;
2129 else
2130 --skip_count;
2131 line_start = ptr + 1;
2135 else
2137 --ptr;
2138 while (++ptr, --size >= 0)
2140 if ((c = *ptr) != NUL && c != NL) /* catch most common case */
2141 continue;
2142 if (c == NUL)
2143 *ptr = NL; /* NULs are replaced by newlines! */
2144 else
2146 if (skip_count == 0)
2148 *ptr = NUL; /* end of line */
2149 len = (colnr_T)(ptr - line_start + 1);
2150 if (fileformat == EOL_DOS)
2152 if (ptr[-1] == CAR) /* remove CR */
2154 ptr[-1] = NUL;
2155 --len;
2158 * Reading in Dos format, but no CR-LF found!
2159 * When 'fileformats' includes "unix", delete all
2160 * the lines read so far and start all over again.
2161 * Otherwise give an error message later.
2163 else if (ff_error != EOL_DOS)
2165 if ( try_unix
2166 && !read_stdin
2167 && (read_buffer
2168 || lseek(fd, (off_t)0L, SEEK_SET) == 0))
2170 fileformat = EOL_UNIX;
2171 if (set_options)
2172 set_fileformat(EOL_UNIX, OPT_LOCAL);
2173 file_rewind = TRUE;
2174 keep_fileformat = TRUE;
2175 goto retry;
2177 ff_error = EOL_DOS;
2180 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2182 error = TRUE;
2183 break;
2185 ++lnum;
2186 if (--read_count == 0)
2188 error = TRUE; /* break loop */
2189 line_start = ptr; /* nothing left to write */
2190 break;
2193 else
2194 --skip_count;
2195 line_start = ptr + 1;
2199 linerest = (long)(ptr - line_start);
2200 ui_breakcheck();
2203 failed:
2204 /* not an error, max. number of lines reached */
2205 if (error && read_count == 0)
2206 error = FALSE;
2209 * If we get EOF in the middle of a line, note the fact and
2210 * complete the line ourselves.
2211 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2213 if (!error
2214 && !got_int
2215 && linerest != 0
2216 && !(!curbuf->b_p_bin
2217 && fileformat == EOL_DOS
2218 && *line_start == Ctrl_Z
2219 && ptr == line_start + 1))
2221 /* remember for when writing */
2222 if (set_options)
2223 curbuf->b_p_eol = FALSE;
2224 *ptr = NUL;
2225 if (ml_append(lnum, line_start,
2226 (colnr_T)(ptr - line_start + 1), newfile) == FAIL)
2227 error = TRUE;
2228 else
2229 read_no_eol_lnum = ++lnum;
2232 if (set_options)
2233 save_file_ff(curbuf); /* remember the current file format */
2235 #ifdef FEAT_CRYPT
2236 if (cryptkey != curbuf->b_p_key)
2237 vim_free(cryptkey);
2238 #endif
2240 #ifdef FEAT_MBYTE
2241 /* If editing a new file: set 'fenc' for the current buffer.
2242 * Also for ":read ++edit file". */
2243 if (set_options)
2244 set_string_option_direct((char_u *)"fenc", -1, fenc,
2245 OPT_FREE|OPT_LOCAL, 0);
2246 if (fenc_alloced)
2247 vim_free(fenc);
2248 # ifdef USE_ICONV
2249 if (iconv_fd != (iconv_t)-1)
2251 iconv_close(iconv_fd);
2252 iconv_fd = (iconv_t)-1;
2254 # endif
2255 #endif
2257 if (!read_buffer && !read_stdin)
2258 close(fd); /* errors are ignored */
2259 #ifdef HAVE_FD_CLOEXEC
2260 else
2262 int fdflags = fcntl(fd, F_GETFD);
2263 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
2264 fcntl(fd, F_SETFD, fdflags | FD_CLOEXEC);
2266 #endif
2267 vim_free(buffer);
2269 #ifdef HAVE_DUP
2270 if (read_stdin)
2272 /* Use stderr for stdin, makes shell commands work. */
2273 close(0);
2274 ignored = dup(2);
2276 #endif
2278 #ifdef FEAT_MBYTE
2279 if (tmpname != NULL)
2281 mch_remove(tmpname); /* delete converted file */
2282 vim_free(tmpname);
2284 #endif
2285 --no_wait_return; /* may wait for return now */
2288 * In recovery mode everything but autocommands is skipped.
2290 if (!recoverymode)
2292 /* need to delete the last line, which comes from the empty buffer */
2293 if (newfile && wasempty && !(curbuf->b_ml.ml_flags & ML_EMPTY))
2295 #ifdef FEAT_NETBEANS_INTG
2296 netbeansFireChanges = 0;
2297 #endif
2298 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
2299 #ifdef FEAT_NETBEANS_INTG
2300 netbeansFireChanges = 1;
2301 #endif
2302 --linecnt;
2304 linecnt = curbuf->b_ml.ml_line_count - linecnt;
2305 if (filesize == 0)
2306 linecnt = 0;
2307 if (newfile || read_buffer)
2309 redraw_curbuf_later(NOT_VALID);
2310 #ifdef FEAT_DIFF
2311 /* After reading the text into the buffer the diff info needs to
2312 * be updated. */
2313 diff_invalidate(curbuf);
2314 #endif
2315 #ifdef FEAT_FOLDING
2316 /* All folds in the window are invalid now. Mark them for update
2317 * before triggering autocommands. */
2318 foldUpdateAll(curwin);
2319 #endif
2321 else if (linecnt) /* appended at least one line */
2322 appended_lines_mark(from, linecnt);
2324 #ifndef ALWAYS_USE_GUI
2326 * If we were reading from the same terminal as where messages go,
2327 * the screen will have been messed up.
2328 * Switch on raw mode now and clear the screen.
2330 if (read_stdin)
2332 settmode(TMODE_RAW); /* set to raw mode */
2333 starttermcap();
2334 screenclear();
2336 #endif
2338 if (got_int)
2340 if (!(flags & READ_DUMMY))
2342 filemess(curbuf, sfname, (char_u *)_(e_interr), 0);
2343 if (newfile)
2344 curbuf->b_p_ro = TRUE; /* must use "w!" now */
2346 msg_scroll = msg_save;
2347 #ifdef FEAT_VIMINFO
2348 check_marks_read();
2349 #endif
2350 return OK; /* an interrupt isn't really an error */
2353 if (!filtering && !(flags & READ_DUMMY))
2355 msg_add_fname(curbuf, sfname); /* fname in IObuff with quotes */
2356 c = FALSE;
2358 #ifdef UNIX
2359 # ifdef S_ISFIFO
2360 if (S_ISFIFO(perm)) /* fifo or socket */
2362 STRCAT(IObuff, _("[fifo/socket]"));
2363 c = TRUE;
2365 # else
2366 # ifdef S_IFIFO
2367 if ((perm & S_IFMT) == S_IFIFO) /* fifo */
2369 STRCAT(IObuff, _("[fifo]"));
2370 c = TRUE;
2372 # endif
2373 # ifdef S_IFSOCK
2374 if ((perm & S_IFMT) == S_IFSOCK) /* or socket */
2376 STRCAT(IObuff, _("[socket]"));
2377 c = TRUE;
2379 # endif
2380 # endif
2381 # ifdef OPEN_CHR_FILES
2382 if (S_ISCHR(perm)) /* or character special */
2384 STRCAT(IObuff, _("[character special]"));
2385 c = TRUE;
2387 # endif
2388 #endif
2389 if (curbuf->b_p_ro)
2391 STRCAT(IObuff, shortmess(SHM_RO) ? _("[RO]") : _("[readonly]"));
2392 c = TRUE;
2394 if (read_no_eol_lnum)
2396 msg_add_eol();
2397 c = TRUE;
2399 if (ff_error == EOL_DOS)
2401 STRCAT(IObuff, _("[CR missing]"));
2402 c = TRUE;
2404 if (split)
2406 STRCAT(IObuff, _("[long lines split]"));
2407 c = TRUE;
2409 #ifdef FEAT_MBYTE
2410 if (notconverted)
2412 STRCAT(IObuff, _("[NOT converted]"));
2413 c = TRUE;
2415 else if (converted)
2417 STRCAT(IObuff, _("[converted]"));
2418 c = TRUE;
2420 #endif
2421 #ifdef FEAT_CRYPT
2422 if (cryptkey != NULL)
2424 STRCAT(IObuff, _("[crypted]"));
2425 c = TRUE;
2427 #endif
2428 #ifdef FEAT_MBYTE
2429 if (conv_error != 0)
2431 sprintf((char *)IObuff + STRLEN(IObuff),
2432 _("[CONVERSION ERROR in line %ld]"), (long)conv_error);
2433 c = TRUE;
2435 else if (illegal_byte > 0)
2437 sprintf((char *)IObuff + STRLEN(IObuff),
2438 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte);
2439 c = TRUE;
2441 else
2442 #endif
2443 if (error)
2445 STRCAT(IObuff, _("[READ ERRORS]"));
2446 c = TRUE;
2448 if (msg_add_fileformat(fileformat))
2449 c = TRUE;
2450 #ifdef FEAT_CRYPT
2451 if (cryptkey != NULL)
2452 msg_add_lines(c, (long)linecnt, filesize - CRYPT_MAGIC_LEN);
2453 else
2454 #endif
2455 msg_add_lines(c, (long)linecnt, filesize);
2457 vim_free(keep_msg);
2458 keep_msg = NULL;
2459 msg_scrolled_ign = TRUE;
2460 #ifdef ALWAYS_USE_GUI
2461 /* Don't show the message when reading stdin, it would end up in a
2462 * message box (which might be shown when exiting!) */
2463 if (read_stdin || read_buffer)
2464 p = msg_may_trunc(FALSE, IObuff);
2465 else
2466 #endif
2467 p = msg_trunc_attr(IObuff, FALSE, 0);
2468 if (read_stdin || read_buffer || restart_edit != 0
2469 || (msg_scrolled != 0 && !need_wait_return))
2470 /* Need to repeat the message after redrawing when:
2471 * - When reading from stdin (the screen will be cleared next).
2472 * - When restart_edit is set (otherwise there will be a delay
2473 * before redrawing).
2474 * - When the screen was scrolled but there is no wait-return
2475 * prompt. */
2476 set_keep_msg(p, 0);
2477 msg_scrolled_ign = FALSE;
2480 /* with errors writing the file requires ":w!" */
2481 if (newfile && (error
2482 #ifdef FEAT_MBYTE
2483 || conv_error != 0
2484 || (illegal_byte > 0 && bad_char_behavior != BAD_KEEP)
2485 #endif
2487 curbuf->b_p_ro = TRUE;
2489 u_clearline(); /* cannot use "U" command after adding lines */
2492 * In Ex mode: cursor at last new line.
2493 * Otherwise: cursor at first new line.
2495 if (exmode_active)
2496 curwin->w_cursor.lnum = from + linecnt;
2497 else
2498 curwin->w_cursor.lnum = from + 1;
2499 check_cursor_lnum();
2500 beginline(BL_WHITE | BL_FIX); /* on first non-blank */
2503 * Set '[ and '] marks to the newly read lines.
2505 curbuf->b_op_start.lnum = from + 1;
2506 curbuf->b_op_start.col = 0;
2507 curbuf->b_op_end.lnum = from + linecnt;
2508 curbuf->b_op_end.col = 0;
2510 #ifdef WIN32
2512 * Work around a weird problem: When a file has two links (only
2513 * possible on NTFS) and we write through one link, then stat() it
2514 * through the other link, the timestamp information may be wrong.
2515 * It's correct again after reading the file, thus reset the timestamp
2516 * here.
2518 if (newfile && !read_stdin && !read_buffer
2519 && mch_stat((char *)fname, &st) >= 0)
2521 buf_store_time(curbuf, &st, fname);
2522 curbuf->b_mtime_read = curbuf->b_mtime;
2524 #endif
2526 msg_scroll = msg_save;
2528 #ifdef FEAT_VIMINFO
2530 * Get the marks before executing autocommands, so they can be used there.
2532 check_marks_read();
2533 #endif
2536 * Trick: We remember if the last line of the read didn't have
2537 * an eol for when writing it again. This is required for
2538 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2540 write_no_eol_lnum = read_no_eol_lnum;
2542 #ifdef FEAT_AUTOCMD
2543 if (!read_stdin && !read_buffer)
2545 int m = msg_scroll;
2546 int n = msg_scrolled;
2548 /* Save the fileformat now, otherwise the buffer will be considered
2549 * modified if the format/encoding was automatically detected. */
2550 if (set_options)
2551 save_file_ff(curbuf);
2554 * The output from the autocommands should not overwrite anything and
2555 * should not be overwritten: Set msg_scroll, restore its value if no
2556 * output was done.
2558 msg_scroll = TRUE;
2559 if (filtering)
2560 apply_autocmds_exarg(EVENT_FILTERREADPOST, NULL, sfname,
2561 FALSE, curbuf, eap);
2562 else if (newfile)
2563 apply_autocmds_exarg(EVENT_BUFREADPOST, NULL, sfname,
2564 FALSE, curbuf, eap);
2565 else
2566 apply_autocmds_exarg(EVENT_FILEREADPOST, sfname, sfname,
2567 FALSE, NULL, eap);
2568 if (msg_scrolled == n)
2569 msg_scroll = m;
2570 #ifdef FEAT_EVAL
2571 if (aborting()) /* autocmds may abort script processing */
2572 return FAIL;
2573 #endif
2575 #endif
2577 if (recoverymode && error)
2578 return FAIL;
2579 return OK;
2582 #ifdef OPEN_CHR_FILES
2584 * Returns TRUE if the file name argument is of the form "/dev/fd/\d\+",
2585 * which is the name of files used for process substitution output by
2586 * some shells on some operating systems, e.g., bash on SunOS.
2587 * Do not accept "/dev/fd/[012]", opening these may hang Vim.
2589 static int
2590 is_dev_fd_file(fname)
2591 char_u *fname;
2593 return (STRNCMP(fname, "/dev/fd/", 8) == 0
2594 && VIM_ISDIGIT(fname[8])
2595 && *skipdigits(fname + 9) == NUL
2596 && (fname[9] != NUL
2597 || (fname[8] != '0' && fname[8] != '1' && fname[8] != '2')));
2599 #endif
2601 #ifdef FEAT_MBYTE
2604 * From the current line count and characters read after that, estimate the
2605 * line number where we are now.
2606 * Used for error messages that include a line number.
2608 static linenr_T
2609 readfile_linenr(linecnt, p, endp)
2610 linenr_T linecnt; /* line count before reading more bytes */
2611 char_u *p; /* start of more bytes read */
2612 char_u *endp; /* end of more bytes read */
2614 char_u *s;
2615 linenr_T lnum;
2617 lnum = curbuf->b_ml.ml_line_count - linecnt + 1;
2618 for (s = p; s < endp; ++s)
2619 if (*s == '\n')
2620 ++lnum;
2621 return lnum;
2623 #endif
2626 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2627 * equal to the buffer "buf". Used for calling readfile().
2628 * Returns OK or FAIL.
2631 prep_exarg(eap, buf)
2632 exarg_T *eap;
2633 buf_T *buf;
2635 eap->cmd = alloc((unsigned)(STRLEN(buf->b_p_ff)
2636 #ifdef FEAT_MBYTE
2637 + STRLEN(buf->b_p_fenc)
2638 #endif
2639 + 15));
2640 if (eap->cmd == NULL)
2641 return FAIL;
2643 #ifdef FEAT_MBYTE
2644 sprintf((char *)eap->cmd, "e ++ff=%s ++enc=%s", buf->b_p_ff, buf->b_p_fenc);
2645 eap->force_enc = 14 + (int)STRLEN(buf->b_p_ff);
2646 eap->bad_char = buf->b_bad_char;
2647 #else
2648 sprintf((char *)eap->cmd, "e ++ff=%s", buf->b_p_ff);
2649 #endif
2650 eap->force_ff = 7;
2652 eap->force_bin = buf->b_p_bin ? FORCE_BIN : FORCE_NOBIN;
2653 eap->read_edit = FALSE;
2654 eap->forceit = FALSE;
2655 return OK;
2658 #ifdef FEAT_MBYTE
2660 * Find next fileencoding to use from 'fileencodings'.
2661 * "pp" points to fenc_next. It's advanced to the next item.
2662 * When there are no more items, an empty string is returned and *pp is set to
2663 * NULL.
2664 * When *pp is not set to NULL, the result is in allocated memory.
2666 static char_u *
2667 next_fenc(pp)
2668 char_u **pp;
2670 char_u *p;
2671 char_u *r;
2673 if (**pp == NUL)
2675 *pp = NULL;
2676 return (char_u *)"";
2678 p = vim_strchr(*pp, ',');
2679 if (p == NULL)
2681 r = enc_canonize(*pp);
2682 *pp += STRLEN(*pp);
2684 else
2686 r = vim_strnsave(*pp, (int)(p - *pp));
2687 *pp = p + 1;
2688 if (r != NULL)
2690 p = enc_canonize(r);
2691 vim_free(r);
2692 r = p;
2695 if (r == NULL) /* out of memory */
2697 r = (char_u *)"";
2698 *pp = NULL;
2700 return r;
2703 # ifdef FEAT_EVAL
2705 * Convert a file with the 'charconvert' expression.
2706 * This closes the file which is to be read, converts it and opens the
2707 * resulting file for reading.
2708 * Returns name of the resulting converted file (the caller should delete it
2709 * after reading it).
2710 * Returns NULL if the conversion failed ("*fdp" is not set) .
2712 static char_u *
2713 readfile_charconvert(fname, fenc, fdp)
2714 char_u *fname; /* name of input file */
2715 char_u *fenc; /* converted from */
2716 int *fdp; /* in/out: file descriptor of file */
2718 char_u *tmpname;
2719 char_u *errmsg = NULL;
2721 tmpname = vim_tempname('r');
2722 if (tmpname == NULL)
2723 errmsg = (char_u *)_("Can't find temp file for conversion");
2724 else
2726 close(*fdp); /* close the input file, ignore errors */
2727 *fdp = -1;
2728 if (eval_charconvert(fenc, enc_utf8 ? (char_u *)"utf-8" : p_enc,
2729 fname, tmpname) == FAIL)
2730 errmsg = (char_u *)_("Conversion with 'charconvert' failed");
2731 if (errmsg == NULL && (*fdp = mch_open((char *)tmpname,
2732 O_RDONLY | O_EXTRA, 0)) < 0)
2733 errmsg = (char_u *)_("can't read output of 'charconvert'");
2736 if (errmsg != NULL)
2738 /* Don't use emsg(), it breaks mappings, the retry with
2739 * another type of conversion might still work. */
2740 MSG(errmsg);
2741 if (tmpname != NULL)
2743 mch_remove(tmpname); /* delete converted file */
2744 vim_free(tmpname);
2745 tmpname = NULL;
2749 /* If the input file is closed, open it (caller should check for error). */
2750 if (*fdp < 0)
2751 *fdp = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2753 return tmpname;
2755 # endif
2757 #endif
2759 #ifdef FEAT_VIMINFO
2761 * Read marks for the current buffer from the viminfo file, when we support
2762 * buffer marks and the buffer has a name.
2764 static void
2765 check_marks_read()
2767 if (!curbuf->b_marks_read && get_viminfo_parameter('\'') > 0
2768 && curbuf->b_ffname != NULL)
2769 read_viminfo(NULL, VIF_WANT_MARKS);
2771 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2772 * the ' parameter after opening a buffer. */
2773 curbuf->b_marks_read = TRUE;
2775 #endif
2777 #ifdef FEAT_CRYPT
2779 * Check for magic number used for encryption.
2780 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2781 * *filesizep are updated.
2782 * Return the (new) encryption key, NULL for no encryption.
2784 static char_u *
2785 check_for_cryptkey(cryptkey, ptr, sizep, filesizep, newfile)
2786 char_u *cryptkey; /* previous encryption key or NULL */
2787 char_u *ptr; /* pointer to read bytes */
2788 long *sizep; /* length of read bytes */
2789 long *filesizep; /* nr of bytes used from file */
2790 int newfile; /* editing a new buffer */
2792 if (*sizep >= CRYPT_MAGIC_LEN
2793 && STRNCMP(ptr, CRYPT_MAGIC, CRYPT_MAGIC_LEN) == 0)
2795 if (cryptkey == NULL)
2797 if (*curbuf->b_p_key)
2798 cryptkey = curbuf->b_p_key;
2799 else
2801 /* When newfile is TRUE, store the typed key
2802 * in the 'key' option and don't free it. */
2803 cryptkey = get_crypt_key(newfile, FALSE);
2804 /* check if empty key entered */
2805 if (cryptkey != NULL && *cryptkey == NUL)
2807 if (cryptkey != curbuf->b_p_key)
2808 vim_free(cryptkey);
2809 cryptkey = NULL;
2814 if (cryptkey != NULL)
2816 crypt_init_keys(cryptkey);
2818 /* Remove magic number from the text */
2819 *filesizep += CRYPT_MAGIC_LEN;
2820 *sizep -= CRYPT_MAGIC_LEN;
2821 mch_memmove(ptr, ptr + CRYPT_MAGIC_LEN, (size_t)*sizep);
2824 /* When starting to edit a new file which does not have
2825 * encryption, clear the 'key' option, except when
2826 * starting up (called with -x argument) */
2827 else if (newfile && *curbuf->b_p_key && !starting)
2828 set_option_value((char_u *)"key", 0L, (char_u *)"", OPT_LOCAL);
2830 return cryptkey;
2832 #endif
2834 #ifdef UNIX
2835 static void
2836 set_file_time(fname, atime, mtime)
2837 char_u *fname;
2838 time_t atime; /* access time */
2839 time_t mtime; /* modification time */
2841 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2842 struct utimbuf buf;
2844 buf.actime = atime;
2845 buf.modtime = mtime;
2846 (void)utime((char *)fname, &buf);
2847 # else
2848 # if defined(HAVE_UTIMES)
2849 struct timeval tvp[2];
2851 tvp[0].tv_sec = atime;
2852 tvp[0].tv_usec = 0;
2853 tvp[1].tv_sec = mtime;
2854 tvp[1].tv_usec = 0;
2855 # ifdef NeXT
2856 (void)utimes((char *)fname, tvp);
2857 # else
2858 (void)utimes((char *)fname, (const struct timeval *)&tvp);
2859 # endif
2860 # endif
2861 # endif
2863 #endif /* UNIX */
2865 #if defined(VMS) && !defined(MIN)
2866 /* Older DECC compiler for VAX doesn't define MIN() */
2867 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2868 #endif
2871 * Return TRUE if a file appears to be read-only from the file permissions.
2874 check_file_readonly(fname, perm)
2875 char_u *fname; /* full path to file */
2876 int perm; /* known permissions on file */
2878 #ifndef USE_MCH_ACCESS
2879 int fd = 0;
2880 #endif
2882 return (
2883 #ifdef USE_MCH_ACCESS
2884 # ifdef UNIX
2885 (perm & 0222) == 0 ||
2886 # endif
2887 mch_access((char *)fname, W_OK)
2888 #else
2889 (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0
2890 ? TRUE : (close(fd), FALSE)
2891 #endif
2897 * buf_write() - write to file "fname" lines "start" through "end"
2899 * We do our own buffering here because fwrite() is so slow.
2901 * If "forceit" is true, we don't care for errors when attempting backups.
2902 * In case of an error everything possible is done to restore the original
2903 * file. But when "forceit" is TRUE, we risk losing it.
2905 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2906 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2908 * This function must NOT use NameBuff (because it's called by autowrite()).
2910 * return FAIL for failure, OK otherwise
2913 buf_write(buf, fname, sfname, start, end, eap, append, forceit,
2914 reset_changed, filtering)
2915 buf_T *buf;
2916 char_u *fname;
2917 char_u *sfname;
2918 linenr_T start, end;
2919 exarg_T *eap; /* for forced 'ff' and 'fenc', can be
2920 NULL! */
2921 int append; /* append to the file */
2922 int forceit;
2923 int reset_changed;
2924 int filtering;
2926 int fd;
2927 char_u *backup = NULL;
2928 int backup_copy = FALSE; /* copy the original file? */
2929 int dobackup;
2930 char_u *ffname;
2931 char_u *wfname = NULL; /* name of file to write to */
2932 char_u *s;
2933 char_u *ptr;
2934 char_u c;
2935 int len;
2936 linenr_T lnum;
2937 long nchars;
2938 char_u *errmsg = NULL;
2939 int errmsg_allocated = FALSE;
2940 char_u *errnum = NULL;
2941 char_u *buffer;
2942 char_u smallbuf[SMBUFSIZE];
2943 char_u *backup_ext;
2944 int bufsize;
2945 long perm; /* file permissions */
2946 int retval = OK;
2947 int newfile = FALSE; /* TRUE if file doesn't exist yet */
2948 int msg_save = msg_scroll;
2949 int overwriting; /* TRUE if writing over original */
2950 int no_eol = FALSE; /* no end-of-line written */
2951 int device = FALSE; /* writing to a device */
2952 struct stat st_old;
2953 int prev_got_int = got_int;
2954 int file_readonly = FALSE; /* overwritten file is read-only */
2955 static char *err_readonly = "is read-only (cannot override: \"W\" in 'cpoptions')";
2956 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2957 int made_writable = FALSE; /* 'w' bit has been set */
2958 #endif
2959 /* writing everything */
2960 int whole = (start == 1 && end == buf->b_ml.ml_line_count);
2961 #ifdef FEAT_AUTOCMD
2962 linenr_T old_line_count = buf->b_ml.ml_line_count;
2963 #endif
2964 int attr;
2965 int fileformat;
2966 int write_bin;
2967 struct bw_info write_info; /* info for buf_write_bytes() */
2968 #ifdef FEAT_MBYTE
2969 int converted = FALSE;
2970 int notconverted = FALSE;
2971 char_u *fenc; /* effective 'fileencoding' */
2972 char_u *fenc_tofree = NULL; /* allocated "fenc" */
2973 #endif
2974 #ifdef HAS_BW_FLAGS
2975 int wb_flags = 0;
2976 #endif
2977 #ifdef HAVE_ACL
2978 vim_acl_T acl = NULL; /* ACL copied from original file to
2979 backup or new file */
2980 #endif
2982 if (fname == NULL || *fname == NUL) /* safety check */
2983 return FAIL;
2986 * Disallow writing from .exrc and .vimrc in current directory for
2987 * security reasons.
2989 if (check_secure())
2990 return FAIL;
2992 /* Avoid a crash for a long name. */
2993 if (STRLEN(fname) >= MAXPATHL)
2995 EMSG(_(e_longname));
2996 return FAIL;
2999 #ifdef FEAT_MBYTE
3000 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
3001 write_info.bw_conv_buf = NULL;
3002 write_info.bw_conv_error = FALSE;
3003 write_info.bw_conv_error_lnum = 0;
3004 write_info.bw_restlen = 0;
3005 # ifdef USE_ICONV
3006 write_info.bw_iconv_fd = (iconv_t)-1;
3007 # endif
3008 #endif
3010 /* After writing a file changedtick changes but we don't want to display
3011 * the line. */
3012 ex_no_reprint = TRUE;
3015 * If there is no file name yet, use the one for the written file.
3016 * BF_NOTEDITED is set to reflect this (in case the write fails).
3017 * Don't do this when the write is for a filter command.
3018 * Don't do this when appending.
3019 * Only do this when 'cpoptions' contains the 'F' flag.
3021 if (buf->b_ffname == NULL
3022 && reset_changed
3023 && whole
3024 && buf == curbuf
3025 #ifdef FEAT_QUICKFIX
3026 && !bt_nofile(buf)
3027 #endif
3028 && !filtering
3029 && (!append || vim_strchr(p_cpo, CPO_FNAMEAPP) != NULL)
3030 && vim_strchr(p_cpo, CPO_FNAMEW) != NULL)
3032 if (set_rw_fname(fname, sfname) == FAIL)
3033 return FAIL;
3034 buf = curbuf; /* just in case autocmds made "buf" invalid */
3037 if (sfname == NULL)
3038 sfname = fname;
3040 * For Unix: Use the short file name whenever possible.
3041 * Avoids problems with networks and when directory names are changed.
3042 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
3043 * another directory, which we don't detect
3045 ffname = fname; /* remember full fname */
3046 #ifdef UNIX
3047 fname = sfname;
3048 #endif
3050 if (buf->b_ffname != NULL && fnamecmp(ffname, buf->b_ffname) == 0)
3051 overwriting = TRUE;
3052 else
3053 overwriting = FALSE;
3055 if (exiting)
3056 settmode(TMODE_COOK); /* when exiting allow typahead now */
3058 ++no_wait_return; /* don't wait for return yet */
3061 * Set '[ and '] marks to the lines to be written.
3063 buf->b_op_start.lnum = start;
3064 buf->b_op_start.col = 0;
3065 buf->b_op_end.lnum = end;
3066 buf->b_op_end.col = 0;
3068 #ifdef FEAT_AUTOCMD
3070 aco_save_T aco;
3071 int buf_ffname = FALSE;
3072 int buf_sfname = FALSE;
3073 int buf_fname_f = FALSE;
3074 int buf_fname_s = FALSE;
3075 int did_cmd = FALSE;
3076 int nofile_err = FALSE;
3077 int empty_memline = (buf->b_ml.ml_mfp == NULL);
3080 * Apply PRE aucocommands.
3081 * Set curbuf to the buffer to be written.
3082 * Careful: The autocommands may call buf_write() recursively!
3084 if (ffname == buf->b_ffname)
3085 buf_ffname = TRUE;
3086 if (sfname == buf->b_sfname)
3087 buf_sfname = TRUE;
3088 if (fname == buf->b_ffname)
3089 buf_fname_f = TRUE;
3090 if (fname == buf->b_sfname)
3091 buf_fname_s = TRUE;
3093 /* set curwin/curbuf to buf and save a few things */
3094 aucmd_prepbuf(&aco, buf);
3096 if (append)
3098 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEAPPENDCMD,
3099 sfname, sfname, FALSE, curbuf, eap)))
3101 #ifdef FEAT_QUICKFIX
3102 if (overwriting && bt_nofile(curbuf))
3103 nofile_err = TRUE;
3104 else
3105 #endif
3106 apply_autocmds_exarg(EVENT_FILEAPPENDPRE,
3107 sfname, sfname, FALSE, curbuf, eap);
3110 else if (filtering)
3112 apply_autocmds_exarg(EVENT_FILTERWRITEPRE,
3113 NULL, sfname, FALSE, curbuf, eap);
3115 else if (reset_changed && whole)
3117 if (!(did_cmd = apply_autocmds_exarg(EVENT_BUFWRITECMD,
3118 sfname, sfname, FALSE, curbuf, eap)))
3120 #ifdef FEAT_QUICKFIX
3121 if (overwriting && bt_nofile(curbuf))
3122 nofile_err = TRUE;
3123 else
3124 #endif
3125 apply_autocmds_exarg(EVENT_BUFWRITEPRE,
3126 sfname, sfname, FALSE, curbuf, eap);
3129 else
3131 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEWRITECMD,
3132 sfname, sfname, FALSE, curbuf, eap)))
3134 #ifdef FEAT_QUICKFIX
3135 if (overwriting && bt_nofile(curbuf))
3136 nofile_err = TRUE;
3137 else
3138 #endif
3139 apply_autocmds_exarg(EVENT_FILEWRITEPRE,
3140 sfname, sfname, FALSE, curbuf, eap);
3144 /* restore curwin/curbuf and a few other things */
3145 aucmd_restbuf(&aco);
3148 * In three situations we return here and don't write the file:
3149 * 1. the autocommands deleted or unloaded the buffer.
3150 * 2. The autocommands abort script processing.
3151 * 3. If one of the "Cmd" autocommands was executed.
3153 if (!buf_valid(buf))
3154 buf = NULL;
3155 if (buf == NULL || (buf->b_ml.ml_mfp == NULL && !empty_memline)
3156 || did_cmd || nofile_err
3157 #ifdef FEAT_EVAL
3158 || aborting()
3159 #endif
3162 --no_wait_return;
3163 msg_scroll = msg_save;
3164 if (nofile_err)
3165 EMSG(_("E676: No matching autocommands for acwrite buffer"));
3167 if (nofile_err
3168 #ifdef FEAT_EVAL
3169 || aborting()
3170 #endif
3172 /* An aborting error, interrupt or exception in the
3173 * autocommands. */
3174 return FAIL;
3175 if (did_cmd)
3177 if (buf == NULL)
3178 /* The buffer was deleted. We assume it was written
3179 * (can't retry anyway). */
3180 return OK;
3181 if (overwriting)
3183 /* Assume the buffer was written, update the timestamp. */
3184 ml_timestamp(buf);
3185 if (append)
3186 buf->b_flags &= ~BF_NEW;
3187 else
3188 buf->b_flags &= ~BF_WRITE_MASK;
3190 if (reset_changed && buf->b_changed && !append
3191 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL))
3192 /* Buffer still changed, the autocommands didn't work
3193 * properly. */
3194 return FAIL;
3195 return OK;
3197 #ifdef FEAT_EVAL
3198 if (!aborting())
3199 #endif
3200 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3201 return FAIL;
3205 * The autocommands may have changed the number of lines in the file.
3206 * When writing the whole file, adjust the end.
3207 * When writing part of the file, assume that the autocommands only
3208 * changed the number of lines that are to be written (tricky!).
3210 if (buf->b_ml.ml_line_count != old_line_count)
3212 if (whole) /* write all */
3213 end = buf->b_ml.ml_line_count;
3214 else if (buf->b_ml.ml_line_count > old_line_count) /* more lines */
3215 end += buf->b_ml.ml_line_count - old_line_count;
3216 else /* less lines */
3218 end -= old_line_count - buf->b_ml.ml_line_count;
3219 if (end < start)
3221 --no_wait_return;
3222 msg_scroll = msg_save;
3223 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3224 return FAIL;
3230 * The autocommands may have changed the name of the buffer, which may
3231 * be kept in fname, ffname and sfname.
3233 if (buf_ffname)
3234 ffname = buf->b_ffname;
3235 if (buf_sfname)
3236 sfname = buf->b_sfname;
3237 if (buf_fname_f)
3238 fname = buf->b_ffname;
3239 if (buf_fname_s)
3240 fname = buf->b_sfname;
3242 #endif
3244 #ifdef FEAT_NETBEANS_INTG
3245 if (usingNetbeans && isNetbeansBuffer(buf))
3247 if (whole)
3250 * b_changed can be 0 after an undo, but we still need to write
3251 * the buffer to NetBeans.
3253 if (buf->b_changed || isNetbeansModified(buf))
3255 --no_wait_return; /* may wait for return now */
3256 msg_scroll = msg_save;
3257 netbeans_save_buffer(buf); /* no error checking... */
3258 return retval;
3260 else
3262 errnum = (char_u *)"E656: ";
3263 errmsg = (char_u *)_("NetBeans disallows writes of unmodified buffers");
3264 buffer = NULL;
3265 goto fail;
3268 else
3270 errnum = (char_u *)"E657: ";
3271 errmsg = (char_u *)_("Partial writes disallowed for NetBeans buffers");
3272 buffer = NULL;
3273 goto fail;
3276 #endif
3278 if (shortmess(SHM_OVER) && !exiting)
3279 msg_scroll = FALSE; /* overwrite previous file message */
3280 else
3281 msg_scroll = TRUE; /* don't overwrite previous file message */
3282 if (!filtering)
3283 filemess(buf,
3284 #ifndef UNIX
3285 sfname,
3286 #else
3287 fname,
3288 #endif
3289 (char_u *)"", 0); /* show that we are busy */
3290 msg_scroll = FALSE; /* always overwrite the file message now */
3292 buffer = alloc(BUFSIZE);
3293 if (buffer == NULL) /* can't allocate big buffer, use small
3294 * one (to be able to write when out of
3295 * memory) */
3297 buffer = smallbuf;
3298 bufsize = SMBUFSIZE;
3300 else
3301 bufsize = BUFSIZE;
3304 * Get information about original file (if there is one).
3306 #if defined(UNIX) && !defined(ARCHIE)
3307 st_old.st_dev = 0;
3308 st_old.st_ino = 0;
3309 perm = -1;
3310 if (mch_stat((char *)fname, &st_old) < 0)
3311 newfile = TRUE;
3312 else
3314 perm = st_old.st_mode;
3315 if (!S_ISREG(st_old.st_mode)) /* not a file */
3317 if (S_ISDIR(st_old.st_mode))
3319 errnum = (char_u *)"E502: ";
3320 errmsg = (char_u *)_("is a directory");
3321 goto fail;
3323 if (mch_nodetype(fname) != NODE_WRITABLE)
3325 errnum = (char_u *)"E503: ";
3326 errmsg = (char_u *)_("is not a file or writable device");
3327 goto fail;
3329 /* It's a device of some kind (or a fifo) which we can write to
3330 * but for which we can't make a backup. */
3331 device = TRUE;
3332 newfile = TRUE;
3333 perm = -1;
3336 #else /* !UNIX */
3338 * Check for a writable device name.
3340 c = mch_nodetype(fname);
3341 if (c == NODE_OTHER)
3343 errnum = (char_u *)"E503: ";
3344 errmsg = (char_u *)_("is not a file or writable device");
3345 goto fail;
3347 if (c == NODE_WRITABLE)
3349 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3350 /* MS-Windows allows opening a device, but we will probably get stuck
3351 * trying to write to it. */
3352 if (!p_odev)
3354 errnum = (char_u *)"E796: ";
3355 errmsg = (char_u *)_("writing to device disabled with 'opendevice' option");
3356 goto fail;
3358 # endif
3359 device = TRUE;
3360 newfile = TRUE;
3361 perm = -1;
3363 else
3365 perm = mch_getperm(fname);
3366 if (perm < 0)
3367 newfile = TRUE;
3368 else if (mch_isdir(fname))
3370 errnum = (char_u *)"E502: ";
3371 errmsg = (char_u *)_("is a directory");
3372 goto fail;
3374 if (overwriting)
3375 (void)mch_stat((char *)fname, &st_old);
3377 #endif /* !UNIX */
3379 if (!device && !newfile)
3382 * Check if the file is really writable (when renaming the file to
3383 * make a backup we won't discover it later).
3385 file_readonly = check_file_readonly(fname, (int)perm);
3387 if (!forceit && file_readonly)
3389 if (vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3391 errnum = (char_u *)"E504: ";
3392 errmsg = (char_u *)_(err_readonly);
3394 else
3396 errnum = (char_u *)"E505: ";
3397 errmsg = (char_u *)_("is read-only (add ! to override)");
3399 goto fail;
3403 * Check if the timestamp hasn't changed since reading the file.
3405 if (overwriting)
3407 retval = check_mtime(buf, &st_old);
3408 if (retval == FAIL)
3409 goto fail;
3413 #ifdef HAVE_ACL
3415 * For systems that support ACL: get the ACL from the original file.
3417 if (!newfile)
3418 acl = mch_get_acl(fname);
3419 #endif
3422 * If 'backupskip' is not empty, don't make a backup for some files.
3424 dobackup = (p_wb || p_bk || *p_pm != NUL);
3425 #ifdef FEAT_WILDIGN
3426 if (dobackup && *p_bsk != NUL && match_file_list(p_bsk, sfname, ffname))
3427 dobackup = FALSE;
3428 #endif
3431 * Save the value of got_int and reset it. We don't want a previous
3432 * interruption cancel writing, only hitting CTRL-C while writing should
3433 * abort it.
3435 prev_got_int = got_int;
3436 got_int = FALSE;
3438 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3439 buf->b_saving = TRUE;
3442 * If we are not appending or filtering, the file exists, and the
3443 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3444 * When 'patchmode' is set also make a backup when appending.
3446 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3447 * off. This helps when editing large files on almost-full disks.
3449 if (!(append && *p_pm == NUL) && !filtering && perm >= 0 && dobackup)
3451 #if defined(UNIX) || defined(WIN32)
3452 struct stat st;
3453 #endif
3455 if ((bkc_flags & BKC_YES) || append) /* "yes" */
3456 backup_copy = TRUE;
3457 #if defined(UNIX) || defined(WIN32)
3458 else if ((bkc_flags & BKC_AUTO)) /* "auto" */
3460 int i;
3462 # ifdef UNIX
3464 * Don't rename the file when:
3465 * - it's a hard link
3466 * - it's a symbolic link
3467 * - we don't have write permission in the directory
3468 * - we can't set the owner/group of the new file
3470 if (st_old.st_nlink > 1
3471 || mch_lstat((char *)fname, &st) < 0
3472 || st.st_dev != st_old.st_dev
3473 || st.st_ino != st_old.st_ino
3474 # ifndef HAVE_FCHOWN
3475 || st.st_uid != st_old.st_uid
3476 || st.st_gid != st_old.st_gid
3477 # endif
3479 backup_copy = TRUE;
3480 else
3481 # else
3482 # ifdef WIN32
3483 /* On NTFS file systems hard links are possible. */
3484 if (mch_is_linked(fname))
3485 backup_copy = TRUE;
3486 else
3487 # endif
3488 # endif
3491 * Check if we can create a file and set the owner/group to
3492 * the ones from the original file.
3493 * First find a file name that doesn't exist yet (use some
3494 * arbitrary numbers).
3496 STRCPY(IObuff, fname);
3497 for (i = 4913; ; i += 123)
3499 sprintf((char *)gettail(IObuff), "%d", i);
3500 if (mch_lstat((char *)IObuff, &st) < 0)
3501 break;
3503 fd = mch_open((char *)IObuff,
3504 O_CREAT|O_WRONLY|O_EXCL|O_NOFOLLOW, perm);
3505 if (fd < 0) /* can't write in directory */
3506 backup_copy = TRUE;
3507 else
3509 # ifdef UNIX
3510 # ifdef HAVE_FCHOWN
3511 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
3512 # endif
3513 if (mch_stat((char *)IObuff, &st) < 0
3514 || st.st_uid != st_old.st_uid
3515 || st.st_gid != st_old.st_gid
3516 || (long)st.st_mode != perm)
3517 backup_copy = TRUE;
3518 # endif
3519 /* Close the file before removing it, on MS-Windows we
3520 * can't delete an open file. */
3521 close(fd);
3522 mch_remove(IObuff);
3527 # ifdef UNIX
3529 * Break symlinks and/or hardlinks if we've been asked to.
3531 if ((bkc_flags & BKC_BREAKSYMLINK) || (bkc_flags & BKC_BREAKHARDLINK))
3533 int lstat_res;
3535 lstat_res = mch_lstat((char *)fname, &st);
3537 /* Symlinks. */
3538 if ((bkc_flags & BKC_BREAKSYMLINK)
3539 && lstat_res == 0
3540 && st.st_ino != st_old.st_ino)
3541 backup_copy = FALSE;
3543 /* Hardlinks. */
3544 if ((bkc_flags & BKC_BREAKHARDLINK)
3545 && st_old.st_nlink > 1
3546 && (lstat_res != 0 || st.st_ino == st_old.st_ino))
3547 backup_copy = FALSE;
3549 #endif
3551 #endif
3553 /* make sure we have a valid backup extension to use */
3554 if (*p_bex == NUL)
3556 #ifdef RISCOS
3557 backup_ext = (char_u *)"/bak";
3558 #else
3559 backup_ext = (char_u *)".bak";
3560 #endif
3562 else
3563 backup_ext = p_bex;
3565 if (backup_copy
3566 && (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
3568 int bfd;
3569 char_u *copybuf, *wp;
3570 int some_error = FALSE;
3571 struct stat st_new;
3572 char_u *dirp;
3573 char_u *rootname;
3574 #if defined(UNIX) && !defined(SHORT_FNAME)
3575 int did_set_shortname;
3576 #endif
3578 copybuf = alloc(BUFSIZE + 1);
3579 if (copybuf == NULL)
3581 some_error = TRUE; /* out of memory */
3582 goto nobackup;
3586 * Try to make the backup in each directory in the 'bdir' option.
3588 * Unix semantics has it, that we may have a writable file,
3589 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3590 * - the directory is not writable,
3591 * - the file may be a symbolic link,
3592 * - the file may belong to another user/group, etc.
3594 * For these reasons, the existing writable file must be truncated
3595 * and reused. Creation of a backup COPY will be attempted.
3597 dirp = p_bdir;
3598 while (*dirp)
3600 #ifdef UNIX
3601 st_new.st_ino = 0;
3602 st_new.st_dev = 0;
3603 st_new.st_gid = 0;
3604 #endif
3607 * Isolate one directory name, using an entry in 'bdir'.
3609 (void)copy_option_part(&dirp, copybuf, BUFSIZE, ",");
3610 rootname = get_file_in_dir(fname, copybuf);
3611 if (rootname == NULL)
3613 some_error = TRUE; /* out of memory */
3614 goto nobackup;
3617 #if defined(UNIX) && !defined(SHORT_FNAME)
3618 did_set_shortname = FALSE;
3619 #endif
3622 * May try twice if 'shortname' not set.
3624 for (;;)
3627 * Make backup file name.
3629 backup = buf_modname(
3630 #ifdef SHORT_FNAME
3631 TRUE,
3632 #else
3633 (buf->b_p_sn || buf->b_shortname),
3634 #endif
3635 rootname, backup_ext, FALSE);
3636 if (backup == NULL)
3638 vim_free(rootname);
3639 some_error = TRUE; /* out of memory */
3640 goto nobackup;
3644 * Check if backup file already exists.
3646 if (mch_stat((char *)backup, &st_new) >= 0)
3648 #ifdef UNIX
3650 * Check if backup file is same as original file.
3651 * May happen when modname() gave the same file back.
3652 * E.g. silly link, or file name-length reached.
3653 * If we don't check here, we either ruin the file
3654 * when copying or erase it after writing. jw.
3656 if (st_new.st_dev == st_old.st_dev
3657 && st_new.st_ino == st_old.st_ino)
3659 vim_free(backup);
3660 backup = NULL; /* no backup file to delete */
3661 # ifndef SHORT_FNAME
3663 * may try again with 'shortname' set
3665 if (!(buf->b_shortname || buf->b_p_sn))
3667 buf->b_shortname = TRUE;
3668 did_set_shortname = TRUE;
3669 continue;
3671 /* setting shortname didn't help */
3672 if (did_set_shortname)
3673 buf->b_shortname = FALSE;
3674 # endif
3675 break;
3677 #endif
3680 * If we are not going to keep the backup file, don't
3681 * delete an existing one, try to use another name.
3682 * Change one character, just before the extension.
3684 if (!p_bk)
3686 wp = backup + STRLEN(backup) - 1
3687 - STRLEN(backup_ext);
3688 if (wp < backup) /* empty file name ??? */
3689 wp = backup;
3690 *wp = 'z';
3691 while (*wp > 'a'
3692 && mch_stat((char *)backup, &st_new) >= 0)
3693 --*wp;
3694 /* They all exist??? Must be something wrong. */
3695 if (*wp == 'a')
3697 vim_free(backup);
3698 backup = NULL;
3702 break;
3704 vim_free(rootname);
3707 * Try to create the backup file
3709 if (backup != NULL)
3711 /* remove old backup, if present */
3712 mch_remove(backup);
3713 /* Open with O_EXCL to avoid the file being created while
3714 * we were sleeping (symlink hacker attack?) */
3715 bfd = mch_open((char *)backup,
3716 O_WRONLY|O_CREAT|O_EXTRA|O_EXCL|O_NOFOLLOW,
3717 perm & 0777);
3718 if (bfd < 0)
3720 vim_free(backup);
3721 backup = NULL;
3723 else
3725 /* set file protection same as original file, but
3726 * strip s-bit */
3727 (void)mch_setperm(backup, perm & 0777);
3729 #ifdef UNIX
3731 * Try to set the group of the backup same as the
3732 * original file. If this fails, set the protection
3733 * bits for the group same as the protection bits for
3734 * others.
3736 if (st_new.st_gid != st_old.st_gid
3737 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3738 && fchown(bfd, (uid_t)-1, st_old.st_gid) != 0
3739 # endif
3741 mch_setperm(backup,
3742 (perm & 0707) | ((perm & 07) << 3));
3743 # ifdef HAVE_SELINUX
3744 mch_copy_sec(fname, backup);
3745 # endif
3746 #endif
3749 * copy the file.
3751 write_info.bw_fd = bfd;
3752 write_info.bw_buf = copybuf;
3753 #ifdef HAS_BW_FLAGS
3754 write_info.bw_flags = FIO_NOCONVERT;
3755 #endif
3756 while ((write_info.bw_len = vim_read(fd, copybuf,
3757 BUFSIZE)) > 0)
3759 if (buf_write_bytes(&write_info) == FAIL)
3761 errmsg = (char_u *)_("E506: Can't write to backup file (add ! to override)");
3762 break;
3764 ui_breakcheck();
3765 if (got_int)
3767 errmsg = (char_u *)_(e_interr);
3768 break;
3772 if (close(bfd) < 0 && errmsg == NULL)
3773 errmsg = (char_u *)_("E507: Close error for backup file (add ! to override)");
3774 if (write_info.bw_len < 0)
3775 errmsg = (char_u *)_("E508: Can't read file for backup (add ! to override)");
3776 #ifdef UNIX
3777 set_file_time(backup, st_old.st_atime, st_old.st_mtime);
3778 #endif
3779 #ifdef HAVE_ACL
3780 mch_set_acl(backup, acl);
3781 #endif
3782 #ifdef HAVE_SELINUX
3783 mch_copy_sec(fname, backup);
3784 #endif
3785 break;
3789 nobackup:
3790 close(fd); /* ignore errors for closing read file */
3791 vim_free(copybuf);
3793 if (backup == NULL && errmsg == NULL)
3794 errmsg = (char_u *)_("E509: Cannot create backup file (add ! to override)");
3795 /* ignore errors when forceit is TRUE */
3796 if ((some_error || errmsg != NULL) && !forceit)
3798 retval = FAIL;
3799 goto fail;
3801 errmsg = NULL;
3803 else
3805 char_u *dirp;
3806 char_u *p;
3807 char_u *rootname;
3810 * Make a backup by renaming the original file.
3813 * If 'cpoptions' includes the "W" flag, we don't want to
3814 * overwrite a read-only file. But rename may be possible
3815 * anyway, thus we need an extra check here.
3817 if (file_readonly && vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3819 errnum = (char_u *)"E504: ";
3820 errmsg = (char_u *)_(err_readonly);
3821 goto fail;
3826 * Form the backup file name - change path/fo.o.h to
3827 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3828 * that works is used.
3830 dirp = p_bdir;
3831 while (*dirp)
3834 * Isolate one directory name and make the backup file name.
3836 (void)copy_option_part(&dirp, IObuff, IOSIZE, ",");
3837 rootname = get_file_in_dir(fname, IObuff);
3838 if (rootname == NULL)
3839 backup = NULL;
3840 else
3842 backup = buf_modname(
3843 #ifdef SHORT_FNAME
3844 TRUE,
3845 #else
3846 (buf->b_p_sn || buf->b_shortname),
3847 #endif
3848 rootname, backup_ext, FALSE);
3849 vim_free(rootname);
3852 if (backup != NULL)
3855 * If we are not going to keep the backup file, don't
3856 * delete an existing one, try to use another name.
3857 * Change one character, just before the extension.
3859 if (!p_bk && mch_getperm(backup) >= 0)
3861 p = backup + STRLEN(backup) - 1 - STRLEN(backup_ext);
3862 if (p < backup) /* empty file name ??? */
3863 p = backup;
3864 *p = 'z';
3865 while (*p > 'a' && mch_getperm(backup) >= 0)
3866 --*p;
3867 /* They all exist??? Must be something wrong! */
3868 if (*p == 'a')
3870 vim_free(backup);
3871 backup = NULL;
3875 if (backup != NULL)
3878 * Delete any existing backup and move the current version
3879 * to the backup. For safety, we don't remove the backup
3880 * until the write has finished successfully. And if the
3881 * 'backup' option is set, leave it around.
3884 * If the renaming of the original file to the backup file
3885 * works, quit here.
3887 if (vim_rename(fname, backup) == 0)
3888 break;
3890 vim_free(backup); /* don't do the rename below */
3891 backup = NULL;
3894 if (backup == NULL && !forceit)
3896 errmsg = (char_u *)_("E510: Can't make backup file (add ! to override)");
3897 goto fail;
3902 #if defined(UNIX) && !defined(ARCHIE)
3903 /* When using ":w!" and the file was read-only: make it writable */
3904 if (forceit && perm >= 0 && !(perm & 0200) && st_old.st_uid == getuid()
3905 && vim_strchr(p_cpo, CPO_FWRITE) == NULL)
3907 perm |= 0200;
3908 (void)mch_setperm(fname, perm);
3909 made_writable = TRUE;
3911 #endif
3913 /* When using ":w!" and writing to the current file, 'readonly' makes no
3914 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3915 if (forceit && overwriting && vim_strchr(p_cpo, CPO_KEEPRO) == NULL)
3917 buf->b_p_ro = FALSE;
3918 #ifdef FEAT_TITLE
3919 need_maketitle = TRUE; /* set window title later */
3920 #endif
3921 #ifdef FEAT_WINDOWS
3922 status_redraw_all(); /* redraw status lines later */
3923 #endif
3926 if (end > buf->b_ml.ml_line_count)
3927 end = buf->b_ml.ml_line_count;
3928 if (buf->b_ml.ml_flags & ML_EMPTY)
3929 start = end + 1;
3932 * If the original file is being overwritten, there is a small chance that
3933 * we crash in the middle of writing. Therefore the file is preserved now.
3934 * This makes all block numbers positive so that recovery does not need
3935 * the original file.
3936 * Don't do this if there is a backup file and we are exiting.
3938 if (reset_changed && !newfile && overwriting
3939 && !(exiting && backup != NULL))
3941 ml_preserve(buf, FALSE);
3942 if (got_int)
3944 errmsg = (char_u *)_(e_interr);
3945 goto restore_backup;
3949 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3951 * Before risking to lose the original file verify if there's
3952 * a resource fork to preserve, and if cannot be done warn
3953 * the users. This happens when overwriting without backups.
3955 if (backup == NULL && overwriting && !append)
3956 if (mch_has_resource_fork(fname))
3958 errmsg = (char_u *)_("E460: The resource fork would be lost (add ! to override)");
3959 goto restore_backup;
3961 #endif
3963 #ifdef VMS
3964 vms_remove_version(fname); /* remove version */
3965 #endif
3966 /* Default: write the file directly. May write to a temp file for
3967 * multi-byte conversion. */
3968 wfname = fname;
3970 #ifdef FEAT_MBYTE
3971 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3972 if (eap != NULL && eap->force_enc != 0)
3974 fenc = eap->cmd + eap->force_enc;
3975 fenc = enc_canonize(fenc);
3976 fenc_tofree = fenc;
3978 else
3979 fenc = buf->b_p_fenc;
3982 * Check if the file needs to be converted.
3984 converted = need_conversion(fenc);
3987 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3988 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3989 * Prepare the flags for it and allocate bw_conv_buf when needed.
3991 if (converted && (enc_utf8 || STRCMP(p_enc, "latin1") == 0))
3993 wb_flags = get_fio_flags(fenc);
3994 if (wb_flags & (FIO_UCS2 | FIO_UCS4 | FIO_UTF16 | FIO_UTF8))
3996 /* Need to allocate a buffer to translate into. */
3997 if (wb_flags & (FIO_UCS2 | FIO_UTF16 | FIO_UTF8))
3998 write_info.bw_conv_buflen = bufsize * 2;
3999 else /* FIO_UCS4 */
4000 write_info.bw_conv_buflen = bufsize * 4;
4001 write_info.bw_conv_buf
4002 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4003 if (write_info.bw_conv_buf == NULL)
4004 end = 0;
4008 # ifdef WIN3264
4009 if (converted && wb_flags == 0 && (wb_flags = get_win_fio_flags(fenc)) != 0)
4011 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
4012 write_info.bw_conv_buflen = bufsize * 4;
4013 write_info.bw_conv_buf
4014 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4015 if (write_info.bw_conv_buf == NULL)
4016 end = 0;
4018 # endif
4020 # ifdef MACOS_X
4021 if (converted && wb_flags == 0 && (wb_flags = get_mac_fio_flags(fenc)) != 0)
4023 write_info.bw_conv_buflen = bufsize * 3;
4024 write_info.bw_conv_buf
4025 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4026 if (write_info.bw_conv_buf == NULL)
4027 end = 0;
4029 # endif
4031 # if defined(FEAT_EVAL) || defined(USE_ICONV)
4032 if (converted && wb_flags == 0)
4034 # ifdef USE_ICONV
4036 * Use iconv() conversion when conversion is needed and it's not done
4037 * internally.
4039 write_info.bw_iconv_fd = (iconv_t)my_iconv_open(fenc,
4040 enc_utf8 ? (char_u *)"utf-8" : p_enc);
4041 if (write_info.bw_iconv_fd != (iconv_t)-1)
4043 /* We're going to use iconv(), allocate a buffer to convert in. */
4044 write_info.bw_conv_buflen = bufsize * ICONV_MULT;
4045 write_info.bw_conv_buf
4046 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
4047 if (write_info.bw_conv_buf == NULL)
4048 end = 0;
4049 write_info.bw_first = TRUE;
4051 # ifdef FEAT_EVAL
4052 else
4053 # endif
4054 # endif
4056 # ifdef FEAT_EVAL
4058 * When the file needs to be converted with 'charconvert' after
4059 * writing, write to a temp file instead and let the conversion
4060 * overwrite the original file.
4062 if (*p_ccv != NUL)
4064 wfname = vim_tempname('w');
4065 if (wfname == NULL) /* Can't write without a tempfile! */
4067 errmsg = (char_u *)_("E214: Can't find temp file for writing");
4068 goto restore_backup;
4071 # endif
4073 # endif
4074 if (converted && wb_flags == 0
4075 # ifdef USE_ICONV
4076 && write_info.bw_iconv_fd == (iconv_t)-1
4077 # endif
4078 # ifdef FEAT_EVAL
4079 && wfname == fname
4080 # endif
4083 if (!forceit)
4085 errmsg = (char_u *)_("E213: Cannot convert (add ! to write without conversion)");
4086 goto restore_backup;
4088 notconverted = TRUE;
4090 #endif
4093 * Open the file "wfname" for writing.
4094 * We may try to open the file twice: If we can't write to the
4095 * file and forceit is TRUE we delete the existing file and try to create
4096 * a new one. If this still fails we may have lost the original file!
4097 * (this may happen when the user reached his quotum for number of files).
4098 * Appending will fail if the file does not exist and forceit is FALSE.
4100 while ((fd = mch_open((char *)wfname, O_WRONLY | O_EXTRA | (append
4101 ? (forceit ? (O_APPEND | O_CREAT) : O_APPEND)
4102 : (O_CREAT | O_TRUNC))
4103 , perm < 0 ? 0666 : (perm & 0777))) < 0)
4106 * A forced write will try to create a new file if the old one is
4107 * still readonly. This may also happen when the directory is
4108 * read-only. In that case the mch_remove() will fail.
4110 if (errmsg == NULL)
4112 #ifdef UNIX
4113 struct stat st;
4115 /* Don't delete the file when it's a hard or symbolic link. */
4116 if ((!newfile && st_old.st_nlink > 1)
4117 || (mch_lstat((char *)fname, &st) == 0
4118 && (st.st_dev != st_old.st_dev
4119 || st.st_ino != st_old.st_ino)))
4120 errmsg = (char_u *)_("E166: Can't open linked file for writing");
4121 else
4122 #endif
4124 errmsg = (char_u *)_("E212: Can't open file for writing");
4125 if (forceit && vim_strchr(p_cpo, CPO_FWRITE) == NULL
4126 && perm >= 0)
4128 #ifdef UNIX
4129 /* we write to the file, thus it should be marked
4130 writable after all */
4131 if (!(perm & 0200))
4132 made_writable = TRUE;
4133 perm |= 0200;
4134 if (st_old.st_uid != getuid() || st_old.st_gid != getgid())
4135 perm &= 0777;
4136 #endif
4137 if (!append) /* don't remove when appending */
4138 mch_remove(wfname);
4139 continue;
4144 restore_backup:
4146 struct stat st;
4149 * If we failed to open the file, we don't need a backup. Throw it
4150 * away. If we moved or removed the original file try to put the
4151 * backup in its place.
4153 if (backup != NULL && wfname == fname)
4155 if (backup_copy)
4158 * There is a small chance that we removed the original,
4159 * try to move the copy in its place.
4160 * This may not work if the vim_rename() fails.
4161 * In that case we leave the copy around.
4163 /* If file does not exist, put the copy in its place */
4164 if (mch_stat((char *)fname, &st) < 0)
4165 vim_rename(backup, fname);
4166 /* if original file does exist throw away the copy */
4167 if (mch_stat((char *)fname, &st) >= 0)
4168 mch_remove(backup);
4170 else
4172 /* try to put the original file back */
4173 vim_rename(backup, fname);
4177 /* if original file no longer exists give an extra warning */
4178 if (!newfile && mch_stat((char *)fname, &st) < 0)
4179 end = 0;
4182 #ifdef FEAT_MBYTE
4183 if (wfname != fname)
4184 vim_free(wfname);
4185 #endif
4186 goto fail;
4188 errmsg = NULL;
4190 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4191 /* TODO: Is it need for MACOS_X? (Dany) */
4193 * On macintosh copy the original files attributes (i.e. the backup)
4194 * This is done in order to preserve the resource fork and the
4195 * Finder attribute (label, comments, custom icons, file creator)
4197 if (backup != NULL && overwriting && !append)
4199 if (backup_copy)
4200 (void)mch_copy_file_attribute(wfname, backup);
4201 else
4202 (void)mch_copy_file_attribute(backup, wfname);
4205 if (!overwriting && !append)
4207 if (buf->b_ffname != NULL)
4208 (void)mch_copy_file_attribute(buf->b_ffname, wfname);
4209 /* Should copy resource fork */
4211 #endif
4213 write_info.bw_fd = fd;
4215 #ifdef FEAT_CRYPT
4216 if (*buf->b_p_key && !filtering)
4218 crypt_init_keys(buf->b_p_key);
4219 /* Write magic number, so that Vim knows that this file is encrypted
4220 * when reading it again. This also undergoes utf-8 to ucs-2/4
4221 * conversion when needed. */
4222 write_info.bw_buf = (char_u *)CRYPT_MAGIC;
4223 write_info.bw_len = CRYPT_MAGIC_LEN;
4224 write_info.bw_flags = FIO_NOCONVERT;
4225 if (buf_write_bytes(&write_info) == FAIL)
4226 end = 0;
4227 wb_flags |= FIO_ENCRYPTED;
4229 #endif
4231 write_info.bw_buf = buffer;
4232 nchars = 0;
4234 /* use "++bin", "++nobin" or 'binary' */
4235 if (eap != NULL && eap->force_bin != 0)
4236 write_bin = (eap->force_bin == FORCE_BIN);
4237 else
4238 write_bin = buf->b_p_bin;
4240 #ifdef FEAT_MBYTE
4242 * The BOM is written just after the encryption magic number.
4243 * Skip it when appending and the file already existed, the BOM only makes
4244 * sense at the start of the file.
4246 if (buf->b_p_bomb && !write_bin && (!append || perm < 0))
4248 write_info.bw_len = make_bom(buffer, fenc);
4249 if (write_info.bw_len > 0)
4251 /* don't convert, do encryption */
4252 write_info.bw_flags = FIO_NOCONVERT | wb_flags;
4253 if (buf_write_bytes(&write_info) == FAIL)
4254 end = 0;
4255 else
4256 nchars += write_info.bw_len;
4259 write_info.bw_start_lnum = start;
4260 #endif
4262 write_info.bw_len = bufsize;
4263 #ifdef HAS_BW_FLAGS
4264 write_info.bw_flags = wb_flags;
4265 #endif
4266 fileformat = get_fileformat_force(buf, eap);
4267 s = buffer;
4268 len = 0;
4269 for (lnum = start; lnum <= end; ++lnum)
4272 * The next while loop is done once for each character written.
4273 * Keep it fast!
4275 ptr = ml_get_buf(buf, lnum, FALSE) - 1;
4276 while ((c = *++ptr) != NUL)
4278 if (c == NL)
4279 *s = NUL; /* replace newlines with NULs */
4280 else if (c == CAR && fileformat == EOL_MAC)
4281 *s = NL; /* Mac: replace CRs with NLs */
4282 else
4283 *s = c;
4284 ++s;
4285 if (++len != bufsize)
4286 continue;
4287 if (buf_write_bytes(&write_info) == FAIL)
4289 end = 0; /* write error: break loop */
4290 break;
4292 nchars += bufsize;
4293 s = buffer;
4294 len = 0;
4295 #ifdef FEAT_MBYTE
4296 write_info.bw_start_lnum = lnum;
4297 #endif
4299 /* write failed or last line has no EOL: stop here */
4300 if (end == 0
4301 || (lnum == end
4302 && write_bin
4303 && (lnum == write_no_eol_lnum
4304 || (lnum == buf->b_ml.ml_line_count && !buf->b_p_eol))))
4306 ++lnum; /* written the line, count it */
4307 no_eol = TRUE;
4308 break;
4310 if (fileformat == EOL_UNIX)
4311 *s++ = NL;
4312 else
4314 *s++ = CAR; /* EOL_MAC or EOL_DOS: write CR */
4315 if (fileformat == EOL_DOS) /* write CR-NL */
4317 if (++len == bufsize)
4319 if (buf_write_bytes(&write_info) == FAIL)
4321 end = 0; /* write error: break loop */
4322 break;
4324 nchars += bufsize;
4325 s = buffer;
4326 len = 0;
4328 *s++ = NL;
4331 if (++len == bufsize && end)
4333 if (buf_write_bytes(&write_info) == FAIL)
4335 end = 0; /* write error: break loop */
4336 break;
4338 nchars += bufsize;
4339 s = buffer;
4340 len = 0;
4342 ui_breakcheck();
4343 if (got_int)
4345 end = 0; /* Interrupted, break loop */
4346 break;
4349 #ifdef VMS
4351 * On VMS there is a problem: newlines get added when writing blocks
4352 * at a time. Fix it by writing a line at a time.
4353 * This is much slower!
4354 * Explanation: VAX/DECC RTL insists that records in some RMS
4355 * structures end with a newline (carriage return) character, and if
4356 * they don't it adds one.
4357 * With other RMS structures it works perfect without this fix.
4359 if (buf->b_fab_rfm == FAB$C_VFC
4360 || ((buf->b_fab_rat & (FAB$M_FTN | FAB$M_CR)) != 0))
4362 int b2write;
4364 buf->b_fab_mrs = (buf->b_fab_mrs == 0
4365 ? MIN(4096, bufsize)
4366 : MIN(buf->b_fab_mrs, bufsize));
4368 b2write = len;
4369 while (b2write > 0)
4371 write_info.bw_len = MIN(b2write, buf->b_fab_mrs);
4372 if (buf_write_bytes(&write_info) == FAIL)
4374 end = 0;
4375 break;
4377 b2write -= MIN(b2write, buf->b_fab_mrs);
4379 write_info.bw_len = bufsize;
4380 nchars += len;
4381 s = buffer;
4382 len = 0;
4384 #endif
4386 if (len > 0 && end > 0)
4388 write_info.bw_len = len;
4389 if (buf_write_bytes(&write_info) == FAIL)
4390 end = 0; /* write error */
4391 nchars += len;
4394 #if defined(UNIX) && defined(HAVE_FSYNC)
4395 /* On many journalling file systems there is a bug that causes both the
4396 * original and the backup file to be lost when halting the system right
4397 * after writing the file. That's because only the meta-data is
4398 * journalled. Syncing the file slows down the system, but assures it has
4399 * been written to disk and we don't lose it.
4400 * For a device do try the fsync() but don't complain if it does not work
4401 * (could be a pipe).
4402 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4403 if (p_fs && fsync(fd) != 0 && !device)
4405 errmsg = (char_u *)_("E667: Fsync failed");
4406 end = 0;
4408 #endif
4410 #ifdef HAVE_SELINUX
4411 /* Probably need to set the security context. */
4412 if (!backup_copy)
4413 mch_copy_sec(backup, wfname);
4414 #endif
4416 #ifdef UNIX
4417 /* When creating a new file, set its owner/group to that of the original
4418 * file. Get the new device and inode number. */
4419 if (backup != NULL && !backup_copy)
4421 # ifdef HAVE_FCHOWN
4422 struct stat st;
4424 /* don't change the owner when it's already OK, some systems remove
4425 * permission or ACL stuff */
4426 if (mch_stat((char *)wfname, &st) < 0
4427 || st.st_uid != st_old.st_uid
4428 || st.st_gid != st_old.st_gid)
4430 ignored = fchown(fd, st_old.st_uid, st_old.st_gid);
4431 if (perm >= 0) /* set permission again, may have changed */
4432 (void)mch_setperm(wfname, perm);
4434 # endif
4435 buf_setino(buf);
4437 else if (!buf->b_dev_valid)
4438 /* Set the inode when creating a new file. */
4439 buf_setino(buf);
4440 #endif
4442 if (close(fd) != 0)
4444 errmsg = (char_u *)_("E512: Close failed");
4445 end = 0;
4448 #ifdef UNIX
4449 if (made_writable)
4450 perm &= ~0200; /* reset 'w' bit for security reasons */
4451 #endif
4452 if (perm >= 0) /* set perm. of new file same as old file */
4453 (void)mch_setperm(wfname, perm);
4454 #ifdef RISCOS
4455 if (!append && !filtering)
4456 /* Set the filetype after writing the file. */
4457 mch_set_filetype(wfname, buf->b_p_oft);
4458 #endif
4459 #ifdef HAVE_ACL
4460 /* Probably need to set the ACL before changing the user (can't set the
4461 * ACL on a file the user doesn't own). */
4462 if (!backup_copy)
4463 mch_set_acl(wfname, acl);
4464 #endif
4467 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4468 if (wfname != fname)
4471 * The file was written to a temp file, now it needs to be converted
4472 * with 'charconvert' to (overwrite) the output file.
4474 if (end != 0)
4476 if (eval_charconvert(enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc,
4477 wfname, fname) == FAIL)
4479 write_info.bw_conv_error = TRUE;
4480 end = 0;
4483 mch_remove(wfname);
4484 vim_free(wfname);
4486 #endif
4488 if (end == 0)
4490 if (errmsg == NULL)
4492 #ifdef FEAT_MBYTE
4493 if (write_info.bw_conv_error)
4495 if (write_info.bw_conv_error_lnum == 0)
4496 errmsg = (char_u *)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4497 else
4499 errmsg_allocated = TRUE;
4500 errmsg = alloc(300);
4501 vim_snprintf((char *)errmsg, 300, _("E513: write error, conversion failed in line %ld (make 'fenc' empty to override)"),
4502 (long)write_info.bw_conv_error_lnum);
4505 else
4506 #endif
4507 if (got_int)
4508 errmsg = (char_u *)_(e_interr);
4509 else
4510 errmsg = (char_u *)_("E514: write error (file system full?)");
4514 * If we have a backup file, try to put it in place of the new file,
4515 * because the new file is probably corrupt. This avoids losing the
4516 * original file when trying to make a backup when writing the file a
4517 * second time.
4518 * When "backup_copy" is set we need to copy the backup over the new
4519 * file. Otherwise rename the backup file.
4520 * If this is OK, don't give the extra warning message.
4522 if (backup != NULL)
4524 if (backup_copy)
4526 /* This may take a while, if we were interrupted let the user
4527 * know we got the message. */
4528 if (got_int)
4530 MSG(_(e_interr));
4531 out_flush();
4533 if ((fd = mch_open((char *)backup, O_RDONLY | O_EXTRA, 0)) >= 0)
4535 if ((write_info.bw_fd = mch_open((char *)fname,
4536 O_WRONLY | O_CREAT | O_TRUNC | O_EXTRA,
4537 perm & 0777)) >= 0)
4539 /* copy the file. */
4540 write_info.bw_buf = smallbuf;
4541 #ifdef HAS_BW_FLAGS
4542 write_info.bw_flags = FIO_NOCONVERT;
4543 #endif
4544 while ((write_info.bw_len = vim_read(fd, smallbuf,
4545 SMBUFSIZE)) > 0)
4546 if (buf_write_bytes(&write_info) == FAIL)
4547 break;
4549 if (close(write_info.bw_fd) >= 0
4550 && write_info.bw_len == 0)
4551 end = 1; /* success */
4553 close(fd); /* ignore errors for closing read file */
4556 else
4558 if (vim_rename(backup, fname) == 0)
4559 end = 1;
4562 goto fail;
4565 lnum -= start; /* compute number of written lines */
4566 --no_wait_return; /* may wait for return now */
4568 #if !(defined(UNIX) || defined(VMS))
4569 fname = sfname; /* use shortname now, for the messages */
4570 #endif
4571 if (!filtering)
4573 msg_add_fname(buf, fname); /* put fname in IObuff with quotes */
4574 c = FALSE;
4575 #ifdef FEAT_MBYTE
4576 if (write_info.bw_conv_error)
4578 STRCAT(IObuff, _(" CONVERSION ERROR"));
4579 c = TRUE;
4580 if (write_info.bw_conv_error_lnum != 0)
4582 size_t l = STRLEN(IObuff);
4583 vim_snprintf((char *)IObuff + l, IOSIZE - l, _(" in line %ld;"),
4584 (long)write_info.bw_conv_error_lnum);
4587 else if (notconverted)
4589 STRCAT(IObuff, _("[NOT converted]"));
4590 c = TRUE;
4592 else if (converted)
4594 STRCAT(IObuff, _("[converted]"));
4595 c = TRUE;
4597 #endif
4598 if (device)
4600 STRCAT(IObuff, _("[Device]"));
4601 c = TRUE;
4603 else if (newfile)
4605 STRCAT(IObuff, shortmess(SHM_NEW) ? _("[New]") : _("[New File]"));
4606 c = TRUE;
4608 if (no_eol)
4610 msg_add_eol();
4611 c = TRUE;
4613 /* may add [unix/dos/mac] */
4614 if (msg_add_fileformat(fileformat))
4615 c = TRUE;
4616 #ifdef FEAT_CRYPT
4617 if (wb_flags & FIO_ENCRYPTED)
4619 STRCAT(IObuff, _("[crypted]"));
4620 c = TRUE;
4622 #endif
4623 msg_add_lines(c, (long)lnum, nchars); /* add line/char count */
4624 if (!shortmess(SHM_WRITE))
4626 if (append)
4627 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [a]") : _(" appended"));
4628 else
4629 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [w]") : _(" written"));
4632 set_keep_msg(msg_trunc_attr(IObuff, FALSE, 0), 0);
4635 /* When written everything correctly: reset 'modified'. Unless not
4636 * writing to the original file and '+' is not in 'cpoptions'. */
4637 if (reset_changed && whole && !append
4638 #ifdef FEAT_MBYTE
4639 && !write_info.bw_conv_error
4640 #endif
4641 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL)
4644 unchanged(buf, TRUE);
4645 u_unchanged(buf);
4649 * If written to the current file, update the timestamp of the swap file
4650 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4652 if (overwriting)
4654 ml_timestamp(buf);
4655 if (append)
4656 buf->b_flags &= ~BF_NEW;
4657 else
4658 buf->b_flags &= ~BF_WRITE_MASK;
4662 * If we kept a backup until now, and we are in patch mode, then we make
4663 * the backup file our 'original' file.
4665 if (*p_pm && dobackup)
4667 char *org = (char *)buf_modname(
4668 #ifdef SHORT_FNAME
4669 TRUE,
4670 #else
4671 (buf->b_p_sn || buf->b_shortname),
4672 #endif
4673 fname, p_pm, FALSE);
4675 if (backup != NULL)
4677 struct stat st;
4680 * If the original file does not exist yet
4681 * the current backup file becomes the original file
4683 if (org == NULL)
4684 EMSG(_("E205: Patchmode: can't save original file"));
4685 else if (mch_stat(org, &st) < 0)
4687 vim_rename(backup, (char_u *)org);
4688 vim_free(backup); /* don't delete the file */
4689 backup = NULL;
4690 #ifdef UNIX
4691 set_file_time((char_u *)org, st_old.st_atime, st_old.st_mtime);
4692 #endif
4696 * If there is no backup file, remember that a (new) file was
4697 * created.
4699 else
4701 int empty_fd;
4703 if (org == NULL
4704 || (empty_fd = mch_open(org,
4705 O_CREAT | O_EXTRA | O_EXCL | O_NOFOLLOW,
4706 perm < 0 ? 0666 : (perm & 0777))) < 0)
4707 EMSG(_("E206: patchmode: can't touch empty original file"));
4708 else
4709 close(empty_fd);
4711 if (org != NULL)
4713 mch_setperm((char_u *)org, mch_getperm(fname) & 0777);
4714 vim_free(org);
4719 * Remove the backup unless 'backup' option is set
4721 if (!p_bk && backup != NULL && mch_remove(backup) != 0)
4722 EMSG(_("E207: Can't delete backup file"));
4724 #ifdef FEAT_SUN_WORKSHOP
4725 if (usingSunWorkShop)
4726 workshop_file_saved((char *) ffname);
4727 #endif
4729 goto nofail;
4732 * Finish up. We get here either after failure or success.
4734 fail:
4735 --no_wait_return; /* may wait for return now */
4736 nofail:
4738 /* Done saving, we accept changed buffer warnings again */
4739 buf->b_saving = FALSE;
4741 vim_free(backup);
4742 if (buffer != smallbuf)
4743 vim_free(buffer);
4744 #ifdef FEAT_MBYTE
4745 vim_free(fenc_tofree);
4746 vim_free(write_info.bw_conv_buf);
4747 # ifdef USE_ICONV
4748 if (write_info.bw_iconv_fd != (iconv_t)-1)
4750 iconv_close(write_info.bw_iconv_fd);
4751 write_info.bw_iconv_fd = (iconv_t)-1;
4753 # endif
4754 #endif
4755 #ifdef HAVE_ACL
4756 mch_free_acl(acl);
4757 #endif
4759 if (errmsg != NULL)
4761 int numlen = errnum != NULL ? (int)STRLEN(errnum) : 0;
4763 attr = hl_attr(HLF_E); /* set highlight for error messages */
4764 msg_add_fname(buf,
4765 #ifndef UNIX
4766 sfname
4767 #else
4768 fname
4769 #endif
4770 ); /* put file name in IObuff with quotes */
4771 if (STRLEN(IObuff) + STRLEN(errmsg) + numlen >= IOSIZE)
4772 IObuff[IOSIZE - STRLEN(errmsg) - numlen - 1] = NUL;
4773 /* If the error message has the form "is ...", put the error number in
4774 * front of the file name. */
4775 if (errnum != NULL)
4777 STRMOVE(IObuff + numlen, IObuff);
4778 mch_memmove(IObuff, errnum, (size_t)numlen);
4780 STRCAT(IObuff, errmsg);
4781 emsg(IObuff);
4782 if (errmsg_allocated)
4783 vim_free(errmsg);
4785 retval = FAIL;
4786 if (end == 0)
4788 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4789 attr | MSG_HIST);
4790 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4791 attr | MSG_HIST);
4793 /* Update the timestamp to avoid an "overwrite changed file"
4794 * prompt when writing again. */
4795 if (mch_stat((char *)fname, &st_old) >= 0)
4797 buf_store_time(buf, &st_old, fname);
4798 buf->b_mtime_read = buf->b_mtime;
4802 msg_scroll = msg_save;
4804 #ifdef FEAT_AUTOCMD
4805 #ifdef FEAT_EVAL
4806 if (!should_abort(retval))
4807 #else
4808 if (!got_int)
4809 #endif
4811 aco_save_T aco;
4813 write_no_eol_lnum = 0; /* in case it was set by the previous read */
4816 * Apply POST autocommands.
4817 * Careful: The autocommands may call buf_write() recursively!
4819 aucmd_prepbuf(&aco, buf);
4821 if (append)
4822 apply_autocmds_exarg(EVENT_FILEAPPENDPOST, fname, fname,
4823 FALSE, curbuf, eap);
4824 else if (filtering)
4825 apply_autocmds_exarg(EVENT_FILTERWRITEPOST, NULL, fname,
4826 FALSE, curbuf, eap);
4827 else if (reset_changed && whole)
4828 apply_autocmds_exarg(EVENT_BUFWRITEPOST, fname, fname,
4829 FALSE, curbuf, eap);
4830 else
4831 apply_autocmds_exarg(EVENT_FILEWRITEPOST, fname, fname,
4832 FALSE, curbuf, eap);
4834 /* restore curwin/curbuf and a few other things */
4835 aucmd_restbuf(&aco);
4837 #ifdef FEAT_EVAL
4838 if (aborting()) /* autocmds may abort script processing */
4839 retval = FALSE;
4840 #endif
4842 #endif
4844 got_int |= prev_got_int;
4846 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4847 /* Update machine specific information. */
4848 mch_post_buffer_write(buf);
4849 #endif
4850 #ifdef FEAT_ODB_EDITOR
4851 odb_post_buffer_write(buf);
4852 #endif
4854 return retval;
4858 * Set the name of the current buffer. Use when the buffer doesn't have a
4859 * name and a ":r" or ":w" command with a file name is used.
4861 static int
4862 set_rw_fname(fname, sfname)
4863 char_u *fname;
4864 char_u *sfname;
4866 #ifdef FEAT_AUTOCMD
4867 buf_T *buf = curbuf;
4869 /* It's like the unnamed buffer is deleted.... */
4870 if (curbuf->b_p_bl)
4871 apply_autocmds(EVENT_BUFDELETE, NULL, NULL, FALSE, curbuf);
4872 apply_autocmds(EVENT_BUFWIPEOUT, NULL, NULL, FALSE, curbuf);
4873 # ifdef FEAT_EVAL
4874 if (aborting()) /* autocmds may abort script processing */
4875 return FAIL;
4876 # endif
4877 if (curbuf != buf)
4879 /* We are in another buffer now, don't do the renaming. */
4880 EMSG(_(e_auchangedbuf));
4881 return FAIL;
4883 #endif
4885 if (setfname(curbuf, fname, sfname, FALSE) == OK)
4886 curbuf->b_flags |= BF_NOTEDITED;
4888 #ifdef FEAT_AUTOCMD
4889 /* ....and a new named one is created */
4890 apply_autocmds(EVENT_BUFNEW, NULL, NULL, FALSE, curbuf);
4891 if (curbuf->b_p_bl)
4892 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, curbuf);
4893 # ifdef FEAT_EVAL
4894 if (aborting()) /* autocmds may abort script processing */
4895 return FAIL;
4896 # endif
4898 /* Do filetype detection now if 'filetype' is empty. */
4899 if (*curbuf->b_p_ft == NUL)
4901 if (au_has_group((char_u *)"filetypedetect"))
4902 (void)do_doautocmd((char_u *)"filetypedetect BufRead", FALSE);
4903 do_modelines(0);
4905 #endif
4907 return OK;
4911 * Put file name into IObuff with quotes.
4913 void
4914 msg_add_fname(buf, fname)
4915 buf_T *buf;
4916 char_u *fname;
4918 if (fname == NULL)
4919 fname = (char_u *)"-stdin-";
4920 home_replace(buf, fname, IObuff + 1, IOSIZE - 4, TRUE);
4921 IObuff[0] = '"';
4922 STRCAT(IObuff, "\" ");
4926 * Append message for text mode to IObuff.
4927 * Return TRUE if something appended.
4929 static int
4930 msg_add_fileformat(eol_type)
4931 int eol_type;
4933 #ifndef USE_CRNL
4934 if (eol_type == EOL_DOS)
4936 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[dos]") : _("[dos format]"));
4937 return TRUE;
4939 #endif
4940 #ifndef USE_CR
4941 if (eol_type == EOL_MAC)
4943 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[mac]") : _("[mac format]"));
4944 return TRUE;
4946 #endif
4947 #if defined(USE_CRNL) || defined(USE_CR)
4948 if (eol_type == EOL_UNIX)
4950 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[unix]") : _("[unix format]"));
4951 return TRUE;
4953 #endif
4954 return FALSE;
4958 * Append line and character count to IObuff.
4960 void
4961 msg_add_lines(insert_space, lnum, nchars)
4962 int insert_space;
4963 long lnum;
4964 long nchars;
4966 char_u *p;
4968 p = IObuff + STRLEN(IObuff);
4970 if (insert_space)
4971 *p++ = ' ';
4972 if (shortmess(SHM_LINES))
4973 sprintf((char *)p, "%ldL, %ldC", lnum, nchars);
4974 else
4976 if (lnum == 1)
4977 STRCPY(p, _("1 line, "));
4978 else
4979 sprintf((char *)p, _("%ld lines, "), lnum);
4980 p += STRLEN(p);
4981 if (nchars == 1)
4982 STRCPY(p, _("1 character"));
4983 else
4984 sprintf((char *)p, _("%ld characters"), nchars);
4989 * Append message for missing line separator to IObuff.
4991 static void
4992 msg_add_eol()
4994 STRCAT(IObuff, shortmess(SHM_LAST) ? _("[noeol]") : _("[Incomplete last line]"));
4998 * Check modification time of file, before writing to it.
4999 * The size isn't checked, because using a tool like "gzip" takes care of
5000 * using the same timestamp but can't set the size.
5002 static int
5003 check_mtime(buf, st)
5004 buf_T *buf;
5005 struct stat *st;
5007 if (buf->b_mtime_read != 0
5008 && time_differs((long)st->st_mtime, buf->b_mtime_read))
5010 msg_scroll = TRUE; /* don't overwrite messages here */
5011 msg_silent = 0; /* must give this prompt */
5012 /* don't use emsg() here, don't want to flush the buffers */
5013 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
5014 hl_attr(HLF_E));
5015 if (ask_yesno((char_u *)_("Do you really want to write to it"),
5016 TRUE) == 'n')
5017 return FAIL;
5018 msg_scroll = FALSE; /* always overwrite the file message now */
5020 return OK;
5023 static int
5024 time_differs(t1, t2)
5025 long t1, t2;
5027 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
5028 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
5029 * the seconds. Since the roundoff is done when flushing the inode, the
5030 * time may change unexpectedly by one second!!! */
5031 return (t1 - t2 > 1 || t2 - t1 > 1);
5032 #else
5033 return (t1 != t2);
5034 #endif
5038 * Call write() to write a number of bytes to the file.
5039 * Also handles encryption and 'encoding' conversion.
5041 * Return FAIL for failure, OK otherwise.
5043 static int
5044 buf_write_bytes(ip)
5045 struct bw_info *ip;
5047 int wlen;
5048 char_u *buf = ip->bw_buf; /* data to write */
5049 int len = ip->bw_len; /* length of data */
5050 #ifdef HAS_BW_FLAGS
5051 int flags = ip->bw_flags; /* extra flags */
5052 #endif
5054 #ifdef FEAT_MBYTE
5056 * Skip conversion when writing the crypt magic number or the BOM.
5058 if (!(flags & FIO_NOCONVERT))
5060 char_u *p;
5061 unsigned c;
5062 int n;
5064 if (flags & FIO_UTF8)
5067 * Convert latin1 in the buffer to UTF-8 in the file.
5069 p = ip->bw_conv_buf; /* translate to buffer */
5070 for (wlen = 0; wlen < len; ++wlen)
5071 p += utf_char2bytes(buf[wlen], p);
5072 buf = ip->bw_conv_buf;
5073 len = (int)(p - ip->bw_conv_buf);
5075 else if (flags & (FIO_UCS4 | FIO_UTF16 | FIO_UCS2 | FIO_LATIN1))
5078 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
5079 * Latin1 chars in the file.
5081 if (flags & FIO_LATIN1)
5082 p = buf; /* translate in-place (can only get shorter) */
5083 else
5084 p = ip->bw_conv_buf; /* translate to buffer */
5085 for (wlen = 0; wlen < len; wlen += n)
5087 if (wlen == 0 && ip->bw_restlen != 0)
5089 int l;
5091 /* Use remainder of previous call. Append the start of
5092 * buf[] to get a full sequence. Might still be too
5093 * short! */
5094 l = CONV_RESTLEN - ip->bw_restlen;
5095 if (l > len)
5096 l = len;
5097 mch_memmove(ip->bw_rest + ip->bw_restlen, buf, (size_t)l);
5098 n = utf_ptr2len_len(ip->bw_rest, ip->bw_restlen + l);
5099 if (n > ip->bw_restlen + len)
5101 /* We have an incomplete byte sequence at the end to
5102 * be written. We can't convert it without the
5103 * remaining bytes. Keep them for the next call. */
5104 if (ip->bw_restlen + len > CONV_RESTLEN)
5105 return FAIL;
5106 ip->bw_restlen += len;
5107 break;
5109 if (n > 1)
5110 c = utf_ptr2char(ip->bw_rest);
5111 else
5112 c = ip->bw_rest[0];
5113 if (n >= ip->bw_restlen)
5115 n -= ip->bw_restlen;
5116 ip->bw_restlen = 0;
5118 else
5120 ip->bw_restlen -= n;
5121 mch_memmove(ip->bw_rest, ip->bw_rest + n,
5122 (size_t)ip->bw_restlen);
5123 n = 0;
5126 else
5128 n = utf_ptr2len_len(buf + wlen, len - wlen);
5129 if (n > len - wlen)
5131 /* We have an incomplete byte sequence at the end to
5132 * be written. We can't convert it without the
5133 * remaining bytes. Keep them for the next call. */
5134 if (len - wlen > CONV_RESTLEN)
5135 return FAIL;
5136 ip->bw_restlen = len - wlen;
5137 mch_memmove(ip->bw_rest, buf + wlen,
5138 (size_t)ip->bw_restlen);
5139 break;
5141 if (n > 1)
5142 c = utf_ptr2char(buf + wlen);
5143 else
5144 c = buf[wlen];
5147 if (ucs2bytes(c, &p, flags) && !ip->bw_conv_error)
5149 ip->bw_conv_error = TRUE;
5150 ip->bw_conv_error_lnum = ip->bw_start_lnum;
5152 if (c == NL)
5153 ++ip->bw_start_lnum;
5155 if (flags & FIO_LATIN1)
5156 len = (int)(p - buf);
5157 else
5159 buf = ip->bw_conv_buf;
5160 len = (int)(p - ip->bw_conv_buf);
5164 # ifdef WIN3264
5165 else if (flags & FIO_CODEPAGE)
5168 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
5169 * codepage.
5171 char_u *from;
5172 size_t fromlen;
5173 char_u *to;
5174 int u8c;
5175 BOOL bad = FALSE;
5176 int needed;
5178 if (ip->bw_restlen > 0)
5180 /* Need to concatenate the remainder of the previous call and
5181 * the bytes of the current call. Use the end of the
5182 * conversion buffer for this. */
5183 fromlen = len + ip->bw_restlen;
5184 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5185 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5186 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5188 else
5190 from = buf;
5191 fromlen = len;
5194 to = ip->bw_conv_buf;
5195 if (enc_utf8)
5197 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
5198 * The buffer has been allocated to be big enough. */
5199 while (fromlen > 0)
5201 n = (int)utf_ptr2len_len(from, (int)fromlen);
5202 if (n > (int)fromlen) /* incomplete byte sequence */
5203 break;
5204 u8c = utf_ptr2char(from);
5205 *to++ = (u8c & 0xff);
5206 *to++ = (u8c >> 8);
5207 fromlen -= n;
5208 from += n;
5211 /* Copy remainder to ip->bw_rest[] to be used for the next
5212 * call. */
5213 if (fromlen > CONV_RESTLEN)
5215 /* weird overlong sequence */
5216 ip->bw_conv_error = TRUE;
5217 return FAIL;
5219 mch_memmove(ip->bw_rest, from, fromlen);
5220 ip->bw_restlen = (int)fromlen;
5222 else
5224 /* Convert from enc_codepage to UCS-2, to the start of the
5225 * buffer. The buffer has been allocated to be big enough. */
5226 ip->bw_restlen = 0;
5227 needed = MultiByteToWideChar(enc_codepage,
5228 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen,
5229 NULL, 0);
5230 if (needed == 0)
5232 /* When conversion fails there may be a trailing byte. */
5233 needed = MultiByteToWideChar(enc_codepage,
5234 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen - 1,
5235 NULL, 0);
5236 if (needed == 0)
5238 /* Conversion doesn't work. */
5239 ip->bw_conv_error = TRUE;
5240 return FAIL;
5242 /* Save the trailing byte for the next call. */
5243 ip->bw_rest[0] = from[fromlen - 1];
5244 ip->bw_restlen = 1;
5246 needed = MultiByteToWideChar(enc_codepage, MB_ERR_INVALID_CHARS,
5247 (LPCSTR)from, (int)(fromlen - ip->bw_restlen),
5248 (LPWSTR)to, needed);
5249 if (needed == 0)
5251 /* Safety check: Conversion doesn't work. */
5252 ip->bw_conv_error = TRUE;
5253 return FAIL;
5255 to += needed * 2;
5258 fromlen = to - ip->bw_conv_buf;
5259 buf = to;
5260 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5261 if (FIO_GET_CP(flags) == CP_UTF8)
5263 /* Convert from UCS-2 to UTF-8, using the remainder of the
5264 * conversion buffer. Fails when out of space. */
5265 for (from = ip->bw_conv_buf; fromlen > 1; fromlen -= 2)
5267 u8c = *from++;
5268 u8c += (*from++ << 8);
5269 to += utf_char2bytes(u8c, to);
5270 if (to + 6 >= ip->bw_conv_buf + ip->bw_conv_buflen)
5272 ip->bw_conv_error = TRUE;
5273 return FAIL;
5276 len = (int)(to - buf);
5278 else
5279 #endif
5281 /* Convert from UCS-2 to the codepage, using the remainder of
5282 * the conversion buffer. If the conversion uses the default
5283 * character "0", the data doesn't fit in this encoding, so
5284 * fail. */
5285 len = WideCharToMultiByte(FIO_GET_CP(flags), 0,
5286 (LPCWSTR)ip->bw_conv_buf, (int)fromlen / sizeof(WCHAR),
5287 (LPSTR)to, (int)(ip->bw_conv_buflen - fromlen), 0,
5288 &bad);
5289 if (bad)
5291 ip->bw_conv_error = TRUE;
5292 return FAIL;
5296 # endif
5298 # ifdef MACOS_CONVERT
5299 else if (flags & FIO_MACROMAN)
5302 * Convert UTF-8 or latin1 to Apple MacRoman.
5304 char_u *from;
5305 size_t fromlen;
5307 if (ip->bw_restlen > 0)
5309 /* Need to concatenate the remainder of the previous call and
5310 * the bytes of the current call. Use the end of the
5311 * conversion buffer for this. */
5312 fromlen = len + ip->bw_restlen;
5313 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5314 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5315 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5317 else
5319 from = buf;
5320 fromlen = len;
5323 if (enc2macroman(from, fromlen,
5324 ip->bw_conv_buf, &len, ip->bw_conv_buflen,
5325 ip->bw_rest, &ip->bw_restlen) == FAIL)
5327 ip->bw_conv_error = TRUE;
5328 return FAIL;
5330 buf = ip->bw_conv_buf;
5332 # endif
5334 # ifdef USE_ICONV
5335 if (ip->bw_iconv_fd != (iconv_t)-1)
5337 const char *from;
5338 size_t fromlen;
5339 char *to;
5340 size_t tolen;
5342 /* Convert with iconv(). */
5343 if (ip->bw_restlen > 0)
5345 char *fp;
5347 /* Need to concatenate the remainder of the previous call and
5348 * the bytes of the current call. Use the end of the
5349 * conversion buffer for this. */
5350 fromlen = len + ip->bw_restlen;
5351 fp = (char *)ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5352 mch_memmove(fp, ip->bw_rest, (size_t)ip->bw_restlen);
5353 mch_memmove(fp + ip->bw_restlen, buf, (size_t)len);
5354 from = fp;
5355 tolen = ip->bw_conv_buflen - fromlen;
5357 else
5359 from = (const char *)buf;
5360 fromlen = len;
5361 tolen = ip->bw_conv_buflen;
5363 to = (char *)ip->bw_conv_buf;
5365 if (ip->bw_first)
5367 size_t save_len = tolen;
5369 /* output the initial shift state sequence */
5370 (void)iconv(ip->bw_iconv_fd, NULL, NULL, &to, &tolen);
5372 /* There is a bug in iconv() on Linux (which appears to be
5373 * wide-spread) which sets "to" to NULL and messes up "tolen".
5375 if (to == NULL)
5377 to = (char *)ip->bw_conv_buf;
5378 tolen = save_len;
5380 ip->bw_first = FALSE;
5384 * If iconv() has an error or there is not enough room, fail.
5386 if ((iconv(ip->bw_iconv_fd, (void *)&from, &fromlen, &to, &tolen)
5387 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
5388 || fromlen > CONV_RESTLEN)
5390 ip->bw_conv_error = TRUE;
5391 return FAIL;
5394 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5395 if (fromlen > 0)
5396 mch_memmove(ip->bw_rest, (void *)from, fromlen);
5397 ip->bw_restlen = (int)fromlen;
5399 buf = ip->bw_conv_buf;
5400 len = (int)((char_u *)to - ip->bw_conv_buf);
5402 # endif
5404 #endif /* FEAT_MBYTE */
5406 #ifdef FEAT_CRYPT
5407 if (flags & FIO_ENCRYPTED) /* encrypt the data */
5409 int ztemp, t, i;
5411 for (i = 0; i < len; i++)
5413 ztemp = buf[i];
5414 buf[i] = ZENCODE(ztemp, t);
5417 #endif
5419 /* Repeat the write(), it may be interrupted by a signal. */
5420 while (len > 0)
5422 wlen = vim_write(ip->bw_fd, buf, len);
5423 if (wlen <= 0) /* error! */
5424 return FAIL;
5425 len -= wlen;
5426 buf += wlen;
5428 return OK;
5431 #ifdef FEAT_MBYTE
5433 * Convert a Unicode character to bytes.
5434 * Return TRUE for an error, FALSE when it's OK.
5436 static int
5437 ucs2bytes(c, pp, flags)
5438 unsigned c; /* in: character */
5439 char_u **pp; /* in/out: pointer to result */
5440 int flags; /* FIO_ flags */
5442 char_u *p = *pp;
5443 int error = FALSE;
5444 int cc;
5447 if (flags & FIO_UCS4)
5449 if (flags & FIO_ENDIAN_L)
5451 *p++ = c;
5452 *p++ = (c >> 8);
5453 *p++ = (c >> 16);
5454 *p++ = (c >> 24);
5456 else
5458 *p++ = (c >> 24);
5459 *p++ = (c >> 16);
5460 *p++ = (c >> 8);
5461 *p++ = c;
5464 else if (flags & (FIO_UCS2 | FIO_UTF16))
5466 if (c >= 0x10000)
5468 if (flags & FIO_UTF16)
5470 /* Make two words, ten bits of the character in each. First
5471 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5472 c -= 0x10000;
5473 if (c >= 0x100000)
5474 error = TRUE;
5475 cc = ((c >> 10) & 0x3ff) + 0xd800;
5476 if (flags & FIO_ENDIAN_L)
5478 *p++ = cc;
5479 *p++ = ((unsigned)cc >> 8);
5481 else
5483 *p++ = ((unsigned)cc >> 8);
5484 *p++ = cc;
5486 c = (c & 0x3ff) + 0xdc00;
5488 else
5489 error = TRUE;
5491 if (flags & FIO_ENDIAN_L)
5493 *p++ = c;
5494 *p++ = (c >> 8);
5496 else
5498 *p++ = (c >> 8);
5499 *p++ = c;
5502 else /* Latin1 */
5504 if (c >= 0x100)
5506 error = TRUE;
5507 *p++ = 0xBF;
5509 else
5510 *p++ = c;
5513 *pp = p;
5514 return error;
5518 * Return TRUE if file encoding "fenc" requires conversion from or to
5519 * 'encoding'.
5521 static int
5522 need_conversion(fenc)
5523 char_u *fenc;
5525 int same_encoding;
5526 int enc_flags;
5527 int fenc_flags;
5529 if (*fenc == NUL || STRCMP(p_enc, fenc) == 0)
5530 same_encoding = TRUE;
5531 else
5533 /* Ignore difference between "ansi" and "latin1", "ucs-4" and
5534 * "ucs-4be", etc. */
5535 enc_flags = get_fio_flags(p_enc);
5536 fenc_flags = get_fio_flags(fenc);
5537 same_encoding = (enc_flags != 0 && fenc_flags == enc_flags);
5539 if (same_encoding)
5541 /* Specified encoding matches with 'encoding'. This requires
5542 * conversion when 'encoding' is Unicode but not UTF-8. */
5543 return enc_unicode != 0;
5546 /* Encodings differ. However, conversion is not needed when 'enc' is any
5547 * Unicode encoding and the file is UTF-8. */
5548 return !(enc_utf8 && fenc_flags == FIO_UTF8);
5552 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5553 * internal conversion.
5554 * if "ptr" is an empty string, use 'encoding'.
5556 static int
5557 get_fio_flags(ptr)
5558 char_u *ptr;
5560 int prop;
5562 if (*ptr == NUL)
5563 ptr = p_enc;
5565 prop = enc_canon_props(ptr);
5566 if (prop & ENC_UNICODE)
5568 if (prop & ENC_2BYTE)
5570 if (prop & ENC_ENDIAN_L)
5571 return FIO_UCS2 | FIO_ENDIAN_L;
5572 return FIO_UCS2;
5574 if (prop & ENC_4BYTE)
5576 if (prop & ENC_ENDIAN_L)
5577 return FIO_UCS4 | FIO_ENDIAN_L;
5578 return FIO_UCS4;
5580 if (prop & ENC_2WORD)
5582 if (prop & ENC_ENDIAN_L)
5583 return FIO_UTF16 | FIO_ENDIAN_L;
5584 return FIO_UTF16;
5586 return FIO_UTF8;
5588 if (prop & ENC_LATIN1)
5589 return FIO_LATIN1;
5590 /* must be ENC_DBCS, requires iconv() */
5591 return 0;
5594 #ifdef WIN3264
5596 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5597 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5598 * Used for conversion between 'encoding' and 'fileencoding'.
5600 static int
5601 get_win_fio_flags(ptr)
5602 char_u *ptr;
5604 int cp;
5606 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5607 if (!enc_utf8 && enc_codepage <= 0)
5608 return 0;
5610 cp = encname2codepage(ptr);
5611 if (cp == 0)
5613 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5614 if (STRCMP(ptr, "utf-8") == 0)
5615 cp = CP_UTF8;
5616 else
5617 # endif
5618 return 0;
5620 return FIO_PUT_CP(cp) | FIO_CODEPAGE;
5622 #endif
5624 #ifdef MACOS_X
5626 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5627 * needed for the internal conversion to/from utf-8 or latin1.
5629 static int
5630 get_mac_fio_flags(ptr)
5631 char_u *ptr;
5633 if ((enc_utf8 || STRCMP(p_enc, "latin1") == 0)
5634 && (enc_canon_props(ptr) & ENC_MACROMAN))
5635 return FIO_MACROMAN;
5636 return 0;
5638 #endif
5641 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5642 * "size" must be at least 2.
5643 * Return the name of the encoding and set "*lenp" to the length.
5644 * Returns NULL when no BOM found.
5646 static char_u *
5647 check_for_bom(p, size, lenp, flags)
5648 char_u *p;
5649 long size;
5650 int *lenp;
5651 int flags;
5653 char *name = NULL;
5654 int len = 2;
5656 if (p[0] == 0xef && p[1] == 0xbb && size >= 3 && p[2] == 0xbf
5657 && (flags == FIO_ALL || flags == FIO_UTF8 || flags == 0))
5659 name = "utf-8"; /* EF BB BF */
5660 len = 3;
5662 else if (p[0] == 0xff && p[1] == 0xfe)
5664 if (size >= 4 && p[2] == 0 && p[3] == 0
5665 && (flags == FIO_ALL || flags == (FIO_UCS4 | FIO_ENDIAN_L)))
5667 name = "ucs-4le"; /* FF FE 00 00 */
5668 len = 4;
5670 else if (flags == (FIO_UCS2 | FIO_ENDIAN_L))
5671 name = "ucs-2le"; /* FF FE */
5672 else if (flags == FIO_ALL || flags == (FIO_UTF16 | FIO_ENDIAN_L))
5673 /* utf-16le is preferred, it also works for ucs-2le text */
5674 name = "utf-16le"; /* FF FE */
5676 else if (p[0] == 0xfe && p[1] == 0xff
5677 && (flags == FIO_ALL || flags == FIO_UCS2 || flags == FIO_UTF16))
5679 /* Default to utf-16, it works also for ucs-2 text. */
5680 if (flags == FIO_UCS2)
5681 name = "ucs-2"; /* FE FF */
5682 else
5683 name = "utf-16"; /* FE FF */
5685 else if (size >= 4 && p[0] == 0 && p[1] == 0 && p[2] == 0xfe
5686 && p[3] == 0xff && (flags == FIO_ALL || flags == FIO_UCS4))
5688 name = "ucs-4"; /* 00 00 FE FF */
5689 len = 4;
5692 *lenp = len;
5693 return (char_u *)name;
5697 * Generate a BOM in "buf[4]" for encoding "name".
5698 * Return the length of the BOM (zero when no BOM).
5700 static int
5701 make_bom(buf, name)
5702 char_u *buf;
5703 char_u *name;
5705 int flags;
5706 char_u *p;
5708 flags = get_fio_flags(name);
5710 /* Can't put a BOM in a non-Unicode file. */
5711 if (flags == FIO_LATIN1 || flags == 0)
5712 return 0;
5714 if (flags == FIO_UTF8) /* UTF-8 */
5716 buf[0] = 0xef;
5717 buf[1] = 0xbb;
5718 buf[2] = 0xbf;
5719 return 3;
5721 p = buf;
5722 (void)ucs2bytes(0xfeff, &p, flags);
5723 return (int)(p - buf);
5725 #endif
5727 #if defined(FEAT_VIMINFO) || defined(FEAT_BROWSE) || \
5728 defined(FEAT_QUICKFIX) || defined(FEAT_AUTOCMD) || defined(PROTO)
5730 * Try to find a shortname by comparing the fullname with the current
5731 * directory.
5732 * Returns "full_path" or pointer into "full_path" if shortened.
5734 char_u *
5735 shorten_fname1(full_path)
5736 char_u *full_path;
5738 char_u dirname[MAXPATHL];
5739 char_u *p = full_path;
5741 if (mch_dirname(dirname, MAXPATHL) == OK)
5743 p = shorten_fname(full_path, dirname);
5744 if (p == NULL || *p == NUL)
5745 p = full_path;
5747 return p;
5749 #endif
5752 * Try to find a shortname by comparing the fullname with the current
5753 * directory.
5754 * Returns NULL if not shorter name possible, pointer into "full_path"
5755 * otherwise.
5757 char_u *
5758 shorten_fname(full_path, dir_name)
5759 char_u *full_path;
5760 char_u *dir_name;
5762 int len;
5763 char_u *p;
5765 if (full_path == NULL)
5766 return NULL;
5767 len = (int)STRLEN(dir_name);
5768 if (fnamencmp(dir_name, full_path, len) == 0)
5770 p = full_path + len;
5771 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5773 * MSDOS: when a file is in the root directory, dir_name will end in a
5774 * slash, since C: by itself does not define a specific dir. In this
5775 * case p may already be correct. <negri>
5777 if (!((len > 2) && (*(p - 2) == ':')))
5778 #endif
5780 if (vim_ispathsep(*p))
5781 ++p;
5782 #ifndef VMS /* the path separator is always part of the path */
5783 else
5784 p = NULL;
5785 #endif
5788 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5790 * When using a file in the current drive, remove the drive name:
5791 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5792 * a floppy from "A:\dir" to "B:\dir".
5794 else if (len > 3
5795 && TOUPPER_LOC(full_path[0]) == TOUPPER_LOC(dir_name[0])
5796 && full_path[1] == ':'
5797 && vim_ispathsep(full_path[2]))
5798 p = full_path + 2;
5799 #endif
5800 else
5801 p = NULL;
5802 return p;
5806 * Shorten filenames for all buffers.
5807 * When "force" is TRUE: Use full path from now on for files currently being
5808 * edited, both for file name and swap file name. Try to shorten the file
5809 * names a bit, if safe to do so.
5810 * When "force" is FALSE: Only try to shorten absolute file names.
5811 * For buffers that have buftype "nofile" or "scratch": never change the file
5812 * name.
5814 void
5815 shorten_fnames(force)
5816 int force;
5818 char_u dirname[MAXPATHL];
5819 buf_T *buf;
5820 char_u *p;
5822 mch_dirname(dirname, MAXPATHL);
5823 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
5825 if (buf->b_fname != NULL
5826 #ifdef FEAT_QUICKFIX
5827 && !bt_nofile(buf)
5828 #endif
5829 && !path_with_url(buf->b_fname)
5830 && (force
5831 || buf->b_sfname == NULL
5832 || mch_isFullName(buf->b_sfname)))
5834 vim_free(buf->b_sfname);
5835 buf->b_sfname = NULL;
5836 p = shorten_fname(buf->b_ffname, dirname);
5837 if (p != NULL)
5839 buf->b_sfname = vim_strsave(p);
5840 buf->b_fname = buf->b_sfname;
5842 if (p == NULL || buf->b_fname == NULL)
5843 buf->b_fname = buf->b_ffname;
5846 /* Always make the swap file name a full path, a "nofile" buffer may
5847 * also have a swap file. */
5848 mf_fullname(buf->b_ml.ml_mfp);
5850 #ifdef FEAT_WINDOWS
5851 status_redraw_all();
5852 redraw_tabline = TRUE;
5853 #endif
5856 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5857 || defined(FEAT_GUI_MSWIN) \
5858 || defined(FEAT_GUI_MAC) \
5859 || defined(PROTO) \
5860 || defined(FEAT_GUI_MACVIM)
5862 * Shorten all filenames in "fnames[count]" by current directory.
5864 void
5865 shorten_filenames(fnames, count)
5866 char_u **fnames;
5867 int count;
5869 int i;
5870 char_u dirname[MAXPATHL];
5871 char_u *p;
5873 if (fnames == NULL || count < 1)
5874 return;
5875 mch_dirname(dirname, sizeof(dirname));
5876 for (i = 0; i < count; ++i)
5878 if ((p = shorten_fname(fnames[i], dirname)) != NULL)
5880 /* shorten_fname() returns pointer in given "fnames[i]". If free
5881 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5882 * "p" first then free fnames[i]. */
5883 p = vim_strsave(p);
5884 vim_free(fnames[i]);
5885 fnames[i] = p;
5889 #endif
5892 * add extension to file name - change path/fo.o.h to path/fo.o.h.ext or
5893 * fo_o_h.ext for MSDOS or when shortname option set.
5895 * Assumed that fname is a valid name found in the filesystem we assure that
5896 * the return value is a different name and ends in 'ext'.
5897 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5898 * characters otherwise.
5899 * Space for the returned name is allocated, must be freed later.
5900 * Returns NULL when out of memory.
5902 char_u *
5903 modname(fname, ext, prepend_dot)
5904 char_u *fname, *ext;
5905 int prepend_dot; /* may prepend a '.' to file name */
5907 return buf_modname(
5908 #ifdef SHORT_FNAME
5909 TRUE,
5910 #else
5911 (curbuf->b_p_sn || curbuf->b_shortname),
5912 #endif
5913 fname, ext, prepend_dot);
5916 char_u *
5917 buf_modname(shortname, fname, ext, prepend_dot)
5918 int shortname; /* use 8.3 file name */
5919 char_u *fname, *ext;
5920 int prepend_dot; /* may prepend a '.' to file name */
5922 char_u *retval;
5923 char_u *s;
5924 char_u *e;
5925 char_u *ptr;
5926 int fnamelen, extlen;
5928 extlen = (int)STRLEN(ext);
5931 * If there is no file name we must get the name of the current directory
5932 * (we need the full path in case :cd is used).
5934 if (fname == NULL || *fname == NUL)
5936 retval = alloc((unsigned)(MAXPATHL + extlen + 3));
5937 if (retval == NULL)
5938 return NULL;
5939 if (mch_dirname(retval, MAXPATHL) == FAIL ||
5940 (fnamelen = (int)STRLEN(retval)) == 0)
5942 vim_free(retval);
5943 return NULL;
5945 if (!after_pathsep(retval, retval + fnamelen))
5947 retval[fnamelen++] = PATHSEP;
5948 retval[fnamelen] = NUL;
5950 #ifndef SHORT_FNAME
5951 prepend_dot = FALSE; /* nothing to prepend a dot to */
5952 #endif
5954 else
5956 fnamelen = (int)STRLEN(fname);
5957 retval = alloc((unsigned)(fnamelen + extlen + 3));
5958 if (retval == NULL)
5959 return NULL;
5960 STRCPY(retval, fname);
5961 #ifdef VMS
5962 vms_remove_version(retval); /* we do not need versions here */
5963 #endif
5967 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5968 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5969 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5970 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5972 for (ptr = retval + fnamelen; ptr > retval; mb_ptr_back(retval, ptr))
5974 #ifndef RISCOS
5975 if (*ext == '.'
5976 # ifdef USE_LONG_FNAME
5977 && (!USE_LONG_FNAME || shortname)
5978 # else
5979 # ifndef SHORT_FNAME
5980 && shortname
5981 # endif
5982 # endif
5984 if (*ptr == '.') /* replace '.' by '_' */
5985 *ptr = '_';
5986 #endif
5987 if (vim_ispathsep(*ptr))
5989 ++ptr;
5990 break;
5994 /* the file name has at most BASENAMELEN characters. */
5995 #ifndef SHORT_FNAME
5996 if (STRLEN(ptr) > (unsigned)BASENAMELEN)
5997 ptr[BASENAMELEN] = '\0';
5998 #endif
6000 s = ptr + STRLEN(ptr);
6003 * For 8.3 file names we may have to reduce the length.
6005 #ifdef USE_LONG_FNAME
6006 if (!USE_LONG_FNAME || shortname)
6007 #else
6008 # ifndef SHORT_FNAME
6009 if (shortname)
6010 # endif
6011 #endif
6014 * If there is no file name, or the file name ends in '/', and the
6015 * extension starts with '.', put a '_' before the dot, because just
6016 * ".ext" is invalid.
6018 if (fname == NULL || *fname == NUL
6019 || vim_ispathsep(fname[STRLEN(fname) - 1]))
6021 #ifdef RISCOS
6022 if (*ext == '/')
6023 #else
6024 if (*ext == '.')
6025 #endif
6026 *s++ = '_';
6029 * If the extension starts with '.', truncate the base name at 8
6030 * characters
6032 #ifdef RISCOS
6033 /* We normally use '/', but swap files are '_' */
6034 else if (*ext == '/' || *ext == '_')
6035 #else
6036 else if (*ext == '.')
6037 #endif
6039 if ((size_t)(s - ptr) > (size_t)8)
6041 s = ptr + 8;
6042 *s = '\0';
6046 * If the extension doesn't start with '.', and the file name
6047 * doesn't have an extension yet, append a '.'
6049 #ifdef RISCOS
6050 else if ((e = vim_strchr(ptr, '/')) == NULL)
6051 *s++ = '/';
6052 #else
6053 else if ((e = vim_strchr(ptr, '.')) == NULL)
6054 *s++ = '.';
6055 #endif
6057 * If the extension doesn't start with '.', and there already is an
6058 * extension, it may need to be truncated
6060 else if ((int)STRLEN(e) + extlen > 4)
6061 s = e + 4 - extlen;
6063 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
6065 * If there is no file name, and the extension starts with '.', put a
6066 * '_' before the dot, because just ".ext" may be invalid if it's on a
6067 * FAT partition, and on HPFS it doesn't matter.
6069 else if ((fname == NULL || *fname == NUL) && *ext == '.')
6070 *s++ = '_';
6071 #endif
6074 * Append the extension.
6075 * ext can start with '.' and cannot exceed 3 more characters.
6077 STRCPY(s, ext);
6079 #ifndef SHORT_FNAME
6081 * Prepend the dot.
6083 if (prepend_dot && !shortname && *(e = gettail(retval)) !=
6084 #ifdef RISCOS
6086 #else
6088 #endif
6089 #ifdef USE_LONG_FNAME
6090 && USE_LONG_FNAME
6091 #endif
6094 STRMOVE(e + 1, e);
6095 #ifdef RISCOS
6096 *e = '/';
6097 #else
6098 *e = '.';
6099 #endif
6101 #endif
6104 * Check that, after appending the extension, the file name is really
6105 * different.
6107 if (fname != NULL && STRCMP(fname, retval) == 0)
6109 /* we search for a character that can be replaced by '_' */
6110 while (--s >= ptr)
6112 if (*s != '_')
6114 *s = '_';
6115 break;
6118 if (s < ptr) /* fname was "________.<ext>", how tricky! */
6119 *ptr = 'v';
6121 return retval;
6125 * Like fgets(), but if the file line is too long, it is truncated and the
6126 * rest of the line is thrown away. Returns TRUE for end-of-file.
6129 vim_fgets(buf, size, fp)
6130 char_u *buf;
6131 int size;
6132 FILE *fp;
6134 char *eof;
6135 #define FGETS_SIZE 200
6136 char tbuf[FGETS_SIZE];
6138 buf[size - 2] = NUL;
6139 #ifdef USE_CR
6140 eof = fgets_cr((char *)buf, size, fp);
6141 #else
6142 eof = fgets((char *)buf, size, fp);
6143 #endif
6144 if (buf[size - 2] != NUL && buf[size - 2] != '\n')
6146 buf[size - 1] = NUL; /* Truncate the line */
6148 /* Now throw away the rest of the line: */
6151 tbuf[FGETS_SIZE - 2] = NUL;
6152 #ifdef USE_CR
6153 ignoredp = fgets_cr((char *)tbuf, FGETS_SIZE, fp);
6154 #else
6155 ignoredp = fgets((char *)tbuf, FGETS_SIZE, fp);
6156 #endif
6157 } while (tbuf[FGETS_SIZE - 2] != NUL && tbuf[FGETS_SIZE - 2] != '\n');
6159 return (eof == NULL);
6162 #if defined(USE_CR) || defined(PROTO)
6164 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
6165 * Returns TRUE for end-of-file.
6166 * Only used for the Mac, because it's much slower than vim_fgets().
6169 tag_fgets(buf, size, fp)
6170 char_u *buf;
6171 int size;
6172 FILE *fp;
6174 int i = 0;
6175 int c;
6176 int eof = FALSE;
6178 for (;;)
6180 c = fgetc(fp);
6181 if (c == EOF)
6183 eof = TRUE;
6184 break;
6186 if (c == '\r')
6188 /* Always store a NL for end-of-line. */
6189 if (i < size - 1)
6190 buf[i++] = '\n';
6191 c = fgetc(fp);
6192 if (c != '\n') /* Macintosh format: single CR. */
6193 ungetc(c, fp);
6194 break;
6196 if (i < size - 1)
6197 buf[i++] = c;
6198 if (c == '\n')
6199 break;
6201 buf[i] = NUL;
6202 return eof;
6204 #endif
6207 * rename() only works if both files are on the same file system, this
6208 * function will (attempts to?) copy the file across if rename fails -- webb
6209 * Return -1 for failure, 0 for success.
6212 vim_rename(from, to)
6213 char_u *from;
6214 char_u *to;
6216 int fd_in;
6217 int fd_out;
6218 int n;
6219 char *errmsg = NULL;
6220 char *buffer;
6221 #ifdef AMIGA
6222 BPTR flock;
6223 #endif
6224 struct stat st;
6225 long perm;
6226 #ifdef HAVE_ACL
6227 vim_acl_T acl; /* ACL from original file */
6228 #endif
6229 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6230 int use_tmp_file = FALSE;
6231 #endif
6234 * When the names are identical, there is nothing to do. When they refer
6235 * to the same file (ignoring case and slash/backslash differences) but
6236 * the file name differs we need to go through a temp file.
6238 if (fnamecmp(from, to) == 0)
6240 #ifdef CASE_INSENSITIVE_FILENAME
6241 if (STRCMP(gettail(from), gettail(to)) != 0)
6242 use_tmp_file = TRUE;
6243 else
6244 #endif
6245 return 0;
6249 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
6251 if (mch_stat((char *)from, &st) < 0)
6252 return -1;
6254 #ifdef UNIX
6256 struct stat st_to;
6258 /* It's possible for the source and destination to be the same file.
6259 * This happens when "from" and "to" differ in case and are on a FAT32
6260 * filesystem. In that case go through a temp file name. */
6261 if (mch_stat((char *)to, &st_to) >= 0
6262 && st.st_dev == st_to.st_dev
6263 && st.st_ino == st_to.st_ino)
6264 use_tmp_file = TRUE;
6266 #endif
6268 #if defined(UNIX) || defined(CASE_INSENSITIVE_FILENAME)
6269 if (use_tmp_file)
6271 char tempname[MAXPATHL + 1];
6274 * Find a name that doesn't exist and is in the same directory.
6275 * Rename "from" to "tempname" and then rename "tempname" to "to".
6277 if (STRLEN(from) >= MAXPATHL - 5)
6278 return -1;
6279 STRCPY(tempname, from);
6280 for (n = 123; n < 99999; ++n)
6282 sprintf((char *)gettail((char_u *)tempname), "%d", n);
6283 if (mch_stat(tempname, &st) < 0)
6285 if (mch_rename((char *)from, tempname) == 0)
6287 if (mch_rename(tempname, (char *)to) == 0)
6288 return 0;
6289 /* Strange, the second step failed. Try moving the
6290 * file back and return failure. */
6291 mch_rename(tempname, (char *)from);
6292 return -1;
6294 /* If it fails for one temp name it will most likely fail
6295 * for any temp name, give up. */
6296 return -1;
6299 return -1;
6301 #endif
6304 * Delete the "to" file, this is required on some systems to make the
6305 * mch_rename() work, on other systems it makes sure that we don't have
6306 * two files when the mch_rename() fails.
6309 #ifdef AMIGA
6311 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
6312 * that the name of the "to" file is the same as the "from" file, even
6313 * though the names are different. To avoid the chance of accidentally
6314 * deleting the "from" file (horror!) we lock it during the remove.
6316 * When used for making a backup before writing the file: This should not
6317 * happen with ":w", because startscript() should detect this problem and
6318 * set buf->b_shortname, causing modname() to return a correct ".bak" file
6319 * name. This problem does exist with ":w filename", but then the
6320 * original file will be somewhere else so the backup isn't really
6321 * important. If autoscripting is off the rename may fail.
6323 flock = Lock((UBYTE *)from, (long)ACCESS_READ);
6324 #endif
6325 mch_remove(to);
6326 #ifdef AMIGA
6327 if (flock)
6328 UnLock(flock);
6329 #endif
6332 * First try a normal rename, return if it works.
6334 if (mch_rename((char *)from, (char *)to) == 0)
6335 return 0;
6338 * Rename() failed, try copying the file.
6340 perm = mch_getperm(from);
6341 #ifdef HAVE_ACL
6342 /* For systems that support ACL: get the ACL from the original file. */
6343 acl = mch_get_acl(from);
6344 #endif
6345 fd_in = mch_open((char *)from, O_RDONLY|O_EXTRA, 0);
6346 if (fd_in == -1)
6348 #ifdef HAVE_ACL
6349 mch_free_acl(acl);
6350 #endif
6351 return -1;
6354 /* Create the new file with same permissions as the original. */
6355 fd_out = mch_open((char *)to,
6356 O_CREAT|O_EXCL|O_WRONLY|O_EXTRA|O_NOFOLLOW, (int)perm);
6357 if (fd_out == -1)
6359 close(fd_in);
6360 #ifdef HAVE_ACL
6361 mch_free_acl(acl);
6362 #endif
6363 return -1;
6366 buffer = (char *)alloc(BUFSIZE);
6367 if (buffer == NULL)
6369 close(fd_out);
6370 close(fd_in);
6371 #ifdef HAVE_ACL
6372 mch_free_acl(acl);
6373 #endif
6374 return -1;
6377 while ((n = vim_read(fd_in, buffer, BUFSIZE)) > 0)
6378 if (vim_write(fd_out, buffer, n) != n)
6380 errmsg = _("E208: Error writing to \"%s\"");
6381 break;
6384 vim_free(buffer);
6385 close(fd_in);
6386 if (close(fd_out) < 0)
6387 errmsg = _("E209: Error closing \"%s\"");
6388 if (n < 0)
6390 errmsg = _("E210: Error reading \"%s\"");
6391 to = from;
6393 #ifndef UNIX /* for Unix mch_open() already set the permission */
6394 mch_setperm(to, perm);
6395 #endif
6396 #ifdef HAVE_ACL
6397 mch_set_acl(to, acl);
6398 mch_free_acl(acl);
6399 #endif
6400 if (errmsg != NULL)
6402 EMSG2(errmsg, to);
6403 return -1;
6405 mch_remove(from);
6406 return 0;
6409 static int already_warned = FALSE;
6410 #ifdef FEAT_GUI_MACVIM
6411 static int default_reload_choice = 0;
6412 #endif
6415 * Check if any not hidden buffer has been changed.
6416 * Postpone the check if there are characters in the stuff buffer, a global
6417 * command is being executed, a mapping is being executed or an autocommand is
6418 * busy.
6419 * Returns TRUE if some message was written (screen should be redrawn and
6420 * cursor positioned).
6423 check_timestamps(focus)
6424 int focus; /* called for GUI focus event */
6426 buf_T *buf;
6427 int didit = 0;
6428 int n;
6430 /* Don't check timestamps while system() or another low-level function may
6431 * cause us to lose and gain focus. */
6432 if (no_check_timestamps > 0)
6433 return FALSE;
6435 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6436 * event and we would keep on checking if the file is steadily growing.
6437 * Do check again after typing something. */
6438 if (focus && did_check_timestamps)
6440 need_check_timestamps = TRUE;
6441 return FALSE;
6444 if (!stuff_empty() || global_busy || !typebuf_typed()
6445 #ifdef FEAT_AUTOCMD
6446 || autocmd_busy || curbuf_lock > 0 || allbuf_lock > 0
6447 #endif
6449 need_check_timestamps = TRUE; /* check later */
6450 else
6452 ++no_wait_return;
6453 did_check_timestamps = TRUE;
6454 already_warned = FALSE;
6455 #ifdef FEAT_GUI_MACVIM
6456 default_reload_choice = 0;
6457 #endif
6458 for (buf = firstbuf; buf != NULL; )
6460 /* Only check buffers in a window. */
6461 if (buf->b_nwindows > 0)
6463 n = buf_check_timestamp(buf, focus);
6464 if (didit < n)
6465 didit = n;
6466 if (n > 0 && !buf_valid(buf))
6468 /* Autocommands have removed the buffer, start at the
6469 * first one again. */
6470 buf = firstbuf;
6471 continue;
6474 buf = buf->b_next;
6476 #ifdef FEAT_GUI_MACVIM
6477 default_reload_choice = 0;
6478 #endif
6479 --no_wait_return;
6480 need_check_timestamps = FALSE;
6481 if (need_wait_return && didit == 2)
6483 /* make sure msg isn't overwritten */
6484 msg_puts((char_u *)"\n");
6485 out_flush();
6488 return didit;
6492 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6493 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6494 * empty.
6496 static int
6497 move_lines(frombuf, tobuf)
6498 buf_T *frombuf;
6499 buf_T *tobuf;
6501 buf_T *tbuf = curbuf;
6502 int retval = OK;
6503 linenr_T lnum;
6504 char_u *p;
6506 /* Copy the lines in "frombuf" to "tobuf". */
6507 curbuf = tobuf;
6508 for (lnum = 1; lnum <= frombuf->b_ml.ml_line_count; ++lnum)
6510 p = vim_strsave(ml_get_buf(frombuf, lnum, FALSE));
6511 if (p == NULL || ml_append(lnum - 1, p, 0, FALSE) == FAIL)
6513 vim_free(p);
6514 retval = FAIL;
6515 break;
6517 vim_free(p);
6520 /* Delete all the lines in "frombuf". */
6521 if (retval != FAIL)
6523 curbuf = frombuf;
6524 for (lnum = curbuf->b_ml.ml_line_count; lnum > 0; --lnum)
6525 if (ml_delete(lnum, FALSE) == FAIL)
6527 /* Oops! We could try putting back the saved lines, but that
6528 * might fail again... */
6529 retval = FAIL;
6530 break;
6534 curbuf = tbuf;
6535 return retval;
6539 * Check if buffer "buf" has been changed.
6540 * Also check if the file for a new buffer unexpectedly appeared.
6541 * return 1 if a changed buffer was found.
6542 * return 2 if a message has been displayed.
6543 * return 0 otherwise.
6546 buf_check_timestamp(buf, focus)
6547 buf_T *buf;
6548 int focus UNUSED; /* called for GUI focus event */
6550 struct stat st;
6551 int stat_res;
6552 int retval = 0;
6553 char_u *path;
6554 char_u *tbuf;
6555 char *mesg = NULL;
6556 char *mesg2 = "";
6557 int helpmesg = FALSE;
6558 int reload = FALSE;
6559 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6560 int can_reload = FALSE;
6561 #endif
6562 size_t orig_size = buf->b_orig_size;
6563 int orig_mode = buf->b_orig_mode;
6564 #ifdef FEAT_GUI
6565 int save_mouse_correct = need_mouse_correct;
6566 #endif
6567 #ifdef FEAT_AUTOCMD
6568 static int busy = FALSE;
6569 int n;
6570 char_u *s;
6571 #endif
6572 char *reason;
6574 /* If there is no file name, the buffer is not loaded, 'buftype' is
6575 * set, we are in the middle of a save or being called recursively: ignore
6576 * this buffer. */
6577 if (buf->b_ffname == NULL
6578 || buf->b_ml.ml_mfp == NULL
6579 #if defined(FEAT_QUICKFIX)
6580 || *buf->b_p_bt != NUL
6581 #endif
6582 || buf->b_saving
6583 #ifdef FEAT_AUTOCMD
6584 || busy
6585 #endif
6586 #ifdef FEAT_NETBEANS_INTG
6587 || isNetbeansBuffer(buf)
6588 #endif
6590 return 0;
6592 if ( !(buf->b_flags & BF_NOTEDITED)
6593 && buf->b_mtime != 0
6594 && ((stat_res = mch_stat((char *)buf->b_ffname, &st)) < 0
6595 || time_differs((long)st.st_mtime, buf->b_mtime)
6596 #ifdef HAVE_ST_MODE
6597 || (int)st.st_mode != buf->b_orig_mode
6598 #else
6599 || mch_getperm(buf->b_ffname) != buf->b_orig_mode
6600 #endif
6603 retval = 1;
6605 /* set b_mtime to stop further warnings (e.g., when executing
6606 * FileChangedShell autocmd) */
6607 if (stat_res < 0)
6609 buf->b_mtime = 0;
6610 buf->b_orig_size = 0;
6611 buf->b_orig_mode = 0;
6613 else
6614 buf_store_time(buf, &st, buf->b_ffname);
6616 /* Don't do anything for a directory. Might contain the file
6617 * explorer. */
6618 if (mch_isdir(buf->b_fname))
6622 * If 'autoread' is set, the buffer has no changes and the file still
6623 * exists, reload the buffer. Use the buffer-local option value if it
6624 * was set, the global option value otherwise.
6626 else if ((buf->b_p_ar >= 0 ? buf->b_p_ar : p_ar)
6627 && !bufIsChanged(buf) && stat_res >= 0)
6628 reload = TRUE;
6629 else
6631 if (stat_res < 0)
6632 reason = "deleted";
6633 else if (bufIsChanged(buf))
6634 reason = "conflict";
6635 else if (orig_size != buf->b_orig_size || buf_contents_changed(buf))
6636 reason = "changed";
6637 else if (orig_mode != buf->b_orig_mode)
6638 reason = "mode";
6639 else
6640 reason = "time";
6642 #ifdef FEAT_AUTOCMD
6644 * Only give the warning if there are no FileChangedShell
6645 * autocommands.
6646 * Avoid being called recursively by setting "busy".
6648 busy = TRUE;
6649 # ifdef FEAT_EVAL
6650 set_vim_var_string(VV_FCS_REASON, (char_u *)reason, -1);
6651 set_vim_var_string(VV_FCS_CHOICE, (char_u *)"", -1);
6652 # endif
6653 ++allbuf_lock;
6654 n = apply_autocmds(EVENT_FILECHANGEDSHELL,
6655 buf->b_fname, buf->b_fname, FALSE, buf);
6656 --allbuf_lock;
6657 busy = FALSE;
6658 if (n)
6660 if (!buf_valid(buf))
6661 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6662 # ifdef FEAT_EVAL
6663 s = get_vim_var_str(VV_FCS_CHOICE);
6664 if (STRCMP(s, "reload") == 0 && *reason != 'd')
6665 reload = TRUE;
6666 else if (STRCMP(s, "ask") == 0)
6667 n = FALSE;
6668 else
6669 # endif
6670 return 2;
6672 if (!n)
6673 #endif
6675 if (*reason == 'd')
6676 mesg = _("E211: File \"%s\" no longer available");
6677 else
6679 helpmesg = TRUE;
6680 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6681 can_reload = TRUE;
6682 #endif
6684 * Check if the file contents really changed to avoid
6685 * giving a warning when only the timestamp was set (e.g.,
6686 * checked out of CVS). Always warn when the buffer was
6687 * changed.
6689 if (reason[2] == 'n')
6691 mesg = _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6692 mesg2 = _("See \":help W12\" for more info.");
6694 else if (reason[1] == 'h')
6696 mesg = _("W11: Warning: File \"%s\" has changed since editing started");
6697 mesg2 = _("See \":help W11\" for more info.");
6699 else if (*reason == 'm')
6701 mesg = _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6702 mesg2 = _("See \":help W16\" for more info.");
6704 else
6705 /* Only timestamp changed, store it to avoid a warning
6706 * in check_mtime() later. */
6707 buf->b_mtime_read = buf->b_mtime;
6713 else if ((buf->b_flags & BF_NEW) && !(buf->b_flags & BF_NEW_W)
6714 && vim_fexists(buf->b_ffname))
6716 retval = 1;
6717 mesg = _("W13: Warning: File \"%s\" has been created after editing started");
6718 buf->b_flags |= BF_NEW_W;
6719 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6720 can_reload = TRUE;
6721 #endif
6724 if (mesg != NULL)
6726 path = home_replace_save(buf, buf->b_fname);
6727 if (path != NULL)
6729 if (!helpmesg)
6730 mesg2 = "";
6731 tbuf = alloc((unsigned)(STRLEN(path) + STRLEN(mesg)
6732 + STRLEN(mesg2) + 2));
6733 sprintf((char *)tbuf, mesg, path);
6734 #ifdef FEAT_EVAL
6735 /* Set warningmsg here, before the unimportant and output-specific
6736 * mesg2 has been appended. */
6737 set_vim_var_string(VV_WARNINGMSG, tbuf, -1);
6738 #endif
6739 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6740 if (can_reload)
6742 if (*mesg2 != NUL)
6744 STRCAT(tbuf, "\n");
6745 STRCAT(tbuf, mesg2);
6747 # ifdef FEAT_GUI_MACVIM
6748 if (default_reload_choice > 0)
6750 if (default_reload_choice == 2)
6751 reload = TRUE;
6753 else
6755 switch (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6756 (char_u *)_("&OK\n&Load File\nLoad &All\n&Ignore All"),
6757 1, NULL))
6759 case 3:
6760 default_reload_choice = 2;
6761 case 2:
6762 reload = TRUE;
6763 break;
6764 case 4:
6765 default_reload_choice = 1;
6766 break;
6769 # else
6770 if (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6771 (char_u *)_("&OK\n&Load File"), 1, NULL) == 2)
6772 reload = TRUE;
6773 # endif
6775 else
6776 #endif
6777 if (State > NORMAL_BUSY || (State & CMDLINE) || already_warned)
6779 if (*mesg2 != NUL)
6781 STRCAT(tbuf, "; ");
6782 STRCAT(tbuf, mesg2);
6784 EMSG(tbuf);
6785 retval = 2;
6787 else
6789 # ifdef FEAT_AUTOCMD
6790 if (!autocmd_busy)
6791 # endif
6793 msg_start();
6794 msg_puts_attr(tbuf, hl_attr(HLF_E) + MSG_HIST);
6795 if (*mesg2 != NUL)
6796 msg_puts_attr((char_u *)mesg2,
6797 hl_attr(HLF_W) + MSG_HIST);
6798 msg_clr_eos();
6799 (void)msg_end();
6800 if (emsg_silent == 0)
6802 out_flush();
6803 # ifdef FEAT_GUI
6804 if (!focus)
6805 # endif
6806 /* give the user some time to think about it */
6807 ui_delay(1000L, TRUE);
6809 /* don't redraw and erase the message */
6810 redraw_cmdline = FALSE;
6813 already_warned = TRUE;
6816 vim_free(path);
6817 vim_free(tbuf);
6821 if (reload)
6822 /* Reload the buffer. */
6823 buf_reload(buf, orig_mode);
6825 #ifdef FEAT_AUTOCMD
6826 /* Trigger FileChangedShell when the file was changed in any way. */
6827 if (buf_valid(buf) && retval != 0)
6828 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST,
6829 buf->b_fname, buf->b_fname, FALSE, buf);
6830 #endif
6831 #ifdef FEAT_GUI
6832 /* restore this in case an autocommand has set it; it would break
6833 * 'mousefocus' */
6834 need_mouse_correct = save_mouse_correct;
6835 #endif
6837 return retval;
6841 * Reload a buffer that is already loaded.
6842 * Used when the file was changed outside of Vim.
6843 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6844 * buf->b_orig_mode may have been reset already.
6846 void
6847 buf_reload(buf, orig_mode)
6848 buf_T *buf;
6849 int orig_mode;
6851 exarg_T ea;
6852 pos_T old_cursor;
6853 linenr_T old_topline;
6854 int old_ro = buf->b_p_ro;
6855 buf_T *savebuf;
6856 int saved = OK;
6857 aco_save_T aco;
6859 /* set curwin/curbuf for "buf" and save some things */
6860 aucmd_prepbuf(&aco, buf);
6862 /* We only want to read the text from the file, not reset the syntax
6863 * highlighting, clear marks, diff status, etc. Force the fileformat
6864 * and encoding to be the same. */
6865 if (prep_exarg(&ea, buf) == OK)
6867 old_cursor = curwin->w_cursor;
6868 old_topline = curwin->w_topline;
6871 * To behave like when a new file is edited (matters for
6872 * BufReadPost autocommands) we first need to delete the current
6873 * buffer contents. But if reading the file fails we should keep
6874 * the old contents. Can't use memory only, the file might be
6875 * too big. Use a hidden buffer to move the buffer contents to.
6877 if (bufempty())
6878 savebuf = NULL;
6879 else
6881 /* Allocate a buffer without putting it in the buffer list. */
6882 savebuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6883 if (savebuf != NULL && buf == curbuf)
6885 /* Open the memline. */
6886 curbuf = savebuf;
6887 curwin->w_buffer = savebuf;
6888 saved = ml_open(curbuf);
6889 curbuf = buf;
6890 curwin->w_buffer = buf;
6892 if (savebuf == NULL || saved == FAIL || buf != curbuf
6893 || move_lines(buf, savebuf) == FAIL)
6895 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6896 buf->b_fname);
6897 saved = FAIL;
6901 if (saved == OK)
6903 curbuf->b_flags |= BF_CHECK_RO; /* check for RO again */
6904 #ifdef FEAT_AUTOCMD
6905 keep_filetype = TRUE; /* don't detect 'filetype' */
6906 #endif
6907 if (readfile(buf->b_ffname, buf->b_fname, (linenr_T)0,
6908 (linenr_T)0,
6909 (linenr_T)MAXLNUM, &ea, READ_NEW) == FAIL)
6911 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6912 if (!aborting())
6913 #endif
6914 EMSG2(_("E321: Could not reload \"%s\""), buf->b_fname);
6915 if (savebuf != NULL && buf_valid(savebuf) && buf == curbuf)
6917 /* Put the text back from the save buffer. First
6918 * delete any lines that readfile() added. */
6919 while (!bufempty())
6920 if (ml_delete(buf->b_ml.ml_line_count, FALSE) == FAIL)
6921 break;
6922 (void)move_lines(savebuf, buf);
6925 else if (buf == curbuf)
6927 /* Mark the buffer as unmodified and free undo info. */
6928 unchanged(buf, TRUE);
6929 u_blockfree(buf);
6930 u_clearall(buf);
6933 vim_free(ea.cmd);
6935 if (savebuf != NULL && buf_valid(savebuf))
6936 wipe_buffer(savebuf, FALSE);
6938 #ifdef FEAT_DIFF
6939 /* Invalidate diff info if necessary. */
6940 diff_invalidate(curbuf);
6941 #endif
6943 /* Restore the topline and cursor position and check it (lines may
6944 * have been removed). */
6945 if (old_topline > curbuf->b_ml.ml_line_count)
6946 curwin->w_topline = curbuf->b_ml.ml_line_count;
6947 else
6948 curwin->w_topline = old_topline;
6949 curwin->w_cursor = old_cursor;
6950 check_cursor();
6951 update_topline();
6952 #ifdef FEAT_AUTOCMD
6953 keep_filetype = FALSE;
6954 #endif
6955 #ifdef FEAT_FOLDING
6957 win_T *wp;
6958 tabpage_T *tp;
6960 /* Update folds unless they are defined manually. */
6961 FOR_ALL_TAB_WINDOWS(tp, wp)
6962 if (wp->w_buffer == curwin->w_buffer
6963 && !foldmethodIsManual(wp))
6964 foldUpdateAll(wp);
6966 #endif
6967 /* If the mode didn't change and 'readonly' was set, keep the old
6968 * value; the user probably used the ":view" command. But don't
6969 * reset it, might have had a read error. */
6970 if (orig_mode == curbuf->b_orig_mode)
6971 curbuf->b_p_ro |= old_ro;
6974 /* restore curwin/curbuf and a few other things */
6975 aucmd_restbuf(&aco);
6976 /* Careful: autocommands may have made "buf" invalid! */
6979 void
6980 buf_store_time(buf, st, fname)
6981 buf_T *buf;
6982 struct stat *st;
6983 char_u *fname UNUSED;
6985 buf->b_mtime = (long)st->st_mtime;
6986 buf->b_orig_size = (size_t)st->st_size;
6987 #ifdef HAVE_ST_MODE
6988 buf->b_orig_mode = (int)st->st_mode;
6989 #else
6990 buf->b_orig_mode = mch_getperm(fname);
6991 #endif
6995 * Adjust the line with missing eol, used for the next write.
6996 * Used for do_filter(), when the input lines for the filter are deleted.
6998 void
6999 write_lnum_adjust(offset)
7000 linenr_T offset;
7002 if (write_no_eol_lnum != 0) /* only if there is a missing eol */
7003 write_no_eol_lnum += offset;
7006 #if defined(TEMPDIRNAMES) || defined(PROTO)
7007 static long temp_count = 0; /* Temp filename counter. */
7010 * Delete the temp directory and all files it contains.
7012 void
7013 vim_deltempdir()
7015 char_u **files;
7016 int file_count;
7017 int i;
7019 if (vim_tempdir != NULL)
7021 sprintf((char *)NameBuff, "%s*", vim_tempdir);
7022 if (gen_expand_wildcards(1, &NameBuff, &file_count, &files,
7023 EW_DIR|EW_FILE|EW_SILENT) == OK)
7025 for (i = 0; i < file_count; ++i)
7026 mch_remove(files[i]);
7027 FreeWild(file_count, files);
7029 gettail(NameBuff)[-1] = NUL;
7030 (void)mch_rmdir(NameBuff);
7032 vim_free(vim_tempdir);
7033 vim_tempdir = NULL;
7036 #endif
7038 #ifdef TEMPDIRNAMES
7040 * Directory "tempdir" was created. Expand this name to a full path and put
7041 * it in "vim_tempdir". This avoids that using ":cd" would confuse us.
7042 * "tempdir" must be no longer than MAXPATHL.
7044 static void
7045 vim_settempdir(tempdir)
7046 char_u *tempdir;
7048 char_u *buf;
7050 buf = alloc((unsigned)MAXPATHL + 2);
7051 if (buf != NULL)
7053 if (vim_FullName(tempdir, buf, MAXPATHL, FALSE) == FAIL)
7054 STRCPY(buf, tempdir);
7055 # ifdef __EMX__
7056 if (vim_strchr(buf, '/') != NULL)
7057 STRCAT(buf, "/");
7058 else
7059 # endif
7060 add_pathsep(buf);
7061 vim_tempdir = vim_strsave(buf);
7062 vim_free(buf);
7065 #endif
7068 * vim_tempname(): Return a unique name that can be used for a temp file.
7070 * The temp file is NOT created.
7072 * The returned pointer is to allocated memory.
7073 * The returned pointer is NULL if no valid name was found.
7075 char_u *
7076 vim_tempname(extra_char)
7077 int extra_char UNUSED; /* char to use in the name instead of '?' */
7079 #ifdef USE_TMPNAM
7080 char_u itmp[L_tmpnam]; /* use tmpnam() */
7081 #else
7082 char_u itmp[TEMPNAMELEN];
7083 #endif
7085 #ifdef TEMPDIRNAMES
7086 static char *(tempdirs[]) = {TEMPDIRNAMES};
7087 int i;
7088 # ifndef EEXIST
7089 struct stat st;
7090 # endif
7093 * This will create a directory for private use by this instance of Vim.
7094 * This is done once, and the same directory is used for all temp files.
7095 * This method avoids security problems because of symlink attacks et al.
7096 * It's also a bit faster, because we only need to check for an existing
7097 * file when creating the directory and not for each temp file.
7099 if (vim_tempdir == NULL)
7102 * Try the entries in TEMPDIRNAMES to create the temp directory.
7104 for (i = 0; i < (int)(sizeof(tempdirs) / sizeof(char *)); ++i)
7106 size_t itmplen;
7107 # ifndef HAVE_MKDTEMP
7108 long nr;
7109 long off;
7110 # endif
7112 /* expand $TMP, leave room for "/v1100000/999999999" */
7113 expand_env((char_u *)tempdirs[i], itmp, TEMPNAMELEN - 20);
7114 if (mch_isdir(itmp)) /* directory exists */
7116 # ifdef __EMX__
7117 /* If $TMP contains a forward slash (perhaps using bash or
7118 * tcsh), don't add a backslash, use a forward slash!
7119 * Adding 2 backslashes didn't work. */
7120 if (vim_strchr(itmp, '/') != NULL)
7121 STRCAT(itmp, "/");
7122 else
7123 # endif
7124 add_pathsep(itmp);
7125 itmplen = STRLEN(itmp);
7127 # ifdef HAVE_MKDTEMP
7128 /* Leave room for filename */
7129 STRCAT(itmp, "vXXXXXX");
7130 if (mkdtemp((char *)itmp) != NULL)
7131 vim_settempdir(itmp);
7132 # else
7133 /* Get an arbitrary number of up to 6 digits. When it's
7134 * unlikely that it already exists it will be faster,
7135 * otherwise it doesn't matter. The use of mkdir() avoids any
7136 * security problems because of the predictable number. */
7137 nr = (mch_get_pid() + (long)time(NULL)) % 1000000L;
7139 /* Try up to 10000 different values until we find a name that
7140 * doesn't exist. */
7141 for (off = 0; off < 10000L; ++off)
7143 int r;
7144 # if defined(UNIX) || defined(VMS)
7145 mode_t umask_save;
7146 # endif
7148 sprintf((char *)itmp + itmplen, "v%ld", nr + off);
7149 # ifndef EEXIST
7150 /* If mkdir() does not set errno to EEXIST, check for
7151 * existing file here. There is a race condition then,
7152 * although it's fail-safe. */
7153 if (mch_stat((char *)itmp, &st) >= 0)
7154 continue;
7155 # endif
7156 # if defined(UNIX) || defined(VMS)
7157 /* Make sure the umask doesn't remove the executable bit.
7158 * "repl" has been reported to use "177". */
7159 umask_save = umask(077);
7160 # endif
7161 r = vim_mkdir(itmp, 0700);
7162 # if defined(UNIX) || defined(VMS)
7163 (void)umask(umask_save);
7164 # endif
7165 if (r == 0)
7167 vim_settempdir(itmp);
7168 break;
7170 # ifdef EEXIST
7171 /* If the mkdir() didn't fail because the file/dir exists,
7172 * we probably can't create any dir here, try another
7173 * place. */
7174 if (errno != EEXIST)
7175 # endif
7176 break;
7178 # endif /* HAVE_MKDTEMP */
7179 if (vim_tempdir != NULL)
7180 break;
7185 if (vim_tempdir != NULL)
7187 /* There is no need to check if the file exists, because we own the
7188 * directory and nobody else creates a file in it. */
7189 sprintf((char *)itmp, "%s%ld", vim_tempdir, temp_count++);
7190 return vim_strsave(itmp);
7193 return NULL;
7195 #else /* TEMPDIRNAMES */
7197 # ifdef WIN3264
7198 char szTempFile[_MAX_PATH + 1];
7199 char buf4[4];
7200 char_u *retval;
7201 char_u *p;
7203 STRCPY(itmp, "");
7204 if (GetTempPath(_MAX_PATH, szTempFile) == 0)
7205 szTempFile[0] = NUL; /* GetTempPath() failed, use current dir */
7206 strcpy(buf4, "VIM");
7207 buf4[2] = extra_char; /* make it "VIa", "VIb", etc. */
7208 if (GetTempFileName(szTempFile, buf4, 0, itmp) == 0)
7209 return NULL;
7210 /* GetTempFileName() will create the file, we don't want that */
7211 (void)DeleteFile(itmp);
7213 /* Backslashes in a temp file name cause problems when filtering with
7214 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
7215 * didn't set 'shellslash'. */
7216 retval = vim_strsave(itmp);
7217 if (*p_shcf == '-' || p_ssl)
7218 for (p = retval; *p; ++p)
7219 if (*p == '\\')
7220 *p = '/';
7221 return retval;
7223 # else /* WIN3264 */
7225 # ifdef USE_TMPNAM
7226 /* tmpnam() will make its own name */
7227 if (*tmpnam((char *)itmp) == NUL)
7228 return NULL;
7229 # else
7230 char_u *p;
7232 # ifdef VMS_TEMPNAM
7233 /* mktemp() is not working on VMS. It seems to be
7234 * a do-nothing function. Therefore we use tempnam().
7236 sprintf((char *)itmp, "VIM%c", extra_char);
7237 p = (char_u *)tempnam("tmp:", (char *)itmp);
7238 if (p != NULL)
7240 /* VMS will use '.LOG' if we don't explicitly specify an extension,
7241 * and VIM will then be unable to find the file later */
7242 STRCPY(itmp, p);
7243 STRCAT(itmp, ".txt");
7244 free(p);
7246 else
7247 return NULL;
7248 # else
7249 STRCPY(itmp, TEMPNAME);
7250 if ((p = vim_strchr(itmp, '?')) != NULL)
7251 *p = extra_char;
7252 if (mktemp((char *)itmp) == NULL)
7253 return NULL;
7254 # endif
7255 # endif
7257 return vim_strsave(itmp);
7258 # endif /* WIN3264 */
7259 #endif /* TEMPDIRNAMES */
7262 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
7264 * Convert all backslashes in fname to forward slashes in-place.
7266 void
7267 forward_slash(fname)
7268 char_u *fname;
7270 char_u *p;
7272 for (p = fname; *p != NUL; ++p)
7273 # ifdef FEAT_MBYTE
7274 /* The Big5 encoding can have '\' in the trail byte. */
7275 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
7276 ++p;
7277 else
7278 # endif
7279 if (*p == '\\')
7280 *p = '/';
7282 #endif
7286 * Code for automatic commands.
7288 * Only included when "FEAT_AUTOCMD" has been defined.
7291 #if defined(FEAT_AUTOCMD) || defined(PROTO)
7294 * The autocommands are stored in a list for each event.
7295 * Autocommands for the same pattern, that are consecutive, are joined
7296 * together, to avoid having to match the pattern too often.
7297 * The result is an array of Autopat lists, which point to AutoCmd lists:
7299 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
7300 * Autopat.cmds Autopat.cmds
7301 * | |
7302 * V V
7303 * AutoCmd.next AutoCmd.next
7304 * | |
7305 * V V
7306 * AutoCmd.next NULL
7309 * NULL
7311 * first_autopat[1] --> Autopat.next --> NULL
7312 * Autopat.cmds
7315 * AutoCmd.next
7318 * NULL
7319 * etc.
7321 * The order of AutoCmds is important, this is the order in which they were
7322 * defined and will have to be executed.
7324 typedef struct AutoCmd
7326 char_u *cmd; /* The command to be executed (NULL
7327 when command has been removed) */
7328 char nested; /* If autocommands nest here */
7329 char last; /* last command in list */
7330 #ifdef FEAT_EVAL
7331 scid_T scriptID; /* script ID where defined */
7332 #endif
7333 struct AutoCmd *next; /* Next AutoCmd in list */
7334 } AutoCmd;
7336 typedef struct AutoPat
7338 int group; /* group ID */
7339 char_u *pat; /* pattern as typed (NULL when pattern
7340 has been removed) */
7341 int patlen; /* strlen() of pat */
7342 regprog_T *reg_prog; /* compiled regprog for pattern */
7343 char allow_dirs; /* Pattern may match whole path */
7344 char last; /* last pattern for apply_autocmds() */
7345 AutoCmd *cmds; /* list of commands to do */
7346 struct AutoPat *next; /* next AutoPat in AutoPat list */
7347 int buflocal_nr; /* !=0 for buffer-local AutoPat */
7348 } AutoPat;
7350 static struct event_name
7352 char *name; /* event name */
7353 event_T event; /* event number */
7354 } event_names[] =
7356 {"BufAdd", EVENT_BUFADD},
7357 {"BufCreate", EVENT_BUFADD},
7358 {"BufDelete", EVENT_BUFDELETE},
7359 {"BufEnter", EVENT_BUFENTER},
7360 {"BufFilePost", EVENT_BUFFILEPOST},
7361 {"BufFilePre", EVENT_BUFFILEPRE},
7362 {"BufHidden", EVENT_BUFHIDDEN},
7363 {"BufLeave", EVENT_BUFLEAVE},
7364 {"BufNew", EVENT_BUFNEW},
7365 {"BufNewFile", EVENT_BUFNEWFILE},
7366 {"BufRead", EVENT_BUFREADPOST},
7367 {"BufReadCmd", EVENT_BUFREADCMD},
7368 {"BufReadPost", EVENT_BUFREADPOST},
7369 {"BufReadPre", EVENT_BUFREADPRE},
7370 {"BufUnload", EVENT_BUFUNLOAD},
7371 {"BufWinEnter", EVENT_BUFWINENTER},
7372 {"BufWinLeave", EVENT_BUFWINLEAVE},
7373 {"BufWipeout", EVENT_BUFWIPEOUT},
7374 {"BufWrite", EVENT_BUFWRITEPRE},
7375 {"BufWritePost", EVENT_BUFWRITEPOST},
7376 {"BufWritePre", EVENT_BUFWRITEPRE},
7377 {"BufWriteCmd", EVENT_BUFWRITECMD},
7378 {"CmdwinEnter", EVENT_CMDWINENTER},
7379 {"CmdwinLeave", EVENT_CMDWINLEAVE},
7380 {"ColorScheme", EVENT_COLORSCHEME},
7381 {"CursorHold", EVENT_CURSORHOLD},
7382 {"CursorHoldI", EVENT_CURSORHOLDI},
7383 {"CursorMoved", EVENT_CURSORMOVED},
7384 {"CursorMovedI", EVENT_CURSORMOVEDI},
7385 {"EncodingChanged", EVENT_ENCODINGCHANGED},
7386 {"FileEncoding", EVENT_ENCODINGCHANGED},
7387 {"FileAppendPost", EVENT_FILEAPPENDPOST},
7388 {"FileAppendPre", EVENT_FILEAPPENDPRE},
7389 {"FileAppendCmd", EVENT_FILEAPPENDCMD},
7390 {"FileChangedShell",EVENT_FILECHANGEDSHELL},
7391 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST},
7392 {"FileChangedRO", EVENT_FILECHANGEDRO},
7393 {"FileReadPost", EVENT_FILEREADPOST},
7394 {"FileReadPre", EVENT_FILEREADPRE},
7395 {"FileReadCmd", EVENT_FILEREADCMD},
7396 {"FileType", EVENT_FILETYPE},
7397 {"FileWritePost", EVENT_FILEWRITEPOST},
7398 {"FileWritePre", EVENT_FILEWRITEPRE},
7399 {"FileWriteCmd", EVENT_FILEWRITECMD},
7400 {"FilterReadPost", EVENT_FILTERREADPOST},
7401 {"FilterReadPre", EVENT_FILTERREADPRE},
7402 {"FilterWritePost", EVENT_FILTERWRITEPOST},
7403 {"FilterWritePre", EVENT_FILTERWRITEPRE},
7404 {"FocusGained", EVENT_FOCUSGAINED},
7405 {"FocusLost", EVENT_FOCUSLOST},
7406 {"FuncUndefined", EVENT_FUNCUNDEFINED},
7407 {"GUIEnter", EVENT_GUIENTER},
7408 {"GUIFailed", EVENT_GUIFAILED},
7409 {"InsertChange", EVENT_INSERTCHANGE},
7410 {"InsertEnter", EVENT_INSERTENTER},
7411 {"InsertLeave", EVENT_INSERTLEAVE},
7412 {"MenuPopup", EVENT_MENUPOPUP},
7413 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
7414 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
7415 {"RemoteReply", EVENT_REMOTEREPLY},
7416 {"SessionLoadPost", EVENT_SESSIONLOADPOST},
7417 {"ShellCmdPost", EVENT_SHELLCMDPOST},
7418 {"ShellFilterPost", EVENT_SHELLFILTERPOST},
7419 {"SourcePre", EVENT_SOURCEPRE},
7420 {"SourceCmd", EVENT_SOURCECMD},
7421 {"SpellFileMissing",EVENT_SPELLFILEMISSING},
7422 {"StdinReadPost", EVENT_STDINREADPOST},
7423 {"StdinReadPre", EVENT_STDINREADPRE},
7424 {"SwapExists", EVENT_SWAPEXISTS},
7425 {"Syntax", EVENT_SYNTAX},
7426 {"TabEnter", EVENT_TABENTER},
7427 {"TabLeave", EVENT_TABLEAVE},
7428 {"TermChanged", EVENT_TERMCHANGED},
7429 {"TermResponse", EVENT_TERMRESPONSE},
7430 {"User", EVENT_USER},
7431 {"VimEnter", EVENT_VIMENTER},
7432 {"VimLeave", EVENT_VIMLEAVE},
7433 {"VimLeavePre", EVENT_VIMLEAVEPRE},
7434 {"WinEnter", EVENT_WINENTER},
7435 {"WinLeave", EVENT_WINLEAVE},
7436 {"VimResized", EVENT_VIMRESIZED},
7437 {NULL, (event_T)0}
7440 static AutoPat *first_autopat[NUM_EVENTS] =
7442 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7443 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7444 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7445 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7446 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7447 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
7451 * struct used to keep status while executing autocommands for an event.
7453 typedef struct AutoPatCmd
7455 AutoPat *curpat; /* next AutoPat to examine */
7456 AutoCmd *nextcmd; /* next AutoCmd to execute */
7457 int group; /* group being used */
7458 char_u *fname; /* fname to match with */
7459 char_u *sfname; /* sfname to match with */
7460 char_u *tail; /* tail of fname */
7461 event_T event; /* current event */
7462 int arg_bufnr; /* initially equal to <abuf>, set to zero when
7463 buf is deleted */
7464 struct AutoPatCmd *next; /* chain of active apc-s for auto-invalidation*/
7465 } AutoPatCmd;
7467 static AutoPatCmd *active_apc_list = NULL; /* stack of active autocommands */
7470 * augroups stores a list of autocmd group names.
7472 static garray_T augroups = {0, 0, sizeof(char_u *), 10, NULL};
7473 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7476 * The ID of the current group. Group 0 is the default one.
7478 static int current_augroup = AUGROUP_DEFAULT;
7480 static int au_need_clean = FALSE; /* need to delete marked patterns */
7482 static void show_autocmd __ARGS((AutoPat *ap, event_T event));
7483 static void au_remove_pat __ARGS((AutoPat *ap));
7484 static void au_remove_cmds __ARGS((AutoPat *ap));
7485 static void au_cleanup __ARGS((void));
7486 static int au_new_group __ARGS((char_u *name));
7487 static void au_del_group __ARGS((char_u *name));
7488 static event_T event_name2nr __ARGS((char_u *start, char_u **end));
7489 static char_u *event_nr2name __ARGS((event_T event));
7490 static char_u *find_end_event __ARGS((char_u *arg, int have_group));
7491 static int event_ignored __ARGS((event_T event));
7492 static int au_get_grouparg __ARGS((char_u **argp));
7493 static int do_autocmd_event __ARGS((event_T event, char_u *pat, int nested, char_u *cmd, int forceit, int group));
7494 static char_u *getnextac __ARGS((int c, void *cookie, int indent));
7495 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));
7496 static void auto_next_pat __ARGS((AutoPatCmd *apc, int stop_at_last));
7499 static event_T last_event;
7500 static int last_group;
7501 static int autocmd_blocked = 0; /* block all autocmds */
7504 * Show the autocommands for one AutoPat.
7506 static void
7507 show_autocmd(ap, event)
7508 AutoPat *ap;
7509 event_T event;
7511 AutoCmd *ac;
7513 /* Check for "got_int" (here and at various places below), which is set
7514 * when "q" has been hit for the "--more--" prompt */
7515 if (got_int)
7516 return;
7517 if (ap->pat == NULL) /* pattern has been removed */
7518 return;
7520 msg_putchar('\n');
7521 if (got_int)
7522 return;
7523 if (event != last_event || ap->group != last_group)
7525 if (ap->group != AUGROUP_DEFAULT)
7527 if (AUGROUP_NAME(ap->group) == NULL)
7528 msg_puts_attr((char_u *)_("--Deleted--"), hl_attr(HLF_E));
7529 else
7530 msg_puts_attr(AUGROUP_NAME(ap->group), hl_attr(HLF_T));
7531 msg_puts((char_u *)" ");
7533 msg_puts_attr(event_nr2name(event), hl_attr(HLF_T));
7534 last_event = event;
7535 last_group = ap->group;
7536 msg_putchar('\n');
7537 if (got_int)
7538 return;
7540 msg_col = 4;
7541 msg_outtrans(ap->pat);
7543 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7545 if (ac->cmd != NULL) /* skip removed commands */
7547 if (msg_col >= 14)
7548 msg_putchar('\n');
7549 msg_col = 14;
7550 if (got_int)
7551 return;
7552 msg_outtrans(ac->cmd);
7553 #ifdef FEAT_EVAL
7554 if (p_verbose > 0)
7555 last_set_msg(ac->scriptID);
7556 #endif
7557 if (got_int)
7558 return;
7559 if (ac->next != NULL)
7561 msg_putchar('\n');
7562 if (got_int)
7563 return;
7570 * Mark an autocommand pattern for deletion.
7572 static void
7573 au_remove_pat(ap)
7574 AutoPat *ap;
7576 vim_free(ap->pat);
7577 ap->pat = NULL;
7578 ap->buflocal_nr = -1;
7579 au_need_clean = TRUE;
7583 * Mark all commands for a pattern for deletion.
7585 static void
7586 au_remove_cmds(ap)
7587 AutoPat *ap;
7589 AutoCmd *ac;
7591 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7593 vim_free(ac->cmd);
7594 ac->cmd = NULL;
7596 au_need_clean = TRUE;
7600 * Cleanup autocommands and patterns that have been deleted.
7601 * This is only done when not executing autocommands.
7603 static void
7604 au_cleanup()
7606 AutoPat *ap, **prev_ap;
7607 AutoCmd *ac, **prev_ac;
7608 event_T event;
7610 if (autocmd_busy || !au_need_clean)
7611 return;
7613 /* loop over all events */
7614 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7615 event = (event_T)((int)event + 1))
7617 /* loop over all autocommand patterns */
7618 prev_ap = &(first_autopat[(int)event]);
7619 for (ap = *prev_ap; ap != NULL; ap = *prev_ap)
7621 /* loop over all commands for this pattern */
7622 prev_ac = &(ap->cmds);
7623 for (ac = *prev_ac; ac != NULL; ac = *prev_ac)
7625 /* remove the command if the pattern is to be deleted or when
7626 * the command has been marked for deletion */
7627 if (ap->pat == NULL || ac->cmd == NULL)
7629 *prev_ac = ac->next;
7630 vim_free(ac->cmd);
7631 vim_free(ac);
7633 else
7634 prev_ac = &(ac->next);
7637 /* remove the pattern if it has been marked for deletion */
7638 if (ap->pat == NULL)
7640 *prev_ap = ap->next;
7641 vim_free(ap->reg_prog);
7642 vim_free(ap);
7644 else
7645 prev_ap = &(ap->next);
7649 au_need_clean = FALSE;
7653 * Called when buffer is freed, to remove/invalidate related buffer-local
7654 * autocmds.
7656 void
7657 aubuflocal_remove(buf)
7658 buf_T *buf;
7660 AutoPat *ap;
7661 event_T event;
7662 AutoPatCmd *apc;
7664 /* invalidate currently executing autocommands */
7665 for (apc = active_apc_list; apc; apc = apc->next)
7666 if (buf->b_fnum == apc->arg_bufnr)
7667 apc->arg_bufnr = 0;
7669 /* invalidate buflocals looping through events */
7670 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7671 event = (event_T)((int)event + 1))
7672 /* loop over all autocommand patterns */
7673 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
7674 if (ap->buflocal_nr == buf->b_fnum)
7676 au_remove_pat(ap);
7677 if (p_verbose >= 6)
7679 verbose_enter();
7680 smsg((char_u *)
7681 _("auto-removing autocommand: %s <buffer=%d>"),
7682 event_nr2name(event), buf->b_fnum);
7683 verbose_leave();
7686 au_cleanup();
7690 * Add an autocmd group name.
7691 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7693 static int
7694 au_new_group(name)
7695 char_u *name;
7697 int i;
7699 i = au_find_group(name);
7700 if (i == AUGROUP_ERROR) /* the group doesn't exist yet, add it */
7702 /* First try using a free entry. */
7703 for (i = 0; i < augroups.ga_len; ++i)
7704 if (AUGROUP_NAME(i) == NULL)
7705 break;
7706 if (i == augroups.ga_len && ga_grow(&augroups, 1) == FAIL)
7707 return AUGROUP_ERROR;
7709 AUGROUP_NAME(i) = vim_strsave(name);
7710 if (AUGROUP_NAME(i) == NULL)
7711 return AUGROUP_ERROR;
7712 if (i == augroups.ga_len)
7713 ++augroups.ga_len;
7716 return i;
7719 static void
7720 au_del_group(name)
7721 char_u *name;
7723 int i;
7725 i = au_find_group(name);
7726 if (i == AUGROUP_ERROR) /* the group doesn't exist */
7727 EMSG2(_("E367: No such group: \"%s\""), name);
7728 else
7730 vim_free(AUGROUP_NAME(i));
7731 AUGROUP_NAME(i) = NULL;
7736 * Find the ID of an autocmd group name.
7737 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7739 static int
7740 au_find_group(name)
7741 char_u *name;
7743 int i;
7745 for (i = 0; i < augroups.ga_len; ++i)
7746 if (AUGROUP_NAME(i) != NULL && STRCMP(AUGROUP_NAME(i), name) == 0)
7747 return i;
7748 return AUGROUP_ERROR;
7752 * Return TRUE if augroup "name" exists.
7755 au_has_group(name)
7756 char_u *name;
7758 return au_find_group(name) != AUGROUP_ERROR;
7762 * ":augroup {name}".
7764 void
7765 do_augroup(arg, del_group)
7766 char_u *arg;
7767 int del_group;
7769 int i;
7771 if (del_group)
7773 if (*arg == NUL)
7774 EMSG(_(e_argreq));
7775 else
7776 au_del_group(arg);
7778 else if (STRICMP(arg, "end") == 0) /* ":aug end": back to group 0 */
7779 current_augroup = AUGROUP_DEFAULT;
7780 else if (*arg) /* ":aug xxx": switch to group xxx */
7782 i = au_new_group(arg);
7783 if (i != AUGROUP_ERROR)
7784 current_augroup = i;
7786 else /* ":aug": list the group names */
7788 msg_start();
7789 for (i = 0; i < augroups.ga_len; ++i)
7791 if (AUGROUP_NAME(i) != NULL)
7793 msg_puts(AUGROUP_NAME(i));
7794 msg_puts((char_u *)" ");
7797 msg_clr_eos();
7798 msg_end();
7802 #if defined(EXITFREE) || defined(PROTO)
7803 void
7804 free_all_autocmds()
7806 for (current_augroup = -1; current_augroup < augroups.ga_len;
7807 ++current_augroup)
7808 do_autocmd((char_u *)"", TRUE);
7809 ga_clear_strings(&augroups);
7811 #endif
7814 * Return the event number for event name "start".
7815 * Return NUM_EVENTS if the event name was not found.
7816 * Return a pointer to the next event name in "end".
7818 static event_T
7819 event_name2nr(start, end)
7820 char_u *start;
7821 char_u **end;
7823 char_u *p;
7824 int i;
7825 int len;
7827 /* the event name ends with end of line, a blank or a comma */
7828 for (p = start; *p && !vim_iswhite(*p) && *p != ','; ++p)
7830 for (i = 0; event_names[i].name != NULL; ++i)
7832 len = (int)STRLEN(event_names[i].name);
7833 if (len == p - start && STRNICMP(event_names[i].name, start, len) == 0)
7834 break;
7836 if (*p == ',')
7837 ++p;
7838 *end = p;
7839 if (event_names[i].name == NULL)
7840 return NUM_EVENTS;
7841 return event_names[i].event;
7845 * Return the name for event "event".
7847 static char_u *
7848 event_nr2name(event)
7849 event_T event;
7851 int i;
7853 for (i = 0; event_names[i].name != NULL; ++i)
7854 if (event_names[i].event == event)
7855 return (char_u *)event_names[i].name;
7856 return (char_u *)"Unknown";
7860 * Scan over the events. "*" stands for all events.
7862 static char_u *
7863 find_end_event(arg, have_group)
7864 char_u *arg;
7865 int have_group; /* TRUE when group name was found */
7867 char_u *pat;
7868 char_u *p;
7870 if (*arg == '*')
7872 if (arg[1] && !vim_iswhite(arg[1]))
7874 EMSG2(_("E215: Illegal character after *: %s"), arg);
7875 return NULL;
7877 pat = arg + 1;
7879 else
7881 for (pat = arg; *pat && !vim_iswhite(*pat); pat = p)
7883 if ((int)event_name2nr(pat, &p) >= (int)NUM_EVENTS)
7885 if (have_group)
7886 EMSG2(_("E216: No such event: %s"), pat);
7887 else
7888 EMSG2(_("E216: No such group or event: %s"), pat);
7889 return NULL;
7893 return pat;
7897 * Return TRUE if "event" is included in 'eventignore'.
7899 static int
7900 event_ignored(event)
7901 event_T event;
7903 char_u *p = p_ei;
7905 while (*p != NUL)
7907 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7908 return TRUE;
7909 if (event_name2nr(p, &p) == event)
7910 return TRUE;
7913 return FALSE;
7917 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7920 check_ei()
7922 char_u *p = p_ei;
7924 while (*p)
7926 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7928 p += 3;
7929 if (*p == ',')
7930 ++p;
7932 else if (event_name2nr(p, &p) == NUM_EVENTS)
7933 return FAIL;
7936 return OK;
7939 # if defined(FEAT_SYN_HL) || defined(PROTO)
7942 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7943 * buffer loaded into the window. "what" must start with a comma.
7944 * Returns the old value of 'eventignore' in allocated memory.
7946 char_u *
7947 au_event_disable(what)
7948 char *what;
7950 char_u *new_ei;
7951 char_u *save_ei;
7953 save_ei = vim_strsave(p_ei);
7954 if (save_ei != NULL)
7956 new_ei = vim_strnsave(p_ei, (int)(STRLEN(p_ei) + STRLEN(what)));
7957 if (new_ei != NULL)
7959 STRCAT(new_ei, what);
7960 set_string_option_direct((char_u *)"ei", -1, new_ei,
7961 OPT_FREE, SID_NONE);
7962 vim_free(new_ei);
7965 return save_ei;
7968 void
7969 au_event_restore(old_ei)
7970 char_u *old_ei;
7972 if (old_ei != NULL)
7974 set_string_option_direct((char_u *)"ei", -1, old_ei,
7975 OPT_FREE, SID_NONE);
7976 vim_free(old_ei);
7979 # endif /* FEAT_SYN_HL */
7982 * do_autocmd() -- implements the :autocmd command. Can be used in the
7983 * following ways:
7985 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7986 * will be automatically executed for <event>
7987 * when editing a file matching <pat>, in
7988 * the current group.
7989 * :autocmd <event> <pat> Show the auto-commands associated with
7990 * <event> and <pat>.
7991 * :autocmd <event> Show the auto-commands associated with
7992 * <event>.
7993 * :autocmd Show all auto-commands.
7994 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7995 * <event> and <pat>, and add the command
7996 * <cmd>, for the current group.
7997 * :autocmd! <event> <pat> Remove all auto-commands associated with
7998 * <event> and <pat> for the current group.
7999 * :autocmd! <event> Remove all auto-commands associated with
8000 * <event> for the current group.
8001 * :autocmd! Remove ALL auto-commands for the current
8002 * group.
8004 * Multiple events and patterns may be given separated by commas. Here are
8005 * some examples:
8006 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
8007 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
8009 * :autocmd * *.c show all autocommands for *.c files.
8011 * Mostly a {group} argument can optionally appear before <event>.
8013 void
8014 do_autocmd(arg, forceit)
8015 char_u *arg;
8016 int forceit;
8018 char_u *pat;
8019 char_u *envpat = NULL;
8020 char_u *cmd;
8021 event_T event;
8022 int need_free = FALSE;
8023 int nested = FALSE;
8024 int group;
8027 * Check for a legal group name. If not, use AUGROUP_ALL.
8029 group = au_get_grouparg(&arg);
8030 if (arg == NULL) /* out of memory */
8031 return;
8034 * Scan over the events.
8035 * If we find an illegal name, return here, don't do anything.
8037 pat = find_end_event(arg, group != AUGROUP_ALL);
8038 if (pat == NULL)
8039 return;
8042 * Scan over the pattern. Put a NUL at the end.
8044 pat = skipwhite(pat);
8045 cmd = pat;
8046 while (*cmd && (!vim_iswhite(*cmd) || cmd[-1] == '\\'))
8047 cmd++;
8048 if (*cmd)
8049 *cmd++ = NUL;
8051 /* Expand environment variables in the pattern. Set 'shellslash', we want
8052 * forward slashes here. */
8053 if (vim_strchr(pat, '$') != NULL || vim_strchr(pat, '~') != NULL)
8055 #ifdef BACKSLASH_IN_FILENAME
8056 int p_ssl_save = p_ssl;
8058 p_ssl = TRUE;
8059 #endif
8060 envpat = expand_env_save(pat);
8061 #ifdef BACKSLASH_IN_FILENAME
8062 p_ssl = p_ssl_save;
8063 #endif
8064 if (envpat != NULL)
8065 pat = envpat;
8069 * Check for "nested" flag.
8071 cmd = skipwhite(cmd);
8072 if (*cmd != NUL && STRNCMP(cmd, "nested", 6) == 0 && vim_iswhite(cmd[6]))
8074 nested = TRUE;
8075 cmd = skipwhite(cmd + 6);
8079 * Find the start of the commands.
8080 * Expand <sfile> in it.
8082 if (*cmd != NUL)
8084 cmd = expand_sfile(cmd);
8085 if (cmd == NULL) /* some error */
8086 return;
8087 need_free = TRUE;
8091 * Print header when showing autocommands.
8093 if (!forceit && *cmd == NUL)
8095 /* Highlight title */
8096 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
8100 * Loop over the events.
8102 last_event = (event_T)-1; /* for listing the event name */
8103 last_group = AUGROUP_ERROR; /* for listing the group name */
8104 if (*arg == '*' || *arg == NUL)
8106 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
8107 event = (event_T)((int)event + 1))
8108 if (do_autocmd_event(event, pat,
8109 nested, cmd, forceit, group) == FAIL)
8110 break;
8112 else
8114 while (*arg && !vim_iswhite(*arg))
8115 if (do_autocmd_event(event_name2nr(arg, &arg), pat,
8116 nested, cmd, forceit, group) == FAIL)
8117 break;
8120 if (need_free)
8121 vim_free(cmd);
8122 vim_free(envpat);
8126 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
8127 * The "argp" argument is advanced to the following argument.
8129 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
8131 static int
8132 au_get_grouparg(argp)
8133 char_u **argp;
8135 char_u *group_name;
8136 char_u *p;
8137 char_u *arg = *argp;
8138 int group = AUGROUP_ALL;
8140 p = skiptowhite(arg);
8141 if (p > arg)
8143 group_name = vim_strnsave(arg, (int)(p - arg));
8144 if (group_name == NULL) /* out of memory */
8145 return AUGROUP_ERROR;
8146 group = au_find_group(group_name);
8147 if (group == AUGROUP_ERROR)
8148 group = AUGROUP_ALL; /* no match, use all groups */
8149 else
8150 *argp = skipwhite(p); /* match, skip over group name */
8151 vim_free(group_name);
8153 return group;
8157 * do_autocmd() for one event.
8158 * If *pat == NUL do for all patterns.
8159 * If *cmd == NUL show entries.
8160 * If forceit == TRUE delete entries.
8161 * If group is not AUGROUP_ALL, only use this group.
8163 static int
8164 do_autocmd_event(event, pat, nested, cmd, forceit, group)
8165 event_T event;
8166 char_u *pat;
8167 int nested;
8168 char_u *cmd;
8169 int forceit;
8170 int group;
8172 AutoPat *ap;
8173 AutoPat **prev_ap;
8174 AutoCmd *ac;
8175 AutoCmd **prev_ac;
8176 int brace_level;
8177 char_u *endpat;
8178 int findgroup;
8179 int allgroups;
8180 int patlen;
8181 int is_buflocal;
8182 int buflocal_nr;
8183 char_u buflocal_pat[25]; /* for "<buffer=X>" */
8185 if (group == AUGROUP_ALL)
8186 findgroup = current_augroup;
8187 else
8188 findgroup = group;
8189 allgroups = (group == AUGROUP_ALL && !forceit && *cmd == NUL);
8192 * Show or delete all patterns for an event.
8194 if (*pat == NUL)
8196 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
8198 if (forceit) /* delete the AutoPat, if it's in the current group */
8200 if (ap->group == findgroup)
8201 au_remove_pat(ap);
8203 else if (group == AUGROUP_ALL || ap->group == group)
8204 show_autocmd(ap, event);
8209 * Loop through all the specified patterns.
8211 for ( ; *pat; pat = (*endpat == ',' ? endpat + 1 : endpat))
8214 * Find end of the pattern.
8215 * Watch out for a comma in braces, like "*.\{obj,o\}".
8217 brace_level = 0;
8218 for (endpat = pat; *endpat && (*endpat != ',' || brace_level
8219 || endpat[-1] == '\\'); ++endpat)
8221 if (*endpat == '{')
8222 brace_level++;
8223 else if (*endpat == '}')
8224 brace_level--;
8226 if (pat == endpat) /* ignore single comma */
8227 continue;
8228 patlen = (int)(endpat - pat);
8231 * detect special <buflocal[=X]> buffer-local patterns
8233 is_buflocal = FALSE;
8234 buflocal_nr = 0;
8236 if (patlen >= 7 && STRNCMP(pat, "<buffer", 7) == 0
8237 && pat[patlen - 1] == '>')
8239 /* Error will be printed only for addition. printing and removing
8240 * will proceed silently. */
8241 is_buflocal = TRUE;
8242 if (patlen == 8)
8243 buflocal_nr = curbuf->b_fnum;
8244 else if (patlen > 9 && pat[7] == '=')
8246 /* <buffer=abuf> */
8247 if (patlen == 13 && STRNICMP(pat, "<buffer=abuf>", 13))
8248 buflocal_nr = autocmd_bufnr;
8249 /* <buffer=123> */
8250 else if (skipdigits(pat + 8) == pat + patlen - 1)
8251 buflocal_nr = atoi((char *)pat + 8);
8255 if (is_buflocal)
8257 /* normalize pat into standard "<buffer>#N" form */
8258 sprintf((char *)buflocal_pat, "<buffer=%d>", buflocal_nr);
8259 pat = buflocal_pat; /* can modify pat and patlen */
8260 patlen = (int)STRLEN(buflocal_pat); /* but not endpat */
8264 * Find AutoPat entries with this pattern.
8266 prev_ap = &first_autopat[(int)event];
8267 while ((ap = *prev_ap) != NULL)
8269 if (ap->pat != NULL)
8271 /* Accept a pattern when:
8272 * - a group was specified and it's that group, or a group was
8273 * not specified and it's the current group, or a group was
8274 * not specified and we are listing
8275 * - the length of the pattern matches
8276 * - the pattern matches.
8277 * For <buffer[=X]>, this condition works because we normalize
8278 * all buffer-local patterns.
8280 if ((allgroups || ap->group == findgroup)
8281 && ap->patlen == patlen
8282 && STRNCMP(pat, ap->pat, patlen) == 0)
8285 * Remove existing autocommands.
8286 * If adding any new autocmd's for this AutoPat, don't
8287 * delete the pattern from the autopat list, append to
8288 * this list.
8290 if (forceit)
8292 if (*cmd != NUL && ap->next == NULL)
8294 au_remove_cmds(ap);
8295 break;
8297 au_remove_pat(ap);
8301 * Show autocmd's for this autopat, or buflocals <buffer=X>
8303 else if (*cmd == NUL)
8304 show_autocmd(ap, event);
8307 * Add autocmd to this autopat, if it's the last one.
8309 else if (ap->next == NULL)
8310 break;
8313 prev_ap = &ap->next;
8317 * Add a new command.
8319 if (*cmd != NUL)
8322 * If the pattern we want to add a command to does appear at the
8323 * end of the list (or not is not in the list at all), add the
8324 * pattern at the end of the list.
8326 if (ap == NULL)
8328 /* refuse to add buffer-local ap if buffer number is invalid */
8329 if (is_buflocal && (buflocal_nr == 0
8330 || buflist_findnr(buflocal_nr) == NULL))
8332 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
8333 buflocal_nr);
8334 return FAIL;
8337 ap = (AutoPat *)alloc((unsigned)sizeof(AutoPat));
8338 if (ap == NULL)
8339 return FAIL;
8340 ap->pat = vim_strnsave(pat, patlen);
8341 ap->patlen = patlen;
8342 if (ap->pat == NULL)
8344 vim_free(ap);
8345 return FAIL;
8348 if (is_buflocal)
8350 ap->buflocal_nr = buflocal_nr;
8351 ap->reg_prog = NULL;
8353 else
8355 char_u *reg_pat;
8357 ap->buflocal_nr = 0;
8358 reg_pat = file_pat_to_reg_pat(pat, endpat,
8359 &ap->allow_dirs, TRUE);
8360 if (reg_pat != NULL)
8361 ap->reg_prog = vim_regcomp(reg_pat, RE_MAGIC);
8362 vim_free(reg_pat);
8363 if (reg_pat == NULL || ap->reg_prog == NULL)
8365 vim_free(ap->pat);
8366 vim_free(ap);
8367 return FAIL;
8370 ap->cmds = NULL;
8371 *prev_ap = ap;
8372 ap->next = NULL;
8373 if (group == AUGROUP_ALL)
8374 ap->group = current_augroup;
8375 else
8376 ap->group = group;
8380 * Add the autocmd at the end of the AutoCmd list.
8382 prev_ac = &(ap->cmds);
8383 while ((ac = *prev_ac) != NULL)
8384 prev_ac = &ac->next;
8385 ac = (AutoCmd *)alloc((unsigned)sizeof(AutoCmd));
8386 if (ac == NULL)
8387 return FAIL;
8388 ac->cmd = vim_strsave(cmd);
8389 #ifdef FEAT_EVAL
8390 ac->scriptID = current_SID;
8391 #endif
8392 if (ac->cmd == NULL)
8394 vim_free(ac);
8395 return FAIL;
8397 ac->next = NULL;
8398 *prev_ac = ac;
8399 ac->nested = nested;
8403 au_cleanup(); /* may really delete removed patterns/commands now */
8404 return OK;
8408 * Implementation of ":doautocmd [group] event [fname]".
8409 * Return OK for success, FAIL for failure;
8412 do_doautocmd(arg, do_msg)
8413 char_u *arg;
8414 int do_msg; /* give message for no matching autocmds? */
8416 char_u *fname;
8417 int nothing_done = TRUE;
8418 int group;
8421 * Check for a legal group name. If not, use AUGROUP_ALL.
8423 group = au_get_grouparg(&arg);
8424 if (arg == NULL) /* out of memory */
8425 return FAIL;
8427 if (*arg == '*')
8429 EMSG(_("E217: Can't execute autocommands for ALL events"));
8430 return FAIL;
8434 * Scan over the events.
8435 * If we find an illegal name, return here, don't do anything.
8437 fname = find_end_event(arg, group != AUGROUP_ALL);
8438 if (fname == NULL)
8439 return FAIL;
8441 fname = skipwhite(fname);
8444 * Loop over the events.
8446 while (*arg && !vim_iswhite(*arg))
8447 if (apply_autocmds_group(event_name2nr(arg, &arg),
8448 fname, NULL, TRUE, group, curbuf, NULL))
8449 nothing_done = FALSE;
8451 if (nothing_done && do_msg)
8452 MSG(_("No matching autocommands"));
8454 #ifdef FEAT_EVAL
8455 return aborting() ? FAIL : OK;
8456 #else
8457 return OK;
8458 #endif
8462 * ":doautoall": execute autocommands for each loaded buffer.
8464 void
8465 ex_doautoall(eap)
8466 exarg_T *eap;
8468 int retval;
8469 aco_save_T aco;
8470 buf_T *buf;
8473 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8474 * equal to curbuf, but for some buffers there may not be a window.
8475 * So we change the buffer for the current window for a moment. This
8476 * gives problems when the autocommands make changes to the list of
8477 * buffers or windows...
8479 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8481 if (buf->b_ml.ml_mfp != NULL)
8483 /* find a window for this buffer and save some values */
8484 aucmd_prepbuf(&aco, buf);
8486 /* execute the autocommands for this buffer */
8487 retval = do_doautocmd(eap->arg, FALSE);
8489 /* Execute the modeline settings, but don't set window-local
8490 * options if we are using the current window for another buffer. */
8491 do_modelines(curwin == aucmd_win ? OPT_NOWIN : 0);
8493 /* restore the current window */
8494 aucmd_restbuf(&aco);
8496 /* stop if there is some error or buffer was deleted */
8497 if (retval == FAIL || !buf_valid(buf))
8498 break;
8502 check_cursor(); /* just in case lines got deleted */
8506 * Prepare for executing autocommands for (hidden) buffer "buf".
8507 * Search for a visible window containing the current buffer. If there isn't
8508 * one then use "aucmd_win".
8509 * Set "curbuf" and "curwin" to match "buf".
8510 * When FEAT_AUTOCMD is not defined another version is used, see below.
8512 void
8513 aucmd_prepbuf(aco, buf)
8514 aco_save_T *aco; /* structure to save values in */
8515 buf_T *buf; /* new curbuf */
8517 win_T *win;
8518 #ifdef FEAT_WINDOWS
8519 int save_ea;
8520 #endif
8522 /* Find a window that is for the new buffer */
8523 if (buf == curbuf) /* be quick when buf is curbuf */
8524 win = curwin;
8525 else
8526 #ifdef FEAT_WINDOWS
8527 for (win = firstwin; win != NULL; win = win->w_next)
8528 if (win->w_buffer == buf)
8529 break;
8530 #else
8531 win = NULL;
8532 #endif
8534 /* Allocate "aucmd_win" when needed. If this fails (out of memory) fall
8535 * back to using the current window. */
8536 if (win == NULL && aucmd_win == NULL)
8538 win_alloc_aucmd_win();
8539 if (aucmd_win == NULL)
8540 win = curwin;
8542 if (win == NULL && aucmd_win_used)
8543 /* Strange recursive autocommand, fall back to using the current
8544 * window. Expect a few side effects... */
8545 win = curwin;
8547 aco->save_curwin = curwin;
8548 aco->save_curbuf = curbuf;
8549 if (win != NULL)
8551 /* There is a window for "buf" in the current tab page, make it the
8552 * curwin. This is preferred, it has the least side effects (esp. if
8553 * "buf" is curbuf). */
8554 aco->use_aucmd_win = FALSE;
8555 curwin = win;
8557 else
8559 /* There is no window for "buf", use "aucmd_win". To minimize the side
8560 * effects, insert it in a the current tab page.
8561 * Anything related to a window (e.g., setting folds) may have
8562 * unexpected results. */
8563 aco->use_aucmd_win = TRUE;
8564 aucmd_win_used = TRUE;
8565 aucmd_win->w_buffer = buf;
8566 ++buf->b_nwindows;
8567 win_init_empty(aucmd_win); /* set cursor and topline to safe values */
8568 vim_free(aucmd_win->w_localdir);
8569 aucmd_win->w_localdir = NULL;
8571 /* Make sure w_localdir and globaldir are NULL to avoid a chdir() in
8572 * win_enter_ext(). */
8573 aucmd_win->w_localdir = NULL;
8574 aco->globaldir = globaldir;
8575 globaldir = NULL;
8578 #ifdef FEAT_WINDOWS
8579 /* Split the current window, put the aucmd_win in the upper half.
8580 * We don't want the BufEnter or WinEnter autocommands. */
8581 block_autocmds();
8582 make_snapshot(SNAP_AUCMD_IDX);
8583 save_ea = p_ea;
8584 p_ea = FALSE;
8585 (void)win_split_ins(0, WSP_TOP, aucmd_win, 0);
8586 (void)win_comp_pos(); /* recompute window positions */
8587 p_ea = save_ea;
8588 unblock_autocmds();
8589 #endif
8590 curwin = aucmd_win;
8592 curbuf = buf;
8593 aco->new_curwin = curwin;
8594 aco->new_curbuf = curbuf;
8598 * Cleanup after executing autocommands for a (hidden) buffer.
8599 * Restore the window as it was (if possible).
8600 * When FEAT_AUTOCMD is not defined another version is used, see below.
8602 void
8603 aucmd_restbuf(aco)
8604 aco_save_T *aco; /* structure holding saved values */
8606 #ifdef FEAT_WINDOWS
8607 int dummy;
8608 #endif
8610 if (aco->use_aucmd_win)
8612 --curbuf->b_nwindows;
8613 #ifdef FEAT_WINDOWS
8614 /* Find "aucmd_win", it can't be closed, but it may be in another tab
8615 * page. Do not trigger autocommands here. */
8616 block_autocmds();
8617 if (curwin != aucmd_win)
8619 tabpage_T *tp;
8620 win_T *wp;
8622 FOR_ALL_TAB_WINDOWS(tp, wp)
8624 if (wp == aucmd_win)
8626 if (tp != curtab)
8627 goto_tabpage_tp(tp);
8628 win_goto(aucmd_win);
8629 break;
8634 /* Remove the window and frame from the tree of frames. */
8635 (void)winframe_remove(curwin, &dummy, NULL);
8636 win_remove(curwin, NULL);
8637 aucmd_win_used = FALSE;
8638 last_status(FALSE); /* may need to remove last status line */
8639 restore_snapshot(SNAP_AUCMD_IDX, FALSE);
8640 (void)win_comp_pos(); /* recompute window positions */
8641 unblock_autocmds();
8643 if (win_valid(aco->save_curwin))
8644 curwin = aco->save_curwin;
8645 else
8646 /* Hmm, original window disappeared. Just use the first one. */
8647 curwin = firstwin;
8648 # ifdef FEAT_EVAL
8649 vars_clear(&aucmd_win->w_vars.dv_hashtab); /* free all w: variables */
8650 hash_init(&aucmd_win->w_vars.dv_hashtab); /* re-use the hashtab */
8651 # endif
8652 #else
8653 curwin = aco->save_curwin;
8654 #endif
8655 curbuf = curwin->w_buffer;
8657 vim_free(globaldir);
8658 globaldir = aco->globaldir;
8660 /* the buffer contents may have changed */
8661 check_cursor();
8662 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
8664 curwin->w_topline = curbuf->b_ml.ml_line_count;
8665 #ifdef FEAT_DIFF
8666 curwin->w_topfill = 0;
8667 #endif
8669 #if defined(FEAT_GUI)
8670 /* Hide the scrollbars from the aucmd_win and update. */
8671 gui_mch_enable_scrollbar(&aucmd_win->w_scrollbars[SBAR_LEFT], FALSE);
8672 gui_mch_enable_scrollbar(&aucmd_win->w_scrollbars[SBAR_RIGHT], FALSE);
8673 gui_may_update_scrollbars();
8674 #endif
8676 else
8678 /* restore curwin */
8679 #ifdef FEAT_WINDOWS
8680 if (win_valid(aco->save_curwin))
8681 #endif
8683 /* Restore the buffer which was previously edited by curwin, if
8684 * it was changed, we are still the same window and the buffer is
8685 * valid. */
8686 if (curwin == aco->new_curwin
8687 && curbuf != aco->new_curbuf
8688 && buf_valid(aco->new_curbuf)
8689 && aco->new_curbuf->b_ml.ml_mfp != NULL)
8691 --curbuf->b_nwindows;
8692 curbuf = aco->new_curbuf;
8693 curwin->w_buffer = curbuf;
8694 ++curbuf->b_nwindows;
8697 curwin = aco->save_curwin;
8698 curbuf = curwin->w_buffer;
8703 static int autocmd_nested = FALSE;
8706 * Execute autocommands for "event" and file name "fname".
8707 * Return TRUE if some commands were executed.
8710 apply_autocmds(event, fname, fname_io, force, buf)
8711 event_T event;
8712 char_u *fname; /* NULL or empty means use actual file name */
8713 char_u *fname_io; /* fname to use for <afile> on cmdline */
8714 int force; /* when TRUE, ignore autocmd_busy */
8715 buf_T *buf; /* buffer for <abuf> */
8717 return apply_autocmds_group(event, fname, fname_io, force,
8718 AUGROUP_ALL, buf, NULL);
8722 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8723 * setting v:filearg.
8725 static int
8726 apply_autocmds_exarg(event, fname, fname_io, force, buf, eap)
8727 event_T event;
8728 char_u *fname;
8729 char_u *fname_io;
8730 int force;
8731 buf_T *buf;
8732 exarg_T *eap;
8734 return apply_autocmds_group(event, fname, fname_io, force,
8735 AUGROUP_ALL, buf, eap);
8739 * Like apply_autocmds(), but handles the caller's retval. If the script
8740 * processing is being aborted or if retval is FAIL when inside a try
8741 * conditional, no autocommands are executed. If otherwise the autocommands
8742 * cause the script to be aborted, retval is set to FAIL.
8745 apply_autocmds_retval(event, fname, fname_io, force, buf, retval)
8746 event_T event;
8747 char_u *fname; /* NULL or empty means use actual file name */
8748 char_u *fname_io; /* fname to use for <afile> on cmdline */
8749 int force; /* when TRUE, ignore autocmd_busy */
8750 buf_T *buf; /* buffer for <abuf> */
8751 int *retval; /* pointer to caller's retval */
8753 int did_cmd;
8755 #ifdef FEAT_EVAL
8756 if (should_abort(*retval))
8757 return FALSE;
8758 #endif
8760 did_cmd = apply_autocmds_group(event, fname, fname_io, force,
8761 AUGROUP_ALL, buf, NULL);
8762 if (did_cmd
8763 #ifdef FEAT_EVAL
8764 && aborting()
8765 #endif
8767 *retval = FAIL;
8768 return did_cmd;
8772 * Return TRUE when there is a CursorHold autocommand defined.
8775 has_cursorhold()
8777 return (first_autopat[(int)(get_real_state() == NORMAL_BUSY
8778 ? EVENT_CURSORHOLD : EVENT_CURSORHOLDI)] != NULL);
8782 * Return TRUE if the CursorHold event can be triggered.
8785 trigger_cursorhold()
8787 int state;
8789 if (!did_cursorhold && has_cursorhold() && !Recording
8790 #ifdef FEAT_INS_EXPAND
8791 && !ins_compl_active()
8792 #endif
8795 state = get_real_state();
8796 if (state == NORMAL_BUSY || (state & INSERT) != 0)
8797 return TRUE;
8799 return FALSE;
8803 * Return TRUE when there is a CursorMoved autocommand defined.
8806 has_cursormoved()
8808 return (first_autopat[(int)EVENT_CURSORMOVED] != NULL);
8812 * Return TRUE when there is a CursorMovedI autocommand defined.
8815 has_cursormovedI()
8817 return (first_autopat[(int)EVENT_CURSORMOVEDI] != NULL);
8820 static int
8821 apply_autocmds_group(event, fname, fname_io, force, group, buf, eap)
8822 event_T event;
8823 char_u *fname; /* NULL or empty means use actual file name */
8824 char_u *fname_io; /* fname to use for <afile> on cmdline, NULL means
8825 use fname */
8826 int force; /* when TRUE, ignore autocmd_busy */
8827 int group; /* group ID, or AUGROUP_ALL */
8828 buf_T *buf; /* buffer for <abuf> */
8829 exarg_T *eap; /* command arguments */
8831 char_u *sfname = NULL; /* short file name */
8832 char_u *tail;
8833 int save_changed;
8834 buf_T *old_curbuf;
8835 int retval = FALSE;
8836 char_u *save_sourcing_name;
8837 linenr_T save_sourcing_lnum;
8838 char_u *save_autocmd_fname;
8839 int save_autocmd_fname_full;
8840 int save_autocmd_bufnr;
8841 char_u *save_autocmd_match;
8842 int save_autocmd_busy;
8843 int save_autocmd_nested;
8844 static int nesting = 0;
8845 AutoPatCmd patcmd;
8846 AutoPat *ap;
8847 #ifdef FEAT_EVAL
8848 scid_T save_current_SID;
8849 void *save_funccalp;
8850 char_u *save_cmdarg;
8851 long save_cmdbang;
8852 #endif
8853 static int filechangeshell_busy = FALSE;
8854 #ifdef FEAT_PROFILE
8855 proftime_T wait_time;
8856 #endif
8859 * Quickly return if there are no autocommands for this event or
8860 * autocommands are blocked.
8862 if (first_autopat[(int)event] == NULL || autocmd_blocked > 0)
8863 goto BYPASS_AU;
8866 * When autocommands are busy, new autocommands are only executed when
8867 * explicitly enabled with the "nested" flag.
8869 if (autocmd_busy && !(force || autocmd_nested))
8870 goto BYPASS_AU;
8872 #ifdef FEAT_EVAL
8874 * Quickly return when immediately aborting on error, or when an interrupt
8875 * occurred or an exception was thrown but not caught.
8877 if (aborting())
8878 goto BYPASS_AU;
8879 #endif
8882 * FileChangedShell never nests, because it can create an endless loop.
8884 if (filechangeshell_busy && (event == EVENT_FILECHANGEDSHELL
8885 || event == EVENT_FILECHANGEDSHELLPOST))
8886 goto BYPASS_AU;
8889 * Ignore events in 'eventignore'.
8891 if (event_ignored(event))
8892 goto BYPASS_AU;
8895 * Allow nesting of autocommands, but restrict the depth, because it's
8896 * possible to create an endless loop.
8898 if (nesting == 10)
8900 EMSG(_("E218: autocommand nesting too deep"));
8901 goto BYPASS_AU;
8905 * Check if these autocommands are disabled. Used when doing ":all" or
8906 * ":ball".
8908 if ( (autocmd_no_enter
8909 && (event == EVENT_WINENTER || event == EVENT_BUFENTER))
8910 || (autocmd_no_leave
8911 && (event == EVENT_WINLEAVE || event == EVENT_BUFLEAVE)))
8912 goto BYPASS_AU;
8915 * Save the autocmd_* variables and info about the current buffer.
8917 save_autocmd_fname = autocmd_fname;
8918 save_autocmd_fname_full = autocmd_fname_full;
8919 save_autocmd_bufnr = autocmd_bufnr;
8920 save_autocmd_match = autocmd_match;
8921 save_autocmd_busy = autocmd_busy;
8922 save_autocmd_nested = autocmd_nested;
8923 save_changed = curbuf->b_changed;
8924 old_curbuf = curbuf;
8927 * Set the file name to be used for <afile>.
8928 * Make a copy to avoid that changing a buffer name or directory makes it
8929 * invalid.
8931 if (fname_io == NULL)
8933 if (fname != NULL && *fname != NUL)
8934 autocmd_fname = fname;
8935 else if (buf != NULL)
8936 autocmd_fname = buf->b_ffname;
8937 else
8938 autocmd_fname = NULL;
8940 else
8941 autocmd_fname = fname_io;
8942 if (autocmd_fname != NULL)
8943 autocmd_fname = vim_strsave(autocmd_fname);
8944 autocmd_fname_full = FALSE; /* call FullName_save() later */
8947 * Set the buffer number to be used for <abuf>.
8949 if (buf == NULL)
8950 autocmd_bufnr = 0;
8951 else
8952 autocmd_bufnr = buf->b_fnum;
8955 * When the file name is NULL or empty, use the file name of buffer "buf".
8956 * Always use the full path of the file name to match with, in case
8957 * "allow_dirs" is set.
8959 if (fname == NULL || *fname == NUL)
8961 if (buf == NULL)
8962 fname = NULL;
8963 else
8965 #ifdef FEAT_SYN_HL
8966 if (event == EVENT_SYNTAX)
8967 fname = buf->b_p_syn;
8968 else
8969 #endif
8970 if (event == EVENT_FILETYPE)
8971 fname = buf->b_p_ft;
8972 else
8974 if (buf->b_sfname != NULL)
8975 sfname = vim_strsave(buf->b_sfname);
8976 fname = buf->b_ffname;
8979 if (fname == NULL)
8980 fname = (char_u *)"";
8981 fname = vim_strsave(fname); /* make a copy, so we can change it */
8983 else
8985 sfname = vim_strsave(fname);
8986 /* Don't try expanding FileType, Syntax, FuncUndefined, WindowID or
8987 * QuickFixCmd* */
8988 if (event == EVENT_FILETYPE
8989 || event == EVENT_SYNTAX
8990 || event == EVENT_FUNCUNDEFINED
8991 || event == EVENT_REMOTEREPLY
8992 || event == EVENT_SPELLFILEMISSING
8993 || event == EVENT_QUICKFIXCMDPRE
8994 || event == EVENT_QUICKFIXCMDPOST)
8995 fname = vim_strsave(fname);
8996 else
8997 fname = FullName_save(fname, FALSE);
8999 if (fname == NULL) /* out of memory */
9001 vim_free(sfname);
9002 retval = FALSE;
9003 goto BYPASS_AU;
9006 #ifdef BACKSLASH_IN_FILENAME
9008 * Replace all backslashes with forward slashes. This makes the
9009 * autocommand patterns portable between Unix and MS-DOS.
9011 if (sfname != NULL)
9012 forward_slash(sfname);
9013 forward_slash(fname);
9014 #endif
9016 #ifdef VMS
9017 /* remove version for correct match */
9018 if (sfname != NULL)
9019 vms_remove_version(sfname);
9020 vms_remove_version(fname);
9021 #endif
9024 * Set the name to be used for <amatch>.
9026 autocmd_match = fname;
9029 /* Don't redraw while doing auto commands. */
9030 ++RedrawingDisabled;
9031 save_sourcing_name = sourcing_name;
9032 sourcing_name = NULL; /* don't free this one */
9033 save_sourcing_lnum = sourcing_lnum;
9034 sourcing_lnum = 0; /* no line number here */
9036 #ifdef FEAT_EVAL
9037 save_current_SID = current_SID;
9039 # ifdef FEAT_PROFILE
9040 if (do_profiling == PROF_YES)
9041 prof_child_enter(&wait_time); /* doesn't count for the caller itself */
9042 # endif
9044 /* Don't use local function variables, if called from a function */
9045 save_funccalp = save_funccal();
9046 #endif
9049 * When starting to execute autocommands, save the search patterns.
9051 if (!autocmd_busy)
9053 save_search_patterns();
9054 saveRedobuff();
9055 did_filetype = keep_filetype;
9059 * Note that we are applying autocmds. Some commands need to know.
9061 autocmd_busy = TRUE;
9062 filechangeshell_busy = (event == EVENT_FILECHANGEDSHELL);
9063 ++nesting; /* see matching decrement below */
9065 /* Remember that FileType was triggered. Used for did_filetype(). */
9066 if (event == EVENT_FILETYPE)
9067 did_filetype = TRUE;
9069 tail = gettail(fname);
9071 /* Find first autocommand that matches */
9072 patcmd.curpat = first_autopat[(int)event];
9073 patcmd.nextcmd = NULL;
9074 patcmd.group = group;
9075 patcmd.fname = fname;
9076 patcmd.sfname = sfname;
9077 patcmd.tail = tail;
9078 patcmd.event = event;
9079 patcmd.arg_bufnr = autocmd_bufnr;
9080 patcmd.next = NULL;
9081 auto_next_pat(&patcmd, FALSE);
9083 /* found one, start executing the autocommands */
9084 if (patcmd.curpat != NULL)
9086 /* add to active_apc_list */
9087 patcmd.next = active_apc_list;
9088 active_apc_list = &patcmd;
9090 #ifdef FEAT_EVAL
9091 /* set v:cmdarg (only when there is a matching pattern) */
9092 save_cmdbang = get_vim_var_nr(VV_CMDBANG);
9093 if (eap != NULL)
9095 save_cmdarg = set_cmdarg(eap, NULL);
9096 set_vim_var_nr(VV_CMDBANG, (long)eap->forceit);
9098 else
9099 save_cmdarg = NULL; /* avoid gcc warning */
9100 #endif
9101 retval = TRUE;
9102 /* mark the last pattern, to avoid an endless loop when more patterns
9103 * are added when executing autocommands */
9104 for (ap = patcmd.curpat; ap->next != NULL; ap = ap->next)
9105 ap->last = FALSE;
9106 ap->last = TRUE;
9107 check_lnums(TRUE); /* make sure cursor and topline are valid */
9108 do_cmdline(NULL, getnextac, (void *)&patcmd,
9109 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
9110 #ifdef FEAT_EVAL
9111 if (eap != NULL)
9113 (void)set_cmdarg(NULL, save_cmdarg);
9114 set_vim_var_nr(VV_CMDBANG, save_cmdbang);
9116 #endif
9117 /* delete from active_apc_list */
9118 if (active_apc_list == &patcmd) /* just in case */
9119 active_apc_list = patcmd.next;
9122 --RedrawingDisabled;
9123 autocmd_busy = save_autocmd_busy;
9124 filechangeshell_busy = FALSE;
9125 autocmd_nested = save_autocmd_nested;
9126 vim_free(sourcing_name);
9127 sourcing_name = save_sourcing_name;
9128 sourcing_lnum = save_sourcing_lnum;
9129 vim_free(autocmd_fname);
9130 autocmd_fname = save_autocmd_fname;
9131 autocmd_fname_full = save_autocmd_fname_full;
9132 autocmd_bufnr = save_autocmd_bufnr;
9133 autocmd_match = save_autocmd_match;
9134 #ifdef FEAT_EVAL
9135 current_SID = save_current_SID;
9136 restore_funccal(save_funccalp);
9137 # ifdef FEAT_PROFILE
9138 if (do_profiling == PROF_YES)
9139 prof_child_exit(&wait_time);
9140 # endif
9141 #endif
9142 vim_free(fname);
9143 vim_free(sfname);
9144 --nesting; /* see matching increment above */
9147 * When stopping to execute autocommands, restore the search patterns and
9148 * the redo buffer.
9150 if (!autocmd_busy)
9152 restore_search_patterns();
9153 restoreRedobuff();
9154 did_filetype = FALSE;
9158 * Some events don't set or reset the Changed flag.
9159 * Check if still in the same buffer!
9161 if (curbuf == old_curbuf
9162 && (event == EVENT_BUFREADPOST
9163 || event == EVENT_BUFWRITEPOST
9164 || event == EVENT_FILEAPPENDPOST
9165 || event == EVENT_VIMLEAVE
9166 || event == EVENT_VIMLEAVEPRE))
9168 #ifdef FEAT_TITLE
9169 if (curbuf->b_changed != save_changed)
9170 need_maketitle = TRUE;
9171 #endif
9172 curbuf->b_changed = save_changed;
9175 au_cleanup(); /* may really delete removed patterns/commands now */
9177 BYPASS_AU:
9178 /* When wiping out a buffer make sure all its buffer-local autocommands
9179 * are deleted. */
9180 if (event == EVENT_BUFWIPEOUT && buf != NULL)
9181 aubuflocal_remove(buf);
9183 return retval;
9186 # ifdef FEAT_EVAL
9187 static char_u *old_termresponse = NULL;
9188 # endif
9191 * Block triggering autocommands until unblock_autocmd() is called.
9192 * Can be used recursively, so long as it's symmetric.
9194 void
9195 block_autocmds()
9197 # ifdef FEAT_EVAL
9198 /* Remember the value of v:termresponse. */
9199 if (autocmd_blocked == 0)
9200 old_termresponse = get_vim_var_str(VV_TERMRESPONSE);
9201 # endif
9202 ++autocmd_blocked;
9205 void
9206 unblock_autocmds()
9208 --autocmd_blocked;
9210 # ifdef FEAT_EVAL
9211 /* When v:termresponse was set while autocommands were blocked, trigger
9212 * the autocommands now. Esp. useful when executing a shell command
9213 * during startup (vimdiff). */
9214 if (autocmd_blocked == 0
9215 && get_vim_var_str(VV_TERMRESPONSE) != old_termresponse)
9216 apply_autocmds(EVENT_TERMRESPONSE, NULL, NULL, FALSE, curbuf);
9217 # endif
9221 * Find next autocommand pattern that matches.
9223 static void
9224 auto_next_pat(apc, stop_at_last)
9225 AutoPatCmd *apc;
9226 int stop_at_last; /* stop when 'last' flag is set */
9228 AutoPat *ap;
9229 AutoCmd *cp;
9230 char_u *name;
9231 char *s;
9233 vim_free(sourcing_name);
9234 sourcing_name = NULL;
9236 for (ap = apc->curpat; ap != NULL && !got_int; ap = ap->next)
9238 apc->curpat = NULL;
9240 /* Only use a pattern when it has not been removed, has commands and
9241 * the group matches. For buffer-local autocommands only check the
9242 * buffer number. */
9243 if (ap->pat != NULL && ap->cmds != NULL
9244 && (apc->group == AUGROUP_ALL || apc->group == ap->group))
9246 /* execution-condition */
9247 if (ap->buflocal_nr == 0
9248 ? (match_file_pat(NULL, ap->reg_prog, apc->fname,
9249 apc->sfname, apc->tail, ap->allow_dirs))
9250 : ap->buflocal_nr == apc->arg_bufnr)
9252 name = event_nr2name(apc->event);
9253 s = _("%s Auto commands for \"%s\"");
9254 sourcing_name = alloc((unsigned)(STRLEN(s)
9255 + STRLEN(name) + ap->patlen + 1));
9256 if (sourcing_name != NULL)
9258 sprintf((char *)sourcing_name, s,
9259 (char *)name, (char *)ap->pat);
9260 if (p_verbose >= 8)
9262 verbose_enter();
9263 smsg((char_u *)_("Executing %s"), sourcing_name);
9264 verbose_leave();
9268 apc->curpat = ap;
9269 apc->nextcmd = ap->cmds;
9270 /* mark last command */
9271 for (cp = ap->cmds; cp->next != NULL; cp = cp->next)
9272 cp->last = FALSE;
9273 cp->last = TRUE;
9275 line_breakcheck();
9276 if (apc->curpat != NULL) /* found a match */
9277 break;
9279 if (stop_at_last && ap->last)
9280 break;
9285 * Get next autocommand command.
9286 * Called by do_cmdline() to get the next line for ":if".
9287 * Returns allocated string, or NULL for end of autocommands.
9289 static char_u *
9290 getnextac(c, cookie, indent)
9291 int c UNUSED;
9292 void *cookie;
9293 int indent UNUSED;
9295 AutoPatCmd *acp = (AutoPatCmd *)cookie;
9296 char_u *retval;
9297 AutoCmd *ac;
9299 /* Can be called again after returning the last line. */
9300 if (acp->curpat == NULL)
9301 return NULL;
9303 /* repeat until we find an autocommand to execute */
9304 for (;;)
9306 /* skip removed commands */
9307 while (acp->nextcmd != NULL && acp->nextcmd->cmd == NULL)
9308 if (acp->nextcmd->last)
9309 acp->nextcmd = NULL;
9310 else
9311 acp->nextcmd = acp->nextcmd->next;
9313 if (acp->nextcmd != NULL)
9314 break;
9316 /* at end of commands, find next pattern that matches */
9317 if (acp->curpat->last)
9318 acp->curpat = NULL;
9319 else
9320 acp->curpat = acp->curpat->next;
9321 if (acp->curpat != NULL)
9322 auto_next_pat(acp, TRUE);
9323 if (acp->curpat == NULL)
9324 return NULL;
9327 ac = acp->nextcmd;
9329 if (p_verbose >= 9)
9331 verbose_enter_scroll();
9332 smsg((char_u *)_("autocommand %s"), ac->cmd);
9333 msg_puts((char_u *)"\n"); /* don't overwrite this either */
9334 verbose_leave_scroll();
9336 retval = vim_strsave(ac->cmd);
9337 autocmd_nested = ac->nested;
9338 #ifdef FEAT_EVAL
9339 current_SID = ac->scriptID;
9340 #endif
9341 if (ac->last)
9342 acp->nextcmd = NULL;
9343 else
9344 acp->nextcmd = ac->next;
9345 return retval;
9349 * Return TRUE if there is a matching autocommand for "fname".
9350 * To account for buffer-local autocommands, function needs to know
9351 * in which buffer the file will be opened.
9354 has_autocmd(event, sfname, buf)
9355 event_T event;
9356 char_u *sfname;
9357 buf_T *buf;
9359 AutoPat *ap;
9360 char_u *fname;
9361 char_u *tail = gettail(sfname);
9362 int retval = FALSE;
9364 fname = FullName_save(sfname, FALSE);
9365 if (fname == NULL)
9366 return FALSE;
9368 #ifdef BACKSLASH_IN_FILENAME
9370 * Replace all backslashes with forward slashes. This makes the
9371 * autocommand patterns portable between Unix and MS-DOS.
9373 sfname = vim_strsave(sfname);
9374 if (sfname != NULL)
9375 forward_slash(sfname);
9376 forward_slash(fname);
9377 #endif
9379 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
9380 if (ap->pat != NULL && ap->cmds != NULL
9381 && (ap->buflocal_nr == 0
9382 ? match_file_pat(NULL, ap->reg_prog,
9383 fname, sfname, tail, ap->allow_dirs)
9384 : buf != NULL && ap->buflocal_nr == buf->b_fnum
9387 retval = TRUE;
9388 break;
9391 vim_free(fname);
9392 #ifdef BACKSLASH_IN_FILENAME
9393 vim_free(sfname);
9394 #endif
9396 return retval;
9399 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
9401 * Function given to ExpandGeneric() to obtain the list of autocommand group
9402 * names.
9404 char_u *
9405 get_augroup_name(xp, idx)
9406 expand_T *xp UNUSED;
9407 int idx;
9409 if (idx == augroups.ga_len) /* add "END" add the end */
9410 return (char_u *)"END";
9411 if (idx >= augroups.ga_len) /* end of list */
9412 return NULL;
9413 if (AUGROUP_NAME(idx) == NULL) /* skip deleted entries */
9414 return (char_u *)"";
9415 return AUGROUP_NAME(idx); /* return a name */
9418 static int include_groups = FALSE;
9420 char_u *
9421 set_context_in_autocmd(xp, arg, doautocmd)
9422 expand_T *xp;
9423 char_u *arg;
9424 int doautocmd; /* TRUE for :doauto*, FALSE for :autocmd */
9426 char_u *p;
9427 int group;
9429 /* check for a group name, skip it if present */
9430 include_groups = FALSE;
9431 p = arg;
9432 group = au_get_grouparg(&arg);
9433 if (group == AUGROUP_ERROR)
9434 return NULL;
9435 /* If there only is a group name that's what we expand. */
9436 if (*arg == NUL && group != AUGROUP_ALL && !vim_iswhite(arg[-1]))
9438 arg = p;
9439 group = AUGROUP_ALL;
9442 /* skip over event name */
9443 for (p = arg; *p != NUL && !vim_iswhite(*p); ++p)
9444 if (*p == ',')
9445 arg = p + 1;
9446 if (*p == NUL)
9448 if (group == AUGROUP_ALL)
9449 include_groups = TRUE;
9450 xp->xp_context = EXPAND_EVENTS; /* expand event name */
9451 xp->xp_pattern = arg;
9452 return NULL;
9455 /* skip over pattern */
9456 arg = skipwhite(p);
9457 while (*arg && (!vim_iswhite(*arg) || arg[-1] == '\\'))
9458 arg++;
9459 if (*arg)
9460 return arg; /* expand (next) command */
9462 if (doautocmd)
9463 xp->xp_context = EXPAND_FILES; /* expand file names */
9464 else
9465 xp->xp_context = EXPAND_NOTHING; /* pattern is not expanded */
9466 return NULL;
9470 * Function given to ExpandGeneric() to obtain the list of event names.
9472 char_u *
9473 get_event_name(xp, idx)
9474 expand_T *xp UNUSED;
9475 int idx;
9477 if (idx < augroups.ga_len) /* First list group names, if wanted */
9479 if (!include_groups || AUGROUP_NAME(idx) == NULL)
9480 return (char_u *)""; /* skip deleted entries */
9481 return AUGROUP_NAME(idx); /* return a name */
9483 return (char_u *)event_names[idx - augroups.ga_len].name;
9486 #endif /* FEAT_CMDL_COMPL */
9489 * Return TRUE if autocmd is supported.
9492 autocmd_supported(name)
9493 char_u *name;
9495 char_u *p;
9497 return (event_name2nr(name, &p) != NUM_EVENTS);
9501 * Return TRUE if an autocommand is defined for a group, event and
9502 * pattern: The group can be omitted to accept any group. "event" and "pattern"
9503 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
9504 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
9505 * Used for:
9506 * exists("#Group") or
9507 * exists("#Group#Event") or
9508 * exists("#Group#Event#pat") or
9509 * exists("#Event") or
9510 * exists("#Event#pat")
9513 au_exists(arg)
9514 char_u *arg;
9516 char_u *arg_save;
9517 char_u *pattern = NULL;
9518 char_u *event_name;
9519 char_u *p;
9520 event_T event;
9521 AutoPat *ap;
9522 buf_T *buflocal_buf = NULL;
9523 int group;
9524 int retval = FALSE;
9526 /* Make a copy so that we can change the '#' chars to a NUL. */
9527 arg_save = vim_strsave(arg);
9528 if (arg_save == NULL)
9529 return FALSE;
9530 p = vim_strchr(arg_save, '#');
9531 if (p != NULL)
9532 *p++ = NUL;
9534 /* First, look for an autocmd group name */
9535 group = au_find_group(arg_save);
9536 if (group == AUGROUP_ERROR)
9538 /* Didn't match a group name, assume the first argument is an event. */
9539 group = AUGROUP_ALL;
9540 event_name = arg_save;
9542 else
9544 if (p == NULL)
9546 /* "Group": group name is present and it's recognized */
9547 retval = TRUE;
9548 goto theend;
9551 /* Must be "Group#Event" or "Group#Event#pat". */
9552 event_name = p;
9553 p = vim_strchr(event_name, '#');
9554 if (p != NULL)
9555 *p++ = NUL; /* "Group#Event#pat" */
9558 pattern = p; /* "pattern" is NULL when there is no pattern */
9560 /* find the index (enum) for the event name */
9561 event = event_name2nr(event_name, &p);
9563 /* return FALSE if the event name is not recognized */
9564 if (event == NUM_EVENTS)
9565 goto theend;
9567 /* Find the first autocommand for this event.
9568 * If there isn't any, return FALSE;
9569 * If there is one and no pattern given, return TRUE; */
9570 ap = first_autopat[(int)event];
9571 if (ap == NULL)
9572 goto theend;
9574 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9575 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9576 if (pattern != NULL && STRICMP(pattern, "<buffer>") == 0)
9577 buflocal_buf = curbuf;
9579 /* Check if there is an autocommand with the given pattern. */
9580 for ( ; ap != NULL; ap = ap->next)
9581 /* only use a pattern when it has not been removed and has commands. */
9582 /* For buffer-local autocommands, fnamecmp() works fine. */
9583 if (ap->pat != NULL && ap->cmds != NULL
9584 && (group == AUGROUP_ALL || ap->group == group)
9585 && (pattern == NULL
9586 || (buflocal_buf == NULL
9587 ? fnamecmp(ap->pat, pattern) == 0
9588 : ap->buflocal_nr == buflocal_buf->b_fnum)))
9590 retval = TRUE;
9591 break;
9594 theend:
9595 vim_free(arg_save);
9596 return retval;
9599 #else /* FEAT_AUTOCMD */
9602 * Prepare for executing commands for (hidden) buffer "buf".
9603 * This is the non-autocommand version, it simply saves "curbuf" and sets
9604 * "curbuf" and "curwin" to match "buf".
9606 void
9607 aucmd_prepbuf(aco, buf)
9608 aco_save_T *aco; /* structure to save values in */
9609 buf_T *buf; /* new curbuf */
9611 aco->save_curbuf = curbuf;
9612 --curbuf->b_nwindows;
9613 curbuf = buf;
9614 curwin->w_buffer = buf;
9615 ++curbuf->b_nwindows;
9619 * Restore after executing commands for a (hidden) buffer.
9620 * This is the non-autocommand version.
9622 void
9623 aucmd_restbuf(aco)
9624 aco_save_T *aco; /* structure holding saved values */
9626 --curbuf->b_nwindows;
9627 curbuf = aco->save_curbuf;
9628 curwin->w_buffer = curbuf;
9629 ++curbuf->b_nwindows;
9632 #endif /* FEAT_AUTOCMD */
9635 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9637 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9638 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9639 * vim_regcomp() often.
9640 * Used for autocommands and 'wildignore'.
9641 * Returns TRUE if there is a match, FALSE otherwise.
9644 match_file_pat(pattern, prog, fname, sfname, tail, allow_dirs)
9645 char_u *pattern; /* pattern to match with */
9646 regprog_T *prog; /* pre-compiled regprog or NULL */
9647 char_u *fname; /* full path of file name */
9648 char_u *sfname; /* short file name or NULL */
9649 char_u *tail; /* tail of path */
9650 int allow_dirs; /* allow matching with dir */
9652 regmatch_T regmatch;
9653 int result = FALSE;
9654 #ifdef FEAT_OSFILETYPE
9655 int no_pattern = FALSE; /* TRUE if check is filetype only */
9656 char_u *type_start;
9657 char_u c;
9658 int match = FALSE;
9659 #endif
9661 #ifdef CASE_INSENSITIVE_FILENAME
9662 regmatch.rm_ic = TRUE; /* Always ignore case */
9663 #else
9664 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
9665 #endif
9666 #ifdef FEAT_OSFILETYPE
9667 if (*pattern == '<')
9669 /* There is a filetype condition specified with this pattern.
9670 * Check the filetype matches first. If not, don't bother with the
9671 * pattern (set regprog to NULL).
9672 * Always use magic for the regexp.
9675 for (type_start = pattern + 1; (c = *pattern); pattern++)
9677 if ((c == ';' || c == '>') && match == FALSE)
9679 *pattern = NUL; /* Terminate the string */
9680 match = mch_check_filetype(fname, type_start);
9681 *pattern = c; /* Restore the terminator */
9682 type_start = pattern + 1;
9684 if (c == '>')
9685 break;
9688 /* (c should never be NUL, but check anyway) */
9689 if (match == FALSE || c == NUL)
9690 regmatch.regprog = NULL; /* Doesn't match - don't check pat. */
9691 else if (*pattern == NUL)
9693 regmatch.regprog = NULL; /* Vim will try to free regprog later */
9694 no_pattern = TRUE; /* Always matches - don't check pat. */
9696 else
9697 regmatch.regprog = vim_regcomp(pattern + 1, RE_MAGIC);
9699 else
9700 #endif
9702 if (prog != NULL)
9703 regmatch.regprog = prog;
9704 else
9705 regmatch.regprog = vim_regcomp(pattern, RE_MAGIC);
9709 * Try for a match with the pattern with:
9710 * 1. the full file name, when the pattern has a '/'.
9711 * 2. the short file name, when the pattern has a '/'.
9712 * 3. the tail of the file name, when the pattern has no '/'.
9714 if (
9715 #ifdef FEAT_OSFILETYPE
9716 /* If the check is for a filetype only and we don't care
9717 * about the path then skip all the regexp stuff.
9719 no_pattern ||
9720 #endif
9721 (regmatch.regprog != NULL
9722 && ((allow_dirs
9723 && (vim_regexec(&regmatch, fname, (colnr_T)0)
9724 || (sfname != NULL
9725 && vim_regexec(&regmatch, sfname, (colnr_T)0))))
9726 || (!allow_dirs && vim_regexec(&regmatch, tail, (colnr_T)0)))))
9727 result = TRUE;
9729 if (prog == NULL)
9730 vim_free(regmatch.regprog);
9731 return result;
9733 #endif
9735 #if defined(FEAT_WILDIGN) || defined(PROTO)
9737 * Return TRUE if a file matches with a pattern in "list".
9738 * "list" is a comma-separated list of patterns, like 'wildignore'.
9739 * "sfname" is the short file name or NULL, "ffname" the long file name.
9742 match_file_list(list, sfname, ffname)
9743 char_u *list;
9744 char_u *sfname;
9745 char_u *ffname;
9747 char_u buf[100];
9748 char_u *tail;
9749 char_u *regpat;
9750 char allow_dirs;
9751 int match;
9752 char_u *p;
9754 tail = gettail(sfname);
9756 /* try all patterns in 'wildignore' */
9757 p = list;
9758 while (*p)
9760 copy_option_part(&p, buf, 100, ",");
9761 regpat = file_pat_to_reg_pat(buf, NULL, &allow_dirs, FALSE);
9762 if (regpat == NULL)
9763 break;
9764 match = match_file_pat(regpat, NULL, ffname, sfname,
9765 tail, (int)allow_dirs);
9766 vim_free(regpat);
9767 if (match)
9768 return TRUE;
9770 return FALSE;
9772 #endif
9775 * Convert the given pattern "pat" which has shell style wildcards in it, into
9776 * a regular expression, and return the result in allocated memory. If there
9777 * is a directory path separator to be matched, then TRUE is put in
9778 * allow_dirs, otherwise FALSE is put there -- webb.
9779 * Handle backslashes before special characters, like "\*" and "\ ".
9781 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9782 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9784 * Returns NULL when out of memory.
9786 char_u *
9787 file_pat_to_reg_pat(pat, pat_end, allow_dirs, no_bslash)
9788 char_u *pat;
9789 char_u *pat_end; /* first char after pattern or NULL */
9790 char *allow_dirs; /* Result passed back out in here */
9791 int no_bslash UNUSED; /* Don't use a backward slash as pathsep */
9793 int size;
9794 char_u *endp;
9795 char_u *reg_pat;
9796 char_u *p;
9797 int i;
9798 int nested = 0;
9799 int add_dollar = TRUE;
9800 #ifdef FEAT_OSFILETYPE
9801 int check_length = 0;
9802 #endif
9804 if (allow_dirs != NULL)
9805 *allow_dirs = FALSE;
9806 if (pat_end == NULL)
9807 pat_end = pat + STRLEN(pat);
9809 #ifdef FEAT_OSFILETYPE
9810 /* Find out how much of the string is the filetype check */
9811 if (*pat == '<')
9813 /* Count chars until the next '>' */
9814 for (p = pat + 1; p < pat_end && *p != '>'; p++)
9816 if (p < pat_end)
9818 /* Pattern is of the form <.*>.* */
9819 check_length = p - pat + 1;
9820 if (p + 1 >= pat_end)
9822 /* The 'pattern' is a filetype check ONLY */
9823 reg_pat = (char_u *)alloc(check_length + 1);
9824 if (reg_pat != NULL)
9826 mch_memmove(reg_pat, pat, (size_t)check_length);
9827 reg_pat[check_length] = NUL;
9829 return reg_pat;
9832 /* else: there was no closing '>' - assume it was a normal pattern */
9835 pat += check_length;
9836 size = 2 + check_length;
9837 #else
9838 size = 2; /* '^' at start, '$' at end */
9839 #endif
9841 for (p = pat; p < pat_end; p++)
9843 switch (*p)
9845 case '*':
9846 case '.':
9847 case ',':
9848 case '{':
9849 case '}':
9850 case '~':
9851 size += 2; /* extra backslash */
9852 break;
9853 #ifdef BACKSLASH_IN_FILENAME
9854 case '\\':
9855 case '/':
9856 size += 4; /* could become "[\/]" */
9857 break;
9858 #endif
9859 default:
9860 size++;
9861 # ifdef FEAT_MBYTE
9862 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9864 ++p;
9865 ++size;
9867 # endif
9868 break;
9871 reg_pat = alloc(size + 1);
9872 if (reg_pat == NULL)
9873 return NULL;
9875 #ifdef FEAT_OSFILETYPE
9876 /* Copy the type check in to the start. */
9877 if (check_length)
9878 mch_memmove(reg_pat, pat - check_length, (size_t)check_length);
9879 i = check_length;
9880 #else
9881 i = 0;
9882 #endif
9884 if (pat[0] == '*')
9885 while (pat[0] == '*' && pat < pat_end - 1)
9886 pat++;
9887 else
9888 reg_pat[i++] = '^';
9889 endp = pat_end - 1;
9890 if (*endp == '*')
9892 while (endp - pat > 0 && *endp == '*')
9893 endp--;
9894 add_dollar = FALSE;
9896 for (p = pat; *p && nested >= 0 && p <= endp; p++)
9898 switch (*p)
9900 case '*':
9901 reg_pat[i++] = '.';
9902 reg_pat[i++] = '*';
9903 while (p[1] == '*') /* "**" matches like "*" */
9904 ++p;
9905 break;
9906 case '.':
9907 #ifdef RISCOS
9908 if (allow_dirs != NULL)
9909 *allow_dirs = TRUE;
9910 /* FALLTHROUGH */
9911 #endif
9912 case '~':
9913 reg_pat[i++] = '\\';
9914 reg_pat[i++] = *p;
9915 break;
9916 case '?':
9917 #ifdef RISCOS
9918 case '#':
9919 #endif
9920 reg_pat[i++] = '.';
9921 break;
9922 case '\\':
9923 if (p[1] == NUL)
9924 break;
9925 #ifdef BACKSLASH_IN_FILENAME
9926 if (!no_bslash)
9928 /* translate:
9929 * "\x" to "\\x" e.g., "dir\file"
9930 * "\*" to "\\.*" e.g., "dir\*.c"
9931 * "\?" to "\\." e.g., "dir\??.c"
9932 * "\+" to "\+" e.g., "fileX\+.c"
9934 if ((vim_isfilec(p[1]) || p[1] == '*' || p[1] == '?')
9935 && p[1] != '+')
9937 reg_pat[i++] = '[';
9938 reg_pat[i++] = '\\';
9939 reg_pat[i++] = '/';
9940 reg_pat[i++] = ']';
9941 if (allow_dirs != NULL)
9942 *allow_dirs = TRUE;
9943 break;
9946 #endif
9947 if (*++p == '?'
9948 #ifdef BACKSLASH_IN_FILENAME
9949 && no_bslash
9950 #endif
9952 reg_pat[i++] = '?';
9953 else
9954 if (*p == ',')
9955 reg_pat[i++] = ',';
9956 else
9958 if (allow_dirs != NULL && vim_ispathsep(*p)
9959 #ifdef BACKSLASH_IN_FILENAME
9960 && (!no_bslash || *p != '\\')
9961 #endif
9963 *allow_dirs = TRUE;
9964 reg_pat[i++] = '\\';
9965 reg_pat[i++] = *p;
9967 break;
9968 #ifdef BACKSLASH_IN_FILENAME
9969 case '/':
9970 reg_pat[i++] = '[';
9971 reg_pat[i++] = '\\';
9972 reg_pat[i++] = '/';
9973 reg_pat[i++] = ']';
9974 if (allow_dirs != NULL)
9975 *allow_dirs = TRUE;
9976 break;
9977 #endif
9978 case '{':
9979 reg_pat[i++] = '\\';
9980 reg_pat[i++] = '(';
9981 nested++;
9982 break;
9983 case '}':
9984 reg_pat[i++] = '\\';
9985 reg_pat[i++] = ')';
9986 --nested;
9987 break;
9988 case ',':
9989 if (nested)
9991 reg_pat[i++] = '\\';
9992 reg_pat[i++] = '|';
9994 else
9995 reg_pat[i++] = ',';
9996 break;
9997 default:
9998 # ifdef FEAT_MBYTE
9999 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
10000 reg_pat[i++] = *p++;
10001 else
10002 # endif
10003 if (allow_dirs != NULL && vim_ispathsep(*p))
10004 *allow_dirs = TRUE;
10005 reg_pat[i++] = *p;
10006 break;
10009 if (add_dollar)
10010 reg_pat[i++] = '$';
10011 reg_pat[i] = NUL;
10012 if (nested != 0)
10014 if (nested < 0)
10015 EMSG(_("E219: Missing {."));
10016 else
10017 EMSG(_("E220: Missing }."));
10018 vim_free(reg_pat);
10019 reg_pat = NULL;
10021 return reg_pat;