Merge commit 'svn-vim' into vim
[MacVim/KaoriYa.git] / src / fileio.c
blobbcabbffc88f49ce774ddb867faa19b49b7cdcfc0
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 HAVE_FCNTL_H
25 # include <fcntl.h>
26 #endif
28 #ifdef __TANDEM
29 # include <limits.h> /* for SSIZE_MAX */
30 #endif
32 #if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
33 # include <utime.h> /* for struct utimbuf */
34 #endif
36 #define BUFSIZE 8192 /* size of normal write buffer */
37 #define SMBUFSIZE 256 /* size of emergency write buffer */
39 #ifdef FEAT_CRYPT
40 # define CRYPT_MAGIC "VimCrypt~01!" /* "01" is the version nr */
41 # define CRYPT_MAGIC_LEN 12 /* must be multiple of 4! */
42 #endif
44 /* Is there any system that doesn't have access()? */
45 #define USE_MCH_ACCESS
47 #if defined(sun) && defined(S_ISCHR)
48 # define OPEN_CHR_FILES
49 static int is_dev_fd_file(char_u *fname);
50 #endif
51 #ifdef FEAT_MBYTE
52 static char_u *next_fenc __ARGS((char_u **pp));
53 # ifdef FEAT_EVAL
54 static char_u *readfile_charconvert __ARGS((char_u *fname, char_u *fenc, int *fdp));
55 # endif
56 #endif
57 #ifdef FEAT_VIMINFO
58 static void check_marks_read __ARGS((void));
59 #endif
60 #ifdef FEAT_CRYPT
61 static char_u *check_for_cryptkey __ARGS((char_u *cryptkey, char_u *ptr, long *sizep, long *filesizep, int newfile));
62 #endif
63 #ifdef UNIX
64 static void set_file_time __ARGS((char_u *fname, time_t atime, time_t mtime));
65 #endif
66 static int set_rw_fname __ARGS((char_u *fname, char_u *sfname));
67 static int msg_add_fileformat __ARGS((int eol_type));
68 static void msg_add_eol __ARGS((void));
69 static int check_mtime __ARGS((buf_T *buf, struct stat *s));
70 static int time_differs __ARGS((long t1, long t2));
71 #ifdef FEAT_AUTOCMD
72 static int apply_autocmds_exarg __ARGS((event_T event, char_u *fname, char_u *fname_io, int force, buf_T *buf, exarg_T *eap));
73 static int au_find_group __ARGS((char_u *name));
75 # define AUGROUP_DEFAULT -1 /* default autocmd group */
76 # define AUGROUP_ERROR -2 /* errornouse autocmd group */
77 # define AUGROUP_ALL -3 /* all autocmd groups */
78 #endif
80 #if defined(FEAT_CRYPT) || defined(FEAT_MBYTE)
81 # define HAS_BW_FLAGS
82 # define FIO_LATIN1 0x01 /* convert Latin1 */
83 # define FIO_UTF8 0x02 /* convert UTF-8 */
84 # define FIO_UCS2 0x04 /* convert UCS-2 */
85 # define FIO_UCS4 0x08 /* convert UCS-4 */
86 # define FIO_UTF16 0x10 /* convert UTF-16 */
87 # ifdef WIN3264
88 # define FIO_CODEPAGE 0x20 /* convert MS-Windows codepage */
89 # define FIO_PUT_CP(x) (((x) & 0xffff) << 16) /* put codepage in top word */
90 # define FIO_GET_CP(x) (((x)>>16) & 0xffff) /* get codepage from top word */
91 # endif
92 # ifdef MACOS_X
93 # define FIO_MACROMAN 0x20 /* convert MacRoman */
94 # endif
95 # define FIO_ENDIAN_L 0x80 /* little endian */
96 # define FIO_ENCRYPTED 0x1000 /* encrypt written bytes */
97 # define FIO_NOCONVERT 0x2000 /* skip encoding conversion */
98 # define FIO_UCSBOM 0x4000 /* check for BOM at start of file */
99 # define FIO_ALL -1 /* allow all formats */
100 #endif
102 /* When converting, a read() or write() may leave some bytes to be converted
103 * for the next call. The value is guessed... */
104 #define CONV_RESTLEN 30
106 /* We have to guess how much a sequence of bytes may expand when converting
107 * with iconv() to be able to allocate a buffer. */
108 #define ICONV_MULT 8
111 * Structure to pass arguments from buf_write() to buf_write_bytes().
113 struct bw_info
115 int bw_fd; /* file descriptor */
116 char_u *bw_buf; /* buffer with data to be written */
117 int bw_len; /* length of data */
118 #ifdef HAS_BW_FLAGS
119 int bw_flags; /* FIO_ flags */
120 #endif
121 #ifdef FEAT_MBYTE
122 char_u bw_rest[CONV_RESTLEN]; /* not converted bytes */
123 int bw_restlen; /* nr of bytes in bw_rest[] */
124 int bw_first; /* first write call */
125 char_u *bw_conv_buf; /* buffer for writing converted chars */
126 int bw_conv_buflen; /* size of bw_conv_buf */
127 int bw_conv_error; /* set for conversion error */
128 # ifdef USE_ICONV
129 iconv_t bw_iconv_fd; /* descriptor for iconv() or -1 */
130 # endif
131 #endif
134 static int buf_write_bytes __ARGS((struct bw_info *ip));
136 #ifdef FEAT_MBYTE
137 static linenr_T readfile_linenr __ARGS((linenr_T linecnt, char_u *p, char_u *endp));
138 static int ucs2bytes __ARGS((unsigned c, char_u **pp, int flags));
139 static int same_encoding __ARGS((char_u *a, char_u *b));
140 static int get_fio_flags __ARGS((char_u *ptr));
141 static char_u *check_for_bom __ARGS((char_u *p, long size, int *lenp, int flags));
142 static int make_bom __ARGS((char_u *buf, char_u *name));
143 # ifdef WIN3264
144 static int get_win_fio_flags __ARGS((char_u *ptr));
145 # endif
146 # ifdef MACOS_X
147 static int get_mac_fio_flags __ARGS((char_u *ptr));
148 # endif
149 #endif
150 static int move_lines __ARGS((buf_T *frombuf, buf_T *tobuf));
153 void
154 filemess(buf, name, s, attr)
155 buf_T *buf;
156 char_u *name;
157 char_u *s;
158 int attr;
160 int msg_scroll_save;
162 if (msg_silent != 0)
163 return;
164 msg_add_fname(buf, name); /* put file name in IObuff with quotes */
165 /* If it's extremely long, truncate it. */
166 if (STRLEN(IObuff) > IOSIZE - 80)
167 IObuff[IOSIZE - 80] = NUL;
168 STRCAT(IObuff, s);
170 * For the first message may have to start a new line.
171 * For further ones overwrite the previous one, reset msg_scroll before
172 * calling filemess().
174 msg_scroll_save = msg_scroll;
175 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
176 msg_scroll = FALSE;
177 if (!msg_scroll) /* wait a bit when overwriting an error msg */
178 check_for_delay(FALSE);
179 msg_start();
180 msg_scroll = msg_scroll_save;
181 msg_scrolled_ign = TRUE;
182 /* may truncate the message to avoid a hit-return prompt */
183 msg_outtrans_attr(msg_may_trunc(FALSE, IObuff), attr);
184 msg_clr_eos();
185 out_flush();
186 msg_scrolled_ign = FALSE;
190 * Read lines from file "fname" into the buffer after line "from".
192 * 1. We allocate blocks with lalloc, as big as possible.
193 * 2. Each block is filled with characters from the file with a single read().
194 * 3. The lines are inserted in the buffer with ml_append().
196 * (caller must check that fname != NULL, unless READ_STDIN is used)
198 * "lines_to_skip" is the number of lines that must be skipped
199 * "lines_to_read" is the number of lines that are appended
200 * When not recovering lines_to_skip is 0 and lines_to_read MAXLNUM.
202 * flags:
203 * READ_NEW starting to edit a new buffer
204 * READ_FILTER reading filter output
205 * READ_STDIN read from stdin instead of a file
206 * READ_BUFFER read from curbuf instead of a file (converting after reading
207 * stdin)
208 * READ_DUMMY read into a dummy buffer (to check if file contents changed)
210 * return FAIL for failure, OK otherwise
213 readfile(fname, sfname, from, lines_to_skip, lines_to_read, eap, flags)
214 char_u *fname;
215 char_u *sfname;
216 linenr_T from;
217 linenr_T lines_to_skip;
218 linenr_T lines_to_read;
219 exarg_T *eap; /* can be NULL! */
220 int flags;
222 int fd = 0;
223 int newfile = (flags & READ_NEW);
224 int check_readonly;
225 int filtering = (flags & READ_FILTER);
226 int read_stdin = (flags & READ_STDIN);
227 int read_buffer = (flags & READ_BUFFER);
228 int set_options = newfile || read_buffer
229 || (eap != NULL && eap->read_edit);
230 linenr_T read_buf_lnum = 1; /* next line to read from curbuf */
231 colnr_T read_buf_col = 0; /* next char to read from this line */
232 char_u c;
233 linenr_T lnum = from;
234 char_u *ptr = NULL; /* pointer into read buffer */
235 char_u *buffer = NULL; /* read buffer */
236 char_u *new_buffer = NULL; /* init to shut up gcc */
237 char_u *line_start = NULL; /* init to shut up gcc */
238 int wasempty; /* buffer was empty before reading */
239 colnr_T len;
240 long size = 0;
241 char_u *p;
242 long filesize = 0;
243 int skip_read = FALSE;
244 #ifdef FEAT_CRYPT
245 char_u *cryptkey = NULL;
246 #endif
247 int split = 0; /* number of split lines */
248 #define UNKNOWN 0x0fffffff /* file size is unknown */
249 linenr_T linecnt;
250 int error = FALSE; /* errors encountered */
251 int ff_error = EOL_UNKNOWN; /* file format with errors */
252 long linerest = 0; /* remaining chars in line */
253 #ifdef UNIX
254 int perm = 0;
255 int swap_mode = -1; /* protection bits for swap file */
256 #else
257 int perm;
258 #endif
259 int fileformat = 0; /* end-of-line format */
260 int keep_fileformat = FALSE;
261 struct stat st;
262 int file_readonly;
263 linenr_T skip_count = 0;
264 linenr_T read_count = 0;
265 int msg_save = msg_scroll;
266 linenr_T read_no_eol_lnum = 0; /* non-zero lnum when last line of
267 * last read was missing the eol */
268 int try_mac = (vim_strchr(p_ffs, 'm') != NULL);
269 int try_dos = (vim_strchr(p_ffs, 'd') != NULL);
270 int try_unix = (vim_strchr(p_ffs, 'x') != NULL);
271 int file_rewind = FALSE;
272 #ifdef FEAT_MBYTE
273 int can_retry;
274 linenr_T conv_error = 0; /* line nr with conversion error */
275 linenr_T illegal_byte = 0; /* line nr with illegal byte */
276 int keep_dest_enc = FALSE; /* don't retry when char doesn't fit
277 in destination encoding */
278 int bad_char_behavior = BAD_REPLACE;
279 /* BAD_KEEP, BAD_DROP or character to
280 * replace with */
281 char_u *tmpname = NULL; /* name of 'charconvert' output file */
282 int fio_flags = 0;
283 char_u *fenc; /* fileencoding to use */
284 int fenc_alloced; /* fenc_next is in allocated memory */
285 char_u *fenc_next = NULL; /* next item in 'fencs' or NULL */
286 int advance_fenc = FALSE;
287 long real_size = 0;
288 # ifdef USE_ICONV
289 iconv_t iconv_fd = (iconv_t)-1; /* descriptor for iconv() or -1 */
290 # ifdef FEAT_EVAL
291 int did_iconv = FALSE; /* TRUE when iconv() failed and trying
292 'charconvert' next */
293 # endif
294 # endif
295 int converted = FALSE; /* TRUE if conversion done */
296 int notconverted = FALSE; /* TRUE if conversion wanted but it
297 wasn't possible */
298 char_u conv_rest[CONV_RESTLEN];
299 int conv_restlen = 0; /* nr of bytes in conv_rest[] */
300 #endif
302 write_no_eol_lnum = 0; /* in case it was set by the previous read */
305 * If there is no file name yet, use the one for the read file.
306 * BF_NOTEDITED is set to reflect this.
307 * Don't do this for a read from a filter.
308 * Only do this when 'cpoptions' contains the 'f' flag.
310 if (curbuf->b_ffname == NULL
311 && !filtering
312 && fname != NULL
313 && vim_strchr(p_cpo, CPO_FNAMER) != NULL
314 && !(flags & READ_DUMMY))
316 if (set_rw_fname(fname, sfname) == FAIL)
317 return FAIL;
320 /* After reading a file the cursor line changes but we don't want to
321 * display the line. */
322 ex_no_reprint = TRUE;
324 /* don't display the file info for another buffer now */
325 need_fileinfo = FALSE;
328 * For Unix: Use the short file name whenever possible.
329 * Avoids problems with networks and when directory names are changed.
330 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
331 * another directory, which we don't detect.
333 if (sfname == NULL)
334 sfname = fname;
335 #if defined(UNIX) || defined(__EMX__)
336 fname = sfname;
337 #endif
339 #ifdef FEAT_AUTOCMD
341 * The BufReadCmd and FileReadCmd events intercept the reading process by
342 * executing the associated commands instead.
344 if (!filtering && !read_stdin && !read_buffer)
346 pos_T pos;
348 pos = curbuf->b_op_start;
350 /* Set '[ mark to the line above where the lines go (line 1 if zero). */
351 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
352 curbuf->b_op_start.col = 0;
354 if (newfile)
356 if (apply_autocmds_exarg(EVENT_BUFREADCMD, NULL, sfname,
357 FALSE, curbuf, eap))
358 #ifdef FEAT_EVAL
359 return aborting() ? FAIL : OK;
360 #else
361 return OK;
362 #endif
364 else if (apply_autocmds_exarg(EVENT_FILEREADCMD, sfname, sfname,
365 FALSE, NULL, eap))
366 #ifdef FEAT_EVAL
367 return aborting() ? FAIL : OK;
368 #else
369 return OK;
370 #endif
372 curbuf->b_op_start = pos;
374 #endif
376 if ((shortmess(SHM_OVER) || curbuf->b_help) && p_verbose == 0)
377 msg_scroll = FALSE; /* overwrite previous file message */
378 else
379 msg_scroll = TRUE; /* don't overwrite previous file message */
382 * If the name ends in a path separator, we can't open it. Check here,
383 * because reading the file may actually work, but then creating the swap
384 * file may destroy it! Reported on MS-DOS and Win 95.
385 * If the name is too long we might crash further on, quit here.
387 if (fname != NULL && *fname != NUL)
389 p = fname + STRLEN(fname);
390 if (after_pathsep(fname, p) || STRLEN(fname) >= MAXPATHL)
392 filemess(curbuf, fname, (char_u *)_("Illegal file name"), 0);
393 msg_end();
394 msg_scroll = msg_save;
395 return FAIL;
399 #ifdef UNIX
401 * On Unix it is possible to read a directory, so we have to
402 * check for it before the mch_open().
404 if (!read_stdin && !read_buffer)
406 perm = mch_getperm(fname);
407 if (perm >= 0 && !S_ISREG(perm) /* not a regular file ... */
408 # ifdef S_ISFIFO
409 && !S_ISFIFO(perm) /* ... or fifo */
410 # endif
411 # ifdef S_ISSOCK
412 && !S_ISSOCK(perm) /* ... or socket */
413 # endif
414 # ifdef OPEN_CHR_FILES
415 && !(S_ISCHR(perm) && is_dev_fd_file(fname))
416 /* ... or a character special file named /dev/fd/<n> */
417 # endif
420 if (S_ISDIR(perm))
421 filemess(curbuf, fname, (char_u *)_("is a directory"), 0);
422 else
423 filemess(curbuf, fname, (char_u *)_("is not a file"), 0);
424 msg_end();
425 msg_scroll = msg_save;
426 return FAIL;
429 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
431 * MS-Windows allows opening a device, but we will probably get stuck
432 * trying to read it.
434 if (!p_odev && mch_nodetype(fname) == NODE_WRITABLE)
436 filemess(curbuf, fname, (char_u *)_("is a device (disabled with 'opendevice' option)"), 0);
437 msg_end();
438 msg_scroll = msg_save;
439 return FAIL;
441 # endif
443 #endif
445 /* set default 'fileformat' */
446 if (set_options)
448 if (eap != NULL && eap->force_ff != 0)
449 set_fileformat(get_fileformat_force(curbuf, eap), OPT_LOCAL);
450 else if (*p_ffs != NUL)
451 set_fileformat(default_fileformat(), OPT_LOCAL);
454 /* set or reset 'binary' */
455 if (eap != NULL && eap->force_bin != 0)
457 int oldval = curbuf->b_p_bin;
459 curbuf->b_p_bin = (eap->force_bin == FORCE_BIN);
460 set_options_bin(oldval, curbuf->b_p_bin, OPT_LOCAL);
464 * When opening a new file we take the readonly flag from the file.
465 * Default is r/w, can be set to r/o below.
466 * Don't reset it when in readonly mode
467 * Only set/reset b_p_ro when BF_CHECK_RO is set.
469 check_readonly = (newfile && (curbuf->b_flags & BF_CHECK_RO));
470 if (check_readonly && !readonlymode)
471 curbuf->b_p_ro = FALSE;
473 if (newfile && !read_stdin && !read_buffer)
475 /* Remember time of file.
476 * For RISCOS, also remember the filetype.
478 if (mch_stat((char *)fname, &st) >= 0)
480 buf_store_time(curbuf, &st, fname);
481 curbuf->b_mtime_read = curbuf->b_mtime;
483 #if defined(RISCOS) && defined(FEAT_OSFILETYPE)
484 /* Read the filetype into the buffer local filetype option. */
485 mch_read_filetype(fname);
486 #endif
487 #ifdef UNIX
489 * Use the protection bits of the original file for the swap file.
490 * This makes it possible for others to read the name of the
491 * edited file from the swapfile, but only if they can read the
492 * edited file.
493 * Remove the "write" and "execute" bits for group and others
494 * (they must not write the swapfile).
495 * Add the "read" and "write" bits for the user, otherwise we may
496 * not be able to write to the file ourselves.
497 * Setting the bits is done below, after creating the swap file.
499 swap_mode = (st.st_mode & 0644) | 0600;
500 #endif
501 #ifdef FEAT_CW_EDITOR
502 /* Get the FSSpec on MacOS
503 * TODO: Update it properly when the buffer name changes
505 (void)GetFSSpecFromPath(curbuf->b_ffname, &curbuf->b_FSSpec);
506 #endif
507 #ifdef VMS
508 curbuf->b_fab_rfm = st.st_fab_rfm;
509 curbuf->b_fab_rat = st.st_fab_rat;
510 curbuf->b_fab_mrs = st.st_fab_mrs;
511 #endif
513 else
515 curbuf->b_mtime = 0;
516 curbuf->b_mtime_read = 0;
517 curbuf->b_orig_size = 0;
518 curbuf->b_orig_mode = 0;
521 /* Reset the "new file" flag. It will be set again below when the
522 * file doesn't exist. */
523 curbuf->b_flags &= ~(BF_NEW | BF_NEW_W);
527 * for UNIX: check readonly with perm and mch_access()
528 * for RISCOS: same as Unix, otherwise file gets re-datestamped!
529 * for MSDOS and Amiga: check readonly by trying to open the file for writing
531 file_readonly = FALSE;
532 if (read_stdin)
534 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
535 /* Force binary I/O on stdin to avoid CR-LF -> LF conversion. */
536 setmode(0, O_BINARY);
537 #endif
539 else if (!read_buffer)
541 #ifdef USE_MCH_ACCESS
542 if (
543 # ifdef UNIX
544 !(perm & 0222) ||
545 # endif
546 mch_access((char *)fname, W_OK))
547 file_readonly = TRUE;
548 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
549 #else
550 if (!newfile
551 || readonlymode
552 || (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0)
554 file_readonly = TRUE;
555 /* try to open ro */
556 fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
558 #endif
561 if (fd < 0) /* cannot open at all */
563 #ifndef UNIX
564 int isdir_f;
565 #endif
566 msg_scroll = msg_save;
567 #ifndef UNIX
569 * On MSDOS and Amiga we can't open a directory, check here.
571 isdir_f = (mch_isdir(fname));
572 perm = mch_getperm(fname); /* check if the file exists */
573 if (isdir_f)
575 filemess(curbuf, sfname, (char_u *)_("is a directory"), 0);
576 curbuf->b_p_ro = TRUE; /* must use "w!" now */
578 else
579 #endif
580 if (newfile)
582 if (perm < 0)
585 * Set the 'new-file' flag, so that when the file has
586 * been created by someone else, a ":w" will complain.
588 curbuf->b_flags |= BF_NEW;
590 /* Create a swap file now, so that other Vims are warned
591 * that we are editing this file. Don't do this for a
592 * "nofile" or "nowrite" buffer type. */
593 #ifdef FEAT_QUICKFIX
594 if (!bt_dontwrite(curbuf))
595 #endif
596 check_need_swap(newfile);
597 if (dir_of_file_exists(fname))
598 filemess(curbuf, sfname, (char_u *)_("[New File]"), 0);
599 else
600 filemess(curbuf, sfname,
601 (char_u *)_("[New DIRECTORY]"), 0);
602 #ifdef FEAT_VIMINFO
603 /* Even though this is a new file, it might have been
604 * edited before and deleted. Get the old marks. */
605 check_marks_read();
606 #endif
607 #ifdef FEAT_MBYTE
608 if (eap != NULL && eap->force_enc != 0)
610 /* set forced 'fileencoding' */
611 fenc = enc_canonize(eap->cmd + eap->force_enc);
612 if (fenc != NULL)
613 set_string_option_direct((char_u *)"fenc", -1,
614 fenc, OPT_FREE|OPT_LOCAL, 0);
615 vim_free(fenc);
617 #endif
618 #ifdef FEAT_AUTOCMD
619 apply_autocmds_exarg(EVENT_BUFNEWFILE, sfname, sfname,
620 FALSE, curbuf, eap);
621 #endif
622 /* remember the current fileformat */
623 save_file_ff(curbuf);
625 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
626 if (aborting()) /* autocmds may abort script processing */
627 return FAIL;
628 #endif
629 return OK; /* a new file is not an error */
631 else
633 filemess(curbuf, sfname, (char_u *)(
634 # ifdef EFBIG
635 (errno == EFBIG) ? _("[File too big]") :
636 # endif
637 _("[Permission Denied]")), 0);
638 curbuf->b_p_ro = TRUE; /* must use "w!" now */
642 return FAIL;
646 * Only set the 'ro' flag for readonly files the first time they are
647 * loaded. Help files always get readonly mode
649 if ((check_readonly && file_readonly) || curbuf->b_help)
650 curbuf->b_p_ro = TRUE;
652 if (set_options)
654 /* Don't change 'eol' if reading from buffer as it will already be
655 * correctly set when reading stdin. */
656 if (!read_buffer)
658 curbuf->b_p_eol = TRUE;
659 curbuf->b_start_eol = TRUE;
661 #ifdef FEAT_MBYTE
662 curbuf->b_p_bomb = FALSE;
663 curbuf->b_start_bomb = FALSE;
664 #endif
667 /* Create a swap file now, so that other Vims are warned that we are
668 * editing this file.
669 * Don't do this for a "nofile" or "nowrite" buffer type. */
670 #ifdef FEAT_QUICKFIX
671 if (!bt_dontwrite(curbuf))
672 #endif
674 check_need_swap(newfile);
675 #ifdef UNIX
676 /* Set swap file protection bits after creating it. */
677 if (swap_mode > 0 && curbuf->b_ml.ml_mfp->mf_fname != NULL)
678 (void)mch_setperm(curbuf->b_ml.ml_mfp->mf_fname, (long)swap_mode);
679 #endif
682 #if defined(HAS_SWAP_EXISTS_ACTION)
683 /* If "Quit" selected at ATTENTION dialog, don't load the file */
684 if (swap_exists_action == SEA_QUIT)
686 if (!read_buffer && !read_stdin)
687 close(fd);
688 return FAIL;
690 #endif
692 ++no_wait_return; /* don't wait for return yet */
695 * Set '[ mark to the line above where the lines go (line 1 if zero).
697 curbuf->b_op_start.lnum = ((from == 0) ? 1 : from);
698 curbuf->b_op_start.col = 0;
700 #ifdef FEAT_AUTOCMD
701 if (!read_buffer)
703 int m = msg_scroll;
704 int n = msg_scrolled;
705 buf_T *old_curbuf = curbuf;
708 * The file must be closed again, the autocommands may want to change
709 * the file before reading it.
711 if (!read_stdin)
712 close(fd); /* ignore errors */
715 * The output from the autocommands should not overwrite anything and
716 * should not be overwritten: Set msg_scroll, restore its value if no
717 * output was done.
719 msg_scroll = TRUE;
720 if (filtering)
721 apply_autocmds_exarg(EVENT_FILTERREADPRE, NULL, sfname,
722 FALSE, curbuf, eap);
723 else if (read_stdin)
724 apply_autocmds_exarg(EVENT_STDINREADPRE, NULL, sfname,
725 FALSE, curbuf, eap);
726 else if (newfile)
727 apply_autocmds_exarg(EVENT_BUFREADPRE, NULL, sfname,
728 FALSE, curbuf, eap);
729 else
730 apply_autocmds_exarg(EVENT_FILEREADPRE, sfname, sfname,
731 FALSE, NULL, eap);
732 if (msg_scrolled == n)
733 msg_scroll = m;
735 #ifdef FEAT_EVAL
736 if (aborting()) /* autocmds may abort script processing */
738 --no_wait_return;
739 msg_scroll = msg_save;
740 curbuf->b_p_ro = TRUE; /* must use "w!" now */
741 return FAIL;
743 #endif
745 * Don't allow the autocommands to change the current buffer.
746 * Try to re-open the file.
748 if (!read_stdin && (curbuf != old_curbuf
749 || (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) < 0))
751 --no_wait_return;
752 msg_scroll = msg_save;
753 if (fd < 0)
754 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
755 else
756 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
757 curbuf->b_p_ro = TRUE; /* must use "w!" now */
758 return FAIL;
761 #endif /* FEAT_AUTOCMD */
763 /* Autocommands may add lines to the file, need to check if it is empty */
764 wasempty = (curbuf->b_ml.ml_flags & ML_EMPTY);
766 if (!recoverymode && !filtering && !(flags & READ_DUMMY))
769 * Show the user that we are busy reading the input. Sometimes this
770 * may take a while. When reading from stdin another program may
771 * still be running, don't move the cursor to the last line, unless
772 * always using the GUI.
774 if (read_stdin)
776 #ifndef ALWAYS_USE_GUI
777 mch_msg(_("Vim: Reading from stdin...\n"));
778 #endif
779 #ifdef FEAT_GUI
780 /* Also write a message in the GUI window, if there is one. */
781 if (gui.in_use && !gui.dying && !gui.starting)
783 p = (char_u *)_("Reading from stdin...");
784 gui_write(p, (int)STRLEN(p));
786 #endif
788 else if (!read_buffer)
789 filemess(curbuf, sfname, (char_u *)"", 0);
792 msg_scroll = FALSE; /* overwrite the file message */
795 * Set linecnt now, before the "retry" caused by a wrong guess for
796 * fileformat, and after the autocommands, which may change them.
798 linecnt = curbuf->b_ml.ml_line_count;
800 #ifdef FEAT_MBYTE
801 /* "++bad=" argument. */
802 if (eap != NULL && eap->bad_char != 0)
804 bad_char_behavior = eap->bad_char;
805 if (set_options)
806 curbuf->b_bad_char = eap->bad_char;
808 else
809 curbuf->b_bad_char = 0;
812 * Decide which 'encoding' to use or use first.
814 if (eap != NULL && eap->force_enc != 0)
816 fenc = enc_canonize(eap->cmd + eap->force_enc);
817 fenc_alloced = TRUE;
818 keep_dest_enc = TRUE;
820 else if (curbuf->b_p_bin)
822 fenc = (char_u *)""; /* binary: don't convert */
823 fenc_alloced = FALSE;
825 else if (curbuf->b_help)
827 char_u firstline[80];
828 int fc;
830 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
831 * fails it must be latin1.
832 * Always do this when 'encoding' is "utf-8". Otherwise only do
833 * this when needed to avoid [converted] remarks all the time.
834 * It is needed when the first line contains non-ASCII characters.
835 * That is only in *.??x files. */
836 fenc = (char_u *)"latin1";
837 c = enc_utf8;
838 if (!c && !read_stdin)
840 fc = fname[STRLEN(fname) - 1];
841 if (TOLOWER_ASC(fc) == 'x')
843 /* Read the first line (and a bit more). Immediately rewind to
844 * the start of the file. If the read() fails "len" is -1. */
845 len = vim_read(fd, firstline, 80);
846 lseek(fd, (off_t)0L, SEEK_SET);
847 for (p = firstline; p < firstline + len; ++p)
848 if (*p >= 0x80)
850 c = TRUE;
851 break;
856 if (c)
858 fenc_next = fenc;
859 fenc = (char_u *)"utf-8";
861 /* When the file is utf-8 but a character doesn't fit in
862 * 'encoding' don't retry. In help text editing utf-8 bytes
863 * doesn't make sense. */
864 if (!enc_utf8)
865 keep_dest_enc = TRUE;
867 fenc_alloced = FALSE;
869 else if (*p_fencs == NUL)
871 fenc = curbuf->b_p_fenc; /* use format from buffer */
872 fenc_alloced = FALSE;
874 else
876 fenc_next = p_fencs; /* try items in 'fileencodings' */
877 fenc = next_fenc(&fenc_next);
878 fenc_alloced = TRUE;
880 #endif
883 * Jump back here to retry reading the file in different ways.
884 * Reasons to retry:
885 * - encoding conversion failed: try another one from "fenc_next"
886 * - BOM detected and fenc was set, need to setup conversion
887 * - "fileformat" check failed: try another
889 * Variables set for special retry actions:
890 * "file_rewind" Rewind the file to start reading it again.
891 * "advance_fenc" Advance "fenc" using "fenc_next".
892 * "skip_read" Re-use already read bytes (BOM detected).
893 * "did_iconv" iconv() conversion failed, try 'charconvert'.
894 * "keep_fileformat" Don't reset "fileformat".
896 * Other status indicators:
897 * "tmpname" When != NULL did conversion with 'charconvert'.
898 * Output file has to be deleted afterwards.
899 * "iconv_fd" When != -1 did conversion with iconv().
901 retry:
903 if (file_rewind)
905 if (read_buffer)
907 read_buf_lnum = 1;
908 read_buf_col = 0;
910 else if (read_stdin || lseek(fd, (off_t)0L, SEEK_SET) != 0)
912 /* Can't rewind the file, give up. */
913 error = TRUE;
914 goto failed;
916 /* Delete the previously read lines. */
917 while (lnum > from)
918 ml_delete(lnum--, FALSE);
919 file_rewind = FALSE;
920 #ifdef FEAT_MBYTE
921 if (set_options)
923 curbuf->b_p_bomb = FALSE;
924 curbuf->b_start_bomb = FALSE;
926 conv_error = 0;
927 #endif
931 * When retrying with another "fenc" and the first time "fileformat"
932 * will be reset.
934 if (keep_fileformat)
935 keep_fileformat = FALSE;
936 else
938 if (eap != NULL && eap->force_ff != 0)
939 fileformat = get_fileformat_force(curbuf, eap);
940 else if (curbuf->b_p_bin)
941 fileformat = EOL_UNIX; /* binary: use Unix format */
942 else if (*p_ffs == NUL)
943 fileformat = get_fileformat(curbuf);/* use format from buffer */
944 else
945 fileformat = EOL_UNKNOWN; /* detect from file */
948 #ifdef FEAT_MBYTE
949 # ifdef USE_ICONV
950 if (iconv_fd != (iconv_t)-1)
952 /* aborted conversion with iconv(), close the descriptor */
953 iconv_close(iconv_fd);
954 iconv_fd = (iconv_t)-1;
956 # endif
958 if (advance_fenc)
961 * Try the next entry in 'fileencodings'.
963 advance_fenc = FALSE;
965 if (eap != NULL && eap->force_enc != 0)
967 /* Conversion given with "++cc=" wasn't possible, read
968 * without conversion. */
969 notconverted = TRUE;
970 conv_error = 0;
971 if (fenc_alloced)
972 vim_free(fenc);
973 fenc = (char_u *)"";
974 fenc_alloced = FALSE;
976 else
978 if (fenc_alloced)
979 vim_free(fenc);
980 if (fenc_next != NULL)
982 fenc = next_fenc(&fenc_next);
983 fenc_alloced = (fenc_next != NULL);
985 else
987 fenc = (char_u *)"";
988 fenc_alloced = FALSE;
991 if (tmpname != NULL)
993 mch_remove(tmpname); /* delete converted file */
994 vim_free(tmpname);
995 tmpname = NULL;
1000 * Conversion is required when the encoding of the file is different
1001 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4 (requires
1002 * conversion to UTF-8).
1004 fio_flags = 0;
1005 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
1006 if (converted || enc_unicode != 0)
1009 /* "ucs-bom" means we need to check the first bytes of the file
1010 * for a BOM. */
1011 if (STRCMP(fenc, ENC_UCSBOM) == 0)
1012 fio_flags = FIO_UCSBOM;
1015 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
1016 * done. This is handled below after read(). Prepare the
1017 * fio_flags to avoid having to parse the string each time.
1018 * Also check for Unicode to Latin1 conversion, because iconv()
1019 * appears not to handle this correctly. This works just like
1020 * conversion to UTF-8 except how the resulting character is put in
1021 * the buffer.
1023 else if (enc_utf8 || STRCMP(p_enc, "latin1") == 0)
1024 fio_flags = get_fio_flags(fenc);
1026 # ifdef WIN3264
1028 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1029 * is handled with MultiByteToWideChar().
1031 if (fio_flags == 0)
1032 fio_flags = get_win_fio_flags(fenc);
1033 # endif
1035 # ifdef MACOS_X
1036 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1037 if (fio_flags == 0)
1038 fio_flags = get_mac_fio_flags(fenc);
1039 # endif
1041 # ifdef USE_ICONV
1043 * Try using iconv() if we can't convert internally.
1045 if (fio_flags == 0
1046 # ifdef FEAT_EVAL
1047 && !did_iconv
1048 # endif
1050 iconv_fd = (iconv_t)my_iconv_open(
1051 enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc);
1052 # endif
1054 # ifdef FEAT_EVAL
1056 * Use the 'charconvert' expression when conversion is required
1057 * and we can't do it internally or with iconv().
1059 if (fio_flags == 0 && !read_stdin && !read_buffer && *p_ccv != NUL
1060 # ifdef USE_ICONV
1061 && iconv_fd == (iconv_t)-1
1062 # endif
1065 # ifdef USE_ICONV
1066 did_iconv = FALSE;
1067 # endif
1068 /* Skip conversion when it's already done (retry for wrong
1069 * "fileformat"). */
1070 if (tmpname == NULL)
1072 tmpname = readfile_charconvert(fname, fenc, &fd);
1073 if (tmpname == NULL)
1075 /* Conversion failed. Try another one. */
1076 advance_fenc = TRUE;
1077 if (fd < 0)
1079 /* Re-opening the original file failed! */
1080 EMSG(_("E202: Conversion made file unreadable!"));
1081 error = TRUE;
1082 goto failed;
1084 goto retry;
1088 else
1089 # endif
1091 if (fio_flags == 0
1092 # ifdef USE_ICONV
1093 && iconv_fd == (iconv_t)-1
1094 # endif
1097 /* Conversion wanted but we can't.
1098 * Try the next conversion in 'fileencodings' */
1099 advance_fenc = TRUE;
1100 goto retry;
1105 /* Set "can_retry" when it's possible to rewind the file and try with
1106 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1107 * stdin or fixed at a specific encoding. */
1108 can_retry = (*fenc != NUL && !read_stdin && !keep_dest_enc);
1109 #endif
1111 if (!skip_read)
1113 linerest = 0;
1114 filesize = 0;
1115 skip_count = lines_to_skip;
1116 read_count = lines_to_read;
1117 #ifdef FEAT_MBYTE
1118 conv_restlen = 0;
1119 #endif
1122 while (!error && !got_int)
1125 * We allocate as much space for the file as we can get, plus
1126 * space for the old line plus room for one terminating NUL.
1127 * The amount is limited by the fact that read() only can read
1128 * upto max_unsigned characters (and other things).
1130 #if SIZEOF_INT <= 2
1131 if (linerest >= 0x7ff0)
1133 ++split;
1134 *ptr = NL; /* split line by inserting a NL */
1135 size = 1;
1137 else
1138 #endif
1140 if (!skip_read)
1142 #if SIZEOF_INT > 2
1143 # if defined(SSIZE_MAX) && (SSIZE_MAX < 0x10000L)
1144 size = SSIZE_MAX; /* use max I/O size, 52K */
1145 # else
1146 size = 0x10000L; /* use buffer >= 64K */
1147 # endif
1148 #else
1149 size = 0x7ff0L - linerest; /* limit buffer to 32K */
1150 #endif
1152 for ( ; size >= 10; size = (long)((long_u)size >> 1))
1154 if ((new_buffer = lalloc((long_u)(size + linerest + 1),
1155 FALSE)) != NULL)
1156 break;
1158 if (new_buffer == NULL)
1160 do_outofmem_msg((long_u)(size * 2 + linerest + 1));
1161 error = TRUE;
1162 break;
1164 if (linerest) /* copy characters from the previous buffer */
1165 mch_memmove(new_buffer, ptr - linerest, (size_t)linerest);
1166 vim_free(buffer);
1167 buffer = new_buffer;
1168 ptr = buffer + linerest;
1169 line_start = buffer;
1171 #ifdef FEAT_MBYTE
1172 /* May need room to translate into.
1173 * For iconv() we don't really know the required space, use a
1174 * factor ICONV_MULT.
1175 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1176 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1177 * become up to 4 bytes, size must be multiple of 2
1178 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1179 * multiple of 2
1180 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1181 * multiple of 4 */
1182 real_size = (int)size;
1183 # ifdef USE_ICONV
1184 if (iconv_fd != (iconv_t)-1)
1185 size = size / ICONV_MULT;
1186 else
1187 # endif
1188 if (fio_flags & FIO_LATIN1)
1189 size = size / 2;
1190 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1191 size = (size * 2 / 3) & ~1;
1192 else if (fio_flags & FIO_UCS4)
1193 size = (size * 2 / 3) & ~3;
1194 else if (fio_flags == FIO_UCSBOM)
1195 size = size / ICONV_MULT; /* worst case */
1196 # ifdef WIN3264
1197 else if (fio_flags & FIO_CODEPAGE)
1198 size = size / ICONV_MULT; /* also worst case */
1199 # endif
1200 # ifdef MACOS_X
1201 else if (fio_flags & FIO_MACROMAN)
1202 size = size / ICONV_MULT; /* also worst case */
1203 # endif
1204 #endif
1206 #ifdef FEAT_MBYTE
1207 if (conv_restlen > 0)
1209 /* Insert unconverted bytes from previous line. */
1210 mch_memmove(ptr, conv_rest, conv_restlen);
1211 ptr += conv_restlen;
1212 size -= conv_restlen;
1214 #endif
1216 if (read_buffer)
1219 * Read bytes from curbuf. Used for converting text read
1220 * from stdin.
1222 if (read_buf_lnum > from)
1223 size = 0;
1224 else
1226 int n, ni;
1227 long tlen;
1229 tlen = 0;
1230 for (;;)
1232 p = ml_get(read_buf_lnum) + read_buf_col;
1233 n = (int)STRLEN(p);
1234 if ((int)tlen + n + 1 > size)
1236 /* Filled up to "size", append partial line.
1237 * Change NL to NUL to reverse the effect done
1238 * below. */
1239 n = (int)(size - tlen);
1240 for (ni = 0; ni < n; ++ni)
1242 if (p[ni] == NL)
1243 ptr[tlen++] = NUL;
1244 else
1245 ptr[tlen++] = p[ni];
1247 read_buf_col += n;
1248 break;
1250 else
1252 /* Append whole line and new-line. Change NL
1253 * to NUL to reverse the effect done below. */
1254 for (ni = 0; ni < n; ++ni)
1256 if (p[ni] == NL)
1257 ptr[tlen++] = NUL;
1258 else
1259 ptr[tlen++] = p[ni];
1261 ptr[tlen++] = NL;
1262 read_buf_col = 0;
1263 if (++read_buf_lnum > from)
1265 /* When the last line didn't have an
1266 * end-of-line don't add it now either. */
1267 if (!curbuf->b_p_eol)
1268 --tlen;
1269 size = tlen;
1270 break;
1276 else
1279 * Read bytes from the file.
1281 size = vim_read(fd, ptr, size);
1284 if (size <= 0)
1286 if (size < 0) /* read error */
1287 error = TRUE;
1288 #ifdef FEAT_MBYTE
1289 else if (conv_restlen > 0)
1291 /* Reached end-of-file but some trailing bytes could
1292 * not be converted. Truncated file? */
1293 if (conv_error == 0)
1294 conv_error = linecnt;
1295 if (bad_char_behavior != BAD_DROP)
1297 fio_flags = 0; /* don't convert this */
1298 # ifdef USE_ICONV
1299 if (iconv_fd != (iconv_t)-1)
1301 iconv_close(iconv_fd);
1302 iconv_fd = (iconv_t)-1;
1304 # endif
1305 if (bad_char_behavior == BAD_KEEP)
1307 /* Keep the trailing bytes as-is. */
1308 size = conv_restlen;
1309 ptr -= conv_restlen;
1311 else
1313 /* Replace the trailing bytes with the
1314 * replacement character. */
1315 size = 1;
1316 *--ptr = bad_char_behavior;
1318 conv_restlen = 0;
1321 #endif
1324 #ifdef FEAT_CRYPT
1326 * At start of file: Check for magic number of encryption.
1328 if (filesize == 0)
1329 cryptkey = check_for_cryptkey(cryptkey, ptr, &size,
1330 &filesize, newfile);
1332 * Decrypt the read bytes.
1334 if (cryptkey != NULL && size > 0)
1335 for (p = ptr; p < ptr + size; ++p)
1336 ZDECODE(*p);
1337 #endif
1339 skip_read = FALSE;
1341 #ifdef FEAT_MBYTE
1343 * At start of file (or after crypt magic number): Check for BOM.
1344 * Also check for a BOM for other Unicode encodings, but not after
1345 * converting with 'charconvert' or when a BOM has already been
1346 * found.
1348 if ((filesize == 0
1349 # ifdef FEAT_CRYPT
1350 || (filesize == CRYPT_MAGIC_LEN && cryptkey != NULL)
1351 # endif
1353 && (fio_flags == FIO_UCSBOM
1354 || (!curbuf->b_p_bomb
1355 && tmpname == NULL
1356 && (*fenc == 'u' || (*fenc == NUL && enc_utf8)))))
1358 char_u *ccname;
1359 int blen;
1361 /* no BOM detection in a short file or in binary mode */
1362 if (size < 2 || curbuf->b_p_bin)
1363 ccname = NULL;
1364 else
1365 ccname = check_for_bom(ptr, size, &blen,
1366 fio_flags == FIO_UCSBOM ? FIO_ALL : get_fio_flags(fenc));
1367 if (ccname != NULL)
1369 /* Remove BOM from the text */
1370 filesize += blen;
1371 size -= blen;
1372 mch_memmove(ptr, ptr + blen, (size_t)size);
1373 if (set_options)
1375 curbuf->b_p_bomb = TRUE;
1376 curbuf->b_start_bomb = TRUE;
1380 if (fio_flags == FIO_UCSBOM)
1382 if (ccname == NULL)
1384 /* No BOM detected: retry with next encoding. */
1385 advance_fenc = TRUE;
1387 else
1389 /* BOM detected: set "fenc" and jump back */
1390 if (fenc_alloced)
1391 vim_free(fenc);
1392 fenc = ccname;
1393 fenc_alloced = FALSE;
1395 /* retry reading without getting new bytes or rewinding */
1396 skip_read = TRUE;
1397 goto retry;
1400 #endif
1402 * Break here for a read error or end-of-file.
1404 if (size <= 0)
1405 break;
1407 #ifdef FEAT_MBYTE
1409 /* Include not converted bytes. */
1410 ptr -= conv_restlen;
1411 size += conv_restlen;
1412 conv_restlen = 0;
1414 # ifdef USE_ICONV
1415 if (iconv_fd != (iconv_t)-1)
1418 * Attempt conversion of the read bytes to 'encoding' using
1419 * iconv().
1421 const char *fromp;
1422 char *top;
1423 size_t from_size;
1424 size_t to_size;
1426 fromp = (char *)ptr;
1427 from_size = size;
1428 ptr += size;
1429 top = (char *)ptr;
1430 to_size = real_size - size;
1433 * If there is conversion error or not enough room try using
1434 * another conversion. Except for when there is no
1435 * alternative (help files).
1437 while ((iconv(iconv_fd, (void *)&fromp, &from_size,
1438 &top, &to_size)
1439 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
1440 || from_size > CONV_RESTLEN)
1442 if (can_retry)
1443 goto rewind_retry;
1444 if (conv_error == 0)
1445 conv_error = readfile_linenr(linecnt,
1446 ptr, (char_u *)top);
1448 /* Deal with a bad byte and continue with the next. */
1449 ++fromp;
1450 --from_size;
1451 if (bad_char_behavior == BAD_KEEP)
1453 *top++ = *(fromp - 1);
1454 --to_size;
1456 else if (bad_char_behavior != BAD_DROP)
1458 *top++ = bad_char_behavior;
1459 --to_size;
1463 if (from_size > 0)
1465 /* Some remaining characters, keep them for the next
1466 * round. */
1467 mch_memmove(conv_rest, (char_u *)fromp, from_size);
1468 conv_restlen = (int)from_size;
1471 /* move the linerest to before the converted characters */
1472 line_start = ptr - linerest;
1473 mch_memmove(line_start, buffer, (size_t)linerest);
1474 size = (long)((char_u *)top - ptr);
1476 # endif
1478 # ifdef WIN3264
1479 if (fio_flags & FIO_CODEPAGE)
1481 char_u *src, *dst;
1482 WCHAR ucs2buf[3];
1483 int ucs2len;
1484 int codepage = FIO_GET_CP(fio_flags);
1485 int bytelen;
1486 int found_bad;
1487 char replstr[2];
1490 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1491 * a codepage, using standard MS-Windows functions. This
1492 * requires two steps:
1493 * 1. convert from 'fileencoding' to ucs-2
1494 * 2. convert from ucs-2 to 'encoding'
1496 * Because there may be illegal bytes AND an incomplete byte
1497 * sequence at the end, we may have to do the conversion one
1498 * character at a time to get it right.
1501 /* Replacement string for WideCharToMultiByte(). */
1502 if (bad_char_behavior > 0)
1503 replstr[0] = bad_char_behavior;
1504 else
1505 replstr[0] = '?';
1506 replstr[1] = NUL;
1509 * Move the bytes to the end of the buffer, so that we have
1510 * room to put the result at the start.
1512 src = ptr + real_size - size;
1513 mch_memmove(src, ptr, size);
1516 * Do the conversion.
1518 dst = ptr;
1519 size = size;
1520 while (size > 0)
1522 found_bad = FALSE;
1524 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1525 if (codepage == CP_UTF8)
1527 /* Handle CP_UTF8 input ourselves to be able to handle
1528 * trailing bytes properly.
1529 * Get one UTF-8 character from src. */
1530 bytelen = (int)utf_ptr2len_len(src, size);
1531 if (bytelen > size)
1533 /* Only got some bytes of a character. Normally
1534 * it's put in "conv_rest", but if it's too long
1535 * deal with it as if they were illegal bytes. */
1536 if (bytelen <= CONV_RESTLEN)
1537 break;
1539 /* weird overlong byte sequence */
1540 bytelen = size;
1541 found_bad = TRUE;
1543 else
1545 int u8c = utf_ptr2char(src);
1547 if (u8c > 0xffff || (*src >= 0x80 && bytelen == 1))
1548 found_bad = TRUE;
1549 ucs2buf[0] = u8c;
1550 ucs2len = 1;
1553 else
1554 # endif
1556 /* We don't know how long the byte sequence is, try
1557 * from one to three bytes. */
1558 for (bytelen = 1; bytelen <= size && bytelen <= 3;
1559 ++bytelen)
1561 ucs2len = MultiByteToWideChar(codepage,
1562 MB_ERR_INVALID_CHARS,
1563 (LPCSTR)src, bytelen,
1564 ucs2buf, 3);
1565 if (ucs2len > 0)
1566 break;
1568 if (ucs2len == 0)
1570 /* If we have only one byte then it's probably an
1571 * incomplete byte sequence. Otherwise discard
1572 * one byte as a bad character. */
1573 if (size == 1)
1574 break;
1575 found_bad = TRUE;
1576 bytelen = 1;
1580 if (!found_bad)
1582 int i;
1584 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1585 if (enc_utf8)
1587 /* From UCS-2 to UTF-8. Cannot fail. */
1588 for (i = 0; i < ucs2len; ++i)
1589 dst += utf_char2bytes(ucs2buf[i], dst);
1591 else
1593 BOOL bad = FALSE;
1594 int dstlen;
1596 /* From UCS-2 to "enc_codepage". If the
1597 * conversion uses the default character "?",
1598 * the data doesn't fit in this encoding. */
1599 dstlen = WideCharToMultiByte(enc_codepage, 0,
1600 (LPCWSTR)ucs2buf, ucs2len,
1601 (LPSTR)dst, (int)(src - dst),
1602 replstr, &bad);
1603 if (bad)
1604 found_bad = TRUE;
1605 else
1606 dst += dstlen;
1610 if (found_bad)
1612 /* Deal with bytes we can't convert. */
1613 if (can_retry)
1614 goto rewind_retry;
1615 if (conv_error == 0)
1616 conv_error = readfile_linenr(linecnt, ptr, dst);
1617 if (bad_char_behavior != BAD_DROP)
1619 if (bad_char_behavior == BAD_KEEP)
1621 mch_memmove(dst, src, bytelen);
1622 dst += bytelen;
1624 else
1625 *dst++ = bad_char_behavior;
1629 src += bytelen;
1630 size -= bytelen;
1633 if (size > 0)
1635 /* An incomplete byte sequence remaining. */
1636 mch_memmove(conv_rest, src, size);
1637 conv_restlen = size;
1640 /* The new size is equal to how much "dst" was advanced. */
1641 size = (long)(dst - ptr);
1643 else
1644 # endif
1645 # ifdef MACOS_CONVERT
1646 if (fio_flags & FIO_MACROMAN)
1649 * Conversion from Apple MacRoman char encoding to UTF-8 or
1650 * latin1. This is in os_mac_conv.c.
1652 if (macroman2enc(ptr, &size, real_size) == FAIL)
1653 goto rewind_retry;
1655 else
1656 # endif
1657 if (fio_flags != 0)
1659 int u8c;
1660 char_u *dest;
1661 char_u *tail = NULL;
1664 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1665 * "enc_utf8" not set: Convert Unicode to Latin1.
1666 * Go from end to start through the buffer, because the number
1667 * of bytes may increase.
1668 * "dest" points to after where the UTF-8 bytes go, "p" points
1669 * to after the next character to convert.
1671 dest = ptr + real_size;
1672 if (fio_flags == FIO_LATIN1 || fio_flags == FIO_UTF8)
1674 p = ptr + size;
1675 if (fio_flags == FIO_UTF8)
1677 /* Check for a trailing incomplete UTF-8 sequence */
1678 tail = ptr + size - 1;
1679 while (tail > ptr && (*tail & 0xc0) == 0x80)
1680 --tail;
1681 if (tail + utf_byte2len(*tail) <= ptr + size)
1682 tail = NULL;
1683 else
1684 p = tail;
1687 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1689 /* Check for a trailing byte */
1690 p = ptr + (size & ~1);
1691 if (size & 1)
1692 tail = p;
1693 if ((fio_flags & FIO_UTF16) && p > ptr)
1695 /* Check for a trailing leading word */
1696 if (fio_flags & FIO_ENDIAN_L)
1698 u8c = (*--p << 8);
1699 u8c += *--p;
1701 else
1703 u8c = *--p;
1704 u8c += (*--p << 8);
1706 if (u8c >= 0xd800 && u8c <= 0xdbff)
1707 tail = p;
1708 else
1709 p += 2;
1712 else /* FIO_UCS4 */
1714 /* Check for trailing 1, 2 or 3 bytes */
1715 p = ptr + (size & ~3);
1716 if (size & 3)
1717 tail = p;
1720 /* If there is a trailing incomplete sequence move it to
1721 * conv_rest[]. */
1722 if (tail != NULL)
1724 conv_restlen = (int)((ptr + size) - tail);
1725 mch_memmove(conv_rest, (char_u *)tail, conv_restlen);
1726 size -= conv_restlen;
1730 while (p > ptr)
1732 if (fio_flags & FIO_LATIN1)
1733 u8c = *--p;
1734 else if (fio_flags & (FIO_UCS2 | FIO_UTF16))
1736 if (fio_flags & FIO_ENDIAN_L)
1738 u8c = (*--p << 8);
1739 u8c += *--p;
1741 else
1743 u8c = *--p;
1744 u8c += (*--p << 8);
1746 if ((fio_flags & FIO_UTF16)
1747 && u8c >= 0xdc00 && u8c <= 0xdfff)
1749 int u16c;
1751 if (p == ptr)
1753 /* Missing leading word. */
1754 if (can_retry)
1755 goto rewind_retry;
1756 if (conv_error == 0)
1757 conv_error = readfile_linenr(linecnt,
1758 ptr, p);
1759 if (bad_char_behavior == BAD_DROP)
1760 continue;
1761 if (bad_char_behavior != BAD_KEEP)
1762 u8c = bad_char_behavior;
1765 /* found second word of double-word, get the first
1766 * word and compute the resulting character */
1767 if (fio_flags & FIO_ENDIAN_L)
1769 u16c = (*--p << 8);
1770 u16c += *--p;
1772 else
1774 u16c = *--p;
1775 u16c += (*--p << 8);
1777 u8c = 0x10000 + ((u16c & 0x3ff) << 10)
1778 + (u8c & 0x3ff);
1780 /* Check if the word is indeed a leading word. */
1781 if (u16c < 0xd800 || u16c > 0xdbff)
1783 if (can_retry)
1784 goto rewind_retry;
1785 if (conv_error == 0)
1786 conv_error = readfile_linenr(linecnt,
1787 ptr, p);
1788 if (bad_char_behavior == BAD_DROP)
1789 continue;
1790 if (bad_char_behavior != BAD_KEEP)
1791 u8c = bad_char_behavior;
1795 else if (fio_flags & FIO_UCS4)
1797 if (fio_flags & FIO_ENDIAN_L)
1799 u8c = (*--p << 24);
1800 u8c += (*--p << 16);
1801 u8c += (*--p << 8);
1802 u8c += *--p;
1804 else /* big endian */
1806 u8c = *--p;
1807 u8c += (*--p << 8);
1808 u8c += (*--p << 16);
1809 u8c += (*--p << 24);
1812 else /* UTF-8 */
1814 if (*--p < 0x80)
1815 u8c = *p;
1816 else
1818 len = utf_head_off(ptr, p);
1819 p -= len;
1820 u8c = utf_ptr2char(p);
1821 if (len == 0)
1823 /* Not a valid UTF-8 character, retry with
1824 * another fenc when possible, otherwise just
1825 * report the error. */
1826 if (can_retry)
1827 goto rewind_retry;
1828 if (conv_error == 0)
1829 conv_error = readfile_linenr(linecnt,
1830 ptr, p);
1831 if (bad_char_behavior == BAD_DROP)
1832 continue;
1833 if (bad_char_behavior != BAD_KEEP)
1834 u8c = bad_char_behavior;
1838 if (enc_utf8) /* produce UTF-8 */
1840 dest -= utf_char2len(u8c);
1841 (void)utf_char2bytes(u8c, dest);
1843 else /* produce Latin1 */
1845 --dest;
1846 if (u8c >= 0x100)
1848 /* character doesn't fit in latin1, retry with
1849 * another fenc when possible, otherwise just
1850 * report the error. */
1851 if (can_retry)
1852 goto rewind_retry;
1853 if (conv_error == 0)
1854 conv_error = readfile_linenr(linecnt, ptr, p);
1855 if (bad_char_behavior == BAD_DROP)
1856 ++dest;
1857 else if (bad_char_behavior == BAD_KEEP)
1858 *dest = u8c;
1859 else if (eap != NULL && eap->bad_char != 0)
1860 *dest = bad_char_behavior;
1861 else
1862 *dest = 0xBF;
1864 else
1865 *dest = u8c;
1869 /* move the linerest to before the converted characters */
1870 line_start = dest - linerest;
1871 mch_memmove(line_start, buffer, (size_t)linerest);
1872 size = (long)((ptr + real_size) - dest);
1873 ptr = dest;
1875 else if (enc_utf8 && conv_error == 0 && !curbuf->b_p_bin)
1877 /* Reading UTF-8: Check if the bytes are valid UTF-8.
1878 * Need to start before "ptr" when part of the character was
1879 * read in the previous read() call. */
1880 for (p = ptr - utf_head_off(buffer, ptr); ; ++p)
1882 int todo = (int)((ptr + size) - p);
1883 int l;
1885 if (todo <= 0)
1886 break;
1887 if (*p >= 0x80)
1889 /* A length of 1 means it's an illegal byte. Accept
1890 * an incomplete character at the end though, the next
1891 * read() will get the next bytes, we'll check it
1892 * then. */
1893 l = utf_ptr2len_len(p, todo);
1894 if (l > todo)
1896 /* Incomplete byte sequence, the next read()
1897 * should get them and check the bytes. */
1898 p += todo;
1899 break;
1901 if (l == 1)
1903 /* Illegal byte. If we can try another encoding
1904 * do that. */
1905 if (can_retry)
1906 break;
1908 /* Remember the first linenr with an illegal byte */
1909 if (illegal_byte == 0)
1910 illegal_byte = readfile_linenr(linecnt, ptr, p);
1911 # ifdef USE_ICONV
1912 /* When we did a conversion report an error. */
1913 if (iconv_fd != (iconv_t)-1 && conv_error == 0)
1914 conv_error = readfile_linenr(linecnt, ptr, p);
1915 # endif
1917 /* Drop, keep or replace the bad byte. */
1918 if (bad_char_behavior == BAD_DROP)
1920 mch_memmove(p, p+1, todo - 1);
1921 --p;
1922 --size;
1924 else if (bad_char_behavior != BAD_KEEP)
1925 *p = bad_char_behavior;
1927 p += l - 1;
1930 if (p < ptr + size)
1932 /* Detected a UTF-8 error. */
1933 rewind_retry:
1934 /* Retry reading with another conversion. */
1935 # if defined(FEAT_EVAL) && defined(USE_ICONV)
1936 if (*p_ccv != NUL && iconv_fd != (iconv_t)-1)
1937 /* iconv() failed, try 'charconvert' */
1938 did_iconv = TRUE;
1939 else
1940 # endif
1941 /* use next item from 'fileencodings' */
1942 advance_fenc = TRUE;
1943 file_rewind = TRUE;
1944 goto retry;
1947 #endif
1949 /* count the number of characters (after conversion!) */
1950 filesize += size;
1953 * when reading the first part of a file: guess EOL type
1955 if (fileformat == EOL_UNKNOWN)
1957 /* First try finding a NL, for Dos and Unix */
1958 if (try_dos || try_unix)
1960 for (p = ptr; p < ptr + size; ++p)
1962 if (*p == NL)
1964 if (!try_unix
1965 || (try_dos && p > ptr && p[-1] == CAR))
1966 fileformat = EOL_DOS;
1967 else
1968 fileformat = EOL_UNIX;
1969 break;
1973 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
1974 if (fileformat == EOL_UNIX && try_mac)
1976 /* Need to reset the counters when retrying fenc. */
1977 try_mac = 1;
1978 try_unix = 1;
1979 for (; p >= ptr && *p != CAR; p--)
1981 if (p >= ptr)
1983 for (p = ptr; p < ptr + size; ++p)
1985 if (*p == NL)
1986 try_unix++;
1987 else if (*p == CAR)
1988 try_mac++;
1990 if (try_mac > try_unix)
1991 fileformat = EOL_MAC;
1996 /* No NL found: may use Mac format */
1997 if (fileformat == EOL_UNKNOWN && try_mac)
1998 fileformat = EOL_MAC;
2000 /* Still nothing found? Use first format in 'ffs' */
2001 if (fileformat == EOL_UNKNOWN)
2002 fileformat = default_fileformat();
2004 /* if editing a new file: may set p_tx and p_ff */
2005 if (set_options)
2006 set_fileformat(fileformat, OPT_LOCAL);
2011 * This loop is executed once for every character read.
2012 * Keep it fast!
2014 if (fileformat == EOL_MAC)
2016 --ptr;
2017 while (++ptr, --size >= 0)
2019 /* catch most common case first */
2020 if ((c = *ptr) != NUL && c != CAR && c != NL)
2021 continue;
2022 if (c == NUL)
2023 *ptr = NL; /* NULs are replaced by newlines! */
2024 else if (c == NL)
2025 *ptr = CAR; /* NLs are replaced by CRs! */
2026 else
2028 if (skip_count == 0)
2030 *ptr = NUL; /* end of line */
2031 len = (colnr_T) (ptr - line_start + 1);
2032 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2034 error = TRUE;
2035 break;
2037 ++lnum;
2038 if (--read_count == 0)
2040 error = TRUE; /* break loop */
2041 line_start = ptr; /* nothing left to write */
2042 break;
2045 else
2046 --skip_count;
2047 line_start = ptr + 1;
2051 else
2053 --ptr;
2054 while (++ptr, --size >= 0)
2056 if ((c = *ptr) != NUL && c != NL) /* catch most common case */
2057 continue;
2058 if (c == NUL)
2059 *ptr = NL; /* NULs are replaced by newlines! */
2060 else
2062 if (skip_count == 0)
2064 *ptr = NUL; /* end of line */
2065 len = (colnr_T)(ptr - line_start + 1);
2066 if (fileformat == EOL_DOS)
2068 if (ptr[-1] == CAR) /* remove CR */
2070 ptr[-1] = NUL;
2071 --len;
2074 * Reading in Dos format, but no CR-LF found!
2075 * When 'fileformats' includes "unix", delete all
2076 * the lines read so far and start all over again.
2077 * Otherwise give an error message later.
2079 else if (ff_error != EOL_DOS)
2081 if ( try_unix
2082 && !read_stdin
2083 && (read_buffer
2084 || lseek(fd, (off_t)0L, SEEK_SET) == 0))
2086 fileformat = EOL_UNIX;
2087 if (set_options)
2088 set_fileformat(EOL_UNIX, OPT_LOCAL);
2089 file_rewind = TRUE;
2090 keep_fileformat = TRUE;
2091 goto retry;
2093 ff_error = EOL_DOS;
2096 if (ml_append(lnum, line_start, len, newfile) == FAIL)
2098 error = TRUE;
2099 break;
2101 ++lnum;
2102 if (--read_count == 0)
2104 error = TRUE; /* break loop */
2105 line_start = ptr; /* nothing left to write */
2106 break;
2109 else
2110 --skip_count;
2111 line_start = ptr + 1;
2115 linerest = (long)(ptr - line_start);
2116 ui_breakcheck();
2119 failed:
2120 /* not an error, max. number of lines reached */
2121 if (error && read_count == 0)
2122 error = FALSE;
2125 * If we get EOF in the middle of a line, note the fact and
2126 * complete the line ourselves.
2127 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2129 if (!error
2130 && !got_int
2131 && linerest != 0
2132 && !(!curbuf->b_p_bin
2133 && fileformat == EOL_DOS
2134 && *line_start == Ctrl_Z
2135 && ptr == line_start + 1))
2137 /* remember for when writing */
2138 if (set_options)
2139 curbuf->b_p_eol = FALSE;
2140 *ptr = NUL;
2141 if (ml_append(lnum, line_start,
2142 (colnr_T)(ptr - line_start + 1), newfile) == FAIL)
2143 error = TRUE;
2144 else
2145 read_no_eol_lnum = ++lnum;
2148 if (set_options)
2149 save_file_ff(curbuf); /* remember the current file format */
2151 #ifdef FEAT_CRYPT
2152 if (cryptkey != curbuf->b_p_key)
2153 vim_free(cryptkey);
2154 #endif
2156 #ifdef FEAT_MBYTE
2157 /* If editing a new file: set 'fenc' for the current buffer.
2158 * Also for ":read ++edit file". */
2159 if (set_options)
2160 set_string_option_direct((char_u *)"fenc", -1, fenc,
2161 OPT_FREE|OPT_LOCAL, 0);
2162 if (fenc_alloced)
2163 vim_free(fenc);
2164 # ifdef USE_ICONV
2165 if (iconv_fd != (iconv_t)-1)
2167 iconv_close(iconv_fd);
2168 iconv_fd = (iconv_t)-1;
2170 # endif
2171 #endif
2173 if (!read_buffer && !read_stdin)
2174 close(fd); /* errors are ignored */
2175 vim_free(buffer);
2177 #ifdef HAVE_DUP
2178 if (read_stdin)
2180 /* Use stderr for stdin, makes shell commands work. */
2181 close(0);
2182 dup(2);
2184 #endif
2186 #ifdef FEAT_MBYTE
2187 if (tmpname != NULL)
2189 mch_remove(tmpname); /* delete converted file */
2190 vim_free(tmpname);
2192 #endif
2193 --no_wait_return; /* may wait for return now */
2196 * In recovery mode everything but autocommands is skipped.
2198 if (!recoverymode)
2200 /* need to delete the last line, which comes from the empty buffer */
2201 if (newfile && wasempty && !(curbuf->b_ml.ml_flags & ML_EMPTY))
2203 #ifdef FEAT_NETBEANS_INTG
2204 netbeansFireChanges = 0;
2205 #endif
2206 ml_delete(curbuf->b_ml.ml_line_count, FALSE);
2207 #ifdef FEAT_NETBEANS_INTG
2208 netbeansFireChanges = 1;
2209 #endif
2210 --linecnt;
2212 linecnt = curbuf->b_ml.ml_line_count - linecnt;
2213 if (filesize == 0)
2214 linecnt = 0;
2215 if (newfile || read_buffer)
2217 redraw_curbuf_later(NOT_VALID);
2218 #ifdef FEAT_DIFF
2219 /* After reading the text into the buffer the diff info needs to
2220 * be updated. */
2221 diff_invalidate(curbuf);
2222 #endif
2223 #ifdef FEAT_FOLDING
2224 /* All folds in the window are invalid now. Mark them for update
2225 * before triggering autocommands. */
2226 foldUpdateAll(curwin);
2227 #endif
2229 else if (linecnt) /* appended at least one line */
2230 appended_lines_mark(from, linecnt);
2232 #ifndef ALWAYS_USE_GUI
2234 * If we were reading from the same terminal as where messages go,
2235 * the screen will have been messed up.
2236 * Switch on raw mode now and clear the screen.
2238 if (read_stdin)
2240 settmode(TMODE_RAW); /* set to raw mode */
2241 starttermcap();
2242 screenclear();
2244 #endif
2246 if (got_int)
2248 if (!(flags & READ_DUMMY))
2250 filemess(curbuf, sfname, (char_u *)_(e_interr), 0);
2251 if (newfile)
2252 curbuf->b_p_ro = TRUE; /* must use "w!" now */
2254 msg_scroll = msg_save;
2255 #ifdef FEAT_VIMINFO
2256 check_marks_read();
2257 #endif
2258 return OK; /* an interrupt isn't really an error */
2261 if (!filtering && !(flags & READ_DUMMY))
2263 msg_add_fname(curbuf, sfname); /* fname in IObuff with quotes */
2264 c = FALSE;
2266 #ifdef UNIX
2267 # ifdef S_ISFIFO
2268 if (S_ISFIFO(perm)) /* fifo or socket */
2270 STRCAT(IObuff, _("[fifo/socket]"));
2271 c = TRUE;
2273 # else
2274 # ifdef S_IFIFO
2275 if ((perm & S_IFMT) == S_IFIFO) /* fifo */
2277 STRCAT(IObuff, _("[fifo]"));
2278 c = TRUE;
2280 # endif
2281 # ifdef S_IFSOCK
2282 if ((perm & S_IFMT) == S_IFSOCK) /* or socket */
2284 STRCAT(IObuff, _("[socket]"));
2285 c = TRUE;
2287 # endif
2288 # endif
2289 # ifdef OPEN_CHR_FILES
2290 if (S_ISCHR(perm)) /* or character special */
2292 STRCAT(IObuff, _("[character special]"));
2293 c = TRUE;
2295 # endif
2296 #endif
2297 if (curbuf->b_p_ro)
2299 STRCAT(IObuff, shortmess(SHM_RO) ? _("[RO]") : _("[readonly]"));
2300 c = TRUE;
2302 if (read_no_eol_lnum)
2304 msg_add_eol();
2305 c = TRUE;
2307 if (ff_error == EOL_DOS)
2309 STRCAT(IObuff, _("[CR missing]"));
2310 c = TRUE;
2312 if (ff_error == EOL_MAC)
2314 STRCAT(IObuff, _("[NL found]"));
2315 c = TRUE;
2317 if (split)
2319 STRCAT(IObuff, _("[long lines split]"));
2320 c = TRUE;
2322 #ifdef FEAT_MBYTE
2323 if (notconverted)
2325 STRCAT(IObuff, _("[NOT converted]"));
2326 c = TRUE;
2328 else if (converted)
2330 STRCAT(IObuff, _("[converted]"));
2331 c = TRUE;
2333 #endif
2334 #ifdef FEAT_CRYPT
2335 if (cryptkey != NULL)
2337 STRCAT(IObuff, _("[crypted]"));
2338 c = TRUE;
2340 #endif
2341 #ifdef FEAT_MBYTE
2342 if (conv_error != 0)
2344 sprintf((char *)IObuff + STRLEN(IObuff),
2345 _("[CONVERSION ERROR in line %ld]"), (long)conv_error);
2346 c = TRUE;
2348 else if (illegal_byte > 0)
2350 sprintf((char *)IObuff + STRLEN(IObuff),
2351 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte);
2352 c = TRUE;
2354 else
2355 #endif
2356 if (error)
2358 STRCAT(IObuff, _("[READ ERRORS]"));
2359 c = TRUE;
2361 if (msg_add_fileformat(fileformat))
2362 c = TRUE;
2363 #ifdef FEAT_CRYPT
2364 if (cryptkey != NULL)
2365 msg_add_lines(c, (long)linecnt, filesize - CRYPT_MAGIC_LEN);
2366 else
2367 #endif
2368 msg_add_lines(c, (long)linecnt, filesize);
2370 vim_free(keep_msg);
2371 keep_msg = NULL;
2372 msg_scrolled_ign = TRUE;
2373 #ifdef ALWAYS_USE_GUI
2374 /* Don't show the message when reading stdin, it would end up in a
2375 * message box (which might be shown when exiting!) */
2376 if (read_stdin || read_buffer)
2377 p = msg_may_trunc(FALSE, IObuff);
2378 else
2379 #endif
2380 p = msg_trunc_attr(IObuff, FALSE, 0);
2381 if (read_stdin || read_buffer || restart_edit != 0
2382 || (msg_scrolled != 0 && !need_wait_return))
2383 /* Need to repeat the message after redrawing when:
2384 * - When reading from stdin (the screen will be cleared next).
2385 * - When restart_edit is set (otherwise there will be a delay
2386 * before redrawing).
2387 * - When the screen was scrolled but there is no wait-return
2388 * prompt. */
2389 set_keep_msg(p, 0);
2390 msg_scrolled_ign = FALSE;
2393 /* with errors writing the file requires ":w!" */
2394 if (newfile && (error
2395 #ifdef FEAT_MBYTE
2396 || conv_error != 0
2397 || (illegal_byte > 0 && bad_char_behavior != BAD_KEEP)
2398 #endif
2400 curbuf->b_p_ro = TRUE;
2402 u_clearline(); /* cannot use "U" command after adding lines */
2405 * In Ex mode: cursor at last new line.
2406 * Otherwise: cursor at first new line.
2408 if (exmode_active)
2409 curwin->w_cursor.lnum = from + linecnt;
2410 else
2411 curwin->w_cursor.lnum = from + 1;
2412 check_cursor_lnum();
2413 beginline(BL_WHITE | BL_FIX); /* on first non-blank */
2416 * Set '[ and '] marks to the newly read lines.
2418 curbuf->b_op_start.lnum = from + 1;
2419 curbuf->b_op_start.col = 0;
2420 curbuf->b_op_end.lnum = from + linecnt;
2421 curbuf->b_op_end.col = 0;
2423 #ifdef WIN32
2425 * Work around a weird problem: When a file has two links (only
2426 * possible on NTFS) and we write through one link, then stat() it
2427 * throught the other link, the timestamp information may be wrong.
2428 * It's correct again after reading the file, thus reset the timestamp
2429 * here.
2431 if (newfile && !read_stdin && !read_buffer
2432 && mch_stat((char *)fname, &st) >= 0)
2434 buf_store_time(curbuf, &st, fname);
2435 curbuf->b_mtime_read = curbuf->b_mtime;
2437 #endif
2439 msg_scroll = msg_save;
2441 #ifdef FEAT_VIMINFO
2443 * Get the marks before executing autocommands, so they can be used there.
2445 check_marks_read();
2446 #endif
2449 * Trick: We remember if the last line of the read didn't have
2450 * an eol for when writing it again. This is required for
2451 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2453 write_no_eol_lnum = read_no_eol_lnum;
2455 #ifdef FEAT_AUTOCMD
2456 if (!read_stdin && !read_buffer)
2458 int m = msg_scroll;
2459 int n = msg_scrolled;
2461 /* Save the fileformat now, otherwise the buffer will be considered
2462 * modified if the format/encoding was automatically detected. */
2463 if (set_options)
2464 save_file_ff(curbuf);
2467 * The output from the autocommands should not overwrite anything and
2468 * should not be overwritten: Set msg_scroll, restore its value if no
2469 * output was done.
2471 msg_scroll = TRUE;
2472 if (filtering)
2473 apply_autocmds_exarg(EVENT_FILTERREADPOST, NULL, sfname,
2474 FALSE, curbuf, eap);
2475 else if (newfile)
2476 apply_autocmds_exarg(EVENT_BUFREADPOST, NULL, sfname,
2477 FALSE, curbuf, eap);
2478 else
2479 apply_autocmds_exarg(EVENT_FILEREADPOST, sfname, sfname,
2480 FALSE, NULL, eap);
2481 if (msg_scrolled == n)
2482 msg_scroll = m;
2483 #ifdef FEAT_EVAL
2484 if (aborting()) /* autocmds may abort script processing */
2485 return FAIL;
2486 #endif
2488 #endif
2490 if (recoverymode && error)
2491 return FAIL;
2492 return OK;
2495 #ifdef OPEN_CHR_FILES
2497 * Returns TRUE if the file name argument is of the form "/dev/fd/\d\+",
2498 * which is the name of files used for process substitution output by
2499 * some shells on some operating systems, e.g., bash on SunOS.
2500 * Do not accept "/dev/fd/[012]", opening these may hang Vim.
2502 static int
2503 is_dev_fd_file(fname)
2504 char_u *fname;
2506 return (STRNCMP(fname, "/dev/fd/", 8) == 0
2507 && VIM_ISDIGIT(fname[8])
2508 && *skipdigits(fname + 9) == NUL
2509 && (fname[9] != NUL
2510 || (fname[8] != '0' && fname[8] != '1' && fname[8] != '2')));
2512 #endif
2514 #ifdef FEAT_MBYTE
2517 * From the current line count and characters read after that, estimate the
2518 * line number where we are now.
2519 * Used for error messages that include a line number.
2521 static linenr_T
2522 readfile_linenr(linecnt, p, endp)
2523 linenr_T linecnt; /* line count before reading more bytes */
2524 char_u *p; /* start of more bytes read */
2525 char_u *endp; /* end of more bytes read */
2527 char_u *s;
2528 linenr_T lnum;
2530 lnum = curbuf->b_ml.ml_line_count - linecnt + 1;
2531 for (s = p; s < endp; ++s)
2532 if (*s == '\n')
2533 ++lnum;
2534 return lnum;
2536 #endif
2539 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2540 * equal to the buffer "buf". Used for calling readfile().
2541 * Returns OK or FAIL.
2544 prep_exarg(eap, buf)
2545 exarg_T *eap;
2546 buf_T *buf;
2548 eap->cmd = alloc((unsigned)(STRLEN(buf->b_p_ff)
2549 #ifdef FEAT_MBYTE
2550 + STRLEN(buf->b_p_fenc)
2551 #endif
2552 + 15));
2553 if (eap->cmd == NULL)
2554 return FAIL;
2556 #ifdef FEAT_MBYTE
2557 sprintf((char *)eap->cmd, "e ++ff=%s ++enc=%s", buf->b_p_ff, buf->b_p_fenc);
2558 eap->force_enc = 14 + (int)STRLEN(buf->b_p_ff);
2559 eap->bad_char = buf->b_bad_char;
2560 #else
2561 sprintf((char *)eap->cmd, "e ++ff=%s", buf->b_p_ff);
2562 #endif
2563 eap->force_ff = 7;
2565 eap->force_bin = buf->b_p_bin ? FORCE_BIN : FORCE_NOBIN;
2566 eap->read_edit = FALSE;
2567 eap->forceit = FALSE;
2568 return OK;
2571 #ifdef FEAT_MBYTE
2573 * Find next fileencoding to use from 'fileencodings'.
2574 * "pp" points to fenc_next. It's advanced to the next item.
2575 * When there are no more items, an empty string is returned and *pp is set to
2576 * NULL.
2577 * When *pp is not set to NULL, the result is in allocated memory.
2579 static char_u *
2580 next_fenc(pp)
2581 char_u **pp;
2583 char_u *p;
2584 char_u *r;
2586 if (**pp == NUL)
2588 *pp = NULL;
2589 return (char_u *)"";
2591 p = vim_strchr(*pp, ',');
2592 if (p == NULL)
2594 r = enc_canonize(*pp);
2595 *pp += STRLEN(*pp);
2597 else
2599 r = vim_strnsave(*pp, (int)(p - *pp));
2600 *pp = p + 1;
2601 if (r != NULL)
2603 p = enc_canonize(r);
2604 vim_free(r);
2605 r = p;
2608 if (r == NULL) /* out of memory */
2610 r = (char_u *)"";
2611 *pp = NULL;
2613 return r;
2616 # ifdef FEAT_EVAL
2618 * Convert a file with the 'charconvert' expression.
2619 * This closes the file which is to be read, converts it and opens the
2620 * resulting file for reading.
2621 * Returns name of the resulting converted file (the caller should delete it
2622 * after reading it).
2623 * Returns NULL if the conversion failed ("*fdp" is not set) .
2625 static char_u *
2626 readfile_charconvert(fname, fenc, fdp)
2627 char_u *fname; /* name of input file */
2628 char_u *fenc; /* converted from */
2629 int *fdp; /* in/out: file descriptor of file */
2631 char_u *tmpname;
2632 char_u *errmsg = NULL;
2634 tmpname = vim_tempname('r');
2635 if (tmpname == NULL)
2636 errmsg = (char_u *)_("Can't find temp file for conversion");
2637 else
2639 close(*fdp); /* close the input file, ignore errors */
2640 *fdp = -1;
2641 if (eval_charconvert(fenc, enc_utf8 ? (char_u *)"utf-8" : p_enc,
2642 fname, tmpname) == FAIL)
2643 errmsg = (char_u *)_("Conversion with 'charconvert' failed");
2644 if (errmsg == NULL && (*fdp = mch_open((char *)tmpname,
2645 O_RDONLY | O_EXTRA, 0)) < 0)
2646 errmsg = (char_u *)_("can't read output of 'charconvert'");
2649 if (errmsg != NULL)
2651 /* Don't use emsg(), it breaks mappings, the retry with
2652 * another type of conversion might still work. */
2653 MSG(errmsg);
2654 if (tmpname != NULL)
2656 mch_remove(tmpname); /* delete converted file */
2657 vim_free(tmpname);
2658 tmpname = NULL;
2662 /* If the input file is closed, open it (caller should check for error). */
2663 if (*fdp < 0)
2664 *fdp = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0);
2666 return tmpname;
2668 # endif
2670 #endif
2672 #ifdef FEAT_VIMINFO
2674 * Read marks for the current buffer from the viminfo file, when we support
2675 * buffer marks and the buffer has a name.
2677 static void
2678 check_marks_read()
2680 if (!curbuf->b_marks_read && get_viminfo_parameter('\'') > 0
2681 && curbuf->b_ffname != NULL)
2682 read_viminfo(NULL, FALSE, TRUE, FALSE);
2684 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2685 * the ' parameter after opening a buffer. */
2686 curbuf->b_marks_read = TRUE;
2688 #endif
2690 #ifdef FEAT_CRYPT
2692 * Check for magic number used for encryption.
2693 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2694 * *filesizep are updated.
2695 * Return the (new) encryption key, NULL for no encryption.
2697 static char_u *
2698 check_for_cryptkey(cryptkey, ptr, sizep, filesizep, newfile)
2699 char_u *cryptkey; /* previous encryption key or NULL */
2700 char_u *ptr; /* pointer to read bytes */
2701 long *sizep; /* length of read bytes */
2702 long *filesizep; /* nr of bytes used from file */
2703 int newfile; /* editing a new buffer */
2705 if (*sizep >= CRYPT_MAGIC_LEN
2706 && STRNCMP(ptr, CRYPT_MAGIC, CRYPT_MAGIC_LEN) == 0)
2708 if (cryptkey == NULL)
2710 if (*curbuf->b_p_key)
2711 cryptkey = curbuf->b_p_key;
2712 else
2714 /* When newfile is TRUE, store the typed key
2715 * in the 'key' option and don't free it. */
2716 cryptkey = get_crypt_key(newfile, FALSE);
2717 /* check if empty key entered */
2718 if (cryptkey != NULL && *cryptkey == NUL)
2720 if (cryptkey != curbuf->b_p_key)
2721 vim_free(cryptkey);
2722 cryptkey = NULL;
2727 if (cryptkey != NULL)
2729 crypt_init_keys(cryptkey);
2731 /* Remove magic number from the text */
2732 *filesizep += CRYPT_MAGIC_LEN;
2733 *sizep -= CRYPT_MAGIC_LEN;
2734 mch_memmove(ptr, ptr + CRYPT_MAGIC_LEN, (size_t)*sizep);
2737 /* When starting to edit a new file which does not have
2738 * encryption, clear the 'key' option, except when
2739 * starting up (called with -x argument) */
2740 else if (newfile && *curbuf->b_p_key && !starting)
2741 set_option_value((char_u *)"key", 0L, (char_u *)"", OPT_LOCAL);
2743 return cryptkey;
2745 #endif
2747 #ifdef UNIX
2748 static void
2749 set_file_time(fname, atime, mtime)
2750 char_u *fname;
2751 time_t atime; /* access time */
2752 time_t mtime; /* modification time */
2754 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2755 struct utimbuf buf;
2757 buf.actime = atime;
2758 buf.modtime = mtime;
2759 (void)utime((char *)fname, &buf);
2760 # else
2761 # if defined(HAVE_UTIMES)
2762 struct timeval tvp[2];
2764 tvp[0].tv_sec = atime;
2765 tvp[0].tv_usec = 0;
2766 tvp[1].tv_sec = mtime;
2767 tvp[1].tv_usec = 0;
2768 # ifdef NeXT
2769 (void)utimes((char *)fname, tvp);
2770 # else
2771 (void)utimes((char *)fname, (const struct timeval *)&tvp);
2772 # endif
2773 # endif
2774 # endif
2776 #endif /* UNIX */
2778 #if defined(VMS) && !defined(MIN)
2779 /* Older DECC compiler for VAX doesn't define MIN() */
2780 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2781 #endif
2784 * Return TRUE if a file appears to be read-only from the file permissions.
2787 check_file_readonly(fname, perm)
2788 char_u *fname; /* full path to file */
2789 int perm; /* known permissions on file */
2791 #ifndef USE_MCH_ACCESS
2792 int fd = 0;
2793 #endif
2795 return (
2796 #ifdef USE_MCH_ACCESS
2797 # ifdef UNIX
2798 (perm & 0222) == 0 ||
2799 # endif
2800 mch_access((char *)fname, W_OK)
2801 #else
2802 (fd = mch_open((char *)fname, O_RDWR | O_EXTRA, 0)) < 0
2803 ? TRUE : (close(fd), FALSE)
2804 #endif
2810 * buf_write() - write to file "fname" lines "start" through "end"
2812 * We do our own buffering here because fwrite() is so slow.
2814 * If "forceit" is true, we don't care for errors when attempting backups.
2815 * In case of an error everything possible is done to restore the original
2816 * file. But when "forceit" is TRUE, we risk loosing it.
2818 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2819 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2821 * This function must NOT use NameBuff (because it's called by autowrite()).
2823 * return FAIL for failure, OK otherwise
2826 buf_write(buf, fname, sfname, start, end, eap, append, forceit,
2827 reset_changed, filtering)
2828 buf_T *buf;
2829 char_u *fname;
2830 char_u *sfname;
2831 linenr_T start, end;
2832 exarg_T *eap; /* for forced 'ff' and 'fenc', can be
2833 NULL! */
2834 int append; /* append to the file */
2835 int forceit;
2836 int reset_changed;
2837 int filtering;
2839 int fd;
2840 char_u *backup = NULL;
2841 int backup_copy = FALSE; /* copy the original file? */
2842 int dobackup;
2843 char_u *ffname;
2844 char_u *wfname = NULL; /* name of file to write to */
2845 char_u *s;
2846 char_u *ptr;
2847 char_u c;
2848 int len;
2849 linenr_T lnum;
2850 long nchars;
2851 char_u *errmsg = NULL;
2852 char_u *errnum = NULL;
2853 char_u *buffer;
2854 char_u smallbuf[SMBUFSIZE];
2855 char_u *backup_ext;
2856 int bufsize;
2857 long perm; /* file permissions */
2858 int retval = OK;
2859 int newfile = FALSE; /* TRUE if file doesn't exist yet */
2860 int msg_save = msg_scroll;
2861 int overwriting; /* TRUE if writing over original */
2862 int no_eol = FALSE; /* no end-of-line written */
2863 int device = FALSE; /* writing to a device */
2864 struct stat st_old;
2865 int prev_got_int = got_int;
2866 int file_readonly = FALSE; /* overwritten file is read-only */
2867 static char *err_readonly = "is read-only (cannot override: \"W\" in 'cpoptions')";
2868 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2869 int made_writable = FALSE; /* 'w' bit has been set */
2870 #endif
2871 /* writing everything */
2872 int whole = (start == 1 && end == buf->b_ml.ml_line_count);
2873 #ifdef FEAT_AUTOCMD
2874 linenr_T old_line_count = buf->b_ml.ml_line_count;
2875 #endif
2876 int attr;
2877 int fileformat;
2878 int write_bin;
2879 struct bw_info write_info; /* info for buf_write_bytes() */
2880 #ifdef FEAT_MBYTE
2881 int converted = FALSE;
2882 int notconverted = FALSE;
2883 char_u *fenc; /* effective 'fileencoding' */
2884 char_u *fenc_tofree = NULL; /* allocated "fenc" */
2885 #endif
2886 #ifdef HAS_BW_FLAGS
2887 int wb_flags = 0;
2888 #endif
2889 #ifdef HAVE_ACL
2890 vim_acl_T acl = NULL; /* ACL copied from original file to
2891 backup or new file */
2892 #endif
2894 if (fname == NULL || *fname == NUL) /* safety check */
2895 return FAIL;
2898 * Disallow writing from .exrc and .vimrc in current directory for
2899 * security reasons.
2901 if (check_secure())
2902 return FAIL;
2904 /* Avoid a crash for a long name. */
2905 if (STRLEN(fname) >= MAXPATHL)
2907 EMSG(_(e_longname));
2908 return FAIL;
2911 #ifdef FEAT_MBYTE
2912 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
2913 write_info.bw_conv_buf = NULL;
2914 write_info.bw_conv_error = FALSE;
2915 write_info.bw_restlen = 0;
2916 # ifdef USE_ICONV
2917 write_info.bw_iconv_fd = (iconv_t)-1;
2918 # endif
2919 #endif
2921 /* After writing a file changedtick changes but we don't want to display
2922 * the line. */
2923 ex_no_reprint = TRUE;
2926 * If there is no file name yet, use the one for the written file.
2927 * BF_NOTEDITED is set to reflect this (in case the write fails).
2928 * Don't do this when the write is for a filter command.
2929 * Don't do this when appending.
2930 * Only do this when 'cpoptions' contains the 'F' flag.
2932 if (buf->b_ffname == NULL
2933 && reset_changed
2934 && whole
2935 && buf == curbuf
2936 #ifdef FEAT_QUICKFIX
2937 && !bt_nofile(buf)
2938 #endif
2939 && !filtering
2940 && (!append || vim_strchr(p_cpo, CPO_FNAMEAPP) != NULL)
2941 && vim_strchr(p_cpo, CPO_FNAMEW) != NULL)
2943 if (set_rw_fname(fname, sfname) == FAIL)
2944 return FAIL;
2945 buf = curbuf; /* just in case autocmds made "buf" invalid */
2948 if (sfname == NULL)
2949 sfname = fname;
2951 * For Unix: Use the short file name whenever possible.
2952 * Avoids problems with networks and when directory names are changed.
2953 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
2954 * another directory, which we don't detect
2956 ffname = fname; /* remember full fname */
2957 #ifdef UNIX
2958 fname = sfname;
2959 #endif
2961 if (buf->b_ffname != NULL && fnamecmp(ffname, buf->b_ffname) == 0)
2962 overwriting = TRUE;
2963 else
2964 overwriting = FALSE;
2966 if (exiting)
2967 settmode(TMODE_COOK); /* when exiting allow typahead now */
2969 ++no_wait_return; /* don't wait for return yet */
2972 * Set '[ and '] marks to the lines to be written.
2974 buf->b_op_start.lnum = start;
2975 buf->b_op_start.col = 0;
2976 buf->b_op_end.lnum = end;
2977 buf->b_op_end.col = 0;
2979 #ifdef FEAT_AUTOCMD
2981 aco_save_T aco;
2982 int buf_ffname = FALSE;
2983 int buf_sfname = FALSE;
2984 int buf_fname_f = FALSE;
2985 int buf_fname_s = FALSE;
2986 int did_cmd = FALSE;
2987 int nofile_err = FALSE;
2988 int empty_memline = (buf->b_ml.ml_mfp == NULL);
2991 * Apply PRE aucocommands.
2992 * Set curbuf to the buffer to be written.
2993 * Careful: The autocommands may call buf_write() recursively!
2995 if (ffname == buf->b_ffname)
2996 buf_ffname = TRUE;
2997 if (sfname == buf->b_sfname)
2998 buf_sfname = TRUE;
2999 if (fname == buf->b_ffname)
3000 buf_fname_f = TRUE;
3001 if (fname == buf->b_sfname)
3002 buf_fname_s = TRUE;
3004 /* set curwin/curbuf to buf and save a few things */
3005 aucmd_prepbuf(&aco, buf);
3007 if (append)
3009 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEAPPENDCMD,
3010 sfname, sfname, FALSE, curbuf, eap)))
3012 #ifdef FEAT_QUICKFIX
3013 if (overwriting && bt_nofile(curbuf))
3014 nofile_err = TRUE;
3015 else
3016 #endif
3017 apply_autocmds_exarg(EVENT_FILEAPPENDPRE,
3018 sfname, sfname, FALSE, curbuf, eap);
3021 else if (filtering)
3023 apply_autocmds_exarg(EVENT_FILTERWRITEPRE,
3024 NULL, sfname, FALSE, curbuf, eap);
3026 else if (reset_changed && whole)
3028 if (!(did_cmd = apply_autocmds_exarg(EVENT_BUFWRITECMD,
3029 sfname, sfname, FALSE, curbuf, eap)))
3031 #ifdef FEAT_QUICKFIX
3032 if (overwriting && bt_nofile(curbuf))
3033 nofile_err = TRUE;
3034 else
3035 #endif
3036 apply_autocmds_exarg(EVENT_BUFWRITEPRE,
3037 sfname, sfname, FALSE, curbuf, eap);
3040 else
3042 if (!(did_cmd = apply_autocmds_exarg(EVENT_FILEWRITECMD,
3043 sfname, sfname, FALSE, curbuf, eap)))
3045 #ifdef FEAT_QUICKFIX
3046 if (overwriting && bt_nofile(curbuf))
3047 nofile_err = TRUE;
3048 else
3049 #endif
3050 apply_autocmds_exarg(EVENT_FILEWRITEPRE,
3051 sfname, sfname, FALSE, curbuf, eap);
3055 /* restore curwin/curbuf and a few other things */
3056 aucmd_restbuf(&aco);
3059 * In three situations we return here and don't write the file:
3060 * 1. the autocommands deleted or unloaded the buffer.
3061 * 2. The autocommands abort script processing.
3062 * 3. If one of the "Cmd" autocommands was executed.
3064 if (!buf_valid(buf))
3065 buf = NULL;
3066 if (buf == NULL || (buf->b_ml.ml_mfp == NULL && !empty_memline)
3067 || did_cmd || nofile_err
3068 #ifdef FEAT_EVAL
3069 || aborting()
3070 #endif
3073 --no_wait_return;
3074 msg_scroll = msg_save;
3075 if (nofile_err)
3076 EMSG(_("E676: No matching autocommands for acwrite buffer"));
3078 if (nofile_err
3079 #ifdef FEAT_EVAL
3080 || aborting()
3081 #endif
3083 /* An aborting error, interrupt or exception in the
3084 * autocommands. */
3085 return FAIL;
3086 if (did_cmd)
3088 if (buf == NULL)
3089 /* The buffer was deleted. We assume it was written
3090 * (can't retry anyway). */
3091 return OK;
3092 if (overwriting)
3094 /* Assume the buffer was written, update the timestamp. */
3095 ml_timestamp(buf);
3096 if (append)
3097 buf->b_flags &= ~BF_NEW;
3098 else
3099 buf->b_flags &= ~BF_WRITE_MASK;
3101 if (reset_changed && buf->b_changed && !append
3102 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL))
3103 /* Buffer still changed, the autocommands didn't work
3104 * properly. */
3105 return FAIL;
3106 return OK;
3108 #ifdef FEAT_EVAL
3109 if (!aborting())
3110 #endif
3111 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3112 return FAIL;
3116 * The autocommands may have changed the number of lines in the file.
3117 * When writing the whole file, adjust the end.
3118 * When writing part of the file, assume that the autocommands only
3119 * changed the number of lines that are to be written (tricky!).
3121 if (buf->b_ml.ml_line_count != old_line_count)
3123 if (whole) /* write all */
3124 end = buf->b_ml.ml_line_count;
3125 else if (buf->b_ml.ml_line_count > old_line_count) /* more lines */
3126 end += buf->b_ml.ml_line_count - old_line_count;
3127 else /* less lines */
3129 end -= old_line_count - buf->b_ml.ml_line_count;
3130 if (end < start)
3132 --no_wait_return;
3133 msg_scroll = msg_save;
3134 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3135 return FAIL;
3141 * The autocommands may have changed the name of the buffer, which may
3142 * be kept in fname, ffname and sfname.
3144 if (buf_ffname)
3145 ffname = buf->b_ffname;
3146 if (buf_sfname)
3147 sfname = buf->b_sfname;
3148 if (buf_fname_f)
3149 fname = buf->b_ffname;
3150 if (buf_fname_s)
3151 fname = buf->b_sfname;
3153 #endif
3155 #ifdef FEAT_NETBEANS_INTG
3156 if (usingNetbeans && isNetbeansBuffer(buf))
3158 if (whole)
3161 * b_changed can be 0 after an undo, but we still need to write
3162 * the buffer to NetBeans.
3164 if (buf->b_changed || isNetbeansModified(buf))
3166 --no_wait_return; /* may wait for return now */
3167 msg_scroll = msg_save;
3168 netbeans_save_buffer(buf); /* no error checking... */
3169 return retval;
3171 else
3173 errnum = (char_u *)"E656: ";
3174 errmsg = (char_u *)_("NetBeans dissallows writes of unmodified buffers");
3175 buffer = NULL;
3176 goto fail;
3179 else
3181 errnum = (char_u *)"E657: ";
3182 errmsg = (char_u *)_("Partial writes disallowed for NetBeans buffers");
3183 buffer = NULL;
3184 goto fail;
3187 #endif
3189 if (shortmess(SHM_OVER) && !exiting)
3190 msg_scroll = FALSE; /* overwrite previous file message */
3191 else
3192 msg_scroll = TRUE; /* don't overwrite previous file message */
3193 if (!filtering)
3194 filemess(buf,
3195 #ifndef UNIX
3196 sfname,
3197 #else
3198 fname,
3199 #endif
3200 (char_u *)"", 0); /* show that we are busy */
3201 msg_scroll = FALSE; /* always overwrite the file message now */
3203 buffer = alloc(BUFSIZE);
3204 if (buffer == NULL) /* can't allocate big buffer, use small
3205 * one (to be able to write when out of
3206 * memory) */
3208 buffer = smallbuf;
3209 bufsize = SMBUFSIZE;
3211 else
3212 bufsize = BUFSIZE;
3215 * Get information about original file (if there is one).
3217 #if defined(UNIX) && !defined(ARCHIE)
3218 st_old.st_dev = 0;
3219 st_old.st_ino = 0;
3220 perm = -1;
3221 if (mch_stat((char *)fname, &st_old) < 0)
3222 newfile = TRUE;
3223 else
3225 perm = st_old.st_mode;
3226 if (!S_ISREG(st_old.st_mode)) /* not a file */
3228 if (S_ISDIR(st_old.st_mode))
3230 errnum = (char_u *)"E502: ";
3231 errmsg = (char_u *)_("is a directory");
3232 goto fail;
3234 if (mch_nodetype(fname) != NODE_WRITABLE)
3236 errnum = (char_u *)"E503: ";
3237 errmsg = (char_u *)_("is not a file or writable device");
3238 goto fail;
3240 /* It's a device of some kind (or a fifo) which we can write to
3241 * but for which we can't make a backup. */
3242 device = TRUE;
3243 newfile = TRUE;
3244 perm = -1;
3247 #else /* !UNIX */
3249 * Check for a writable device name.
3251 c = mch_nodetype(fname);
3252 if (c == NODE_OTHER)
3254 errnum = (char_u *)"E503: ";
3255 errmsg = (char_u *)_("is not a file or writable device");
3256 goto fail;
3258 if (c == NODE_WRITABLE)
3260 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3261 /* MS-Windows allows opening a device, but we will probably get stuck
3262 * trying to write to it. */
3263 if (!p_odev)
3265 errnum = (char_u *)"E796: ";
3266 errmsg = (char_u *)_("writing to device disabled with 'opendevice' option");
3267 goto fail;
3269 # endif
3270 device = TRUE;
3271 newfile = TRUE;
3272 perm = -1;
3274 else
3276 perm = mch_getperm(fname);
3277 if (perm < 0)
3278 newfile = TRUE;
3279 else if (mch_isdir(fname))
3281 errnum = (char_u *)"E502: ";
3282 errmsg = (char_u *)_("is a directory");
3283 goto fail;
3285 if (overwriting)
3286 (void)mch_stat((char *)fname, &st_old);
3288 #endif /* !UNIX */
3290 if (!device && !newfile)
3293 * Check if the file is really writable (when renaming the file to
3294 * make a backup we won't discover it later).
3296 file_readonly = check_file_readonly(fname, (int)perm);
3298 if (!forceit && file_readonly)
3300 if (vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3302 errnum = (char_u *)"E504: ";
3303 errmsg = (char_u *)_(err_readonly);
3305 else
3307 errnum = (char_u *)"E505: ";
3308 errmsg = (char_u *)_("is read-only (add ! to override)");
3310 goto fail;
3314 * Check if the timestamp hasn't changed since reading the file.
3316 if (overwriting)
3318 retval = check_mtime(buf, &st_old);
3319 if (retval == FAIL)
3320 goto fail;
3324 #ifdef HAVE_ACL
3326 * For systems that support ACL: get the ACL from the original file.
3328 if (!newfile)
3329 acl = mch_get_acl(fname);
3330 #endif
3333 * If 'backupskip' is not empty, don't make a backup for some files.
3335 dobackup = (p_wb || p_bk || *p_pm != NUL);
3336 #ifdef FEAT_WILDIGN
3337 if (dobackup && *p_bsk != NUL && match_file_list(p_bsk, sfname, ffname))
3338 dobackup = FALSE;
3339 #endif
3342 * Save the value of got_int and reset it. We don't want a previous
3343 * interruption cancel writing, only hitting CTRL-C while writing should
3344 * abort it.
3346 prev_got_int = got_int;
3347 got_int = FALSE;
3349 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3350 buf->b_saving = TRUE;
3353 * If we are not appending or filtering, the file exists, and the
3354 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3355 * When 'patchmode' is set also make a backup when appending.
3357 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3358 * off. This helps when editing large files on almost-full disks.
3360 if (!(append && *p_pm == NUL) && !filtering && perm >= 0 && dobackup)
3362 #if defined(UNIX) || defined(WIN32)
3363 struct stat st;
3364 #endif
3366 if ((bkc_flags & BKC_YES) || append) /* "yes" */
3367 backup_copy = TRUE;
3368 #if defined(UNIX) || defined(WIN32)
3369 else if ((bkc_flags & BKC_AUTO)) /* "auto" */
3371 int i;
3373 # ifdef UNIX
3375 * Don't rename the file when:
3376 * - it's a hard link
3377 * - it's a symbolic link
3378 * - we don't have write permission in the directory
3379 * - we can't set the owner/group of the new file
3381 if (st_old.st_nlink > 1
3382 || mch_lstat((char *)fname, &st) < 0
3383 || st.st_dev != st_old.st_dev
3384 || st.st_ino != st_old.st_ino
3385 # ifndef HAVE_FCHOWN
3386 || st.st_uid != st_old.st_uid
3387 || st.st_gid != st_old.st_gid
3388 # endif
3390 backup_copy = TRUE;
3391 else
3392 # else
3393 # ifdef WIN32
3394 /* On NTFS file systems hard links are possible. */
3395 if (mch_is_linked(fname))
3396 backup_copy = TRUE;
3397 else
3398 # endif
3399 # endif
3402 * Check if we can create a file and set the owner/group to
3403 * the ones from the original file.
3404 * First find a file name that doesn't exist yet (use some
3405 * arbitrary numbers).
3407 STRCPY(IObuff, fname);
3408 for (i = 4913; ; i += 123)
3410 sprintf((char *)gettail(IObuff), "%d", i);
3411 if (mch_lstat((char *)IObuff, &st) < 0)
3412 break;
3414 fd = mch_open((char *)IObuff,
3415 O_CREAT|O_WRONLY|O_EXCL|O_NOFOLLOW, perm);
3416 if (fd < 0) /* can't write in directory */
3417 backup_copy = TRUE;
3418 else
3420 # ifdef UNIX
3421 # ifdef HAVE_FCHOWN
3422 fchown(fd, st_old.st_uid, st_old.st_gid);
3423 # endif
3424 if (mch_stat((char *)IObuff, &st) < 0
3425 || st.st_uid != st_old.st_uid
3426 || st.st_gid != st_old.st_gid
3427 || st.st_mode != perm)
3428 backup_copy = TRUE;
3429 # endif
3430 /* Close the file before removing it, on MS-Windows we
3431 * can't delete an open file. */
3432 close(fd);
3433 mch_remove(IObuff);
3438 # ifdef UNIX
3440 * Break symlinks and/or hardlinks if we've been asked to.
3442 if ((bkc_flags & BKC_BREAKSYMLINK) || (bkc_flags & BKC_BREAKHARDLINK))
3444 int lstat_res;
3446 lstat_res = mch_lstat((char *)fname, &st);
3448 /* Symlinks. */
3449 if ((bkc_flags & BKC_BREAKSYMLINK)
3450 && lstat_res == 0
3451 && st.st_ino != st_old.st_ino)
3452 backup_copy = FALSE;
3454 /* Hardlinks. */
3455 if ((bkc_flags & BKC_BREAKHARDLINK)
3456 && st_old.st_nlink > 1
3457 && (lstat_res != 0 || st.st_ino == st_old.st_ino))
3458 backup_copy = FALSE;
3460 #endif
3462 #endif
3464 /* make sure we have a valid backup extension to use */
3465 if (*p_bex == NUL)
3467 #ifdef RISCOS
3468 backup_ext = (char_u *)"/bak";
3469 #else
3470 backup_ext = (char_u *)".bak";
3471 #endif
3473 else
3474 backup_ext = p_bex;
3476 if (backup_copy
3477 && (fd = mch_open((char *)fname, O_RDONLY | O_EXTRA, 0)) >= 0)
3479 int bfd;
3480 char_u *copybuf, *wp;
3481 int some_error = FALSE;
3482 struct stat st_new;
3483 char_u *dirp;
3484 char_u *rootname;
3485 #if defined(UNIX) && !defined(SHORT_FNAME)
3486 int did_set_shortname;
3487 #endif
3489 copybuf = alloc(BUFSIZE + 1);
3490 if (copybuf == NULL)
3492 some_error = TRUE; /* out of memory */
3493 goto nobackup;
3497 * Try to make the backup in each directory in the 'bdir' option.
3499 * Unix semantics has it, that we may have a writable file,
3500 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3501 * - the directory is not writable,
3502 * - the file may be a symbolic link,
3503 * - the file may belong to another user/group, etc.
3505 * For these reasons, the existing writable file must be truncated
3506 * and reused. Creation of a backup COPY will be attempted.
3508 dirp = p_bdir;
3509 while (*dirp)
3511 #ifdef UNIX
3512 st_new.st_ino = 0;
3513 st_new.st_dev = 0;
3514 st_new.st_gid = 0;
3515 #endif
3518 * Isolate one directory name, using an entry in 'bdir'.
3520 (void)copy_option_part(&dirp, copybuf, BUFSIZE, ",");
3521 rootname = get_file_in_dir(fname, copybuf);
3522 if (rootname == NULL)
3524 some_error = TRUE; /* out of memory */
3525 goto nobackup;
3528 #if defined(UNIX) && !defined(SHORT_FNAME)
3529 did_set_shortname = FALSE;
3530 #endif
3533 * May try twice if 'shortname' not set.
3535 for (;;)
3538 * Make backup file name.
3540 backup = buf_modname(
3541 #ifdef SHORT_FNAME
3542 TRUE,
3543 #else
3544 (buf->b_p_sn || buf->b_shortname),
3545 #endif
3546 rootname, backup_ext, FALSE);
3547 if (backup == NULL)
3549 vim_free(rootname);
3550 some_error = TRUE; /* out of memory */
3551 goto nobackup;
3555 * Check if backup file already exists.
3557 if (mch_stat((char *)backup, &st_new) >= 0)
3559 #ifdef UNIX
3561 * Check if backup file is same as original file.
3562 * May happen when modname() gave the same file back.
3563 * E.g. silly link, or file name-length reached.
3564 * If we don't check here, we either ruin the file
3565 * when copying or erase it after writing. jw.
3567 if (st_new.st_dev == st_old.st_dev
3568 && st_new.st_ino == st_old.st_ino)
3570 vim_free(backup);
3571 backup = NULL; /* no backup file to delete */
3572 # ifndef SHORT_FNAME
3574 * may try again with 'shortname' set
3576 if (!(buf->b_shortname || buf->b_p_sn))
3578 buf->b_shortname = TRUE;
3579 did_set_shortname = TRUE;
3580 continue;
3582 /* setting shortname didn't help */
3583 if (did_set_shortname)
3584 buf->b_shortname = FALSE;
3585 # endif
3586 break;
3588 #endif
3591 * If we are not going to keep the backup file, don't
3592 * delete an existing one, try to use another name.
3593 * Change one character, just before the extension.
3595 if (!p_bk)
3597 wp = backup + STRLEN(backup) - 1
3598 - STRLEN(backup_ext);
3599 if (wp < backup) /* empty file name ??? */
3600 wp = backup;
3601 *wp = 'z';
3602 while (*wp > 'a'
3603 && mch_stat((char *)backup, &st_new) >= 0)
3604 --*wp;
3605 /* They all exist??? Must be something wrong. */
3606 if (*wp == 'a')
3608 vim_free(backup);
3609 backup = NULL;
3613 break;
3615 vim_free(rootname);
3618 * Try to create the backup file
3620 if (backup != NULL)
3622 /* remove old backup, if present */
3623 mch_remove(backup);
3624 /* Open with O_EXCL to avoid the file being created while
3625 * we were sleeping (symlink hacker attack?) */
3626 bfd = mch_open((char *)backup,
3627 O_WRONLY|O_CREAT|O_EXTRA|O_EXCL|O_NOFOLLOW,
3628 perm & 0777);
3629 if (bfd < 0)
3631 vim_free(backup);
3632 backup = NULL;
3634 else
3636 /* set file protection same as original file, but
3637 * strip s-bit */
3638 (void)mch_setperm(backup, perm & 0777);
3640 #ifdef UNIX
3642 * Try to set the group of the backup same as the
3643 * original file. If this fails, set the protection
3644 * bits for the group same as the protection bits for
3645 * others.
3647 if (st_new.st_gid != st_old.st_gid
3648 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3649 && fchown(bfd, (uid_t)-1, st_old.st_gid) != 0
3650 # endif
3652 mch_setperm(backup,
3653 (perm & 0707) | ((perm & 07) << 3));
3654 #endif
3657 * copy the file.
3659 write_info.bw_fd = bfd;
3660 write_info.bw_buf = copybuf;
3661 #ifdef HAS_BW_FLAGS
3662 write_info.bw_flags = FIO_NOCONVERT;
3663 #endif
3664 while ((write_info.bw_len = vim_read(fd, copybuf,
3665 BUFSIZE)) > 0)
3667 if (buf_write_bytes(&write_info) == FAIL)
3669 errmsg = (char_u *)_("E506: Can't write to backup file (add ! to override)");
3670 break;
3672 ui_breakcheck();
3673 if (got_int)
3675 errmsg = (char_u *)_(e_interr);
3676 break;
3680 if (close(bfd) < 0 && errmsg == NULL)
3681 errmsg = (char_u *)_("E507: Close error for backup file (add ! to override)");
3682 if (write_info.bw_len < 0)
3683 errmsg = (char_u *)_("E508: Can't read file for backup (add ! to override)");
3684 #ifdef UNIX
3685 set_file_time(backup, st_old.st_atime, st_old.st_mtime);
3686 #endif
3687 #ifdef HAVE_ACL
3688 mch_set_acl(backup, acl);
3689 #endif
3690 break;
3694 nobackup:
3695 close(fd); /* ignore errors for closing read file */
3696 vim_free(copybuf);
3698 if (backup == NULL && errmsg == NULL)
3699 errmsg = (char_u *)_("E509: Cannot create backup file (add ! to override)");
3700 /* ignore errors when forceit is TRUE */
3701 if ((some_error || errmsg != NULL) && !forceit)
3703 retval = FAIL;
3704 goto fail;
3706 errmsg = NULL;
3708 else
3710 char_u *dirp;
3711 char_u *p;
3712 char_u *rootname;
3715 * Make a backup by renaming the original file.
3718 * If 'cpoptions' includes the "W" flag, we don't want to
3719 * overwrite a read-only file. But rename may be possible
3720 * anyway, thus we need an extra check here.
3722 if (file_readonly && vim_strchr(p_cpo, CPO_FWRITE) != NULL)
3724 errnum = (char_u *)"E504: ";
3725 errmsg = (char_u *)_(err_readonly);
3726 goto fail;
3731 * Form the backup file name - change path/fo.o.h to
3732 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3733 * that works is used.
3735 dirp = p_bdir;
3736 while (*dirp)
3739 * Isolate one directory name and make the backup file name.
3741 (void)copy_option_part(&dirp, IObuff, IOSIZE, ",");
3742 rootname = get_file_in_dir(fname, IObuff);
3743 if (rootname == NULL)
3744 backup = NULL;
3745 else
3747 backup = buf_modname(
3748 #ifdef SHORT_FNAME
3749 TRUE,
3750 #else
3751 (buf->b_p_sn || buf->b_shortname),
3752 #endif
3753 rootname, backup_ext, FALSE);
3754 vim_free(rootname);
3757 if (backup != NULL)
3760 * If we are not going to keep the backup file, don't
3761 * delete an existing one, try to use another name.
3762 * Change one character, just before the extension.
3764 if (!p_bk && mch_getperm(backup) >= 0)
3766 p = backup + STRLEN(backup) - 1 - STRLEN(backup_ext);
3767 if (p < backup) /* empty file name ??? */
3768 p = backup;
3769 *p = 'z';
3770 while (*p > 'a' && mch_getperm(backup) >= 0)
3771 --*p;
3772 /* They all exist??? Must be something wrong! */
3773 if (*p == 'a')
3775 vim_free(backup);
3776 backup = NULL;
3780 if (backup != NULL)
3783 * Delete any existing backup and move the current version
3784 * to the backup. For safety, we don't remove the backup
3785 * until the write has finished successfully. And if the
3786 * 'backup' option is set, leave it around.
3789 * If the renaming of the original file to the backup file
3790 * works, quit here.
3792 if (vim_rename(fname, backup) == 0)
3793 break;
3795 vim_free(backup); /* don't do the rename below */
3796 backup = NULL;
3799 if (backup == NULL && !forceit)
3801 errmsg = (char_u *)_("E510: Can't make backup file (add ! to override)");
3802 goto fail;
3807 #if defined(UNIX) && !defined(ARCHIE)
3808 /* When using ":w!" and the file was read-only: make it writable */
3809 if (forceit && perm >= 0 && !(perm & 0200) && st_old.st_uid == getuid()
3810 && vim_strchr(p_cpo, CPO_FWRITE) == NULL)
3812 perm |= 0200;
3813 (void)mch_setperm(fname, perm);
3814 made_writable = TRUE;
3816 #endif
3818 /* When using ":w!" and writing to the current file, 'readonly' makes no
3819 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3820 if (forceit && overwriting && vim_strchr(p_cpo, CPO_KEEPRO) == NULL)
3822 buf->b_p_ro = FALSE;
3823 #ifdef FEAT_TITLE
3824 need_maketitle = TRUE; /* set window title later */
3825 #endif
3826 #ifdef FEAT_WINDOWS
3827 status_redraw_all(); /* redraw status lines later */
3828 #endif
3831 if (end > buf->b_ml.ml_line_count)
3832 end = buf->b_ml.ml_line_count;
3833 if (buf->b_ml.ml_flags & ML_EMPTY)
3834 start = end + 1;
3837 * If the original file is being overwritten, there is a small chance that
3838 * we crash in the middle of writing. Therefore the file is preserved now.
3839 * This makes all block numbers positive so that recovery does not need
3840 * the original file.
3841 * Don't do this if there is a backup file and we are exiting.
3843 if (reset_changed && !newfile && overwriting
3844 && !(exiting && backup != NULL))
3846 ml_preserve(buf, FALSE);
3847 if (got_int)
3849 errmsg = (char_u *)_(e_interr);
3850 goto restore_backup;
3854 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3856 * Before risking to lose the original file verify if there's
3857 * a resource fork to preserve, and if cannot be done warn
3858 * the users. This happens when overwriting without backups.
3860 if (backup == NULL && overwriting && !append)
3861 if (mch_has_resource_fork(fname))
3863 errmsg = (char_u *)_("E460: The resource fork would be lost (add ! to override)");
3864 goto restore_backup;
3866 #endif
3868 #ifdef VMS
3869 vms_remove_version(fname); /* remove version */
3870 #endif
3871 /* Default: write the the file directly. May write to a temp file for
3872 * multi-byte conversion. */
3873 wfname = fname;
3875 #ifdef FEAT_MBYTE
3876 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3877 if (eap != NULL && eap->force_enc != 0)
3879 fenc = eap->cmd + eap->force_enc;
3880 fenc = enc_canonize(fenc);
3881 fenc_tofree = fenc;
3883 else
3884 fenc = buf->b_p_fenc;
3887 * The file needs to be converted when 'fileencoding' is set and
3888 * 'fileencoding' differs from 'encoding'.
3890 converted = (*fenc != NUL && !same_encoding(p_enc, fenc));
3893 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3894 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3895 * Prepare the flags for it and allocate bw_conv_buf when needed.
3897 if (converted && (enc_utf8 || STRCMP(p_enc, "latin1") == 0))
3899 wb_flags = get_fio_flags(fenc);
3900 if (wb_flags & (FIO_UCS2 | FIO_UCS4 | FIO_UTF16 | FIO_UTF8))
3902 /* Need to allocate a buffer to translate into. */
3903 if (wb_flags & (FIO_UCS2 | FIO_UTF16 | FIO_UTF8))
3904 write_info.bw_conv_buflen = bufsize * 2;
3905 else /* FIO_UCS4 */
3906 write_info.bw_conv_buflen = bufsize * 4;
3907 write_info.bw_conv_buf
3908 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3909 if (write_info.bw_conv_buf == NULL)
3910 end = 0;
3914 # ifdef WIN3264
3915 if (converted && wb_flags == 0 && (wb_flags = get_win_fio_flags(fenc)) != 0)
3917 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
3918 write_info.bw_conv_buflen = bufsize * 4;
3919 write_info.bw_conv_buf
3920 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3921 if (write_info.bw_conv_buf == NULL)
3922 end = 0;
3924 # endif
3926 # ifdef MACOS_X
3927 if (converted && wb_flags == 0 && (wb_flags = get_mac_fio_flags(fenc)) != 0)
3929 write_info.bw_conv_buflen = bufsize * 3;
3930 write_info.bw_conv_buf
3931 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3932 if (write_info.bw_conv_buf == NULL)
3933 end = 0;
3935 # endif
3937 # if defined(FEAT_EVAL) || defined(USE_ICONV)
3938 if (converted && wb_flags == 0)
3940 # ifdef USE_ICONV
3942 * Use iconv() conversion when conversion is needed and it's not done
3943 * internally.
3945 write_info.bw_iconv_fd = (iconv_t)my_iconv_open(fenc,
3946 enc_utf8 ? (char_u *)"utf-8" : p_enc);
3947 if (write_info.bw_iconv_fd != (iconv_t)-1)
3949 /* We're going to use iconv(), allocate a buffer to convert in. */
3950 write_info.bw_conv_buflen = bufsize * ICONV_MULT;
3951 write_info.bw_conv_buf
3952 = lalloc((long_u)write_info.bw_conv_buflen, TRUE);
3953 if (write_info.bw_conv_buf == NULL)
3954 end = 0;
3955 write_info.bw_first = TRUE;
3957 # ifdef FEAT_EVAL
3958 else
3959 # endif
3960 # endif
3962 # ifdef FEAT_EVAL
3964 * When the file needs to be converted with 'charconvert' after
3965 * writing, write to a temp file instead and let the conversion
3966 * overwrite the original file.
3968 if (*p_ccv != NUL)
3970 wfname = vim_tempname('w');
3971 if (wfname == NULL) /* Can't write without a tempfile! */
3973 errmsg = (char_u *)_("E214: Can't find temp file for writing");
3974 goto restore_backup;
3977 # endif
3979 # endif
3980 if (converted && wb_flags == 0
3981 # ifdef USE_ICONV
3982 && write_info.bw_iconv_fd == (iconv_t)-1
3983 # endif
3984 # ifdef FEAT_EVAL
3985 && wfname == fname
3986 # endif
3989 if (!forceit)
3991 errmsg = (char_u *)_("E213: Cannot convert (add ! to write without conversion)");
3992 goto restore_backup;
3994 notconverted = TRUE;
3996 #endif
3999 * Open the file "wfname" for writing.
4000 * We may try to open the file twice: If we can't write to the
4001 * file and forceit is TRUE we delete the existing file and try to create
4002 * a new one. If this still fails we may have lost the original file!
4003 * (this may happen when the user reached his quotum for number of files).
4004 * Appending will fail if the file does not exist and forceit is FALSE.
4006 while ((fd = mch_open((char *)wfname, O_WRONLY | O_EXTRA | (append
4007 ? (forceit ? (O_APPEND | O_CREAT) : O_APPEND)
4008 : (O_CREAT | O_TRUNC))
4009 , perm < 0 ? 0666 : (perm & 0777))) < 0)
4012 * A forced write will try to create a new file if the old one is
4013 * still readonly. This may also happen when the directory is
4014 * read-only. In that case the mch_remove() will fail.
4016 if (errmsg == NULL)
4018 #ifdef UNIX
4019 struct stat st;
4021 /* Don't delete the file when it's a hard or symbolic link. */
4022 if ((!newfile && st_old.st_nlink > 1)
4023 || (mch_lstat((char *)fname, &st) == 0
4024 && (st.st_dev != st_old.st_dev
4025 || st.st_ino != st_old.st_ino)))
4026 errmsg = (char_u *)_("E166: Can't open linked file for writing");
4027 else
4028 #endif
4030 errmsg = (char_u *)_("E212: Can't open file for writing");
4031 if (forceit && vim_strchr(p_cpo, CPO_FWRITE) == NULL
4032 && perm >= 0)
4034 #ifdef UNIX
4035 /* we write to the file, thus it should be marked
4036 writable after all */
4037 if (!(perm & 0200))
4038 made_writable = TRUE;
4039 perm |= 0200;
4040 if (st_old.st_uid != getuid() || st_old.st_gid != getgid())
4041 perm &= 0777;
4042 #endif
4043 if (!append) /* don't remove when appending */
4044 mch_remove(wfname);
4045 continue;
4050 restore_backup:
4052 struct stat st;
4055 * If we failed to open the file, we don't need a backup. Throw it
4056 * away. If we moved or removed the original file try to put the
4057 * backup in its place.
4059 if (backup != NULL && wfname == fname)
4061 if (backup_copy)
4064 * There is a small chance that we removed the original,
4065 * try to move the copy in its place.
4066 * This may not work if the vim_rename() fails.
4067 * In that case we leave the copy around.
4069 /* If file does not exist, put the copy in its place */
4070 if (mch_stat((char *)fname, &st) < 0)
4071 vim_rename(backup, fname);
4072 /* if original file does exist throw away the copy */
4073 if (mch_stat((char *)fname, &st) >= 0)
4074 mch_remove(backup);
4076 else
4078 /* try to put the original file back */
4079 vim_rename(backup, fname);
4083 /* if original file no longer exists give an extra warning */
4084 if (!newfile && mch_stat((char *)fname, &st) < 0)
4085 end = 0;
4088 #ifdef FEAT_MBYTE
4089 if (wfname != fname)
4090 vim_free(wfname);
4091 #endif
4092 goto fail;
4094 errmsg = NULL;
4096 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4097 /* TODO: Is it need for MACOS_X? (Dany) */
4099 * On macintosh copy the original files attributes (i.e. the backup)
4100 * This is done in order to preserve the resource fork and the
4101 * Finder attribute (label, comments, custom icons, file creator)
4103 if (backup != NULL && overwriting && !append)
4105 if (backup_copy)
4106 (void)mch_copy_file_attribute(wfname, backup);
4107 else
4108 (void)mch_copy_file_attribute(backup, wfname);
4111 if (!overwriting && !append)
4113 if (buf->b_ffname != NULL)
4114 (void)mch_copy_file_attribute(buf->b_ffname, wfname);
4115 /* Should copy resource fork */
4117 #endif
4119 write_info.bw_fd = fd;
4121 #ifdef FEAT_CRYPT
4122 if (*buf->b_p_key && !filtering)
4124 crypt_init_keys(buf->b_p_key);
4125 /* Write magic number, so that Vim knows that this file is encrypted
4126 * when reading it again. This also undergoes utf-8 to ucs-2/4
4127 * conversion when needed. */
4128 write_info.bw_buf = (char_u *)CRYPT_MAGIC;
4129 write_info.bw_len = CRYPT_MAGIC_LEN;
4130 write_info.bw_flags = FIO_NOCONVERT;
4131 if (buf_write_bytes(&write_info) == FAIL)
4132 end = 0;
4133 wb_flags |= FIO_ENCRYPTED;
4135 #endif
4137 write_info.bw_buf = buffer;
4138 nchars = 0;
4140 /* use "++bin", "++nobin" or 'binary' */
4141 if (eap != NULL && eap->force_bin != 0)
4142 write_bin = (eap->force_bin == FORCE_BIN);
4143 else
4144 write_bin = buf->b_p_bin;
4146 #ifdef FEAT_MBYTE
4148 * The BOM is written just after the encryption magic number.
4149 * Skip it when appending and the file already existed, the BOM only makes
4150 * sense at the start of the file.
4152 if (buf->b_p_bomb && !write_bin && (!append || perm < 0))
4154 write_info.bw_len = make_bom(buffer, fenc);
4155 if (write_info.bw_len > 0)
4157 /* don't convert, do encryption */
4158 write_info.bw_flags = FIO_NOCONVERT | wb_flags;
4159 if (buf_write_bytes(&write_info) == FAIL)
4160 end = 0;
4161 else
4162 nchars += write_info.bw_len;
4165 #endif
4167 write_info.bw_len = bufsize;
4168 #ifdef HAS_BW_FLAGS
4169 write_info.bw_flags = wb_flags;
4170 #endif
4171 fileformat = get_fileformat_force(buf, eap);
4172 s = buffer;
4173 len = 0;
4174 for (lnum = start; lnum <= end; ++lnum)
4177 * The next while loop is done once for each character written.
4178 * Keep it fast!
4180 ptr = ml_get_buf(buf, lnum, FALSE) - 1;
4181 while ((c = *++ptr) != NUL)
4183 if (c == NL)
4184 *s = NUL; /* replace newlines with NULs */
4185 else if (c == CAR && fileformat == EOL_MAC)
4186 *s = NL; /* Mac: replace CRs with NLs */
4187 else
4188 *s = c;
4189 ++s;
4190 if (++len != bufsize)
4191 continue;
4192 if (buf_write_bytes(&write_info) == FAIL)
4194 end = 0; /* write error: break loop */
4195 break;
4197 nchars += bufsize;
4198 s = buffer;
4199 len = 0;
4201 /* write failed or last line has no EOL: stop here */
4202 if (end == 0
4203 || (lnum == end
4204 && write_bin
4205 && (lnum == write_no_eol_lnum
4206 || (lnum == buf->b_ml.ml_line_count && !buf->b_p_eol))))
4208 ++lnum; /* written the line, count it */
4209 no_eol = TRUE;
4210 break;
4212 if (fileformat == EOL_UNIX)
4213 *s++ = NL;
4214 else
4216 *s++ = CAR; /* EOL_MAC or EOL_DOS: write CR */
4217 if (fileformat == EOL_DOS) /* write CR-NL */
4219 if (++len == bufsize)
4221 if (buf_write_bytes(&write_info) == FAIL)
4223 end = 0; /* write error: break loop */
4224 break;
4226 nchars += bufsize;
4227 s = buffer;
4228 len = 0;
4230 *s++ = NL;
4233 if (++len == bufsize && end)
4235 if (buf_write_bytes(&write_info) == FAIL)
4237 end = 0; /* write error: break loop */
4238 break;
4240 nchars += bufsize;
4241 s = buffer;
4242 len = 0;
4244 ui_breakcheck();
4245 if (got_int)
4247 end = 0; /* Interrupted, break loop */
4248 break;
4251 #ifdef VMS
4253 * On VMS there is a problem: newlines get added when writing blocks
4254 * at a time. Fix it by writing a line at a time.
4255 * This is much slower!
4256 * Explanation: VAX/DECC RTL insists that records in some RMS
4257 * structures end with a newline (carriage return) character, and if
4258 * they don't it adds one.
4259 * With other RMS structures it works perfect without this fix.
4261 if (buf->b_fab_rfm == FAB$C_VFC
4262 || ((buf->b_fab_rat & (FAB$M_FTN | FAB$M_CR)) != 0))
4264 int b2write;
4266 buf->b_fab_mrs = (buf->b_fab_mrs == 0
4267 ? MIN(4096, bufsize)
4268 : MIN(buf->b_fab_mrs, bufsize));
4270 b2write = len;
4271 while (b2write > 0)
4273 write_info.bw_len = MIN(b2write, buf->b_fab_mrs);
4274 if (buf_write_bytes(&write_info) == FAIL)
4276 end = 0;
4277 break;
4279 b2write -= MIN(b2write, buf->b_fab_mrs);
4281 write_info.bw_len = bufsize;
4282 nchars += len;
4283 s = buffer;
4284 len = 0;
4286 #endif
4288 if (len > 0 && end > 0)
4290 write_info.bw_len = len;
4291 if (buf_write_bytes(&write_info) == FAIL)
4292 end = 0; /* write error */
4293 nchars += len;
4296 #if defined(UNIX) && defined(HAVE_FSYNC)
4297 /* On many journalling file systems there is a bug that causes both the
4298 * original and the backup file to be lost when halting the system right
4299 * after writing the file. That's because only the meta-data is
4300 * journalled. Syncing the file slows down the system, but assures it has
4301 * been written to disk and we don't lose it.
4302 * For a device do try the fsync() but don't complain if it does not work
4303 * (could be a pipe).
4304 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4305 if (p_fs && fsync(fd) != 0 && !device)
4307 errmsg = (char_u *)_("E667: Fsync failed");
4308 end = 0;
4310 #endif
4312 #ifdef UNIX
4313 /* When creating a new file, set its owner/group to that of the original
4314 * file. Get the new device and inode number. */
4315 if (backup != NULL && !backup_copy)
4317 # ifdef HAVE_FCHOWN
4318 struct stat st;
4320 /* don't change the owner when it's already OK, some systems remove
4321 * permission or ACL stuff */
4322 if (mch_stat((char *)wfname, &st) < 0
4323 || st.st_uid != st_old.st_uid
4324 || st.st_gid != st_old.st_gid)
4326 fchown(fd, st_old.st_uid, st_old.st_gid);
4327 if (perm >= 0) /* set permission again, may have changed */
4328 (void)mch_setperm(wfname, perm);
4330 # endif
4331 buf_setino(buf);
4333 else if (buf->b_dev < 0)
4334 /* Set the inode when creating a new file. */
4335 buf_setino(buf);
4336 #endif
4338 if (close(fd) != 0)
4340 errmsg = (char_u *)_("E512: Close failed");
4341 end = 0;
4344 #ifdef UNIX
4345 if (made_writable)
4346 perm &= ~0200; /* reset 'w' bit for security reasons */
4347 #endif
4348 if (perm >= 0) /* set perm. of new file same as old file */
4349 (void)mch_setperm(wfname, perm);
4350 #ifdef RISCOS
4351 if (!append && !filtering)
4352 /* Set the filetype after writing the file. */
4353 mch_set_filetype(wfname, buf->b_p_oft);
4354 #endif
4355 #ifdef HAVE_ACL
4356 /* Probably need to set the ACL before changing the user (can't set the
4357 * ACL on a file the user doesn't own). */
4358 if (!backup_copy)
4359 mch_set_acl(wfname, acl);
4360 #endif
4363 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4364 if (wfname != fname)
4367 * The file was written to a temp file, now it needs to be converted
4368 * with 'charconvert' to (overwrite) the output file.
4370 if (end != 0)
4372 if (eval_charconvert(enc_utf8 ? (char_u *)"utf-8" : p_enc, fenc,
4373 wfname, fname) == FAIL)
4375 write_info.bw_conv_error = TRUE;
4376 end = 0;
4379 mch_remove(wfname);
4380 vim_free(wfname);
4382 #endif
4384 if (end == 0)
4386 if (errmsg == NULL)
4388 #ifdef FEAT_MBYTE
4389 if (write_info.bw_conv_error)
4390 errmsg = (char_u *)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4391 else
4392 #endif
4393 if (got_int)
4394 errmsg = (char_u *)_(e_interr);
4395 else
4396 errmsg = (char_u *)_("E514: write error (file system full?)");
4400 * If we have a backup file, try to put it in place of the new file,
4401 * because the new file is probably corrupt. This avoids loosing the
4402 * original file when trying to make a backup when writing the file a
4403 * second time.
4404 * When "backup_copy" is set we need to copy the backup over the new
4405 * file. Otherwise rename the backup file.
4406 * If this is OK, don't give the extra warning message.
4408 if (backup != NULL)
4410 if (backup_copy)
4412 /* This may take a while, if we were interrupted let the user
4413 * know we got the message. */
4414 if (got_int)
4416 MSG(_(e_interr));
4417 out_flush();
4419 if ((fd = mch_open((char *)backup, O_RDONLY | O_EXTRA, 0)) >= 0)
4421 if ((write_info.bw_fd = mch_open((char *)fname,
4422 O_WRONLY | O_CREAT | O_TRUNC | O_EXTRA,
4423 perm & 0777)) >= 0)
4425 /* copy the file. */
4426 write_info.bw_buf = smallbuf;
4427 #ifdef HAS_BW_FLAGS
4428 write_info.bw_flags = FIO_NOCONVERT;
4429 #endif
4430 while ((write_info.bw_len = vim_read(fd, smallbuf,
4431 SMBUFSIZE)) > 0)
4432 if (buf_write_bytes(&write_info) == FAIL)
4433 break;
4435 if (close(write_info.bw_fd) >= 0
4436 && write_info.bw_len == 0)
4437 end = 1; /* success */
4439 close(fd); /* ignore errors for closing read file */
4442 else
4444 if (vim_rename(backup, fname) == 0)
4445 end = 1;
4448 goto fail;
4451 lnum -= start; /* compute number of written lines */
4452 --no_wait_return; /* may wait for return now */
4454 #if !(defined(UNIX) || defined(VMS))
4455 fname = sfname; /* use shortname now, for the messages */
4456 #endif
4457 if (!filtering)
4459 msg_add_fname(buf, fname); /* put fname in IObuff with quotes */
4460 c = FALSE;
4461 #ifdef FEAT_MBYTE
4462 if (write_info.bw_conv_error)
4464 STRCAT(IObuff, _(" CONVERSION ERROR"));
4465 c = TRUE;
4467 else if (notconverted)
4469 STRCAT(IObuff, _("[NOT converted]"));
4470 c = TRUE;
4472 else if (converted)
4474 STRCAT(IObuff, _("[converted]"));
4475 c = TRUE;
4477 #endif
4478 if (device)
4480 STRCAT(IObuff, _("[Device]"));
4481 c = TRUE;
4483 else if (newfile)
4485 STRCAT(IObuff, shortmess(SHM_NEW) ? _("[New]") : _("[New File]"));
4486 c = TRUE;
4488 if (no_eol)
4490 msg_add_eol();
4491 c = TRUE;
4493 /* may add [unix/dos/mac] */
4494 if (msg_add_fileformat(fileformat))
4495 c = TRUE;
4496 #ifdef FEAT_CRYPT
4497 if (wb_flags & FIO_ENCRYPTED)
4499 STRCAT(IObuff, _("[crypted]"));
4500 c = TRUE;
4502 #endif
4503 msg_add_lines(c, (long)lnum, nchars); /* add line/char count */
4504 if (!shortmess(SHM_WRITE))
4506 if (append)
4507 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [a]") : _(" appended"));
4508 else
4509 STRCAT(IObuff, shortmess(SHM_WRI) ? _(" [w]") : _(" written"));
4512 set_keep_msg(msg_trunc_attr(IObuff, FALSE, 0), 0);
4515 /* When written everything correctly: reset 'modified'. Unless not
4516 * writing to the original file and '+' is not in 'cpoptions'. */
4517 if (reset_changed && whole && !append
4518 #ifdef FEAT_MBYTE
4519 && !write_info.bw_conv_error
4520 #endif
4521 && (overwriting || vim_strchr(p_cpo, CPO_PLUS) != NULL)
4524 unchanged(buf, TRUE);
4525 u_unchanged(buf);
4529 * If written to the current file, update the timestamp of the swap file
4530 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4532 if (overwriting)
4534 ml_timestamp(buf);
4535 if (append)
4536 buf->b_flags &= ~BF_NEW;
4537 else
4538 buf->b_flags &= ~BF_WRITE_MASK;
4542 * If we kept a backup until now, and we are in patch mode, then we make
4543 * the backup file our 'original' file.
4545 if (*p_pm && dobackup)
4547 char *org = (char *)buf_modname(
4548 #ifdef SHORT_FNAME
4549 TRUE,
4550 #else
4551 (buf->b_p_sn || buf->b_shortname),
4552 #endif
4553 fname, p_pm, FALSE);
4555 if (backup != NULL)
4557 struct stat st;
4560 * If the original file does not exist yet
4561 * the current backup file becomes the original file
4563 if (org == NULL)
4564 EMSG(_("E205: Patchmode: can't save original file"));
4565 else if (mch_stat(org, &st) < 0)
4567 vim_rename(backup, (char_u *)org);
4568 vim_free(backup); /* don't delete the file */
4569 backup = NULL;
4570 #ifdef UNIX
4571 set_file_time((char_u *)org, st_old.st_atime, st_old.st_mtime);
4572 #endif
4576 * If there is no backup file, remember that a (new) file was
4577 * created.
4579 else
4581 int empty_fd;
4583 if (org == NULL
4584 || (empty_fd = mch_open(org,
4585 O_CREAT | O_EXTRA | O_EXCL | O_NOFOLLOW,
4586 perm < 0 ? 0666 : (perm & 0777))) < 0)
4587 EMSG(_("E206: patchmode: can't touch empty original file"));
4588 else
4589 close(empty_fd);
4591 if (org != NULL)
4593 mch_setperm((char_u *)org, mch_getperm(fname) & 0777);
4594 vim_free(org);
4599 * Remove the backup unless 'backup' option is set
4601 if (!p_bk && backup != NULL && mch_remove(backup) != 0)
4602 EMSG(_("E207: Can't delete backup file"));
4604 #ifdef FEAT_SUN_WORKSHOP
4605 if (usingSunWorkShop)
4606 workshop_file_saved((char *) ffname);
4607 #endif
4609 goto nofail;
4612 * Finish up. We get here either after failure or success.
4614 fail:
4615 --no_wait_return; /* may wait for return now */
4616 nofail:
4618 /* Done saving, we accept changed buffer warnings again */
4619 buf->b_saving = FALSE;
4621 vim_free(backup);
4622 if (buffer != smallbuf)
4623 vim_free(buffer);
4624 #ifdef FEAT_MBYTE
4625 vim_free(fenc_tofree);
4626 vim_free(write_info.bw_conv_buf);
4627 # ifdef USE_ICONV
4628 if (write_info.bw_iconv_fd != (iconv_t)-1)
4630 iconv_close(write_info.bw_iconv_fd);
4631 write_info.bw_iconv_fd = (iconv_t)-1;
4633 # endif
4634 #endif
4635 #ifdef HAVE_ACL
4636 mch_free_acl(acl);
4637 #endif
4639 if (errmsg != NULL)
4641 int numlen = errnum != NULL ? (int)STRLEN(errnum) : 0;
4643 attr = hl_attr(HLF_E); /* set highlight for error messages */
4644 msg_add_fname(buf,
4645 #ifndef UNIX
4646 sfname
4647 #else
4648 fname
4649 #endif
4650 ); /* put file name in IObuff with quotes */
4651 if (STRLEN(IObuff) + STRLEN(errmsg) + numlen >= IOSIZE)
4652 IObuff[IOSIZE - STRLEN(errmsg) - numlen - 1] = NUL;
4653 /* If the error message has the form "is ...", put the error number in
4654 * front of the file name. */
4655 if (errnum != NULL)
4657 mch_memmove(IObuff + numlen, IObuff, STRLEN(IObuff) + 1);
4658 mch_memmove(IObuff, errnum, (size_t)numlen);
4660 STRCAT(IObuff, errmsg);
4661 emsg(IObuff);
4663 retval = FAIL;
4664 if (end == 0)
4666 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4667 attr | MSG_HIST);
4668 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4669 attr | MSG_HIST);
4671 /* Update the timestamp to avoid an "overwrite changed file"
4672 * prompt when writing again. */
4673 if (mch_stat((char *)fname, &st_old) >= 0)
4675 buf_store_time(buf, &st_old, fname);
4676 buf->b_mtime_read = buf->b_mtime;
4680 msg_scroll = msg_save;
4682 #ifdef FEAT_AUTOCMD
4683 #ifdef FEAT_EVAL
4684 if (!should_abort(retval))
4685 #else
4686 if (!got_int)
4687 #endif
4689 aco_save_T aco;
4691 write_no_eol_lnum = 0; /* in case it was set by the previous read */
4694 * Apply POST autocommands.
4695 * Careful: The autocommands may call buf_write() recursively!
4697 aucmd_prepbuf(&aco, buf);
4699 if (append)
4700 apply_autocmds_exarg(EVENT_FILEAPPENDPOST, fname, fname,
4701 FALSE, curbuf, eap);
4702 else if (filtering)
4703 apply_autocmds_exarg(EVENT_FILTERWRITEPOST, NULL, fname,
4704 FALSE, curbuf, eap);
4705 else if (reset_changed && whole)
4706 apply_autocmds_exarg(EVENT_BUFWRITEPOST, fname, fname,
4707 FALSE, curbuf, eap);
4708 else
4709 apply_autocmds_exarg(EVENT_FILEWRITEPOST, fname, fname,
4710 FALSE, curbuf, eap);
4712 /* restore curwin/curbuf and a few other things */
4713 aucmd_restbuf(&aco);
4715 #ifdef FEAT_EVAL
4716 if (aborting()) /* autocmds may abort script processing */
4717 retval = FALSE;
4718 #endif
4720 #endif
4722 got_int |= prev_got_int;
4724 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4725 /* Update machine specific information. */
4726 mch_post_buffer_write(buf);
4727 #endif
4728 return retval;
4732 * Set the name of the current buffer. Use when the buffer doesn't have a
4733 * name and a ":r" or ":w" command with a file name is used.
4735 static int
4736 set_rw_fname(fname, sfname)
4737 char_u *fname;
4738 char_u *sfname;
4740 #ifdef FEAT_AUTOCMD
4741 /* It's like the unnamed buffer is deleted.... */
4742 if (curbuf->b_p_bl)
4743 apply_autocmds(EVENT_BUFDELETE, NULL, NULL, FALSE, curbuf);
4744 apply_autocmds(EVENT_BUFWIPEOUT, NULL, NULL, FALSE, curbuf);
4745 # ifdef FEAT_EVAL
4746 if (aborting()) /* autocmds may abort script processing */
4747 return FAIL;
4748 # endif
4749 #endif
4751 if (setfname(curbuf, fname, sfname, FALSE) == OK)
4752 curbuf->b_flags |= BF_NOTEDITED;
4754 #ifdef FEAT_AUTOCMD
4755 /* ....and a new named one is created */
4756 apply_autocmds(EVENT_BUFNEW, NULL, NULL, FALSE, curbuf);
4757 if (curbuf->b_p_bl)
4758 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, curbuf);
4759 # ifdef FEAT_EVAL
4760 if (aborting()) /* autocmds may abort script processing */
4761 return FAIL;
4762 # endif
4764 /* Do filetype detection now if 'filetype' is empty. */
4765 if (*curbuf->b_p_ft == NUL)
4767 if (au_has_group((char_u *)"filetypedetect"))
4768 (void)do_doautocmd((char_u *)"filetypedetect BufRead", FALSE);
4769 do_modelines(0);
4771 #endif
4773 return OK;
4777 * Put file name into IObuff with quotes.
4779 void
4780 msg_add_fname(buf, fname)
4781 buf_T *buf;
4782 char_u *fname;
4784 if (fname == NULL)
4785 fname = (char_u *)"-stdin-";
4786 home_replace(buf, fname, IObuff + 1, IOSIZE - 4, TRUE);
4787 IObuff[0] = '"';
4788 STRCAT(IObuff, "\" ");
4792 * Append message for text mode to IObuff.
4793 * Return TRUE if something appended.
4795 static int
4796 msg_add_fileformat(eol_type)
4797 int eol_type;
4799 #ifndef USE_CRNL
4800 if (eol_type == EOL_DOS)
4802 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[dos]") : _("[dos format]"));
4803 return TRUE;
4805 #endif
4806 #ifndef USE_CR
4807 if (eol_type == EOL_MAC)
4809 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[mac]") : _("[mac format]"));
4810 return TRUE;
4812 #endif
4813 #if defined(USE_CRNL) || defined(USE_CR)
4814 if (eol_type == EOL_UNIX)
4816 STRCAT(IObuff, shortmess(SHM_TEXT) ? _("[unix]") : _("[unix format]"));
4817 return TRUE;
4819 #endif
4820 return FALSE;
4824 * Append line and character count to IObuff.
4826 void
4827 msg_add_lines(insert_space, lnum, nchars)
4828 int insert_space;
4829 long lnum;
4830 long nchars;
4832 char_u *p;
4834 p = IObuff + STRLEN(IObuff);
4836 if (insert_space)
4837 *p++ = ' ';
4838 if (shortmess(SHM_LINES))
4839 sprintf((char *)p, "%ldL, %ldC", lnum, nchars);
4840 else
4842 if (lnum == 1)
4843 STRCPY(p, _("1 line, "));
4844 else
4845 sprintf((char *)p, _("%ld lines, "), lnum);
4846 p += STRLEN(p);
4847 if (nchars == 1)
4848 STRCPY(p, _("1 character"));
4849 else
4850 sprintf((char *)p, _("%ld characters"), nchars);
4855 * Append message for missing line separator to IObuff.
4857 static void
4858 msg_add_eol()
4860 STRCAT(IObuff, shortmess(SHM_LAST) ? _("[noeol]") : _("[Incomplete last line]"));
4864 * Check modification time of file, before writing to it.
4865 * The size isn't checked, because using a tool like "gzip" takes care of
4866 * using the same timestamp but can't set the size.
4868 static int
4869 check_mtime(buf, st)
4870 buf_T *buf;
4871 struct stat *st;
4873 if (buf->b_mtime_read != 0
4874 && time_differs((long)st->st_mtime, buf->b_mtime_read))
4876 msg_scroll = TRUE; /* don't overwrite messages here */
4877 msg_silent = 0; /* must give this prompt */
4878 /* don't use emsg() here, don't want to flush the buffers */
4879 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
4880 hl_attr(HLF_E));
4881 if (ask_yesno((char_u *)_("Do you really want to write to it"),
4882 TRUE) == 'n')
4883 return FAIL;
4884 msg_scroll = FALSE; /* always overwrite the file message now */
4886 return OK;
4889 static int
4890 time_differs(t1, t2)
4891 long t1, t2;
4893 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
4894 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
4895 * the seconds. Since the roundoff is done when flushing the inode, the
4896 * time may change unexpectedly by one second!!! */
4897 return (t1 - t2 > 1 || t2 - t1 > 1);
4898 #else
4899 return (t1 != t2);
4900 #endif
4904 * Call write() to write a number of bytes to the file.
4905 * Also handles encryption and 'encoding' conversion.
4907 * Return FAIL for failure, OK otherwise.
4909 static int
4910 buf_write_bytes(ip)
4911 struct bw_info *ip;
4913 int wlen;
4914 char_u *buf = ip->bw_buf; /* data to write */
4915 int len = ip->bw_len; /* length of data */
4916 #ifdef HAS_BW_FLAGS
4917 int flags = ip->bw_flags; /* extra flags */
4918 #endif
4920 #ifdef FEAT_MBYTE
4922 * Skip conversion when writing the crypt magic number or the BOM.
4924 if (!(flags & FIO_NOCONVERT))
4926 char_u *p;
4927 unsigned c;
4928 int n;
4930 if (flags & FIO_UTF8)
4933 * Convert latin1 in the buffer to UTF-8 in the file.
4935 p = ip->bw_conv_buf; /* translate to buffer */
4936 for (wlen = 0; wlen < len; ++wlen)
4937 p += utf_char2bytes(buf[wlen], p);
4938 buf = ip->bw_conv_buf;
4939 len = (int)(p - ip->bw_conv_buf);
4941 else if (flags & (FIO_UCS4 | FIO_UTF16 | FIO_UCS2 | FIO_LATIN1))
4944 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
4945 * Latin1 chars in the file.
4947 if (flags & FIO_LATIN1)
4948 p = buf; /* translate in-place (can only get shorter) */
4949 else
4950 p = ip->bw_conv_buf; /* translate to buffer */
4951 for (wlen = 0; wlen < len; wlen += n)
4953 if (wlen == 0 && ip->bw_restlen != 0)
4955 int l;
4957 /* Use remainder of previous call. Append the start of
4958 * buf[] to get a full sequence. Might still be too
4959 * short! */
4960 l = CONV_RESTLEN - ip->bw_restlen;
4961 if (l > len)
4962 l = len;
4963 mch_memmove(ip->bw_rest + ip->bw_restlen, buf, (size_t)l);
4964 n = utf_ptr2len_len(ip->bw_rest, ip->bw_restlen + l);
4965 if (n > ip->bw_restlen + len)
4967 /* We have an incomplete byte sequence at the end to
4968 * be written. We can't convert it without the
4969 * remaining bytes. Keep them for the next call. */
4970 if (ip->bw_restlen + len > CONV_RESTLEN)
4971 return FAIL;
4972 ip->bw_restlen += len;
4973 break;
4975 if (n > 1)
4976 c = utf_ptr2char(ip->bw_rest);
4977 else
4978 c = ip->bw_rest[0];
4979 if (n >= ip->bw_restlen)
4981 n -= ip->bw_restlen;
4982 ip->bw_restlen = 0;
4984 else
4986 ip->bw_restlen -= n;
4987 mch_memmove(ip->bw_rest, ip->bw_rest + n,
4988 (size_t)ip->bw_restlen);
4989 n = 0;
4992 else
4994 n = utf_ptr2len_len(buf + wlen, len - wlen);
4995 if (n > len - wlen)
4997 /* We have an incomplete byte sequence at the end to
4998 * be written. We can't convert it without the
4999 * remaining bytes. Keep them for the next call. */
5000 if (len - wlen > CONV_RESTLEN)
5001 return FAIL;
5002 ip->bw_restlen = len - wlen;
5003 mch_memmove(ip->bw_rest, buf + wlen,
5004 (size_t)ip->bw_restlen);
5005 break;
5007 if (n > 1)
5008 c = utf_ptr2char(buf + wlen);
5009 else
5010 c = buf[wlen];
5013 ip->bw_conv_error |= ucs2bytes(c, &p, flags);
5015 if (flags & FIO_LATIN1)
5016 len = (int)(p - buf);
5017 else
5019 buf = ip->bw_conv_buf;
5020 len = (int)(p - ip->bw_conv_buf);
5024 # ifdef WIN3264
5025 else if (flags & FIO_CODEPAGE)
5028 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
5029 * codepage.
5031 char_u *from;
5032 size_t fromlen;
5033 char_u *to;
5034 int u8c;
5035 BOOL bad = FALSE;
5036 int needed;
5038 if (ip->bw_restlen > 0)
5040 /* Need to concatenate the remainder of the previous call and
5041 * the bytes of the current call. Use the end of the
5042 * conversion buffer for this. */
5043 fromlen = len + ip->bw_restlen;
5044 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5045 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5046 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5048 else
5050 from = buf;
5051 fromlen = len;
5054 to = ip->bw_conv_buf;
5055 if (enc_utf8)
5057 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
5058 * The buffer has been allocated to be big enough. */
5059 while (fromlen > 0)
5061 n = (int)utf_ptr2len_len(from, (int)fromlen);
5062 if (n > (int)fromlen) /* incomplete byte sequence */
5063 break;
5064 u8c = utf_ptr2char(from);
5065 *to++ = (u8c & 0xff);
5066 *to++ = (u8c >> 8);
5067 fromlen -= n;
5068 from += n;
5071 /* Copy remainder to ip->bw_rest[] to be used for the next
5072 * call. */
5073 if (fromlen > CONV_RESTLEN)
5075 /* weird overlong sequence */
5076 ip->bw_conv_error = TRUE;
5077 return FAIL;
5079 mch_memmove(ip->bw_rest, from, fromlen);
5080 ip->bw_restlen = (int)fromlen;
5082 else
5084 /* Convert from enc_codepage to UCS-2, to the start of the
5085 * buffer. The buffer has been allocated to be big enough. */
5086 ip->bw_restlen = 0;
5087 needed = MultiByteToWideChar(enc_codepage,
5088 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen,
5089 NULL, 0);
5090 if (needed == 0)
5092 /* When conversion fails there may be a trailing byte. */
5093 needed = MultiByteToWideChar(enc_codepage,
5094 MB_ERR_INVALID_CHARS, (LPCSTR)from, (int)fromlen - 1,
5095 NULL, 0);
5096 if (needed == 0)
5098 /* Conversion doesn't work. */
5099 ip->bw_conv_error = TRUE;
5100 return FAIL;
5102 /* Save the trailing byte for the next call. */
5103 ip->bw_rest[0] = from[fromlen - 1];
5104 ip->bw_restlen = 1;
5106 needed = MultiByteToWideChar(enc_codepage, MB_ERR_INVALID_CHARS,
5107 (LPCSTR)from, (int)(fromlen - ip->bw_restlen),
5108 (LPWSTR)to, needed);
5109 if (needed == 0)
5111 /* Safety check: Conversion doesn't work. */
5112 ip->bw_conv_error = TRUE;
5113 return FAIL;
5115 to += needed * 2;
5118 fromlen = to - ip->bw_conv_buf;
5119 buf = to;
5120 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5121 if (FIO_GET_CP(flags) == CP_UTF8)
5123 /* Convert from UCS-2 to UTF-8, using the remainder of the
5124 * conversion buffer. Fails when out of space. */
5125 for (from = ip->bw_conv_buf; fromlen > 1; fromlen -= 2)
5127 u8c = *from++;
5128 u8c += (*from++ << 8);
5129 to += utf_char2bytes(u8c, to);
5130 if (to + 6 >= ip->bw_conv_buf + ip->bw_conv_buflen)
5132 ip->bw_conv_error = TRUE;
5133 return FAIL;
5136 len = (int)(to - buf);
5138 else
5139 #endif
5141 /* Convert from UCS-2 to the codepage, using the remainder of
5142 * the conversion buffer. If the conversion uses the default
5143 * character "0", the data doesn't fit in this encoding, so
5144 * fail. */
5145 len = WideCharToMultiByte(FIO_GET_CP(flags), 0,
5146 (LPCWSTR)ip->bw_conv_buf, (int)fromlen / sizeof(WCHAR),
5147 (LPSTR)to, (int)(ip->bw_conv_buflen - fromlen), 0,
5148 &bad);
5149 if (bad)
5151 ip->bw_conv_error = TRUE;
5152 return FAIL;
5156 # endif
5158 # ifdef MACOS_CONVERT
5159 else if (flags & FIO_MACROMAN)
5162 * Convert UTF-8 or latin1 to Apple MacRoman.
5164 char_u *from;
5165 size_t fromlen;
5167 if (ip->bw_restlen > 0)
5169 /* Need to concatenate the remainder of the previous call and
5170 * the bytes of the current call. Use the end of the
5171 * conversion buffer for this. */
5172 fromlen = len + ip->bw_restlen;
5173 from = ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5174 mch_memmove(from, ip->bw_rest, (size_t)ip->bw_restlen);
5175 mch_memmove(from + ip->bw_restlen, buf, (size_t)len);
5177 else
5179 from = buf;
5180 fromlen = len;
5183 if (enc2macroman(from, fromlen,
5184 ip->bw_conv_buf, &len, ip->bw_conv_buflen,
5185 ip->bw_rest, &ip->bw_restlen) == FAIL)
5187 ip->bw_conv_error = TRUE;
5188 return FAIL;
5190 buf = ip->bw_conv_buf;
5192 # endif
5194 # ifdef USE_ICONV
5195 if (ip->bw_iconv_fd != (iconv_t)-1)
5197 const char *from;
5198 size_t fromlen;
5199 char *to;
5200 size_t tolen;
5202 /* Convert with iconv(). */
5203 if (ip->bw_restlen > 0)
5205 /* Need to concatenate the remainder of the previous call and
5206 * the bytes of the current call. Use the end of the
5207 * conversion buffer for this. */
5208 fromlen = len + ip->bw_restlen;
5209 from = (char *)ip->bw_conv_buf + ip->bw_conv_buflen - fromlen;
5210 mch_memmove((void *)from, ip->bw_rest, (size_t)ip->bw_restlen);
5211 mch_memmove((void *)(from + ip->bw_restlen), buf, (size_t)len);
5212 tolen = ip->bw_conv_buflen - fromlen;
5214 else
5216 from = (const char *)buf;
5217 fromlen = len;
5218 tolen = ip->bw_conv_buflen;
5220 to = (char *)ip->bw_conv_buf;
5222 if (ip->bw_first)
5224 size_t save_len = tolen;
5226 /* output the initial shift state sequence */
5227 (void)iconv(ip->bw_iconv_fd, NULL, NULL, &to, &tolen);
5229 /* There is a bug in iconv() on Linux (which appears to be
5230 * wide-spread) which sets "to" to NULL and messes up "tolen".
5232 if (to == NULL)
5234 to = (char *)ip->bw_conv_buf;
5235 tolen = save_len;
5237 ip->bw_first = FALSE;
5241 * If iconv() has an error or there is not enough room, fail.
5243 if ((iconv(ip->bw_iconv_fd, (void *)&from, &fromlen, &to, &tolen)
5244 == (size_t)-1 && ICONV_ERRNO != ICONV_EINVAL)
5245 || fromlen > CONV_RESTLEN)
5247 ip->bw_conv_error = TRUE;
5248 return FAIL;
5251 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5252 if (fromlen > 0)
5253 mch_memmove(ip->bw_rest, (void *)from, fromlen);
5254 ip->bw_restlen = (int)fromlen;
5256 buf = ip->bw_conv_buf;
5257 len = (int)((char_u *)to - ip->bw_conv_buf);
5259 # endif
5261 #endif /* FEAT_MBYTE */
5263 #ifdef FEAT_CRYPT
5264 if (flags & FIO_ENCRYPTED) /* encrypt the data */
5266 int ztemp, t, i;
5268 for (i = 0; i < len; i++)
5270 ztemp = buf[i];
5271 buf[i] = ZENCODE(ztemp, t);
5274 #endif
5276 /* Repeat the write(), it may be interrupted by a signal. */
5277 while (len > 0)
5279 wlen = vim_write(ip->bw_fd, buf, len);
5280 if (wlen <= 0) /* error! */
5281 return FAIL;
5282 len -= wlen;
5283 buf += wlen;
5285 return OK;
5288 #ifdef FEAT_MBYTE
5290 * Convert a Unicode character to bytes.
5292 static int
5293 ucs2bytes(c, pp, flags)
5294 unsigned c; /* in: character */
5295 char_u **pp; /* in/out: pointer to result */
5296 int flags; /* FIO_ flags */
5298 char_u *p = *pp;
5299 int error = FALSE;
5300 int cc;
5303 if (flags & FIO_UCS4)
5305 if (flags & FIO_ENDIAN_L)
5307 *p++ = c;
5308 *p++ = (c >> 8);
5309 *p++ = (c >> 16);
5310 *p++ = (c >> 24);
5312 else
5314 *p++ = (c >> 24);
5315 *p++ = (c >> 16);
5316 *p++ = (c >> 8);
5317 *p++ = c;
5320 else if (flags & (FIO_UCS2 | FIO_UTF16))
5322 if (c >= 0x10000)
5324 if (flags & FIO_UTF16)
5326 /* Make two words, ten bits of the character in each. First
5327 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5328 c -= 0x10000;
5329 if (c >= 0x100000)
5330 error = TRUE;
5331 cc = ((c >> 10) & 0x3ff) + 0xd800;
5332 if (flags & FIO_ENDIAN_L)
5334 *p++ = cc;
5335 *p++ = ((unsigned)cc >> 8);
5337 else
5339 *p++ = ((unsigned)cc >> 8);
5340 *p++ = cc;
5342 c = (c & 0x3ff) + 0xdc00;
5344 else
5345 error = TRUE;
5347 if (flags & FIO_ENDIAN_L)
5349 *p++ = c;
5350 *p++ = (c >> 8);
5352 else
5354 *p++ = (c >> 8);
5355 *p++ = c;
5358 else /* Latin1 */
5360 if (c >= 0x100)
5362 error = TRUE;
5363 *p++ = 0xBF;
5365 else
5366 *p++ = c;
5369 *pp = p;
5370 return error;
5374 * Return TRUE if "a" and "b" are the same 'encoding'.
5375 * Ignores difference between "ansi" and "latin1", "ucs-4" and "ucs-4be", etc.
5377 static int
5378 same_encoding(a, b)
5379 char_u *a;
5380 char_u *b;
5382 int f;
5384 if (STRCMP(a, b) == 0)
5385 return TRUE;
5386 f = get_fio_flags(a);
5387 return (f != 0 && get_fio_flags(b) == f);
5391 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5392 * internal conversion.
5393 * if "ptr" is an empty string, use 'encoding'.
5395 static int
5396 get_fio_flags(ptr)
5397 char_u *ptr;
5399 int prop;
5401 if (*ptr == NUL)
5402 ptr = p_enc;
5404 prop = enc_canon_props(ptr);
5405 if (prop & ENC_UNICODE)
5407 if (prop & ENC_2BYTE)
5409 if (prop & ENC_ENDIAN_L)
5410 return FIO_UCS2 | FIO_ENDIAN_L;
5411 return FIO_UCS2;
5413 if (prop & ENC_4BYTE)
5415 if (prop & ENC_ENDIAN_L)
5416 return FIO_UCS4 | FIO_ENDIAN_L;
5417 return FIO_UCS4;
5419 if (prop & ENC_2WORD)
5421 if (prop & ENC_ENDIAN_L)
5422 return FIO_UTF16 | FIO_ENDIAN_L;
5423 return FIO_UTF16;
5425 return FIO_UTF8;
5427 if (prop & ENC_LATIN1)
5428 return FIO_LATIN1;
5429 /* must be ENC_DBCS, requires iconv() */
5430 return 0;
5433 #ifdef WIN3264
5435 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5436 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5437 * Used for conversion between 'encoding' and 'fileencoding'.
5439 static int
5440 get_win_fio_flags(ptr)
5441 char_u *ptr;
5443 int cp;
5445 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5446 if (!enc_utf8 && enc_codepage <= 0)
5447 return 0;
5449 cp = encname2codepage(ptr);
5450 if (cp == 0)
5452 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5453 if (STRCMP(ptr, "utf-8") == 0)
5454 cp = CP_UTF8;
5455 else
5456 # endif
5457 return 0;
5459 return FIO_PUT_CP(cp) | FIO_CODEPAGE;
5461 #endif
5463 #ifdef MACOS_X
5465 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5466 * needed for the internal conversion to/from utf-8 or latin1.
5468 static int
5469 get_mac_fio_flags(ptr)
5470 char_u *ptr;
5472 if ((enc_utf8 || STRCMP(p_enc, "latin1") == 0)
5473 && (enc_canon_props(ptr) & ENC_MACROMAN))
5474 return FIO_MACROMAN;
5475 return 0;
5477 #endif
5480 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5481 * "size" must be at least 2.
5482 * Return the name of the encoding and set "*lenp" to the length.
5483 * Returns NULL when no BOM found.
5485 static char_u *
5486 check_for_bom(p, size, lenp, flags)
5487 char_u *p;
5488 long size;
5489 int *lenp;
5490 int flags;
5492 char *name = NULL;
5493 int len = 2;
5495 if (p[0] == 0xef && p[1] == 0xbb && size >= 3 && p[2] == 0xbf
5496 && (flags == FIO_ALL || flags == 0))
5498 name = "utf-8"; /* EF BB BF */
5499 len = 3;
5501 else if (p[0] == 0xff && p[1] == 0xfe)
5503 if (size >= 4 && p[2] == 0 && p[3] == 0
5504 && (flags == FIO_ALL || flags == (FIO_UCS4 | FIO_ENDIAN_L)))
5506 name = "ucs-4le"; /* FF FE 00 00 */
5507 len = 4;
5509 else if (flags == FIO_ALL || flags == (FIO_UCS2 | FIO_ENDIAN_L))
5510 name = "ucs-2le"; /* FF FE */
5511 else if (flags == (FIO_UTF16 | FIO_ENDIAN_L))
5512 name = "utf-16le"; /* FF FE */
5514 else if (p[0] == 0xfe && p[1] == 0xff
5515 && (flags == FIO_ALL || flags == FIO_UCS2 || flags == FIO_UTF16))
5517 /* Default to utf-16, it works also for ucs-2 text. */
5518 if (flags == FIO_UCS2)
5519 name = "ucs-2"; /* FE FF */
5520 else
5521 name = "utf-16"; /* FE FF */
5523 else if (size >= 4 && p[0] == 0 && p[1] == 0 && p[2] == 0xfe
5524 && p[3] == 0xff && (flags == FIO_ALL || flags == FIO_UCS4))
5526 name = "ucs-4"; /* 00 00 FE FF */
5527 len = 4;
5530 *lenp = len;
5531 return (char_u *)name;
5535 * Generate a BOM in "buf[4]" for encoding "name".
5536 * Return the length of the BOM (zero when no BOM).
5538 static int
5539 make_bom(buf, name)
5540 char_u *buf;
5541 char_u *name;
5543 int flags;
5544 char_u *p;
5546 flags = get_fio_flags(name);
5548 /* Can't put a BOM in a non-Unicode file. */
5549 if (flags == FIO_LATIN1 || flags == 0)
5550 return 0;
5552 if (flags == FIO_UTF8) /* UTF-8 */
5554 buf[0] = 0xef;
5555 buf[1] = 0xbb;
5556 buf[2] = 0xbf;
5557 return 3;
5559 p = buf;
5560 (void)ucs2bytes(0xfeff, &p, flags);
5561 return (int)(p - buf);
5563 #endif
5565 #if defined(FEAT_VIMINFO) || defined(FEAT_BROWSE) || \
5566 defined(FEAT_QUICKFIX) || defined(FEAT_AUTOCMD) || defined(PROTO)
5568 * Try to find a shortname by comparing the fullname with the current
5569 * directory.
5570 * Returns "full_path" or pointer into "full_path" if shortened.
5572 char_u *
5573 shorten_fname1(full_path)
5574 char_u *full_path;
5576 char_u dirname[MAXPATHL];
5577 char_u *p = full_path;
5579 if (mch_dirname(dirname, MAXPATHL) == OK)
5581 p = shorten_fname(full_path, dirname);
5582 if (p == NULL || *p == NUL)
5583 p = full_path;
5585 return p;
5587 #endif
5590 * Try to find a shortname by comparing the fullname with the current
5591 * directory.
5592 * Returns NULL if not shorter name possible, pointer into "full_path"
5593 * otherwise.
5595 char_u *
5596 shorten_fname(full_path, dir_name)
5597 char_u *full_path;
5598 char_u *dir_name;
5600 int len;
5601 char_u *p;
5603 if (full_path == NULL)
5604 return NULL;
5605 len = (int)STRLEN(dir_name);
5606 if (fnamencmp(dir_name, full_path, len) == 0)
5608 p = full_path + len;
5609 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5611 * MSDOS: when a file is in the root directory, dir_name will end in a
5612 * slash, since C: by itself does not define a specific dir. In this
5613 * case p may already be correct. <negri>
5615 if (!((len > 2) && (*(p - 2) == ':')))
5616 #endif
5618 if (vim_ispathsep(*p))
5619 ++p;
5620 #ifndef VMS /* the path separator is always part of the path */
5621 else
5622 p = NULL;
5623 #endif
5626 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5628 * When using a file in the current drive, remove the drive name:
5629 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5630 * a floppy from "A:\dir" to "B:\dir".
5632 else if (len > 3
5633 && TOUPPER_LOC(full_path[0]) == TOUPPER_LOC(dir_name[0])
5634 && full_path[1] == ':'
5635 && vim_ispathsep(full_path[2]))
5636 p = full_path + 2;
5637 #endif
5638 else
5639 p = NULL;
5640 return p;
5644 * Shorten filenames for all buffers.
5645 * When "force" is TRUE: Use full path from now on for files currently being
5646 * edited, both for file name and swap file name. Try to shorten the file
5647 * names a bit, if safe to do so.
5648 * When "force" is FALSE: Only try to shorten absolute file names.
5649 * For buffers that have buftype "nofile" or "scratch": never change the file
5650 * name.
5652 void
5653 shorten_fnames(force)
5654 int force;
5656 char_u dirname[MAXPATHL];
5657 buf_T *buf;
5658 char_u *p;
5660 mch_dirname(dirname, MAXPATHL);
5661 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
5663 if (buf->b_fname != NULL
5664 #ifdef FEAT_QUICKFIX
5665 && !bt_nofile(buf)
5666 #endif
5667 && !path_with_url(buf->b_fname)
5668 && (force
5669 || buf->b_sfname == NULL
5670 || mch_isFullName(buf->b_sfname)))
5672 vim_free(buf->b_sfname);
5673 buf->b_sfname = NULL;
5674 p = shorten_fname(buf->b_ffname, dirname);
5675 if (p != NULL)
5677 buf->b_sfname = vim_strsave(p);
5678 buf->b_fname = buf->b_sfname;
5680 if (p == NULL || buf->b_fname == NULL)
5681 buf->b_fname = buf->b_ffname;
5684 /* Always make the swap file name a full path, a "nofile" buffer may
5685 * also have a swap file. */
5686 mf_fullname(buf->b_ml.ml_mfp);
5688 #ifdef FEAT_WINDOWS
5689 status_redraw_all();
5690 redraw_tabline = TRUE;
5691 #endif
5694 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5695 || defined(FEAT_GUI_MSWIN) \
5696 || defined(FEAT_GUI_MAC) \
5697 || defined(PROTO)
5699 * Shorten all filenames in "fnames[count]" by current directory.
5701 void
5702 shorten_filenames(fnames, count)
5703 char_u **fnames;
5704 int count;
5706 int i;
5707 char_u dirname[MAXPATHL];
5708 char_u *p;
5710 if (fnames == NULL || count < 1)
5711 return;
5712 mch_dirname(dirname, sizeof(dirname));
5713 for (i = 0; i < count; ++i)
5715 if ((p = shorten_fname(fnames[i], dirname)) != NULL)
5717 /* shorten_fname() returns pointer in given "fnames[i]". If free
5718 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5719 * "p" first then free fnames[i]. */
5720 p = vim_strsave(p);
5721 vim_free(fnames[i]);
5722 fnames[i] = p;
5726 #endif
5729 * add extention to file name - change path/fo.o.h to path/fo.o.h.ext or
5730 * fo_o_h.ext for MSDOS or when shortname option set.
5732 * Assumed that fname is a valid name found in the filesystem we assure that
5733 * the return value is a different name and ends in 'ext'.
5734 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5735 * characters otherwise.
5736 * Space for the returned name is allocated, must be freed later.
5737 * Returns NULL when out of memory.
5739 char_u *
5740 modname(fname, ext, prepend_dot)
5741 char_u *fname, *ext;
5742 int prepend_dot; /* may prepend a '.' to file name */
5744 return buf_modname(
5745 #ifdef SHORT_FNAME
5746 TRUE,
5747 #else
5748 (curbuf->b_p_sn || curbuf->b_shortname),
5749 #endif
5750 fname, ext, prepend_dot);
5753 char_u *
5754 buf_modname(shortname, fname, ext, prepend_dot)
5755 int shortname; /* use 8.3 file name */
5756 char_u *fname, *ext;
5757 int prepend_dot; /* may prepend a '.' to file name */
5759 char_u *retval;
5760 char_u *s;
5761 char_u *e;
5762 char_u *ptr;
5763 int fnamelen, extlen;
5765 extlen = (int)STRLEN(ext);
5768 * If there is no file name we must get the name of the current directory
5769 * (we need the full path in case :cd is used).
5771 if (fname == NULL || *fname == NUL)
5773 retval = alloc((unsigned)(MAXPATHL + extlen + 3));
5774 if (retval == NULL)
5775 return NULL;
5776 if (mch_dirname(retval, MAXPATHL) == FAIL ||
5777 (fnamelen = (int)STRLEN(retval)) == 0)
5779 vim_free(retval);
5780 return NULL;
5782 if (!after_pathsep(retval, retval + fnamelen))
5784 retval[fnamelen++] = PATHSEP;
5785 retval[fnamelen] = NUL;
5787 #ifndef SHORT_FNAME
5788 prepend_dot = FALSE; /* nothing to prepend a dot to */
5789 #endif
5791 else
5793 fnamelen = (int)STRLEN(fname);
5794 retval = alloc((unsigned)(fnamelen + extlen + 3));
5795 if (retval == NULL)
5796 return NULL;
5797 STRCPY(retval, fname);
5798 #ifdef VMS
5799 vms_remove_version(retval); /* we do not need versions here */
5800 #endif
5804 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5805 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5806 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5807 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5809 for (ptr = retval + fnamelen; ptr > retval; mb_ptr_back(retval, ptr))
5811 #ifndef RISCOS
5812 if (*ext == '.'
5813 # ifdef USE_LONG_FNAME
5814 && (!USE_LONG_FNAME || shortname)
5815 # else
5816 # ifndef SHORT_FNAME
5817 && shortname
5818 # endif
5819 # endif
5821 if (*ptr == '.') /* replace '.' by '_' */
5822 *ptr = '_';
5823 #endif
5824 if (vim_ispathsep(*ptr))
5826 ++ptr;
5827 break;
5831 /* the file name has at most BASENAMELEN characters. */
5832 #ifndef SHORT_FNAME
5833 if (STRLEN(ptr) > (unsigned)BASENAMELEN)
5834 ptr[BASENAMELEN] = '\0';
5835 #endif
5837 s = ptr + STRLEN(ptr);
5840 * For 8.3 file names we may have to reduce the length.
5842 #ifdef USE_LONG_FNAME
5843 if (!USE_LONG_FNAME || shortname)
5844 #else
5845 # ifndef SHORT_FNAME
5846 if (shortname)
5847 # endif
5848 #endif
5851 * If there is no file name, or the file name ends in '/', and the
5852 * extension starts with '.', put a '_' before the dot, because just
5853 * ".ext" is invalid.
5855 if (fname == NULL || *fname == NUL
5856 || vim_ispathsep(fname[STRLEN(fname) - 1]))
5858 #ifdef RISCOS
5859 if (*ext == '/')
5860 #else
5861 if (*ext == '.')
5862 #endif
5863 *s++ = '_';
5866 * If the extension starts with '.', truncate the base name at 8
5867 * characters
5869 #ifdef RISCOS
5870 /* We normally use '/', but swap files are '_' */
5871 else if (*ext == '/' || *ext == '_')
5872 #else
5873 else if (*ext == '.')
5874 #endif
5876 if (s - ptr > (size_t)8)
5878 s = ptr + 8;
5879 *s = '\0';
5883 * If the extension doesn't start with '.', and the file name
5884 * doesn't have an extension yet, append a '.'
5886 #ifdef RISCOS
5887 else if ((e = vim_strchr(ptr, '/')) == NULL)
5888 *s++ = '/';
5889 #else
5890 else if ((e = vim_strchr(ptr, '.')) == NULL)
5891 *s++ = '.';
5892 #endif
5894 * If the extension doesn't start with '.', and there already is an
5895 * extension, it may need to be truncated
5897 else if ((int)STRLEN(e) + extlen > 4)
5898 s = e + 4 - extlen;
5900 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
5902 * If there is no file name, and the extension starts with '.', put a
5903 * '_' before the dot, because just ".ext" may be invalid if it's on a
5904 * FAT partition, and on HPFS it doesn't matter.
5906 else if ((fname == NULL || *fname == NUL) && *ext == '.')
5907 *s++ = '_';
5908 #endif
5911 * Append the extention.
5912 * ext can start with '.' and cannot exceed 3 more characters.
5914 STRCPY(s, ext);
5916 #ifndef SHORT_FNAME
5918 * Prepend the dot.
5920 if (prepend_dot && !shortname && *(e = gettail(retval)) !=
5921 #ifdef RISCOS
5923 #else
5925 #endif
5926 #ifdef USE_LONG_FNAME
5927 && USE_LONG_FNAME
5928 #endif
5931 mch_memmove(e + 1, e, STRLEN(e) + 1);
5932 #ifdef RISCOS
5933 *e = '/';
5934 #else
5935 *e = '.';
5936 #endif
5938 #endif
5941 * Check that, after appending the extension, the file name is really
5942 * different.
5944 if (fname != NULL && STRCMP(fname, retval) == 0)
5946 /* we search for a character that can be replaced by '_' */
5947 while (--s >= ptr)
5949 if (*s != '_')
5951 *s = '_';
5952 break;
5955 if (s < ptr) /* fname was "________.<ext>", how tricky! */
5956 *ptr = 'v';
5958 return retval;
5962 * Like fgets(), but if the file line is too long, it is truncated and the
5963 * rest of the line is thrown away. Returns TRUE for end-of-file.
5966 vim_fgets(buf, size, fp)
5967 char_u *buf;
5968 int size;
5969 FILE *fp;
5971 char *eof;
5972 #define FGETS_SIZE 200
5973 char tbuf[FGETS_SIZE];
5975 buf[size - 2] = NUL;
5976 #ifdef USE_CR
5977 eof = fgets_cr((char *)buf, size, fp);
5978 #else
5979 eof = fgets((char *)buf, size, fp);
5980 #endif
5981 if (buf[size - 2] != NUL && buf[size - 2] != '\n')
5983 buf[size - 1] = NUL; /* Truncate the line */
5985 /* Now throw away the rest of the line: */
5988 tbuf[FGETS_SIZE - 2] = NUL;
5989 #ifdef USE_CR
5990 fgets_cr((char *)tbuf, FGETS_SIZE, fp);
5991 #else
5992 fgets((char *)tbuf, FGETS_SIZE, fp);
5993 #endif
5994 } while (tbuf[FGETS_SIZE - 2] != NUL && tbuf[FGETS_SIZE - 2] != '\n');
5996 return (eof == NULL);
5999 #if defined(USE_CR) || defined(PROTO)
6001 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
6002 * Returns TRUE for end-of-file.
6003 * Only used for the Mac, because it's much slower than vim_fgets().
6006 tag_fgets(buf, size, fp)
6007 char_u *buf;
6008 int size;
6009 FILE *fp;
6011 int i = 0;
6012 int c;
6013 int eof = FALSE;
6015 for (;;)
6017 c = fgetc(fp);
6018 if (c == EOF)
6020 eof = TRUE;
6021 break;
6023 if (c == '\r')
6025 /* Always store a NL for end-of-line. */
6026 if (i < size - 1)
6027 buf[i++] = '\n';
6028 c = fgetc(fp);
6029 if (c != '\n') /* Macintosh format: single CR. */
6030 ungetc(c, fp);
6031 break;
6033 if (i < size - 1)
6034 buf[i++] = c;
6035 if (c == '\n')
6036 break;
6038 buf[i] = NUL;
6039 return eof;
6041 #endif
6044 * rename() only works if both files are on the same file system, this
6045 * function will (attempts to?) copy the file across if rename fails -- webb
6046 * Return -1 for failure, 0 for success.
6049 vim_rename(from, to)
6050 char_u *from;
6051 char_u *to;
6053 int fd_in;
6054 int fd_out;
6055 int n;
6056 char *errmsg = NULL;
6057 char *buffer;
6058 #ifdef AMIGA
6059 BPTR flock;
6060 #endif
6061 struct stat st;
6062 long perm;
6063 #ifdef HAVE_ACL
6064 vim_acl_T acl; /* ACL from original file */
6065 #endif
6068 * When the names are identical, there is nothing to do.
6070 if (fnamecmp(from, to) == 0)
6071 return 0;
6074 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
6076 if (mch_stat((char *)from, &st) < 0)
6077 return -1;
6080 * Delete the "to" file, this is required on some systems to make the
6081 * mch_rename() work, on other systems it makes sure that we don't have
6082 * two files when the mch_rename() fails.
6085 #ifdef AMIGA
6087 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
6088 * that the name of the "to" file is the same as the "from" file, even
6089 * though the names are different. To avoid the chance of accidentally
6090 * deleting the "from" file (horror!) we lock it during the remove.
6092 * When used for making a backup before writing the file: This should not
6093 * happen with ":w", because startscript() should detect this problem and
6094 * set buf->b_shortname, causing modname() to return a correct ".bak" file
6095 * name. This problem does exist with ":w filename", but then the
6096 * original file will be somewhere else so the backup isn't really
6097 * important. If autoscripting is off the rename may fail.
6099 flock = Lock((UBYTE *)from, (long)ACCESS_READ);
6100 #endif
6101 mch_remove(to);
6102 #ifdef AMIGA
6103 if (flock)
6104 UnLock(flock);
6105 #endif
6108 * First try a normal rename, return if it works.
6110 if (mch_rename((char *)from, (char *)to) == 0)
6111 return 0;
6114 * Rename() failed, try copying the file.
6116 perm = mch_getperm(from);
6117 #ifdef HAVE_ACL
6118 /* For systems that support ACL: get the ACL from the original file. */
6119 acl = mch_get_acl(from);
6120 #endif
6121 fd_in = mch_open((char *)from, O_RDONLY|O_EXTRA, 0);
6122 if (fd_in == -1)
6123 return -1;
6125 /* Create the new file with same permissions as the original. */
6126 fd_out = mch_open((char *)to,
6127 O_CREAT|O_EXCL|O_WRONLY|O_EXTRA|O_NOFOLLOW, (int)perm);
6128 if (fd_out == -1)
6130 close(fd_in);
6131 return -1;
6134 buffer = (char *)alloc(BUFSIZE);
6135 if (buffer == NULL)
6137 close(fd_in);
6138 close(fd_out);
6139 return -1;
6142 while ((n = vim_read(fd_in, buffer, BUFSIZE)) > 0)
6143 if (vim_write(fd_out, buffer, n) != n)
6145 errmsg = _("E208: Error writing to \"%s\"");
6146 break;
6149 vim_free(buffer);
6150 close(fd_in);
6151 if (close(fd_out) < 0)
6152 errmsg = _("E209: Error closing \"%s\"");
6153 if (n < 0)
6155 errmsg = _("E210: Error reading \"%s\"");
6156 to = from;
6158 #ifndef UNIX /* for Unix mch_open() already set the permission */
6159 mch_setperm(to, perm);
6160 #endif
6161 #ifdef HAVE_ACL
6162 mch_set_acl(to, acl);
6163 #endif
6164 if (errmsg != NULL)
6166 EMSG2(errmsg, to);
6167 return -1;
6169 mch_remove(from);
6170 return 0;
6173 static int already_warned = FALSE;
6176 * Check if any not hidden buffer has been changed.
6177 * Postpone the check if there are characters in the stuff buffer, a global
6178 * command is being executed, a mapping is being executed or an autocommand is
6179 * busy.
6180 * Returns TRUE if some message was written (screen should be redrawn and
6181 * cursor positioned).
6184 check_timestamps(focus)
6185 int focus; /* called for GUI focus event */
6187 buf_T *buf;
6188 int didit = 0;
6189 int n;
6191 /* Don't check timestamps while system() or another low-level function may
6192 * cause us to lose and gain focus. */
6193 if (no_check_timestamps > 0)
6194 return FALSE;
6196 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6197 * event and we would keep on checking if the file is steadily growing.
6198 * Do check again after typing something. */
6199 if (focus && did_check_timestamps)
6201 need_check_timestamps = TRUE;
6202 return FALSE;
6205 if (!stuff_empty() || global_busy || !typebuf_typed()
6206 #ifdef FEAT_AUTOCMD
6207 || autocmd_busy || curbuf_lock > 0
6208 #endif
6210 need_check_timestamps = TRUE; /* check later */
6211 else
6213 ++no_wait_return;
6214 did_check_timestamps = TRUE;
6215 already_warned = FALSE;
6216 for (buf = firstbuf; buf != NULL; )
6218 /* Only check buffers in a window. */
6219 if (buf->b_nwindows > 0)
6221 n = buf_check_timestamp(buf, focus);
6222 if (didit < n)
6223 didit = n;
6224 if (n > 0 && !buf_valid(buf))
6226 /* Autocommands have removed the buffer, start at the
6227 * first one again. */
6228 buf = firstbuf;
6229 continue;
6232 buf = buf->b_next;
6234 --no_wait_return;
6235 need_check_timestamps = FALSE;
6236 if (need_wait_return && didit == 2)
6238 /* make sure msg isn't overwritten */
6239 msg_puts((char_u *)"\n");
6240 out_flush();
6243 return didit;
6247 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6248 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6249 * empty.
6251 static int
6252 move_lines(frombuf, tobuf)
6253 buf_T *frombuf;
6254 buf_T *tobuf;
6256 buf_T *tbuf = curbuf;
6257 int retval = OK;
6258 linenr_T lnum;
6259 char_u *p;
6261 /* Copy the lines in "frombuf" to "tobuf". */
6262 curbuf = tobuf;
6263 for (lnum = 1; lnum <= frombuf->b_ml.ml_line_count; ++lnum)
6265 p = vim_strsave(ml_get_buf(frombuf, lnum, FALSE));
6266 if (p == NULL || ml_append(lnum - 1, p, 0, FALSE) == FAIL)
6268 vim_free(p);
6269 retval = FAIL;
6270 break;
6272 vim_free(p);
6275 /* Delete all the lines in "frombuf". */
6276 if (retval != FAIL)
6278 curbuf = frombuf;
6279 for (lnum = curbuf->b_ml.ml_line_count; lnum > 0; --lnum)
6280 if (ml_delete(lnum, FALSE) == FAIL)
6282 /* Oops! We could try putting back the saved lines, but that
6283 * might fail again... */
6284 retval = FAIL;
6285 break;
6289 curbuf = tbuf;
6290 return retval;
6294 * Check if buffer "buf" has been changed.
6295 * Also check if the file for a new buffer unexpectedly appeared.
6296 * return 1 if a changed buffer was found.
6297 * return 2 if a message has been displayed.
6298 * return 0 otherwise.
6300 /*ARGSUSED*/
6302 buf_check_timestamp(buf, focus)
6303 buf_T *buf;
6304 int focus; /* called for GUI focus event */
6306 struct stat st;
6307 int stat_res;
6308 int retval = 0;
6309 char_u *path;
6310 char_u *tbuf;
6311 char *mesg = NULL;
6312 char *mesg2 = "";
6313 int helpmesg = FALSE;
6314 int reload = FALSE;
6315 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6316 int can_reload = FALSE;
6317 #endif
6318 size_t orig_size = buf->b_orig_size;
6319 int orig_mode = buf->b_orig_mode;
6320 #ifdef FEAT_GUI
6321 int save_mouse_correct = need_mouse_correct;
6322 #endif
6323 #ifdef FEAT_AUTOCMD
6324 static int busy = FALSE;
6325 int n;
6326 char_u *s;
6327 #endif
6328 char *reason;
6330 /* If there is no file name, the buffer is not loaded, 'buftype' is
6331 * set, we are in the middle of a save or being called recursively: ignore
6332 * this buffer. */
6333 if (buf->b_ffname == NULL
6334 || buf->b_ml.ml_mfp == NULL
6335 #if defined(FEAT_QUICKFIX)
6336 || *buf->b_p_bt != NUL
6337 #endif
6338 || buf->b_saving
6339 #ifdef FEAT_AUTOCMD
6340 || busy
6341 #endif
6342 #ifdef FEAT_NETBEANS_INTG
6343 || isNetbeansBuffer(buf)
6344 #endif
6346 return 0;
6348 if ( !(buf->b_flags & BF_NOTEDITED)
6349 && buf->b_mtime != 0
6350 && ((stat_res = mch_stat((char *)buf->b_ffname, &st)) < 0
6351 || time_differs((long)st.st_mtime, buf->b_mtime)
6352 #ifdef HAVE_ST_MODE
6353 || (int)st.st_mode != buf->b_orig_mode
6354 #else
6355 || mch_getperm(buf->b_ffname) != buf->b_orig_mode
6356 #endif
6359 retval = 1;
6361 /* set b_mtime to stop further warnings (e.g., when executing
6362 * FileChangedShell autocmd) */
6363 if (stat_res < 0)
6365 buf->b_mtime = 0;
6366 buf->b_orig_size = 0;
6367 buf->b_orig_mode = 0;
6369 else
6370 buf_store_time(buf, &st, buf->b_ffname);
6372 /* Don't do anything for a directory. Might contain the file
6373 * explorer. */
6374 if (mch_isdir(buf->b_fname))
6378 * If 'autoread' is set, the buffer has no changes and the file still
6379 * exists, reload the buffer. Use the buffer-local option value if it
6380 * was set, the global option value otherwise.
6382 else if ((buf->b_p_ar >= 0 ? buf->b_p_ar : p_ar)
6383 && !bufIsChanged(buf) && stat_res >= 0)
6384 reload = TRUE;
6385 else
6387 if (stat_res < 0)
6388 reason = "deleted";
6389 else if (bufIsChanged(buf))
6390 reason = "conflict";
6391 else if (orig_size != buf->b_orig_size || buf_contents_changed(buf))
6392 reason = "changed";
6393 else if (orig_mode != buf->b_orig_mode)
6394 reason = "mode";
6395 else
6396 reason = "time";
6398 #ifdef FEAT_AUTOCMD
6400 * Only give the warning if there are no FileChangedShell
6401 * autocommands.
6402 * Avoid being called recursively by setting "busy".
6404 busy = TRUE;
6405 # ifdef FEAT_EVAL
6406 set_vim_var_string(VV_FCS_REASON, (char_u *)reason, -1);
6407 set_vim_var_string(VV_FCS_CHOICE, (char_u *)"", -1);
6408 # endif
6409 n = apply_autocmds(EVENT_FILECHANGEDSHELL,
6410 buf->b_fname, buf->b_fname, FALSE, buf);
6411 busy = FALSE;
6412 if (n)
6414 if (!buf_valid(buf))
6415 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6416 # ifdef FEAT_EVAL
6417 s = get_vim_var_str(VV_FCS_CHOICE);
6418 if (STRCMP(s, "reload") == 0 && *reason != 'd')
6419 reload = TRUE;
6420 else if (STRCMP(s, "ask") == 0)
6421 n = FALSE;
6422 else
6423 # endif
6424 return 2;
6426 if (!n)
6427 #endif
6429 if (*reason == 'd')
6430 mesg = _("E211: File \"%s\" no longer available");
6431 else
6433 helpmesg = TRUE;
6434 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6435 can_reload = TRUE;
6436 #endif
6438 * Check if the file contents really changed to avoid
6439 * giving a warning when only the timestamp was set (e.g.,
6440 * checked out of CVS). Always warn when the buffer was
6441 * changed.
6443 if (reason[2] == 'n')
6445 mesg = _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6446 mesg2 = _("See \":help W12\" for more info.");
6448 else if (reason[1] == 'h')
6450 mesg = _("W11: Warning: File \"%s\" has changed since editing started");
6451 mesg2 = _("See \":help W11\" for more info.");
6453 else if (*reason == 'm')
6455 mesg = _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6456 mesg2 = _("See \":help W16\" for more info.");
6458 /* Else: only timestamp changed, ignored */
6464 else if ((buf->b_flags & BF_NEW) && !(buf->b_flags & BF_NEW_W)
6465 && vim_fexists(buf->b_ffname))
6467 retval = 1;
6468 mesg = _("W13: Warning: File \"%s\" has been created after editing started");
6469 buf->b_flags |= BF_NEW_W;
6470 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6471 can_reload = TRUE;
6472 #endif
6475 if (mesg != NULL)
6477 path = home_replace_save(buf, buf->b_fname);
6478 if (path != NULL)
6480 if (!helpmesg)
6481 mesg2 = "";
6482 tbuf = alloc((unsigned)(STRLEN(path) + STRLEN(mesg)
6483 + STRLEN(mesg2) + 2));
6484 sprintf((char *)tbuf, mesg, path);
6485 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6486 if (can_reload)
6488 if (*mesg2 != NUL)
6490 STRCAT(tbuf, "\n");
6491 STRCAT(tbuf, mesg2);
6493 if (do_dialog(VIM_WARNING, (char_u *)_("Warning"), tbuf,
6494 (char_u *)_("&OK\n&Load File"), 1, NULL) == 2)
6495 reload = TRUE;
6497 else
6498 #endif
6499 if (State > NORMAL_BUSY || (State & CMDLINE) || already_warned)
6501 if (*mesg2 != NUL)
6503 STRCAT(tbuf, "; ");
6504 STRCAT(tbuf, mesg2);
6506 EMSG(tbuf);
6507 retval = 2;
6509 else
6511 # ifdef FEAT_AUTOCMD
6512 if (!autocmd_busy)
6513 # endif
6515 msg_start();
6516 msg_puts_attr(tbuf, hl_attr(HLF_E) + MSG_HIST);
6517 if (*mesg2 != NUL)
6518 msg_puts_attr((char_u *)mesg2,
6519 hl_attr(HLF_W) + MSG_HIST);
6520 msg_clr_eos();
6521 (void)msg_end();
6522 if (emsg_silent == 0)
6524 out_flush();
6525 # ifdef FEAT_GUI
6526 if (!focus)
6527 # endif
6528 /* give the user some time to think about it */
6529 ui_delay(1000L, TRUE);
6531 /* don't redraw and erase the message */
6532 redraw_cmdline = FALSE;
6535 already_warned = TRUE;
6538 vim_free(path);
6539 vim_free(tbuf);
6543 if (reload)
6544 /* Reload the buffer. */
6545 buf_reload(buf, orig_mode);
6547 #ifdef FEAT_AUTOCMD
6548 if (buf_valid(buf))
6549 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST,
6550 buf->b_fname, buf->b_fname, FALSE, buf);
6551 #endif
6552 #ifdef FEAT_GUI
6553 /* restore this in case an autocommand has set it; it would break
6554 * 'mousefocus' */
6555 need_mouse_correct = save_mouse_correct;
6556 #endif
6558 return retval;
6562 * Reload a buffer that is already loaded.
6563 * Used when the file was changed outside of Vim.
6564 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6565 * buf->b_orig_mode may have been reset already.
6567 void
6568 buf_reload(buf, orig_mode)
6569 buf_T *buf;
6570 int orig_mode;
6572 exarg_T ea;
6573 pos_T old_cursor;
6574 linenr_T old_topline;
6575 int old_ro = buf->b_p_ro;
6576 buf_T *savebuf;
6577 int saved = OK;
6578 aco_save_T aco;
6580 /* set curwin/curbuf for "buf" and save some things */
6581 aucmd_prepbuf(&aco, buf);
6583 /* We only want to read the text from the file, not reset the syntax
6584 * highlighting, clear marks, diff status, etc. Force the fileformat
6585 * and encoding to be the same. */
6586 if (prep_exarg(&ea, buf) == OK)
6588 old_cursor = curwin->w_cursor;
6589 old_topline = curwin->w_topline;
6592 * To behave like when a new file is edited (matters for
6593 * BufReadPost autocommands) we first need to delete the current
6594 * buffer contents. But if reading the file fails we should keep
6595 * the old contents. Can't use memory only, the file might be
6596 * too big. Use a hidden buffer to move the buffer contents to.
6598 if (bufempty())
6599 savebuf = NULL;
6600 else
6602 /* Allocate a buffer without putting it in the buffer list. */
6603 savebuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6604 if (savebuf != NULL && buf == curbuf)
6606 /* Open the memline. */
6607 curbuf = savebuf;
6608 curwin->w_buffer = savebuf;
6609 saved = ml_open(curbuf);
6610 curbuf = buf;
6611 curwin->w_buffer = buf;
6613 if (savebuf == NULL || saved == FAIL || buf != curbuf
6614 || move_lines(buf, savebuf) == FAIL)
6616 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6617 buf->b_fname);
6618 saved = FAIL;
6622 if (saved == OK)
6624 curbuf->b_flags |= BF_CHECK_RO; /* check for RO again */
6625 #ifdef FEAT_AUTOCMD
6626 keep_filetype = TRUE; /* don't detect 'filetype' */
6627 #endif
6628 if (readfile(buf->b_ffname, buf->b_fname, (linenr_T)0,
6629 (linenr_T)0,
6630 (linenr_T)MAXLNUM, &ea, READ_NEW) == FAIL)
6632 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6633 if (!aborting())
6634 #endif
6635 EMSG2(_("E321: Could not reload \"%s\""), buf->b_fname);
6636 if (savebuf != NULL && buf_valid(savebuf) && buf == curbuf)
6638 /* Put the text back from the save buffer. First
6639 * delete any lines that readfile() added. */
6640 while (!bufempty())
6641 if (ml_delete(buf->b_ml.ml_line_count, FALSE) == FAIL)
6642 break;
6643 (void)move_lines(savebuf, buf);
6646 else if (buf == curbuf)
6648 /* Mark the buffer as unmodified and free undo info. */
6649 unchanged(buf, TRUE);
6650 u_blockfree(buf);
6651 u_clearall(buf);
6654 vim_free(ea.cmd);
6656 if (savebuf != NULL && buf_valid(savebuf))
6657 wipe_buffer(savebuf, FALSE);
6659 #ifdef FEAT_DIFF
6660 /* Invalidate diff info if necessary. */
6661 diff_invalidate(curbuf);
6662 #endif
6664 /* Restore the topline and cursor position and check it (lines may
6665 * have been removed). */
6666 if (old_topline > curbuf->b_ml.ml_line_count)
6667 curwin->w_topline = curbuf->b_ml.ml_line_count;
6668 else
6669 curwin->w_topline = old_topline;
6670 curwin->w_cursor = old_cursor;
6671 check_cursor();
6672 update_topline();
6673 #ifdef FEAT_AUTOCMD
6674 keep_filetype = FALSE;
6675 #endif
6676 #ifdef FEAT_FOLDING
6678 win_T *wp;
6680 /* Update folds unless they are defined manually. */
6681 FOR_ALL_WINDOWS(wp)
6682 if (wp->w_buffer == curwin->w_buffer
6683 && !foldmethodIsManual(wp))
6684 foldUpdateAll(wp);
6686 #endif
6687 /* If the mode didn't change and 'readonly' was set, keep the old
6688 * value; the user probably used the ":view" command. But don't
6689 * reset it, might have had a read error. */
6690 if (orig_mode == curbuf->b_orig_mode)
6691 curbuf->b_p_ro |= old_ro;
6694 /* restore curwin/curbuf and a few other things */
6695 aucmd_restbuf(&aco);
6696 /* Careful: autocommands may have made "buf" invalid! */
6699 /*ARGSUSED*/
6700 void
6701 buf_store_time(buf, st, fname)
6702 buf_T *buf;
6703 struct stat *st;
6704 char_u *fname;
6706 buf->b_mtime = (long)st->st_mtime;
6707 buf->b_orig_size = (size_t)st->st_size;
6708 #ifdef HAVE_ST_MODE
6709 buf->b_orig_mode = (int)st->st_mode;
6710 #else
6711 buf->b_orig_mode = mch_getperm(fname);
6712 #endif
6716 * Adjust the line with missing eol, used for the next write.
6717 * Used for do_filter(), when the input lines for the filter are deleted.
6719 void
6720 write_lnum_adjust(offset)
6721 linenr_T offset;
6723 if (write_no_eol_lnum != 0) /* only if there is a missing eol */
6724 write_no_eol_lnum += offset;
6727 #if defined(TEMPDIRNAMES) || defined(PROTO)
6728 static long temp_count = 0; /* Temp filename counter. */
6731 * Delete the temp directory and all files it contains.
6733 void
6734 vim_deltempdir()
6736 char_u **files;
6737 int file_count;
6738 int i;
6740 if (vim_tempdir != NULL)
6742 sprintf((char *)NameBuff, "%s*", vim_tempdir);
6743 if (gen_expand_wildcards(1, &NameBuff, &file_count, &files,
6744 EW_DIR|EW_FILE|EW_SILENT) == OK)
6746 for (i = 0; i < file_count; ++i)
6747 mch_remove(files[i]);
6748 FreeWild(file_count, files);
6750 gettail(NameBuff)[-1] = NUL;
6751 (void)mch_rmdir(NameBuff);
6753 vim_free(vim_tempdir);
6754 vim_tempdir = NULL;
6757 #endif
6760 * vim_tempname(): Return a unique name that can be used for a temp file.
6762 * The temp file is NOT created.
6764 * The returned pointer is to allocated memory.
6765 * The returned pointer is NULL if no valid name was found.
6767 /*ARGSUSED*/
6768 char_u *
6769 vim_tempname(extra_char)
6770 int extra_char; /* character to use in the name instead of '?' */
6772 #ifdef USE_TMPNAM
6773 char_u itmp[L_tmpnam]; /* use tmpnam() */
6774 #else
6775 char_u itmp[TEMPNAMELEN];
6776 #endif
6778 #ifdef TEMPDIRNAMES
6779 static char *(tempdirs[]) = {TEMPDIRNAMES};
6780 int i;
6781 long nr;
6782 long off;
6783 # ifndef EEXIST
6784 struct stat st;
6785 # endif
6788 * This will create a directory for private use by this instance of Vim.
6789 * This is done once, and the same directory is used for all temp files.
6790 * This method avoids security problems because of symlink attacks et al.
6791 * It's also a bit faster, because we only need to check for an existing
6792 * file when creating the directory and not for each temp file.
6794 if (vim_tempdir == NULL)
6797 * Try the entries in TEMPDIRNAMES to create the temp directory.
6799 for (i = 0; i < sizeof(tempdirs) / sizeof(char *); ++i)
6801 /* expand $TMP, leave room for "/v1100000/999999999" */
6802 expand_env((char_u *)tempdirs[i], itmp, TEMPNAMELEN - 20);
6803 if (mch_isdir(itmp)) /* directory exists */
6805 # ifdef __EMX__
6806 /* If $TMP contains a forward slash (perhaps using bash or
6807 * tcsh), don't add a backslash, use a forward slash!
6808 * Adding 2 backslashes didn't work. */
6809 if (vim_strchr(itmp, '/') != NULL)
6810 STRCAT(itmp, "/");
6811 else
6812 # endif
6813 add_pathsep(itmp);
6815 /* Get an arbitrary number of up to 6 digits. When it's
6816 * unlikely that it already exists it will be faster,
6817 * otherwise it doesn't matter. The use of mkdir() avoids any
6818 * security problems because of the predictable number. */
6819 nr = (mch_get_pid() + (long)time(NULL)) % 1000000L;
6821 /* Try up to 10000 different values until we find a name that
6822 * doesn't exist. */
6823 for (off = 0; off < 10000L; ++off)
6825 int r;
6826 #if defined(UNIX) || defined(VMS)
6827 mode_t umask_save;
6828 #endif
6830 sprintf((char *)itmp + STRLEN(itmp), "v%ld", nr + off);
6831 # ifndef EEXIST
6832 /* If mkdir() does not set errno to EEXIST, check for
6833 * existing file here. There is a race condition then,
6834 * although it's fail-safe. */
6835 if (mch_stat((char *)itmp, &st) >= 0)
6836 continue;
6837 # endif
6838 #if defined(UNIX) || defined(VMS)
6839 /* Make sure the umask doesn't remove the executable bit.
6840 * "repl" has been reported to use "177". */
6841 umask_save = umask(077);
6842 #endif
6843 r = vim_mkdir(itmp, 0700);
6844 #if defined(UNIX) || defined(VMS)
6845 (void)umask(umask_save);
6846 #endif
6847 if (r == 0)
6849 char_u *buf;
6851 /* Directory was created, use this name.
6852 * Expand to full path; When using the current
6853 * directory a ":cd" would confuse us. */
6854 buf = alloc((unsigned)MAXPATHL + 1);
6855 if (buf != NULL)
6857 if (vim_FullName(itmp, buf, MAXPATHL, FALSE)
6858 == FAIL)
6859 STRCPY(buf, itmp);
6860 # ifdef __EMX__
6861 if (vim_strchr(buf, '/') != NULL)
6862 STRCAT(buf, "/");
6863 else
6864 # endif
6865 add_pathsep(buf);
6866 vim_tempdir = vim_strsave(buf);
6867 vim_free(buf);
6869 break;
6871 # ifdef EEXIST
6872 /* If the mkdir() didn't fail because the file/dir exists,
6873 * we probably can't create any dir here, try another
6874 * place. */
6875 if (errno != EEXIST)
6876 # endif
6877 break;
6879 if (vim_tempdir != NULL)
6880 break;
6885 if (vim_tempdir != NULL)
6887 /* There is no need to check if the file exists, because we own the
6888 * directory and nobody else creates a file in it. */
6889 sprintf((char *)itmp, "%s%ld", vim_tempdir, temp_count++);
6890 return vim_strsave(itmp);
6893 return NULL;
6895 #else /* TEMPDIRNAMES */
6897 # ifdef WIN3264
6898 char szTempFile[_MAX_PATH + 1];
6899 char buf4[4];
6900 char_u *retval;
6901 char_u *p;
6903 STRCPY(itmp, "");
6904 if (GetTempPath(_MAX_PATH, szTempFile) == 0)
6905 szTempFile[0] = NUL; /* GetTempPath() failed, use current dir */
6906 strcpy(buf4, "VIM");
6907 buf4[2] = extra_char; /* make it "VIa", "VIb", etc. */
6908 if (GetTempFileName(szTempFile, buf4, 0, itmp) == 0)
6909 return NULL;
6910 /* GetTempFileName() will create the file, we don't want that */
6911 (void)DeleteFile(itmp);
6913 /* Backslashes in a temp file name cause problems when filtering with
6914 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
6915 * didn't set 'shellslash'. */
6916 retval = vim_strsave(itmp);
6917 if (*p_shcf == '-' || p_ssl)
6918 for (p = retval; *p; ++p)
6919 if (*p == '\\')
6920 *p = '/';
6921 return retval;
6923 # else /* WIN3264 */
6925 # ifdef USE_TMPNAM
6926 /* tmpnam() will make its own name */
6927 if (*tmpnam((char *)itmp) == NUL)
6928 return NULL;
6929 # else
6930 char_u *p;
6932 # ifdef VMS_TEMPNAM
6933 /* mktemp() is not working on VMS. It seems to be
6934 * a do-nothing function. Therefore we use tempnam().
6936 sprintf((char *)itmp, "VIM%c", extra_char);
6937 p = (char_u *)tempnam("tmp:", (char *)itmp);
6938 if (p != NULL)
6940 /* VMS will use '.LOG' if we don't explicitly specify an extension,
6941 * and VIM will then be unable to find the file later */
6942 STRCPY(itmp, p);
6943 STRCAT(itmp, ".txt");
6944 free(p);
6946 else
6947 return NULL;
6948 # else
6949 STRCPY(itmp, TEMPNAME);
6950 if ((p = vim_strchr(itmp, '?')) != NULL)
6951 *p = extra_char;
6952 if (mktemp((char *)itmp) == NULL)
6953 return NULL;
6954 # endif
6955 # endif
6957 return vim_strsave(itmp);
6958 # endif /* WIN3264 */
6959 #endif /* TEMPDIRNAMES */
6962 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
6964 * Convert all backslashes in fname to forward slashes in-place.
6966 void
6967 forward_slash(fname)
6968 char_u *fname;
6970 char_u *p;
6972 for (p = fname; *p != NUL; ++p)
6973 # ifdef FEAT_MBYTE
6974 /* The Big5 encoding can have '\' in the trail byte. */
6975 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
6976 ++p;
6977 else
6978 # endif
6979 if (*p == '\\')
6980 *p = '/';
6982 #endif
6986 * Code for automatic commands.
6988 * Only included when "FEAT_AUTOCMD" has been defined.
6991 #if defined(FEAT_AUTOCMD) || defined(PROTO)
6994 * The autocommands are stored in a list for each event.
6995 * Autocommands for the same pattern, that are consecutive, are joined
6996 * together, to avoid having to match the pattern too often.
6997 * The result is an array of Autopat lists, which point to AutoCmd lists:
6999 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
7000 * Autopat.cmds Autopat.cmds
7001 * | |
7002 * V V
7003 * AutoCmd.next AutoCmd.next
7004 * | |
7005 * V V
7006 * AutoCmd.next NULL
7009 * NULL
7011 * first_autopat[1] --> Autopat.next --> NULL
7012 * Autopat.cmds
7015 * AutoCmd.next
7018 * NULL
7019 * etc.
7021 * The order of AutoCmds is important, this is the order in which they were
7022 * defined and will have to be executed.
7024 typedef struct AutoCmd
7026 char_u *cmd; /* The command to be executed (NULL
7027 when command has been removed) */
7028 char nested; /* If autocommands nest here */
7029 char last; /* last command in list */
7030 #ifdef FEAT_EVAL
7031 scid_T scriptID; /* script ID where defined */
7032 #endif
7033 struct AutoCmd *next; /* Next AutoCmd in list */
7034 } AutoCmd;
7036 typedef struct AutoPat
7038 int group; /* group ID */
7039 char_u *pat; /* pattern as typed (NULL when pattern
7040 has been removed) */
7041 int patlen; /* strlen() of pat */
7042 regprog_T *reg_prog; /* compiled regprog for pattern */
7043 char allow_dirs; /* Pattern may match whole path */
7044 char last; /* last pattern for apply_autocmds() */
7045 AutoCmd *cmds; /* list of commands to do */
7046 struct AutoPat *next; /* next AutoPat in AutoPat list */
7047 int buflocal_nr; /* !=0 for buffer-local AutoPat */
7048 } AutoPat;
7050 static struct event_name
7052 char *name; /* event name */
7053 event_T event; /* event number */
7054 } event_names[] =
7056 {"BufAdd", EVENT_BUFADD},
7057 {"BufCreate", EVENT_BUFADD},
7058 {"BufDelete", EVENT_BUFDELETE},
7059 {"BufEnter", EVENT_BUFENTER},
7060 {"BufFilePost", EVENT_BUFFILEPOST},
7061 {"BufFilePre", EVENT_BUFFILEPRE},
7062 {"BufHidden", EVENT_BUFHIDDEN},
7063 {"BufLeave", EVENT_BUFLEAVE},
7064 {"BufNew", EVENT_BUFNEW},
7065 {"BufNewFile", EVENT_BUFNEWFILE},
7066 {"BufRead", EVENT_BUFREADPOST},
7067 {"BufReadCmd", EVENT_BUFREADCMD},
7068 {"BufReadPost", EVENT_BUFREADPOST},
7069 {"BufReadPre", EVENT_BUFREADPRE},
7070 {"BufUnload", EVENT_BUFUNLOAD},
7071 {"BufWinEnter", EVENT_BUFWINENTER},
7072 {"BufWinLeave", EVENT_BUFWINLEAVE},
7073 {"BufWipeout", EVENT_BUFWIPEOUT},
7074 {"BufWrite", EVENT_BUFWRITEPRE},
7075 {"BufWritePost", EVENT_BUFWRITEPOST},
7076 {"BufWritePre", EVENT_BUFWRITEPRE},
7077 {"BufWriteCmd", EVENT_BUFWRITECMD},
7078 {"CmdwinEnter", EVENT_CMDWINENTER},
7079 {"CmdwinLeave", EVENT_CMDWINLEAVE},
7080 {"ColorScheme", EVENT_COLORSCHEME},
7081 {"CursorHold", EVENT_CURSORHOLD},
7082 {"CursorHoldI", EVENT_CURSORHOLDI},
7083 {"CursorMoved", EVENT_CURSORMOVED},
7084 {"CursorMovedI", EVENT_CURSORMOVEDI},
7085 {"EncodingChanged", EVENT_ENCODINGCHANGED},
7086 {"FileEncoding", EVENT_ENCODINGCHANGED},
7087 {"FileAppendPost", EVENT_FILEAPPENDPOST},
7088 {"FileAppendPre", EVENT_FILEAPPENDPRE},
7089 {"FileAppendCmd", EVENT_FILEAPPENDCMD},
7090 {"FileChangedShell",EVENT_FILECHANGEDSHELL},
7091 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST},
7092 {"FileChangedRO", EVENT_FILECHANGEDRO},
7093 {"FileReadPost", EVENT_FILEREADPOST},
7094 {"FileReadPre", EVENT_FILEREADPRE},
7095 {"FileReadCmd", EVENT_FILEREADCMD},
7096 {"FileType", EVENT_FILETYPE},
7097 {"FileWritePost", EVENT_FILEWRITEPOST},
7098 {"FileWritePre", EVENT_FILEWRITEPRE},
7099 {"FileWriteCmd", EVENT_FILEWRITECMD},
7100 {"FilterReadPost", EVENT_FILTERREADPOST},
7101 {"FilterReadPre", EVENT_FILTERREADPRE},
7102 {"FilterWritePost", EVENT_FILTERWRITEPOST},
7103 {"FilterWritePre", EVENT_FILTERWRITEPRE},
7104 {"FocusGained", EVENT_FOCUSGAINED},
7105 {"FocusLost", EVENT_FOCUSLOST},
7106 {"FuncUndefined", EVENT_FUNCUNDEFINED},
7107 {"GUIEnter", EVENT_GUIENTER},
7108 {"GUIFailed", EVENT_GUIFAILED},
7109 {"InsertChange", EVENT_INSERTCHANGE},
7110 {"InsertEnter", EVENT_INSERTENTER},
7111 {"InsertLeave", EVENT_INSERTLEAVE},
7112 {"MenuPopup", EVENT_MENUPOPUP},
7113 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
7114 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
7115 {"RemoteReply", EVENT_REMOTEREPLY},
7116 {"SessionLoadPost", EVENT_SESSIONLOADPOST},
7117 {"ShellCmdPost", EVENT_SHELLCMDPOST},
7118 {"ShellFilterPost", EVENT_SHELLFILTERPOST},
7119 {"SourcePre", EVENT_SOURCEPRE},
7120 {"SourceCmd", EVENT_SOURCECMD},
7121 {"SpellFileMissing",EVENT_SPELLFILEMISSING},
7122 {"StdinReadPost", EVENT_STDINREADPOST},
7123 {"StdinReadPre", EVENT_STDINREADPRE},
7124 {"SwapExists", EVENT_SWAPEXISTS},
7125 {"Syntax", EVENT_SYNTAX},
7126 {"TabEnter", EVENT_TABENTER},
7127 {"TabLeave", EVENT_TABLEAVE},
7128 {"TermChanged", EVENT_TERMCHANGED},
7129 {"TermResponse", EVENT_TERMRESPONSE},
7130 {"User", EVENT_USER},
7131 {"VimEnter", EVENT_VIMENTER},
7132 {"VimLeave", EVENT_VIMLEAVE},
7133 {"VimLeavePre", EVENT_VIMLEAVEPRE},
7134 {"WinEnter", EVENT_WINENTER},
7135 {"WinLeave", EVENT_WINLEAVE},
7136 {"VimResized", EVENT_VIMRESIZED},
7137 {NULL, (event_T)0}
7140 static AutoPat *first_autopat[NUM_EVENTS] =
7142 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7143 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7144 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7145 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7146 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
7147 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
7151 * struct used to keep status while executing autocommands for an event.
7153 typedef struct AutoPatCmd
7155 AutoPat *curpat; /* next AutoPat to examine */
7156 AutoCmd *nextcmd; /* next AutoCmd to execute */
7157 int group; /* group being used */
7158 char_u *fname; /* fname to match with */
7159 char_u *sfname; /* sfname to match with */
7160 char_u *tail; /* tail of fname */
7161 event_T event; /* current event */
7162 int arg_bufnr; /* initially equal to <abuf>, set to zero when
7163 buf is deleted */
7164 struct AutoPatCmd *next; /* chain of active apc-s for auto-invalidation*/
7165 } AutoPatCmd;
7167 static AutoPatCmd *active_apc_list = NULL; /* stack of active autocommands */
7170 * augroups stores a list of autocmd group names.
7172 static garray_T augroups = {0, 0, sizeof(char_u *), 10, NULL};
7173 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7176 * The ID of the current group. Group 0 is the default one.
7178 static int current_augroup = AUGROUP_DEFAULT;
7180 static int au_need_clean = FALSE; /* need to delete marked patterns */
7182 static void show_autocmd __ARGS((AutoPat *ap, event_T event));
7183 static void au_remove_pat __ARGS((AutoPat *ap));
7184 static void au_remove_cmds __ARGS((AutoPat *ap));
7185 static void au_cleanup __ARGS((void));
7186 static int au_new_group __ARGS((char_u *name));
7187 static void au_del_group __ARGS((char_u *name));
7188 static event_T event_name2nr __ARGS((char_u *start, char_u **end));
7189 static char_u *event_nr2name __ARGS((event_T event));
7190 static char_u *find_end_event __ARGS((char_u *arg, int have_group));
7191 static int event_ignored __ARGS((event_T event));
7192 static int au_get_grouparg __ARGS((char_u **argp));
7193 static int do_autocmd_event __ARGS((event_T event, char_u *pat, int nested, char_u *cmd, int forceit, int group));
7194 static char_u *getnextac __ARGS((int c, void *cookie, int indent));
7195 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));
7196 static void auto_next_pat __ARGS((AutoPatCmd *apc, int stop_at_last));
7199 static event_T last_event;
7200 static int last_group;
7201 static int autocmd_blocked = 0; /* block all autocmds */
7204 * Show the autocommands for one AutoPat.
7206 static void
7207 show_autocmd(ap, event)
7208 AutoPat *ap;
7209 event_T event;
7211 AutoCmd *ac;
7213 /* Check for "got_int" (here and at various places below), which is set
7214 * when "q" has been hit for the "--more--" prompt */
7215 if (got_int)
7216 return;
7217 if (ap->pat == NULL) /* pattern has been removed */
7218 return;
7220 msg_putchar('\n');
7221 if (got_int)
7222 return;
7223 if (event != last_event || ap->group != last_group)
7225 if (ap->group != AUGROUP_DEFAULT)
7227 if (AUGROUP_NAME(ap->group) == NULL)
7228 msg_puts_attr((char_u *)_("--Deleted--"), hl_attr(HLF_E));
7229 else
7230 msg_puts_attr(AUGROUP_NAME(ap->group), hl_attr(HLF_T));
7231 msg_puts((char_u *)" ");
7233 msg_puts_attr(event_nr2name(event), hl_attr(HLF_T));
7234 last_event = event;
7235 last_group = ap->group;
7236 msg_putchar('\n');
7237 if (got_int)
7238 return;
7240 msg_col = 4;
7241 msg_outtrans(ap->pat);
7243 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7245 if (ac->cmd != NULL) /* skip removed commands */
7247 if (msg_col >= 14)
7248 msg_putchar('\n');
7249 msg_col = 14;
7250 if (got_int)
7251 return;
7252 msg_outtrans(ac->cmd);
7253 #ifdef FEAT_EVAL
7254 if (p_verbose > 0)
7255 last_set_msg(ac->scriptID);
7256 #endif
7257 if (got_int)
7258 return;
7259 if (ac->next != NULL)
7261 msg_putchar('\n');
7262 if (got_int)
7263 return;
7270 * Mark an autocommand pattern for deletion.
7272 static void
7273 au_remove_pat(ap)
7274 AutoPat *ap;
7276 vim_free(ap->pat);
7277 ap->pat = NULL;
7278 ap->buflocal_nr = -1;
7279 au_need_clean = TRUE;
7283 * Mark all commands for a pattern for deletion.
7285 static void
7286 au_remove_cmds(ap)
7287 AutoPat *ap;
7289 AutoCmd *ac;
7291 for (ac = ap->cmds; ac != NULL; ac = ac->next)
7293 vim_free(ac->cmd);
7294 ac->cmd = NULL;
7296 au_need_clean = TRUE;
7300 * Cleanup autocommands and patterns that have been deleted.
7301 * This is only done when not executing autocommands.
7303 static void
7304 au_cleanup()
7306 AutoPat *ap, **prev_ap;
7307 AutoCmd *ac, **prev_ac;
7308 event_T event;
7310 if (autocmd_busy || !au_need_clean)
7311 return;
7313 /* loop over all events */
7314 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7315 event = (event_T)((int)event + 1))
7317 /* loop over all autocommand patterns */
7318 prev_ap = &(first_autopat[(int)event]);
7319 for (ap = *prev_ap; ap != NULL; ap = *prev_ap)
7321 /* loop over all commands for this pattern */
7322 prev_ac = &(ap->cmds);
7323 for (ac = *prev_ac; ac != NULL; ac = *prev_ac)
7325 /* remove the command if the pattern is to be deleted or when
7326 * the command has been marked for deletion */
7327 if (ap->pat == NULL || ac->cmd == NULL)
7329 *prev_ac = ac->next;
7330 vim_free(ac->cmd);
7331 vim_free(ac);
7333 else
7334 prev_ac = &(ac->next);
7337 /* remove the pattern if it has been marked for deletion */
7338 if (ap->pat == NULL)
7340 *prev_ap = ap->next;
7341 vim_free(ap->reg_prog);
7342 vim_free(ap);
7344 else
7345 prev_ap = &(ap->next);
7349 au_need_clean = FALSE;
7353 * Called when buffer is freed, to remove/invalidate related buffer-local
7354 * autocmds.
7356 void
7357 aubuflocal_remove(buf)
7358 buf_T *buf;
7360 AutoPat *ap;
7361 event_T event;
7362 AutoPatCmd *apc;
7364 /* invalidate currently executing autocommands */
7365 for (apc = active_apc_list; apc; apc = apc->next)
7366 if (buf->b_fnum == apc->arg_bufnr)
7367 apc->arg_bufnr = 0;
7369 /* invalidate buflocals looping through events */
7370 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7371 event = (event_T)((int)event + 1))
7372 /* loop over all autocommand patterns */
7373 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
7374 if (ap->buflocal_nr == buf->b_fnum)
7376 au_remove_pat(ap);
7377 if (p_verbose >= 6)
7379 verbose_enter();
7380 smsg((char_u *)
7381 _("auto-removing autocommand: %s <buffer=%d>"),
7382 event_nr2name(event), buf->b_fnum);
7383 verbose_leave();
7386 au_cleanup();
7390 * Add an autocmd group name.
7391 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7393 static int
7394 au_new_group(name)
7395 char_u *name;
7397 int i;
7399 i = au_find_group(name);
7400 if (i == AUGROUP_ERROR) /* the group doesn't exist yet, add it */
7402 /* First try using a free entry. */
7403 for (i = 0; i < augroups.ga_len; ++i)
7404 if (AUGROUP_NAME(i) == NULL)
7405 break;
7406 if (i == augroups.ga_len && ga_grow(&augroups, 1) == FAIL)
7407 return AUGROUP_ERROR;
7409 AUGROUP_NAME(i) = vim_strsave(name);
7410 if (AUGROUP_NAME(i) == NULL)
7411 return AUGROUP_ERROR;
7412 if (i == augroups.ga_len)
7413 ++augroups.ga_len;
7416 return i;
7419 static void
7420 au_del_group(name)
7421 char_u *name;
7423 int i;
7425 i = au_find_group(name);
7426 if (i == AUGROUP_ERROR) /* the group doesn't exist */
7427 EMSG2(_("E367: No such group: \"%s\""), name);
7428 else
7430 vim_free(AUGROUP_NAME(i));
7431 AUGROUP_NAME(i) = NULL;
7436 * Find the ID of an autocmd group name.
7437 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7439 static int
7440 au_find_group(name)
7441 char_u *name;
7443 int i;
7445 for (i = 0; i < augroups.ga_len; ++i)
7446 if (AUGROUP_NAME(i) != NULL && STRCMP(AUGROUP_NAME(i), name) == 0)
7447 return i;
7448 return AUGROUP_ERROR;
7452 * Return TRUE if augroup "name" exists.
7455 au_has_group(name)
7456 char_u *name;
7458 return au_find_group(name) != AUGROUP_ERROR;
7462 * ":augroup {name}".
7464 void
7465 do_augroup(arg, del_group)
7466 char_u *arg;
7467 int del_group;
7469 int i;
7471 if (del_group)
7473 if (*arg == NUL)
7474 EMSG(_(e_argreq));
7475 else
7476 au_del_group(arg);
7478 else if (STRICMP(arg, "end") == 0) /* ":aug end": back to group 0 */
7479 current_augroup = AUGROUP_DEFAULT;
7480 else if (*arg) /* ":aug xxx": switch to group xxx */
7482 i = au_new_group(arg);
7483 if (i != AUGROUP_ERROR)
7484 current_augroup = i;
7486 else /* ":aug": list the group names */
7488 msg_start();
7489 for (i = 0; i < augroups.ga_len; ++i)
7491 if (AUGROUP_NAME(i) != NULL)
7493 msg_puts(AUGROUP_NAME(i));
7494 msg_puts((char_u *)" ");
7497 msg_clr_eos();
7498 msg_end();
7502 #if defined(EXITFREE) || defined(PROTO)
7503 void
7504 free_all_autocmds()
7506 for (current_augroup = -1; current_augroup < augroups.ga_len;
7507 ++current_augroup)
7508 do_autocmd((char_u *)"", TRUE);
7509 ga_clear_strings(&augroups);
7511 #endif
7514 * Return the event number for event name "start".
7515 * Return NUM_EVENTS if the event name was not found.
7516 * Return a pointer to the next event name in "end".
7518 static event_T
7519 event_name2nr(start, end)
7520 char_u *start;
7521 char_u **end;
7523 char_u *p;
7524 int i;
7525 int len;
7527 /* the event name ends with end of line, a blank or a comma */
7528 for (p = start; *p && !vim_iswhite(*p) && *p != ','; ++p)
7530 for (i = 0; event_names[i].name != NULL; ++i)
7532 len = (int)STRLEN(event_names[i].name);
7533 if (len == p - start && STRNICMP(event_names[i].name, start, len) == 0)
7534 break;
7536 if (*p == ',')
7537 ++p;
7538 *end = p;
7539 if (event_names[i].name == NULL)
7540 return NUM_EVENTS;
7541 return event_names[i].event;
7545 * Return the name for event "event".
7547 static char_u *
7548 event_nr2name(event)
7549 event_T event;
7551 int i;
7553 for (i = 0; event_names[i].name != NULL; ++i)
7554 if (event_names[i].event == event)
7555 return (char_u *)event_names[i].name;
7556 return (char_u *)"Unknown";
7560 * Scan over the events. "*" stands for all events.
7562 static char_u *
7563 find_end_event(arg, have_group)
7564 char_u *arg;
7565 int have_group; /* TRUE when group name was found */
7567 char_u *pat;
7568 char_u *p;
7570 if (*arg == '*')
7572 if (arg[1] && !vim_iswhite(arg[1]))
7574 EMSG2(_("E215: Illegal character after *: %s"), arg);
7575 return NULL;
7577 pat = arg + 1;
7579 else
7581 for (pat = arg; *pat && !vim_iswhite(*pat); pat = p)
7583 if ((int)event_name2nr(pat, &p) >= (int)NUM_EVENTS)
7585 if (have_group)
7586 EMSG2(_("E216: No such event: %s"), pat);
7587 else
7588 EMSG2(_("E216: No such group or event: %s"), pat);
7589 return NULL;
7593 return pat;
7597 * Return TRUE if "event" is included in 'eventignore'.
7599 static int
7600 event_ignored(event)
7601 event_T event;
7603 char_u *p = p_ei;
7605 while (*p != NUL)
7607 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7608 return TRUE;
7609 if (event_name2nr(p, &p) == event)
7610 return TRUE;
7613 return FALSE;
7617 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7620 check_ei()
7622 char_u *p = p_ei;
7624 while (*p)
7626 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
7628 p += 3;
7629 if (*p == ',')
7630 ++p;
7632 else if (event_name2nr(p, &p) == NUM_EVENTS)
7633 return FAIL;
7636 return OK;
7639 # if defined(FEAT_SYN_HL) || defined(PROTO)
7642 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7643 * buffer loaded into the window. "what" must start with a comma.
7644 * Returns the old value of 'eventignore' in allocated memory.
7646 char_u *
7647 au_event_disable(what)
7648 char *what;
7650 char_u *new_ei;
7651 char_u *save_ei;
7653 save_ei = vim_strsave(p_ei);
7654 if (save_ei != NULL)
7656 new_ei = vim_strnsave(p_ei, (int)(STRLEN(p_ei) + STRLEN(what)));
7657 if (new_ei != NULL)
7659 STRCAT(new_ei, what);
7660 set_string_option_direct((char_u *)"ei", -1, new_ei,
7661 OPT_FREE, SID_NONE);
7662 vim_free(new_ei);
7665 return save_ei;
7668 void
7669 au_event_restore(old_ei)
7670 char_u *old_ei;
7672 if (old_ei != NULL)
7674 set_string_option_direct((char_u *)"ei", -1, old_ei,
7675 OPT_FREE, SID_NONE);
7676 vim_free(old_ei);
7679 # endif /* FEAT_SYN_HL */
7682 * do_autocmd() -- implements the :autocmd command. Can be used in the
7683 * following ways:
7685 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7686 * will be automatically executed for <event>
7687 * when editing a file matching <pat>, in
7688 * the current group.
7689 * :autocmd <event> <pat> Show the auto-commands associated with
7690 * <event> and <pat>.
7691 * :autocmd <event> Show the auto-commands associated with
7692 * <event>.
7693 * :autocmd Show all auto-commands.
7694 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7695 * <event> and <pat>, and add the command
7696 * <cmd>, for the current group.
7697 * :autocmd! <event> <pat> Remove all auto-commands associated with
7698 * <event> and <pat> for the current group.
7699 * :autocmd! <event> Remove all auto-commands associated with
7700 * <event> for the current group.
7701 * :autocmd! Remove ALL auto-commands for the current
7702 * group.
7704 * Multiple events and patterns may be given separated by commas. Here are
7705 * some examples:
7706 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
7707 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
7709 * :autocmd * *.c show all autocommands for *.c files.
7711 * Mostly a {group} argument can optionally appear before <event>.
7713 void
7714 do_autocmd(arg, forceit)
7715 char_u *arg;
7716 int forceit;
7718 char_u *pat;
7719 char_u *envpat = NULL;
7720 char_u *cmd;
7721 event_T event;
7722 int need_free = FALSE;
7723 int nested = FALSE;
7724 int group;
7727 * Check for a legal group name. If not, use AUGROUP_ALL.
7729 group = au_get_grouparg(&arg);
7730 if (arg == NULL) /* out of memory */
7731 return;
7734 * Scan over the events.
7735 * If we find an illegal name, return here, don't do anything.
7737 pat = find_end_event(arg, group != AUGROUP_ALL);
7738 if (pat == NULL)
7739 return;
7742 * Scan over the pattern. Put a NUL at the end.
7744 pat = skipwhite(pat);
7745 cmd = pat;
7746 while (*cmd && (!vim_iswhite(*cmd) || cmd[-1] == '\\'))
7747 cmd++;
7748 if (*cmd)
7749 *cmd++ = NUL;
7751 /* Expand environment variables in the pattern. Set 'shellslash', we want
7752 * forward slashes here. */
7753 if (vim_strchr(pat, '$') != NULL || vim_strchr(pat, '~') != NULL)
7755 #ifdef BACKSLASH_IN_FILENAME
7756 int p_ssl_save = p_ssl;
7758 p_ssl = TRUE;
7759 #endif
7760 envpat = expand_env_save(pat);
7761 #ifdef BACKSLASH_IN_FILENAME
7762 p_ssl = p_ssl_save;
7763 #endif
7764 if (envpat != NULL)
7765 pat = envpat;
7769 * Check for "nested" flag.
7771 cmd = skipwhite(cmd);
7772 if (*cmd != NUL && STRNCMP(cmd, "nested", 6) == 0 && vim_iswhite(cmd[6]))
7774 nested = TRUE;
7775 cmd = skipwhite(cmd + 6);
7779 * Find the start of the commands.
7780 * Expand <sfile> in it.
7782 if (*cmd != NUL)
7784 cmd = expand_sfile(cmd);
7785 if (cmd == NULL) /* some error */
7786 return;
7787 need_free = TRUE;
7791 * Print header when showing autocommands.
7793 if (!forceit && *cmd == NUL)
7795 /* Highlight title */
7796 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
7800 * Loop over the events.
7802 last_event = (event_T)-1; /* for listing the event name */
7803 last_group = AUGROUP_ERROR; /* for listing the group name */
7804 if (*arg == '*' || *arg == NUL)
7806 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
7807 event = (event_T)((int)event + 1))
7808 if (do_autocmd_event(event, pat,
7809 nested, cmd, forceit, group) == FAIL)
7810 break;
7812 else
7814 while (*arg && !vim_iswhite(*arg))
7815 if (do_autocmd_event(event_name2nr(arg, &arg), pat,
7816 nested, cmd, forceit, group) == FAIL)
7817 break;
7820 if (need_free)
7821 vim_free(cmd);
7822 vim_free(envpat);
7826 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
7827 * The "argp" argument is advanced to the following argument.
7829 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
7831 static int
7832 au_get_grouparg(argp)
7833 char_u **argp;
7835 char_u *group_name;
7836 char_u *p;
7837 char_u *arg = *argp;
7838 int group = AUGROUP_ALL;
7840 p = skiptowhite(arg);
7841 if (p > arg)
7843 group_name = vim_strnsave(arg, (int)(p - arg));
7844 if (group_name == NULL) /* out of memory */
7845 return AUGROUP_ERROR;
7846 group = au_find_group(group_name);
7847 if (group == AUGROUP_ERROR)
7848 group = AUGROUP_ALL; /* no match, use all groups */
7849 else
7850 *argp = skipwhite(p); /* match, skip over group name */
7851 vim_free(group_name);
7853 return group;
7857 * do_autocmd() for one event.
7858 * If *pat == NUL do for all patterns.
7859 * If *cmd == NUL show entries.
7860 * If forceit == TRUE delete entries.
7861 * If group is not AUGROUP_ALL, only use this group.
7863 static int
7864 do_autocmd_event(event, pat, nested, cmd, forceit, group)
7865 event_T event;
7866 char_u *pat;
7867 int nested;
7868 char_u *cmd;
7869 int forceit;
7870 int group;
7872 AutoPat *ap;
7873 AutoPat **prev_ap;
7874 AutoCmd *ac;
7875 AutoCmd **prev_ac;
7876 int brace_level;
7877 char_u *endpat;
7878 int findgroup;
7879 int allgroups;
7880 int patlen;
7881 int is_buflocal;
7882 int buflocal_nr;
7883 char_u buflocal_pat[25]; /* for "<buffer=X>" */
7885 if (group == AUGROUP_ALL)
7886 findgroup = current_augroup;
7887 else
7888 findgroup = group;
7889 allgroups = (group == AUGROUP_ALL && !forceit && *cmd == NUL);
7892 * Show or delete all patterns for an event.
7894 if (*pat == NUL)
7896 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
7898 if (forceit) /* delete the AutoPat, if it's in the current group */
7900 if (ap->group == findgroup)
7901 au_remove_pat(ap);
7903 else if (group == AUGROUP_ALL || ap->group == group)
7904 show_autocmd(ap, event);
7909 * Loop through all the specified patterns.
7911 for ( ; *pat; pat = (*endpat == ',' ? endpat + 1 : endpat))
7914 * Find end of the pattern.
7915 * Watch out for a comma in braces, like "*.\{obj,o\}".
7917 brace_level = 0;
7918 for (endpat = pat; *endpat && (*endpat != ',' || brace_level
7919 || endpat[-1] == '\\'); ++endpat)
7921 if (*endpat == '{')
7922 brace_level++;
7923 else if (*endpat == '}')
7924 brace_level--;
7926 if (pat == endpat) /* ignore single comma */
7927 continue;
7928 patlen = (int)(endpat - pat);
7931 * detect special <buflocal[=X]> buffer-local patterns
7933 is_buflocal = FALSE;
7934 buflocal_nr = 0;
7936 if (patlen >= 7 && STRNCMP(pat, "<buffer", 7) == 0
7937 && pat[patlen - 1] == '>')
7939 /* Error will be printed only for addition. printing and removing
7940 * will proceed silently. */
7941 is_buflocal = TRUE;
7942 if (patlen == 8)
7943 buflocal_nr = curbuf->b_fnum;
7944 else if (patlen > 9 && pat[7] == '=')
7946 /* <buffer=abuf> */
7947 if (patlen == 13 && STRNICMP(pat, "<buffer=abuf>", 13))
7948 buflocal_nr = autocmd_bufnr;
7949 /* <buffer=123> */
7950 else if (skipdigits(pat + 8) == pat + patlen - 1)
7951 buflocal_nr = atoi((char *)pat + 8);
7955 if (is_buflocal)
7957 /* normalize pat into standard "<buffer>#N" form */
7958 sprintf((char *)buflocal_pat, "<buffer=%d>", buflocal_nr);
7959 pat = buflocal_pat; /* can modify pat and patlen */
7960 patlen = (int)STRLEN(buflocal_pat); /* but not endpat */
7964 * Find AutoPat entries with this pattern.
7966 prev_ap = &first_autopat[(int)event];
7967 while ((ap = *prev_ap) != NULL)
7969 if (ap->pat != NULL)
7971 /* Accept a pattern when:
7972 * - a group was specified and it's that group, or a group was
7973 * not specified and it's the current group, or a group was
7974 * not specified and we are listing
7975 * - the length of the pattern matches
7976 * - the pattern matches.
7977 * For <buffer[=X]>, this condition works because we normalize
7978 * all buffer-local patterns.
7980 if ((allgroups || ap->group == findgroup)
7981 && ap->patlen == patlen
7982 && STRNCMP(pat, ap->pat, patlen) == 0)
7985 * Remove existing autocommands.
7986 * If adding any new autocmd's for this AutoPat, don't
7987 * delete the pattern from the autopat list, append to
7988 * this list.
7990 if (forceit)
7992 if (*cmd != NUL && ap->next == NULL)
7994 au_remove_cmds(ap);
7995 break;
7997 au_remove_pat(ap);
8001 * Show autocmd's for this autopat, or buflocals <buffer=X>
8003 else if (*cmd == NUL)
8004 show_autocmd(ap, event);
8007 * Add autocmd to this autopat, if it's the last one.
8009 else if (ap->next == NULL)
8010 break;
8013 prev_ap = &ap->next;
8017 * Add a new command.
8019 if (*cmd != NUL)
8022 * If the pattern we want to add a command to does appear at the
8023 * end of the list (or not is not in the list at all), add the
8024 * pattern at the end of the list.
8026 if (ap == NULL)
8028 /* refuse to add buffer-local ap if buffer number is invalid */
8029 if (is_buflocal && (buflocal_nr == 0
8030 || buflist_findnr(buflocal_nr) == NULL))
8032 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
8033 buflocal_nr);
8034 return FAIL;
8037 ap = (AutoPat *)alloc((unsigned)sizeof(AutoPat));
8038 if (ap == NULL)
8039 return FAIL;
8040 ap->pat = vim_strnsave(pat, patlen);
8041 ap->patlen = patlen;
8042 if (ap->pat == NULL)
8044 vim_free(ap);
8045 return FAIL;
8048 if (is_buflocal)
8050 ap->buflocal_nr = buflocal_nr;
8051 ap->reg_prog = NULL;
8053 else
8055 char_u *reg_pat;
8057 ap->buflocal_nr = 0;
8058 reg_pat = file_pat_to_reg_pat(pat, endpat,
8059 &ap->allow_dirs, TRUE);
8060 if (reg_pat != NULL)
8061 ap->reg_prog = vim_regcomp(reg_pat, RE_MAGIC);
8062 vim_free(reg_pat);
8063 if (reg_pat == NULL || ap->reg_prog == NULL)
8065 vim_free(ap->pat);
8066 vim_free(ap);
8067 return FAIL;
8070 ap->cmds = NULL;
8071 *prev_ap = ap;
8072 ap->next = NULL;
8073 if (group == AUGROUP_ALL)
8074 ap->group = current_augroup;
8075 else
8076 ap->group = group;
8080 * Add the autocmd at the end of the AutoCmd list.
8082 prev_ac = &(ap->cmds);
8083 while ((ac = *prev_ac) != NULL)
8084 prev_ac = &ac->next;
8085 ac = (AutoCmd *)alloc((unsigned)sizeof(AutoCmd));
8086 if (ac == NULL)
8087 return FAIL;
8088 ac->cmd = vim_strsave(cmd);
8089 #ifdef FEAT_EVAL
8090 ac->scriptID = current_SID;
8091 #endif
8092 if (ac->cmd == NULL)
8094 vim_free(ac);
8095 return FAIL;
8097 ac->next = NULL;
8098 *prev_ac = ac;
8099 ac->nested = nested;
8103 au_cleanup(); /* may really delete removed patterns/commands now */
8104 return OK;
8108 * Implementation of ":doautocmd [group] event [fname]".
8109 * Return OK for success, FAIL for failure;
8112 do_doautocmd(arg, do_msg)
8113 char_u *arg;
8114 int do_msg; /* give message for no matching autocmds? */
8116 char_u *fname;
8117 int nothing_done = TRUE;
8118 int group;
8121 * Check for a legal group name. If not, use AUGROUP_ALL.
8123 group = au_get_grouparg(&arg);
8124 if (arg == NULL) /* out of memory */
8125 return FAIL;
8127 if (*arg == '*')
8129 EMSG(_("E217: Can't execute autocommands for ALL events"));
8130 return FAIL;
8134 * Scan over the events.
8135 * If we find an illegal name, return here, don't do anything.
8137 fname = find_end_event(arg, group != AUGROUP_ALL);
8138 if (fname == NULL)
8139 return FAIL;
8141 fname = skipwhite(fname);
8144 * Loop over the events.
8146 while (*arg && !vim_iswhite(*arg))
8147 if (apply_autocmds_group(event_name2nr(arg, &arg),
8148 fname, NULL, TRUE, group, curbuf, NULL))
8149 nothing_done = FALSE;
8151 if (nothing_done && do_msg)
8152 MSG(_("No matching autocommands"));
8154 #ifdef FEAT_EVAL
8155 return aborting() ? FAIL : OK;
8156 #else
8157 return OK;
8158 #endif
8162 * ":doautoall": execute autocommands for each loaded buffer.
8164 void
8165 ex_doautoall(eap)
8166 exarg_T *eap;
8168 int retval;
8169 aco_save_T aco;
8170 buf_T *buf;
8173 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8174 * equal to curbuf, but for some buffers there may not be a window.
8175 * So we change the buffer for the current window for a moment. This
8176 * gives problems when the autocommands make changes to the list of
8177 * buffers or windows...
8179 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8181 if (curbuf->b_ml.ml_mfp != NULL)
8183 /* find a window for this buffer and save some values */
8184 aucmd_prepbuf(&aco, buf);
8186 /* execute the autocommands for this buffer */
8187 retval = do_doautocmd(eap->arg, FALSE);
8189 /* Execute the modeline settings, but don't set window-local
8190 * options if we are using the current window for another buffer. */
8191 do_modelines(aco.save_curwin == NULL ? OPT_NOWIN : 0);
8193 /* restore the current window */
8194 aucmd_restbuf(&aco);
8196 /* stop if there is some error or buffer was deleted */
8197 if (retval == FAIL || !buf_valid(buf))
8198 break;
8202 check_cursor(); /* just in case lines got deleted */
8206 * Prepare for executing autocommands for (hidden) buffer "buf".
8207 * Search a window for the current buffer. Save the cursor position and
8208 * screen offset.
8209 * Set "curbuf" and "curwin" to match "buf".
8210 * When FEAT_AUTOCMD is not defined another version is used, see below.
8212 void
8213 aucmd_prepbuf(aco, buf)
8214 aco_save_T *aco; /* structure to save values in */
8215 buf_T *buf; /* new curbuf */
8217 win_T *win;
8219 aco->new_curbuf = buf;
8221 /* Find a window that is for the new buffer */
8222 if (buf == curbuf) /* be quick when buf is curbuf */
8223 win = curwin;
8224 else
8225 #ifdef FEAT_WINDOWS
8226 for (win = firstwin; win != NULL; win = win->w_next)
8227 if (win->w_buffer == buf)
8228 break;
8229 #else
8230 win = NULL;
8231 #endif
8234 * Prefer to use an existing window for the buffer, it has the least side
8235 * effects (esp. if "buf" is curbuf).
8236 * Otherwise, use curwin for "buf". It might make some items in the
8237 * window invalid. At least save the cursor and topline.
8239 if (win != NULL)
8241 /* there is a window for "buf", make it the curwin */
8242 aco->save_curwin = curwin;
8243 curwin = win;
8244 aco->save_buf = win->w_buffer;
8245 aco->new_curwin = win;
8247 else
8249 /* there is no window for "buf", use curwin */
8250 aco->save_curwin = NULL;
8251 aco->save_buf = curbuf;
8252 --curbuf->b_nwindows;
8253 curwin->w_buffer = buf;
8254 ++buf->b_nwindows;
8256 /* save cursor and topline, set them to safe values */
8257 aco->save_cursor = curwin->w_cursor;
8258 curwin->w_cursor.lnum = 1;
8259 curwin->w_cursor.col = 0;
8260 aco->save_topline = curwin->w_topline;
8261 curwin->w_topline = 1;
8262 #ifdef FEAT_DIFF
8263 aco->save_topfill = curwin->w_topfill;
8264 curwin->w_topfill = 0;
8265 #endif
8268 curbuf = buf;
8272 * Cleanup after executing autocommands for a (hidden) buffer.
8273 * Restore the window as it was (if possible).
8274 * When FEAT_AUTOCMD is not defined another version is used, see below.
8276 void
8277 aucmd_restbuf(aco)
8278 aco_save_T *aco; /* structure holding saved values */
8280 if (aco->save_curwin != NULL)
8282 /* restore curwin */
8283 #ifdef FEAT_WINDOWS
8284 if (win_valid(aco->save_curwin))
8285 #endif
8287 /* restore the buffer which was previously edited by curwin, if
8288 * it's still the same window and it's valid */
8289 if (curwin == aco->new_curwin
8290 && buf_valid(aco->save_buf)
8291 && aco->save_buf->b_ml.ml_mfp != NULL)
8293 --curbuf->b_nwindows;
8294 curbuf = aco->save_buf;
8295 curwin->w_buffer = curbuf;
8296 ++curbuf->b_nwindows;
8299 curwin = aco->save_curwin;
8300 curbuf = curwin->w_buffer;
8303 else
8305 /* restore buffer for curwin if it still exists and is loaded */
8306 if (buf_valid(aco->save_buf) && aco->save_buf->b_ml.ml_mfp != NULL)
8308 --curbuf->b_nwindows;
8309 curbuf = aco->save_buf;
8310 curwin->w_buffer = curbuf;
8311 ++curbuf->b_nwindows;
8312 curwin->w_cursor = aco->save_cursor;
8313 check_cursor();
8314 /* check topline < line_count, in case lines got deleted */
8315 if (aco->save_topline <= curbuf->b_ml.ml_line_count)
8317 curwin->w_topline = aco->save_topline;
8318 #ifdef FEAT_DIFF
8319 curwin->w_topfill = aco->save_topfill;
8320 #endif
8322 else
8324 curwin->w_topline = curbuf->b_ml.ml_line_count;
8325 #ifdef FEAT_DIFF
8326 curwin->w_topfill = 0;
8327 #endif
8333 static int autocmd_nested = FALSE;
8336 * Execute autocommands for "event" and file name "fname".
8337 * Return TRUE if some commands were executed.
8340 apply_autocmds(event, fname, fname_io, force, buf)
8341 event_T event;
8342 char_u *fname; /* NULL or empty means use actual file name */
8343 char_u *fname_io; /* fname to use for <afile> on cmdline */
8344 int force; /* when TRUE, ignore autocmd_busy */
8345 buf_T *buf; /* buffer for <abuf> */
8347 return apply_autocmds_group(event, fname, fname_io, force,
8348 AUGROUP_ALL, buf, NULL);
8352 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8353 * setting v:filearg.
8355 static int
8356 apply_autocmds_exarg(event, fname, fname_io, force, buf, eap)
8357 event_T event;
8358 char_u *fname;
8359 char_u *fname_io;
8360 int force;
8361 buf_T *buf;
8362 exarg_T *eap;
8364 return apply_autocmds_group(event, fname, fname_io, force,
8365 AUGROUP_ALL, buf, eap);
8369 * Like apply_autocmds(), but handles the caller's retval. If the script
8370 * processing is being aborted or if retval is FAIL when inside a try
8371 * conditional, no autocommands are executed. If otherwise the autocommands
8372 * cause the script to be aborted, retval is set to FAIL.
8375 apply_autocmds_retval(event, fname, fname_io, force, buf, retval)
8376 event_T event;
8377 char_u *fname; /* NULL or empty means use actual file name */
8378 char_u *fname_io; /* fname to use for <afile> on cmdline */
8379 int force; /* when TRUE, ignore autocmd_busy */
8380 buf_T *buf; /* buffer for <abuf> */
8381 int *retval; /* pointer to caller's retval */
8383 int did_cmd;
8385 #ifdef FEAT_EVAL
8386 if (should_abort(*retval))
8387 return FALSE;
8388 #endif
8390 did_cmd = apply_autocmds_group(event, fname, fname_io, force,
8391 AUGROUP_ALL, buf, NULL);
8392 if (did_cmd
8393 #ifdef FEAT_EVAL
8394 && aborting()
8395 #endif
8397 *retval = FAIL;
8398 return did_cmd;
8402 * Return TRUE when there is a CursorHold autocommand defined.
8405 has_cursorhold()
8407 return (first_autopat[(int)(get_real_state() == NORMAL_BUSY
8408 ? EVENT_CURSORHOLD : EVENT_CURSORHOLDI)] != NULL);
8412 * Return TRUE if the CursorHold event can be triggered.
8415 trigger_cursorhold()
8417 int state;
8419 if (!did_cursorhold && has_cursorhold() && !Recording
8420 #ifdef FEAT_INS_EXPAND
8421 && !ins_compl_active()
8422 #endif
8425 state = get_real_state();
8426 if (state == NORMAL_BUSY || (state & INSERT) != 0)
8427 return TRUE;
8429 return FALSE;
8433 * Return TRUE when there is a CursorMoved autocommand defined.
8436 has_cursormoved()
8438 return (first_autopat[(int)EVENT_CURSORMOVED] != NULL);
8442 * Return TRUE when there is a CursorMovedI autocommand defined.
8445 has_cursormovedI()
8447 return (first_autopat[(int)EVENT_CURSORMOVEDI] != NULL);
8450 static int
8451 apply_autocmds_group(event, fname, fname_io, force, group, buf, eap)
8452 event_T event;
8453 char_u *fname; /* NULL or empty means use actual file name */
8454 char_u *fname_io; /* fname to use for <afile> on cmdline, NULL means
8455 use fname */
8456 int force; /* when TRUE, ignore autocmd_busy */
8457 int group; /* group ID, or AUGROUP_ALL */
8458 buf_T *buf; /* buffer for <abuf> */
8459 exarg_T *eap; /* command arguments */
8461 char_u *sfname = NULL; /* short file name */
8462 char_u *tail;
8463 int save_changed;
8464 buf_T *old_curbuf;
8465 int retval = FALSE;
8466 char_u *save_sourcing_name;
8467 linenr_T save_sourcing_lnum;
8468 char_u *save_autocmd_fname;
8469 int save_autocmd_bufnr;
8470 char_u *save_autocmd_match;
8471 int save_autocmd_busy;
8472 int save_autocmd_nested;
8473 static int nesting = 0;
8474 AutoPatCmd patcmd;
8475 AutoPat *ap;
8476 #ifdef FEAT_EVAL
8477 scid_T save_current_SID;
8478 void *save_funccalp;
8479 char_u *save_cmdarg;
8480 long save_cmdbang;
8481 #endif
8482 static int filechangeshell_busy = FALSE;
8483 #ifdef FEAT_PROFILE
8484 proftime_T wait_time;
8485 #endif
8488 * Quickly return if there are no autocommands for this event or
8489 * autocommands are blocked.
8491 if (first_autopat[(int)event] == NULL || autocmd_blocked > 0)
8492 goto BYPASS_AU;
8495 * When autocommands are busy, new autocommands are only executed when
8496 * explicitly enabled with the "nested" flag.
8498 if (autocmd_busy && !(force || autocmd_nested))
8499 goto BYPASS_AU;
8501 #ifdef FEAT_EVAL
8503 * Quickly return when immediately aborting on error, or when an interrupt
8504 * occurred or an exception was thrown but not caught.
8506 if (aborting())
8507 goto BYPASS_AU;
8508 #endif
8511 * FileChangedShell never nests, because it can create an endless loop.
8513 if (filechangeshell_busy && (event == EVENT_FILECHANGEDSHELL
8514 || event == EVENT_FILECHANGEDSHELLPOST))
8515 goto BYPASS_AU;
8518 * Ignore events in 'eventignore'.
8520 if (event_ignored(event))
8521 goto BYPASS_AU;
8524 * Allow nesting of autocommands, but restrict the depth, because it's
8525 * possible to create an endless loop.
8527 if (nesting == 10)
8529 EMSG(_("E218: autocommand nesting too deep"));
8530 goto BYPASS_AU;
8534 * Check if these autocommands are disabled. Used when doing ":all" or
8535 * ":ball".
8537 if ( (autocmd_no_enter
8538 && (event == EVENT_WINENTER || event == EVENT_BUFENTER))
8539 || (autocmd_no_leave
8540 && (event == EVENT_WINLEAVE || event == EVENT_BUFLEAVE)))
8541 goto BYPASS_AU;
8544 * Save the autocmd_* variables and info about the current buffer.
8546 save_autocmd_fname = autocmd_fname;
8547 save_autocmd_bufnr = autocmd_bufnr;
8548 save_autocmd_match = autocmd_match;
8549 save_autocmd_busy = autocmd_busy;
8550 save_autocmd_nested = autocmd_nested;
8551 save_changed = curbuf->b_changed;
8552 old_curbuf = curbuf;
8555 * Set the file name to be used for <afile>.
8556 * Make a copy to avoid that changing a buffer name or directory makes it
8557 * invalid.
8559 if (fname_io == NULL)
8561 if (fname != NULL && *fname != NUL)
8562 autocmd_fname = fname;
8563 else if (buf != NULL)
8564 autocmd_fname = buf->b_fname;
8565 else
8566 autocmd_fname = NULL;
8568 else
8569 autocmd_fname = fname_io;
8570 if (autocmd_fname != NULL)
8571 autocmd_fname = FullName_save(autocmd_fname, FALSE);
8574 * Set the buffer number to be used for <abuf>.
8576 if (buf == NULL)
8577 autocmd_bufnr = 0;
8578 else
8579 autocmd_bufnr = buf->b_fnum;
8582 * When the file name is NULL or empty, use the file name of buffer "buf".
8583 * Always use the full path of the file name to match with, in case
8584 * "allow_dirs" is set.
8586 if (fname == NULL || *fname == NUL)
8588 if (buf == NULL)
8589 fname = NULL;
8590 else
8592 #ifdef FEAT_SYN_HL
8593 if (event == EVENT_SYNTAX)
8594 fname = buf->b_p_syn;
8595 else
8596 #endif
8597 if (event == EVENT_FILETYPE)
8598 fname = buf->b_p_ft;
8599 else
8601 if (buf->b_sfname != NULL)
8602 sfname = vim_strsave(buf->b_sfname);
8603 fname = buf->b_ffname;
8606 if (fname == NULL)
8607 fname = (char_u *)"";
8608 fname = vim_strsave(fname); /* make a copy, so we can change it */
8610 else
8612 sfname = vim_strsave(fname);
8613 /* Don't try expanding FileType, Syntax, WindowID or QuickFixCmd* */
8614 if (event == EVENT_FILETYPE
8615 || event == EVENT_SYNTAX
8616 || event == EVENT_REMOTEREPLY
8617 || event == EVENT_SPELLFILEMISSING
8618 || event == EVENT_QUICKFIXCMDPRE
8619 || event == EVENT_QUICKFIXCMDPOST)
8620 fname = vim_strsave(fname);
8621 else
8622 fname = FullName_save(fname, FALSE);
8624 if (fname == NULL) /* out of memory */
8626 vim_free(sfname);
8627 retval = FALSE;
8628 goto BYPASS_AU;
8631 #ifdef BACKSLASH_IN_FILENAME
8633 * Replace all backslashes with forward slashes. This makes the
8634 * autocommand patterns portable between Unix and MS-DOS.
8636 if (sfname != NULL)
8637 forward_slash(sfname);
8638 forward_slash(fname);
8639 #endif
8641 #ifdef VMS
8642 /* remove version for correct match */
8643 if (sfname != NULL)
8644 vms_remove_version(sfname);
8645 vms_remove_version(fname);
8646 #endif
8649 * Set the name to be used for <amatch>.
8651 autocmd_match = fname;
8654 /* Don't redraw while doing auto commands. */
8655 ++RedrawingDisabled;
8656 save_sourcing_name = sourcing_name;
8657 sourcing_name = NULL; /* don't free this one */
8658 save_sourcing_lnum = sourcing_lnum;
8659 sourcing_lnum = 0; /* no line number here */
8661 #ifdef FEAT_EVAL
8662 save_current_SID = current_SID;
8664 # ifdef FEAT_PROFILE
8665 if (do_profiling == PROF_YES)
8666 prof_child_enter(&wait_time); /* doesn't count for the caller itself */
8667 # endif
8669 /* Don't use local function variables, if called from a function */
8670 save_funccalp = save_funccal();
8671 #endif
8674 * When starting to execute autocommands, save the search patterns.
8676 if (!autocmd_busy)
8678 save_search_patterns();
8679 saveRedobuff();
8680 did_filetype = keep_filetype;
8684 * Note that we are applying autocmds. Some commands need to know.
8686 autocmd_busy = TRUE;
8687 filechangeshell_busy = (event == EVENT_FILECHANGEDSHELL);
8688 ++nesting; /* see matching decrement below */
8690 /* Remember that FileType was triggered. Used for did_filetype(). */
8691 if (event == EVENT_FILETYPE)
8692 did_filetype = TRUE;
8694 tail = gettail(fname);
8696 /* Find first autocommand that matches */
8697 patcmd.curpat = first_autopat[(int)event];
8698 patcmd.nextcmd = NULL;
8699 patcmd.group = group;
8700 patcmd.fname = fname;
8701 patcmd.sfname = sfname;
8702 patcmd.tail = tail;
8703 patcmd.event = event;
8704 patcmd.arg_bufnr = autocmd_bufnr;
8705 patcmd.next = NULL;
8706 auto_next_pat(&patcmd, FALSE);
8708 /* found one, start executing the autocommands */
8709 if (patcmd.curpat != NULL)
8711 /* add to active_apc_list */
8712 patcmd.next = active_apc_list;
8713 active_apc_list = &patcmd;
8715 #ifdef FEAT_EVAL
8716 /* set v:cmdarg (only when there is a matching pattern) */
8717 save_cmdbang = get_vim_var_nr(VV_CMDBANG);
8718 if (eap != NULL)
8720 save_cmdarg = set_cmdarg(eap, NULL);
8721 set_vim_var_nr(VV_CMDBANG, (long)eap->forceit);
8723 else
8724 save_cmdarg = NULL; /* avoid gcc warning */
8725 #endif
8726 retval = TRUE;
8727 /* mark the last pattern, to avoid an endless loop when more patterns
8728 * are added when executing autocommands */
8729 for (ap = patcmd.curpat; ap->next != NULL; ap = ap->next)
8730 ap->last = FALSE;
8731 ap->last = TRUE;
8732 check_lnums(TRUE); /* make sure cursor and topline are valid */
8733 do_cmdline(NULL, getnextac, (void *)&patcmd,
8734 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
8735 #ifdef FEAT_EVAL
8736 if (eap != NULL)
8738 (void)set_cmdarg(NULL, save_cmdarg);
8739 set_vim_var_nr(VV_CMDBANG, save_cmdbang);
8741 #endif
8742 /* delete from active_apc_list */
8743 if (active_apc_list == &patcmd) /* just in case */
8744 active_apc_list = patcmd.next;
8747 --RedrawingDisabled;
8748 autocmd_busy = save_autocmd_busy;
8749 filechangeshell_busy = FALSE;
8750 autocmd_nested = save_autocmd_nested;
8751 vim_free(sourcing_name);
8752 sourcing_name = save_sourcing_name;
8753 sourcing_lnum = save_sourcing_lnum;
8754 vim_free(autocmd_fname);
8755 autocmd_fname = save_autocmd_fname;
8756 autocmd_bufnr = save_autocmd_bufnr;
8757 autocmd_match = save_autocmd_match;
8758 #ifdef FEAT_EVAL
8759 current_SID = save_current_SID;
8760 restore_funccal(save_funccalp);
8761 # ifdef FEAT_PROFILE
8762 if (do_profiling == PROF_YES)
8763 prof_child_exit(&wait_time);
8764 # endif
8765 #endif
8766 vim_free(fname);
8767 vim_free(sfname);
8768 --nesting; /* see matching increment above */
8771 * When stopping to execute autocommands, restore the search patterns and
8772 * the redo buffer.
8774 if (!autocmd_busy)
8776 restore_search_patterns();
8777 restoreRedobuff();
8778 did_filetype = FALSE;
8782 * Some events don't set or reset the Changed flag.
8783 * Check if still in the same buffer!
8785 if (curbuf == old_curbuf
8786 && (event == EVENT_BUFREADPOST
8787 || event == EVENT_BUFWRITEPOST
8788 || event == EVENT_FILEAPPENDPOST
8789 || event == EVENT_VIMLEAVE
8790 || event == EVENT_VIMLEAVEPRE))
8792 #ifdef FEAT_TITLE
8793 if (curbuf->b_changed != save_changed)
8794 need_maketitle = TRUE;
8795 #endif
8796 curbuf->b_changed = save_changed;
8799 au_cleanup(); /* may really delete removed patterns/commands now */
8801 BYPASS_AU:
8802 /* When wiping out a buffer make sure all its buffer-local autocommands
8803 * are deleted. */
8804 if (event == EVENT_BUFWIPEOUT && buf != NULL)
8805 aubuflocal_remove(buf);
8807 return retval;
8810 # ifdef FEAT_EVAL
8811 static char_u *old_termresponse = NULL;
8812 # endif
8815 * Block triggering autocommands until unblock_autocmd() is called.
8816 * Can be used recursively, so long as it's symmetric.
8818 void
8819 block_autocmds()
8821 # ifdef FEAT_EVAL
8822 /* Remember the value of v:termresponse. */
8823 if (autocmd_blocked == 0)
8824 old_termresponse = get_vim_var_str(VV_TERMRESPONSE);
8825 # endif
8826 ++autocmd_blocked;
8829 void
8830 unblock_autocmds()
8832 --autocmd_blocked;
8834 # ifdef FEAT_EVAL
8835 /* When v:termresponse was set while autocommands were blocked, trigger
8836 * the autocommands now. Esp. useful when executing a shell command
8837 * during startup (vimdiff). */
8838 if (autocmd_blocked == 0
8839 && get_vim_var_str(VV_TERMRESPONSE) != old_termresponse)
8840 apply_autocmds(EVENT_TERMRESPONSE, NULL, NULL, FALSE, curbuf);
8841 # endif
8845 * Find next autocommand pattern that matches.
8847 static void
8848 auto_next_pat(apc, stop_at_last)
8849 AutoPatCmd *apc;
8850 int stop_at_last; /* stop when 'last' flag is set */
8852 AutoPat *ap;
8853 AutoCmd *cp;
8854 char_u *name;
8855 char *s;
8857 vim_free(sourcing_name);
8858 sourcing_name = NULL;
8860 for (ap = apc->curpat; ap != NULL && !got_int; ap = ap->next)
8862 apc->curpat = NULL;
8864 /* only use a pattern when it has not been removed, has commands and
8865 * the group matches. For buffer-local autocommands only check the
8866 * buffer number. */
8867 if (ap->pat != NULL && ap->cmds != NULL
8868 && (apc->group == AUGROUP_ALL || apc->group == ap->group))
8870 /* execution-condition */
8871 if (ap->buflocal_nr == 0
8872 ? (match_file_pat(NULL, ap->reg_prog, apc->fname,
8873 apc->sfname, apc->tail, ap->allow_dirs))
8874 : ap->buflocal_nr == apc->arg_bufnr)
8876 name = event_nr2name(apc->event);
8877 s = _("%s Auto commands for \"%s\"");
8878 sourcing_name = alloc((unsigned)(STRLEN(s)
8879 + STRLEN(name) + ap->patlen + 1));
8880 if (sourcing_name != NULL)
8882 sprintf((char *)sourcing_name, s,
8883 (char *)name, (char *)ap->pat);
8884 if (p_verbose >= 8)
8886 verbose_enter();
8887 smsg((char_u *)_("Executing %s"), sourcing_name);
8888 verbose_leave();
8892 apc->curpat = ap;
8893 apc->nextcmd = ap->cmds;
8894 /* mark last command */
8895 for (cp = ap->cmds; cp->next != NULL; cp = cp->next)
8896 cp->last = FALSE;
8897 cp->last = TRUE;
8899 line_breakcheck();
8900 if (apc->curpat != NULL) /* found a match */
8901 break;
8903 if (stop_at_last && ap->last)
8904 break;
8909 * Get next autocommand command.
8910 * Called by do_cmdline() to get the next line for ":if".
8911 * Returns allocated string, or NULL for end of autocommands.
8913 /* ARGSUSED */
8914 static char_u *
8915 getnextac(c, cookie, indent)
8916 int c; /* not used */
8917 void *cookie;
8918 int indent; /* not used */
8920 AutoPatCmd *acp = (AutoPatCmd *)cookie;
8921 char_u *retval;
8922 AutoCmd *ac;
8924 /* Can be called again after returning the last line. */
8925 if (acp->curpat == NULL)
8926 return NULL;
8928 /* repeat until we find an autocommand to execute */
8929 for (;;)
8931 /* skip removed commands */
8932 while (acp->nextcmd != NULL && acp->nextcmd->cmd == NULL)
8933 if (acp->nextcmd->last)
8934 acp->nextcmd = NULL;
8935 else
8936 acp->nextcmd = acp->nextcmd->next;
8938 if (acp->nextcmd != NULL)
8939 break;
8941 /* at end of commands, find next pattern that matches */
8942 if (acp->curpat->last)
8943 acp->curpat = NULL;
8944 else
8945 acp->curpat = acp->curpat->next;
8946 if (acp->curpat != NULL)
8947 auto_next_pat(acp, TRUE);
8948 if (acp->curpat == NULL)
8949 return NULL;
8952 ac = acp->nextcmd;
8954 if (p_verbose >= 9)
8956 verbose_enter_scroll();
8957 smsg((char_u *)_("autocommand %s"), ac->cmd);
8958 msg_puts((char_u *)"\n"); /* don't overwrite this either */
8959 verbose_leave_scroll();
8961 retval = vim_strsave(ac->cmd);
8962 autocmd_nested = ac->nested;
8963 #ifdef FEAT_EVAL
8964 current_SID = ac->scriptID;
8965 #endif
8966 if (ac->last)
8967 acp->nextcmd = NULL;
8968 else
8969 acp->nextcmd = ac->next;
8970 return retval;
8974 * Return TRUE if there is a matching autocommand for "fname".
8975 * To account for buffer-local autocommands, function needs to know
8976 * in which buffer the file will be opened.
8979 has_autocmd(event, sfname, buf)
8980 event_T event;
8981 char_u *sfname;
8982 buf_T *buf;
8984 AutoPat *ap;
8985 char_u *fname;
8986 char_u *tail = gettail(sfname);
8987 int retval = FALSE;
8989 fname = FullName_save(sfname, FALSE);
8990 if (fname == NULL)
8991 return FALSE;
8993 #ifdef BACKSLASH_IN_FILENAME
8995 * Replace all backslashes with forward slashes. This makes the
8996 * autocommand patterns portable between Unix and MS-DOS.
8998 sfname = vim_strsave(sfname);
8999 if (sfname != NULL)
9000 forward_slash(sfname);
9001 forward_slash(fname);
9002 #endif
9004 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
9005 if (ap->pat != NULL && ap->cmds != NULL
9006 && (ap->buflocal_nr == 0
9007 ? match_file_pat(NULL, ap->reg_prog,
9008 fname, sfname, tail, ap->allow_dirs)
9009 : buf != NULL && ap->buflocal_nr == buf->b_fnum
9012 retval = TRUE;
9013 break;
9016 vim_free(fname);
9017 #ifdef BACKSLASH_IN_FILENAME
9018 vim_free(sfname);
9019 #endif
9021 return retval;
9024 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
9026 * Function given to ExpandGeneric() to obtain the list of autocommand group
9027 * names.
9029 /*ARGSUSED*/
9030 char_u *
9031 get_augroup_name(xp, idx)
9032 expand_T *xp;
9033 int idx;
9035 if (idx == augroups.ga_len) /* add "END" add the end */
9036 return (char_u *)"END";
9037 if (idx >= augroups.ga_len) /* end of list */
9038 return NULL;
9039 if (AUGROUP_NAME(idx) == NULL) /* skip deleted entries */
9040 return (char_u *)"";
9041 return AUGROUP_NAME(idx); /* return a name */
9044 static int include_groups = FALSE;
9046 char_u *
9047 set_context_in_autocmd(xp, arg, doautocmd)
9048 expand_T *xp;
9049 char_u *arg;
9050 int doautocmd; /* TRUE for :doautocmd, FALSE for :autocmd */
9052 char_u *p;
9053 int group;
9055 /* check for a group name, skip it if present */
9056 include_groups = FALSE;
9057 p = arg;
9058 group = au_get_grouparg(&arg);
9059 if (group == AUGROUP_ERROR)
9060 return NULL;
9061 /* If there only is a group name that's what we expand. */
9062 if (*arg == NUL && group != AUGROUP_ALL && !vim_iswhite(arg[-1]))
9064 arg = p;
9065 group = AUGROUP_ALL;
9068 /* skip over event name */
9069 for (p = arg; *p != NUL && !vim_iswhite(*p); ++p)
9070 if (*p == ',')
9071 arg = p + 1;
9072 if (*p == NUL)
9074 if (group == AUGROUP_ALL)
9075 include_groups = TRUE;
9076 xp->xp_context = EXPAND_EVENTS; /* expand event name */
9077 xp->xp_pattern = arg;
9078 return NULL;
9081 /* skip over pattern */
9082 arg = skipwhite(p);
9083 while (*arg && (!vim_iswhite(*arg) || arg[-1] == '\\'))
9084 arg++;
9085 if (*arg)
9086 return arg; /* expand (next) command */
9088 if (doautocmd)
9089 xp->xp_context = EXPAND_FILES; /* expand file names */
9090 else
9091 xp->xp_context = EXPAND_NOTHING; /* pattern is not expanded */
9092 return NULL;
9096 * Function given to ExpandGeneric() to obtain the list of event names.
9098 /*ARGSUSED*/
9099 char_u *
9100 get_event_name(xp, idx)
9101 expand_T *xp;
9102 int idx;
9104 if (idx < augroups.ga_len) /* First list group names, if wanted */
9106 if (!include_groups || AUGROUP_NAME(idx) == NULL)
9107 return (char_u *)""; /* skip deleted entries */
9108 return AUGROUP_NAME(idx); /* return a name */
9110 return (char_u *)event_names[idx - augroups.ga_len].name;
9113 #endif /* FEAT_CMDL_COMPL */
9116 * Return TRUE if autocmd is supported.
9119 autocmd_supported(name)
9120 char_u *name;
9122 char_u *p;
9124 return (event_name2nr(name, &p) != NUM_EVENTS);
9128 * Return TRUE if an autocommand is defined for a group, event and
9129 * pattern: The group can be omitted to accept any group. "event" and "pattern"
9130 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
9131 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
9132 * Used for:
9133 * exists("#Group") or
9134 * exists("#Group#Event") or
9135 * exists("#Group#Event#pat") or
9136 * exists("#Event") or
9137 * exists("#Event#pat")
9140 au_exists(arg)
9141 char_u *arg;
9143 char_u *arg_save;
9144 char_u *pattern = NULL;
9145 char_u *event_name;
9146 char_u *p;
9147 event_T event;
9148 AutoPat *ap;
9149 buf_T *buflocal_buf = NULL;
9150 int group;
9151 int retval = FALSE;
9153 /* Make a copy so that we can change the '#' chars to a NUL. */
9154 arg_save = vim_strsave(arg);
9155 if (arg_save == NULL)
9156 return FALSE;
9157 p = vim_strchr(arg_save, '#');
9158 if (p != NULL)
9159 *p++ = NUL;
9161 /* First, look for an autocmd group name */
9162 group = au_find_group(arg_save);
9163 if (group == AUGROUP_ERROR)
9165 /* Didn't match a group name, assume the first argument is an event. */
9166 group = AUGROUP_ALL;
9167 event_name = arg_save;
9169 else
9171 if (p == NULL)
9173 /* "Group": group name is present and it's recognized */
9174 retval = TRUE;
9175 goto theend;
9178 /* Must be "Group#Event" or "Group#Event#pat". */
9179 event_name = p;
9180 p = vim_strchr(event_name, '#');
9181 if (p != NULL)
9182 *p++ = NUL; /* "Group#Event#pat" */
9185 pattern = p; /* "pattern" is NULL when there is no pattern */
9187 /* find the index (enum) for the event name */
9188 event = event_name2nr(event_name, &p);
9190 /* return FALSE if the event name is not recognized */
9191 if (event == NUM_EVENTS)
9192 goto theend;
9194 /* Find the first autocommand for this event.
9195 * If there isn't any, return FALSE;
9196 * If there is one and no pattern given, return TRUE; */
9197 ap = first_autopat[(int)event];
9198 if (ap == NULL)
9199 goto theend;
9200 if (pattern == NULL)
9202 retval = TRUE;
9203 goto theend;
9206 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9207 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9208 if (STRICMP(pattern, "<buffer>") == 0)
9209 buflocal_buf = curbuf;
9211 /* Check if there is an autocommand with the given pattern. */
9212 for ( ; ap != NULL; ap = ap->next)
9213 /* only use a pattern when it has not been removed and has commands. */
9214 /* For buffer-local autocommands, fnamecmp() works fine. */
9215 if (ap->pat != NULL && ap->cmds != NULL
9216 && (group == AUGROUP_ALL || ap->group == group)
9217 && (buflocal_buf == NULL
9218 ? fnamecmp(ap->pat, pattern) == 0
9219 : ap->buflocal_nr == buflocal_buf->b_fnum))
9221 retval = TRUE;
9222 break;
9225 theend:
9226 vim_free(arg_save);
9227 return retval;
9230 #else /* FEAT_AUTOCMD */
9233 * Prepare for executing commands for (hidden) buffer "buf".
9234 * This is the non-autocommand version, it simply saves "curbuf" and sets
9235 * "curbuf" and "curwin" to match "buf".
9237 void
9238 aucmd_prepbuf(aco, buf)
9239 aco_save_T *aco; /* structure to save values in */
9240 buf_T *buf; /* new curbuf */
9242 aco->save_buf = curbuf;
9243 curbuf = buf;
9244 curwin->w_buffer = buf;
9248 * Restore after executing commands for a (hidden) buffer.
9249 * This is the non-autocommand version.
9251 void
9252 aucmd_restbuf(aco)
9253 aco_save_T *aco; /* structure holding saved values */
9255 curbuf = aco->save_buf;
9256 curwin->w_buffer = curbuf;
9259 #endif /* FEAT_AUTOCMD */
9262 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9264 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9265 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9266 * vim_regcomp() often.
9267 * Used for autocommands and 'wildignore'.
9268 * Returns TRUE if there is a match, FALSE otherwise.
9271 match_file_pat(pattern, prog, fname, sfname, tail, allow_dirs)
9272 char_u *pattern; /* pattern to match with */
9273 regprog_T *prog; /* pre-compiled regprog or NULL */
9274 char_u *fname; /* full path of file name */
9275 char_u *sfname; /* short file name or NULL */
9276 char_u *tail; /* tail of path */
9277 int allow_dirs; /* allow matching with dir */
9279 regmatch_T regmatch;
9280 int result = FALSE;
9281 #ifdef FEAT_OSFILETYPE
9282 int no_pattern = FALSE; /* TRUE if check is filetype only */
9283 char_u *type_start;
9284 char_u c;
9285 int match = FALSE;
9286 #endif
9288 #ifdef CASE_INSENSITIVE_FILENAME
9289 regmatch.rm_ic = TRUE; /* Always ignore case */
9290 #else
9291 regmatch.rm_ic = FALSE; /* Don't ever ignore case */
9292 #endif
9293 #ifdef FEAT_OSFILETYPE
9294 if (*pattern == '<')
9296 /* There is a filetype condition specified with this pattern.
9297 * Check the filetype matches first. If not, don't bother with the
9298 * pattern (set regprog to NULL).
9299 * Always use magic for the regexp.
9302 for (type_start = pattern + 1; (c = *pattern); pattern++)
9304 if ((c == ';' || c == '>') && match == FALSE)
9306 *pattern = NUL; /* Terminate the string */
9307 match = mch_check_filetype(fname, type_start);
9308 *pattern = c; /* Restore the terminator */
9309 type_start = pattern + 1;
9311 if (c == '>')
9312 break;
9315 /* (c should never be NUL, but check anyway) */
9316 if (match == FALSE || c == NUL)
9317 regmatch.regprog = NULL; /* Doesn't match - don't check pat. */
9318 else if (*pattern == NUL)
9320 regmatch.regprog = NULL; /* Vim will try to free regprog later */
9321 no_pattern = TRUE; /* Always matches - don't check pat. */
9323 else
9324 regmatch.regprog = vim_regcomp(pattern + 1, RE_MAGIC);
9326 else
9327 #endif
9329 if (prog != NULL)
9330 regmatch.regprog = prog;
9331 else
9332 regmatch.regprog = vim_regcomp(pattern, RE_MAGIC);
9336 * Try for a match with the pattern with:
9337 * 1. the full file name, when the pattern has a '/'.
9338 * 2. the short file name, when the pattern has a '/'.
9339 * 3. the tail of the file name, when the pattern has no '/'.
9341 if (
9342 #ifdef FEAT_OSFILETYPE
9343 /* If the check is for a filetype only and we don't care
9344 * about the path then skip all the regexp stuff.
9346 no_pattern ||
9347 #endif
9348 (regmatch.regprog != NULL
9349 && ((allow_dirs
9350 && (vim_regexec(&regmatch, fname, (colnr_T)0)
9351 || (sfname != NULL
9352 && vim_regexec(&regmatch, sfname, (colnr_T)0))))
9353 || (!allow_dirs && vim_regexec(&regmatch, tail, (colnr_T)0)))))
9354 result = TRUE;
9356 if (prog == NULL)
9357 vim_free(regmatch.regprog);
9358 return result;
9360 #endif
9362 #if defined(FEAT_WILDIGN) || defined(PROTO)
9364 * Return TRUE if a file matches with a pattern in "list".
9365 * "list" is a comma-separated list of patterns, like 'wildignore'.
9366 * "sfname" is the short file name or NULL, "ffname" the long file name.
9369 match_file_list(list, sfname, ffname)
9370 char_u *list;
9371 char_u *sfname;
9372 char_u *ffname;
9374 char_u buf[100];
9375 char_u *tail;
9376 char_u *regpat;
9377 char allow_dirs;
9378 int match;
9379 char_u *p;
9381 tail = gettail(sfname);
9383 /* try all patterns in 'wildignore' */
9384 p = list;
9385 while (*p)
9387 copy_option_part(&p, buf, 100, ",");
9388 regpat = file_pat_to_reg_pat(buf, NULL, &allow_dirs, FALSE);
9389 if (regpat == NULL)
9390 break;
9391 match = match_file_pat(regpat, NULL, ffname, sfname,
9392 tail, (int)allow_dirs);
9393 vim_free(regpat);
9394 if (match)
9395 return TRUE;
9397 return FALSE;
9399 #endif
9402 * Convert the given pattern "pat" which has shell style wildcards in it, into
9403 * a regular expression, and return the result in allocated memory. If there
9404 * is a directory path separator to be matched, then TRUE is put in
9405 * allow_dirs, otherwise FALSE is put there -- webb.
9406 * Handle backslashes before special characters, like "\*" and "\ ".
9408 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9409 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9411 * Returns NULL when out of memory.
9413 /*ARGSUSED*/
9414 char_u *
9415 file_pat_to_reg_pat(pat, pat_end, allow_dirs, no_bslash)
9416 char_u *pat;
9417 char_u *pat_end; /* first char after pattern or NULL */
9418 char *allow_dirs; /* Result passed back out in here */
9419 int no_bslash; /* Don't use a backward slash as pathsep */
9421 int size;
9422 char_u *endp;
9423 char_u *reg_pat;
9424 char_u *p;
9425 int i;
9426 int nested = 0;
9427 int add_dollar = TRUE;
9428 #ifdef FEAT_OSFILETYPE
9429 int check_length = 0;
9430 #endif
9432 if (allow_dirs != NULL)
9433 *allow_dirs = FALSE;
9434 if (pat_end == NULL)
9435 pat_end = pat + STRLEN(pat);
9437 #ifdef FEAT_OSFILETYPE
9438 /* Find out how much of the string is the filetype check */
9439 if (*pat == '<')
9441 /* Count chars until the next '>' */
9442 for (p = pat + 1; p < pat_end && *p != '>'; p++)
9444 if (p < pat_end)
9446 /* Pattern is of the form <.*>.* */
9447 check_length = p - pat + 1;
9448 if (p + 1 >= pat_end)
9450 /* The 'pattern' is a filetype check ONLY */
9451 reg_pat = (char_u *)alloc(check_length + 1);
9452 if (reg_pat != NULL)
9454 mch_memmove(reg_pat, pat, (size_t)check_length);
9455 reg_pat[check_length] = NUL;
9457 return reg_pat;
9460 /* else: there was no closing '>' - assume it was a normal pattern */
9463 pat += check_length;
9464 size = 2 + check_length;
9465 #else
9466 size = 2; /* '^' at start, '$' at end */
9467 #endif
9469 for (p = pat; p < pat_end; p++)
9471 switch (*p)
9473 case '*':
9474 case '.':
9475 case ',':
9476 case '{':
9477 case '}':
9478 case '~':
9479 size += 2; /* extra backslash */
9480 break;
9481 #ifdef BACKSLASH_IN_FILENAME
9482 case '\\':
9483 case '/':
9484 size += 4; /* could become "[\/]" */
9485 break;
9486 #endif
9487 default:
9488 size++;
9489 # ifdef FEAT_MBYTE
9490 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9492 ++p;
9493 ++size;
9495 # endif
9496 break;
9499 reg_pat = alloc(size + 1);
9500 if (reg_pat == NULL)
9501 return NULL;
9503 #ifdef FEAT_OSFILETYPE
9504 /* Copy the type check in to the start. */
9505 if (check_length)
9506 mch_memmove(reg_pat, pat - check_length, (size_t)check_length);
9507 i = check_length;
9508 #else
9509 i = 0;
9510 #endif
9512 if (pat[0] == '*')
9513 while (pat[0] == '*' && pat < pat_end - 1)
9514 pat++;
9515 else
9516 reg_pat[i++] = '^';
9517 endp = pat_end - 1;
9518 if (*endp == '*')
9520 while (endp - pat > 0 && *endp == '*')
9521 endp--;
9522 add_dollar = FALSE;
9524 for (p = pat; *p && nested >= 0 && p <= endp; p++)
9526 switch (*p)
9528 case '*':
9529 reg_pat[i++] = '.';
9530 reg_pat[i++] = '*';
9531 while (p[1] == '*') /* "**" matches like "*" */
9532 ++p;
9533 break;
9534 case '.':
9535 #ifdef RISCOS
9536 if (allow_dirs != NULL)
9537 *allow_dirs = TRUE;
9538 /* FALLTHROUGH */
9539 #endif
9540 case '~':
9541 reg_pat[i++] = '\\';
9542 reg_pat[i++] = *p;
9543 break;
9544 case '?':
9545 #ifdef RISCOS
9546 case '#':
9547 #endif
9548 reg_pat[i++] = '.';
9549 break;
9550 case '\\':
9551 if (p[1] == NUL)
9552 break;
9553 #ifdef BACKSLASH_IN_FILENAME
9554 if (!no_bslash)
9556 /* translate:
9557 * "\x" to "\\x" e.g., "dir\file"
9558 * "\*" to "\\.*" e.g., "dir\*.c"
9559 * "\?" to "\\." e.g., "dir\??.c"
9560 * "\+" to "\+" e.g., "fileX\+.c"
9562 if ((vim_isfilec(p[1]) || p[1] == '*' || p[1] == '?')
9563 && p[1] != '+')
9565 reg_pat[i++] = '[';
9566 reg_pat[i++] = '\\';
9567 reg_pat[i++] = '/';
9568 reg_pat[i++] = ']';
9569 if (allow_dirs != NULL)
9570 *allow_dirs = TRUE;
9571 break;
9574 #endif
9575 if (*++p == '?'
9576 #ifdef BACKSLASH_IN_FILENAME
9577 && no_bslash
9578 #endif
9580 reg_pat[i++] = '?';
9581 else
9582 if (*p == ',')
9583 reg_pat[i++] = ',';
9584 else
9586 if (allow_dirs != NULL && vim_ispathsep(*p)
9587 #ifdef BACKSLASH_IN_FILENAME
9588 && (!no_bslash || *p != '\\')
9589 #endif
9591 *allow_dirs = TRUE;
9592 reg_pat[i++] = '\\';
9593 reg_pat[i++] = *p;
9595 break;
9596 #ifdef BACKSLASH_IN_FILENAME
9597 case '/':
9598 reg_pat[i++] = '[';
9599 reg_pat[i++] = '\\';
9600 reg_pat[i++] = '/';
9601 reg_pat[i++] = ']';
9602 if (allow_dirs != NULL)
9603 *allow_dirs = TRUE;
9604 break;
9605 #endif
9606 case '{':
9607 reg_pat[i++] = '\\';
9608 reg_pat[i++] = '(';
9609 nested++;
9610 break;
9611 case '}':
9612 reg_pat[i++] = '\\';
9613 reg_pat[i++] = ')';
9614 --nested;
9615 break;
9616 case ',':
9617 if (nested)
9619 reg_pat[i++] = '\\';
9620 reg_pat[i++] = '|';
9622 else
9623 reg_pat[i++] = ',';
9624 break;
9625 default:
9626 # ifdef FEAT_MBYTE
9627 if (enc_dbcs != 0 && (*mb_ptr2len)(p) > 1)
9628 reg_pat[i++] = *p++;
9629 else
9630 # endif
9631 if (allow_dirs != NULL && vim_ispathsep(*p))
9632 *allow_dirs = TRUE;
9633 reg_pat[i++] = *p;
9634 break;
9637 if (add_dollar)
9638 reg_pat[i++] = '$';
9639 reg_pat[i] = NUL;
9640 if (nested != 0)
9642 if (nested < 0)
9643 EMSG(_("E219: Missing {."));
9644 else
9645 EMSG(_("E220: Missing }."));
9646 vim_free(reg_pat);
9647 reg_pat = NULL;
9649 return reg_pat;