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.
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 */
19 # include "vimio.h" /* for mktemp(), CJW 1997-12-03 */
29 # include <limits.h> /* for SSIZE_MAX */
32 #if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
33 # include <utime.h> /* for struct utimbuf */
36 #define BUFSIZE 8192 /* size of normal write buffer */
37 #define SMBUFSIZE 256 /* size of emergency write buffer */
40 # define CRYPT_MAGIC "VimCrypt~01!" /* "01" is the version nr */
41 # define CRYPT_MAGIC_LEN 12 /* must be multiple of 4! */
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
);
52 static char_u
*next_fenc
__ARGS((char_u
**pp
));
54 static char_u
*readfile_charconvert
__ARGS((char_u
*fname
, char_u
*fenc
, int *fdp
));
58 static void check_marks_read
__ARGS((void));
61 static char_u
*check_for_cryptkey
__ARGS((char_u
*cryptkey
, char_u
*ptr
, long *sizep
, long *filesizep
, int newfile
));
64 static void set_file_time
__ARGS((char_u
*fname
, time_t atime
, time_t mtime
));
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
));
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 */
80 #if defined(FEAT_CRYPT) || defined(FEAT_MBYTE)
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 */
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 */
93 # define FIO_MACROMAN 0x20 /* convert MacRoman */
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 */
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. */
111 * Structure to pass arguments from buf_write() to buf_write_bytes().
115 int bw_fd
; /* file descriptor */
116 char_u
*bw_buf
; /* buffer with data to be written */
117 int bw_len
; /* lenght of data */
119 int bw_flags
; /* FIO_ flags */
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 */
129 iconv_t bw_iconv_fd
; /* descriptor for iconv() or -1 */
134 static int buf_write_bytes
__ARGS((struct bw_info
*ip
));
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
));
144 static int get_win_fio_flags
__ARGS((char_u
*ptr
));
147 static int get_mac_fio_flags
__ARGS((char_u
*ptr
));
150 static int move_lines
__ARGS((buf_T
*frombuf
, buf_T
*tobuf
));
154 filemess(buf
, name
, s
, attr
)
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
;
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)
177 if (!msg_scroll
) /* wait a bit when overwriting an error msg */
178 check_for_delay(FALSE
);
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
);
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.
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
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
)
217 linenr_T lines_to_skip
;
218 linenr_T lines_to_read
;
219 exarg_T
*eap
; /* can be NULL! */
223 int newfile
= (flags
& READ_NEW
);
224 int set_options
= newfile
|| (eap
!= NULL
&& eap
->read_edit
);
226 int filtering
= (flags
& READ_FILTER
);
227 int read_stdin
= (flags
& READ_STDIN
);
228 int read_buffer
= (flags
& READ_BUFFER
);
229 linenr_T read_buf_lnum
= 1; /* next line to read from curbuf */
230 colnr_T read_buf_col
= 0; /* next char to read from this line */
232 linenr_T lnum
= from
;
233 char_u
*ptr
= NULL
; /* pointer into read buffer */
234 char_u
*buffer
= NULL
; /* read buffer */
235 char_u
*new_buffer
= NULL
; /* init to shut up gcc */
236 char_u
*line_start
= NULL
; /* init to shut up gcc */
237 int wasempty
; /* buffer was empty before reading */
242 int skip_read
= FALSE
;
244 char_u
*cryptkey
= NULL
;
246 int split
= 0; /* number of split lines */
247 #define UNKNOWN 0x0fffffff /* file size is unknown */
249 int error
= FALSE
; /* errors encountered */
250 int ff_error
= EOL_UNKNOWN
; /* file format with errors */
251 long linerest
= 0; /* remaining chars in line */
254 int swap_mode
= -1; /* protection bits for swap file */
258 int fileformat
= 0; /* end-of-line format */
259 int keep_fileformat
= FALSE
;
262 linenr_T skip_count
= 0;
263 linenr_T read_count
= 0;
264 int msg_save
= msg_scroll
;
265 linenr_T read_no_eol_lnum
= 0; /* non-zero lnum when last line of
266 * last read was missing the eol */
267 int try_mac
= (vim_strchr(p_ffs
, 'm') != NULL
);
268 int try_dos
= (vim_strchr(p_ffs
, 'd') != NULL
);
269 int try_unix
= (vim_strchr(p_ffs
, 'x') != NULL
);
270 int file_rewind
= FALSE
;
273 linenr_T conv_error
= 0; /* line nr with conversion error */
274 linenr_T illegal_byte
= 0; /* line nr with illegal byte */
275 int keep_dest_enc
= FALSE
; /* don't retry when char doesn't fit
276 in destination encoding */
277 int bad_char_behavior
= BAD_REPLACE
;
278 /* BAD_KEEP, BAD_DROP or character to
280 char_u
*tmpname
= NULL
; /* name of 'charconvert' output file */
282 char_u
*fenc
; /* fileencoding to use */
283 int fenc_alloced
; /* fenc_next is in allocated memory */
284 char_u
*fenc_next
= NULL
; /* next item in 'fencs' or NULL */
285 int advance_fenc
= FALSE
;
288 iconv_t iconv_fd
= (iconv_t
)-1; /* descriptor for iconv() or -1 */
290 int did_iconv
= FALSE
; /* TRUE when iconv() failed and trying
291 'charconvert' next */
294 int converted
= FALSE
; /* TRUE if conversion done */
295 int notconverted
= FALSE
; /* TRUE if conversion wanted but it
297 char_u conv_rest
[CONV_RESTLEN
];
298 int conv_restlen
= 0; /* nr of bytes in conv_rest[] */
301 write_no_eol_lnum
= 0; /* in case it was set by the previous read */
304 * If there is no file name yet, use the one for the read file.
305 * BF_NOTEDITED is set to reflect this.
306 * Don't do this for a read from a filter.
307 * Only do this when 'cpoptions' contains the 'f' flag.
309 if (curbuf
->b_ffname
== NULL
312 && vim_strchr(p_cpo
, CPO_FNAMER
) != NULL
313 && !(flags
& READ_DUMMY
))
315 if (set_rw_fname(fname
, sfname
) == FAIL
)
319 /* After reading a file the cursor line changes but we don't want to
320 * display the line. */
321 ex_no_reprint
= TRUE
;
323 /* don't display the file info for another buffer now */
324 need_fileinfo
= FALSE
;
327 * For Unix: Use the short file name whenever possible.
328 * Avoids problems with networks and when directory names are changed.
329 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
330 * another directory, which we don't detect.
334 #if defined(UNIX) || defined(__EMX__)
340 * The BufReadCmd and FileReadCmd events intercept the reading process by
341 * executing the associated commands instead.
343 if (!filtering
&& !read_stdin
&& !read_buffer
)
347 pos
= curbuf
->b_op_start
;
349 /* Set '[ mark to the line above where the lines go (line 1 if zero). */
350 curbuf
->b_op_start
.lnum
= ((from
== 0) ? 1 : from
);
351 curbuf
->b_op_start
.col
= 0;
355 if (apply_autocmds_exarg(EVENT_BUFREADCMD
, NULL
, sfname
,
358 return aborting() ? FAIL
: OK
;
363 else if (apply_autocmds_exarg(EVENT_FILEREADCMD
, sfname
, sfname
,
366 return aborting() ? FAIL
: OK
;
371 curbuf
->b_op_start
= pos
;
375 if ((shortmess(SHM_OVER
) || curbuf
->b_help
) && p_verbose
== 0)
376 msg_scroll
= FALSE
; /* overwrite previous file message */
378 msg_scroll
= TRUE
; /* don't overwrite previous file message */
381 * If the name ends in a path separator, we can't open it. Check here,
382 * because reading the file may actually work, but then creating the swap
383 * file may destroy it! Reported on MS-DOS and Win 95.
384 * If the name is too long we might crash further on, quit here.
386 if (fname
!= NULL
&& *fname
!= NUL
)
388 p
= fname
+ STRLEN(fname
);
389 if (after_pathsep(fname
, p
) || STRLEN(fname
) >= MAXPATHL
)
391 filemess(curbuf
, fname
, (char_u
*)_("Illegal file name"), 0);
393 msg_scroll
= msg_save
;
400 * On Unix it is possible to read a directory, so we have to
401 * check for it before the mch_open().
403 if (!read_stdin
&& !read_buffer
)
405 perm
= mch_getperm(fname
);
406 if (perm
>= 0 && !S_ISREG(perm
) /* not a regular file ... */
408 && !S_ISFIFO(perm
) /* ... or fifo */
411 && !S_ISSOCK(perm
) /* ... or socket */
413 # ifdef OPEN_CHR_FILES
414 && !(S_ISCHR(perm
) && is_dev_fd_file(fname
))
415 /* ... or a character special file named /dev/fd/<n> */
420 filemess(curbuf
, fname
, (char_u
*)_("is a directory"), 0);
422 filemess(curbuf
, fname
, (char_u
*)_("is not a file"), 0);
424 msg_scroll
= msg_save
;
428 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
430 * MS-Windows allows opening a device, but we will probably get stuck
433 if (!p_odev
&& mch_nodetype(fname
) == NODE_WRITABLE
)
435 filemess(curbuf
, fname
, (char_u
*)_("is a device (disabled with 'opendevice' option)"), 0);
437 msg_scroll
= msg_save
;
444 /* set default 'fileformat' */
447 if (eap
!= NULL
&& eap
->force_ff
!= 0)
448 set_fileformat(get_fileformat_force(curbuf
, eap
), OPT_LOCAL
);
449 else if (*p_ffs
!= NUL
)
450 set_fileformat(default_fileformat(), OPT_LOCAL
);
453 /* set or reset 'binary' */
454 if (eap
!= NULL
&& eap
->force_bin
!= 0)
456 int oldval
= curbuf
->b_p_bin
;
458 curbuf
->b_p_bin
= (eap
->force_bin
== FORCE_BIN
);
459 set_options_bin(oldval
, curbuf
->b_p_bin
, OPT_LOCAL
);
463 * When opening a new file we take the readonly flag from the file.
464 * Default is r/w, can be set to r/o below.
465 * Don't reset it when in readonly mode
466 * Only set/reset b_p_ro when BF_CHECK_RO is set.
468 check_readonly
= (newfile
&& (curbuf
->b_flags
& BF_CHECK_RO
));
469 if (check_readonly
&& !readonlymode
)
470 curbuf
->b_p_ro
= FALSE
;
472 if (newfile
&& !read_stdin
&& !read_buffer
)
474 /* Remember time of file.
475 * For RISCOS, also remember the filetype.
477 if (mch_stat((char *)fname
, &st
) >= 0)
479 buf_store_time(curbuf
, &st
, fname
);
480 curbuf
->b_mtime_read
= curbuf
->b_mtime
;
482 #if defined(RISCOS) && defined(FEAT_OSFILETYPE)
483 /* Read the filetype into the buffer local filetype option. */
484 mch_read_filetype(fname
);
488 * Use the protection bits of the original file for the swap file.
489 * This makes it possible for others to read the name of the
490 * edited file from the swapfile, but only if they can read the
492 * Remove the "write" and "execute" bits for group and others
493 * (they must not write the swapfile).
494 * Add the "read" and "write" bits for the user, otherwise we may
495 * not be able to write to the file ourselves.
496 * Setting the bits is done below, after creating the swap file.
498 swap_mode
= (st
.st_mode
& 0644) | 0600;
500 #ifdef FEAT_CW_EDITOR
501 /* Get the FSSpec on MacOS
502 * TODO: Update it properly when the buffer name changes
504 (void)GetFSSpecFromPath(curbuf
->b_ffname
, &curbuf
->b_FSSpec
);
507 curbuf
->b_fab_rfm
= st
.st_fab_rfm
;
508 curbuf
->b_fab_rat
= st
.st_fab_rat
;
509 curbuf
->b_fab_mrs
= st
.st_fab_mrs
;
515 curbuf
->b_mtime_read
= 0;
516 curbuf
->b_orig_size
= 0;
517 curbuf
->b_orig_mode
= 0;
520 /* Reset the "new file" flag. It will be set again below when the
521 * file doesn't exist. */
522 curbuf
->b_flags
&= ~(BF_NEW
| BF_NEW_W
);
526 * for UNIX: check readonly with perm and mch_access()
527 * for RISCOS: same as Unix, otherwise file gets re-datestamped!
528 * for MSDOS and Amiga: check readonly by trying to open the file for writing
530 file_readonly
= FALSE
;
533 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
534 /* Force binary I/O on stdin to avoid CR-LF -> LF conversion. */
535 setmode(0, O_BINARY
);
538 else if (!read_buffer
)
540 #ifdef USE_MCH_ACCESS
545 mch_access((char *)fname
, W_OK
))
546 file_readonly
= TRUE
;
547 fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0);
551 || (fd
= mch_open((char *)fname
, O_RDWR
| O_EXTRA
, 0)) < 0)
553 file_readonly
= TRUE
;
555 fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0);
560 if (fd
< 0) /* cannot open at all */
565 msg_scroll
= msg_save
;
568 * On MSDOS and Amiga we can't open a directory, check here.
570 isdir_f
= (mch_isdir(fname
));
571 perm
= mch_getperm(fname
); /* check if the file exists */
574 filemess(curbuf
, sfname
, (char_u
*)_("is a directory"), 0);
575 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
584 * Set the 'new-file' flag, so that when the file has
585 * been created by someone else, a ":w" will complain.
587 curbuf
->b_flags
|= BF_NEW
;
589 /* Create a swap file now, so that other Vims are warned
590 * that we are editing this file. Don't do this for a
591 * "nofile" or "nowrite" buffer type. */
593 if (!bt_dontwrite(curbuf
))
595 check_need_swap(newfile
);
596 if (dir_of_file_exists(fname
))
597 filemess(curbuf
, sfname
, (char_u
*)_("[New File]"), 0);
599 filemess(curbuf
, sfname
,
600 (char_u
*)_("[New DIRECTORY]"), 0);
602 /* Even though this is a new file, it might have been
603 * edited before and deleted. Get the old marks. */
607 if (eap
!= NULL
&& eap
->force_enc
!= 0)
609 /* set forced 'fileencoding' */
610 fenc
= enc_canonize(eap
->cmd
+ eap
->force_enc
);
612 set_string_option_direct((char_u
*)"fenc", -1,
613 fenc
, OPT_FREE
|OPT_LOCAL
, 0);
618 apply_autocmds_exarg(EVENT_BUFNEWFILE
, sfname
, sfname
,
621 /* remember the current fileformat */
622 save_file_ff(curbuf
);
624 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
625 if (aborting()) /* autocmds may abort script processing */
628 return OK
; /* a new file is not an error */
632 filemess(curbuf
, sfname
, (char_u
*)(
634 (errno
== EFBIG
) ? _("[File too big]") :
636 _("[Permission Denied]")), 0);
637 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
645 * Only set the 'ro' flag for readonly files the first time they are
646 * loaded. Help files always get readonly mode
648 if ((check_readonly
&& file_readonly
) || curbuf
->b_help
)
649 curbuf
->b_p_ro
= TRUE
;
653 curbuf
->b_p_eol
= TRUE
;
654 curbuf
->b_start_eol
= TRUE
;
656 curbuf
->b_p_bomb
= FALSE
;
657 curbuf
->b_start_bomb
= FALSE
;
661 /* Create a swap file now, so that other Vims are warned that we are
663 * Don't do this for a "nofile" or "nowrite" buffer type. */
665 if (!bt_dontwrite(curbuf
))
668 check_need_swap(newfile
);
670 /* Set swap file protection bits after creating it. */
671 if (swap_mode
> 0 && curbuf
->b_ml
.ml_mfp
->mf_fname
!= NULL
)
672 (void)mch_setperm(curbuf
->b_ml
.ml_mfp
->mf_fname
, (long)swap_mode
);
676 #if defined(HAS_SWAP_EXISTS_ACTION)
677 /* If "Quit" selected at ATTENTION dialog, don't load the file */
678 if (swap_exists_action
== SEA_QUIT
)
680 if (!read_buffer
&& !read_stdin
)
686 ++no_wait_return
; /* don't wait for return yet */
689 * Set '[ mark to the line above where the lines go (line 1 if zero).
691 curbuf
->b_op_start
.lnum
= ((from
== 0) ? 1 : from
);
692 curbuf
->b_op_start
.col
= 0;
698 int n
= msg_scrolled
;
699 buf_T
*old_curbuf
= curbuf
;
702 * The file must be closed again, the autocommands may want to change
703 * the file before reading it.
706 close(fd
); /* ignore errors */
709 * The output from the autocommands should not overwrite anything and
710 * should not be overwritten: Set msg_scroll, restore its value if no
715 apply_autocmds_exarg(EVENT_FILTERREADPRE
, NULL
, sfname
,
718 apply_autocmds_exarg(EVENT_STDINREADPRE
, NULL
, sfname
,
721 apply_autocmds_exarg(EVENT_BUFREADPRE
, NULL
, sfname
,
724 apply_autocmds_exarg(EVENT_FILEREADPRE
, sfname
, sfname
,
726 if (msg_scrolled
== n
)
730 if (aborting()) /* autocmds may abort script processing */
733 msg_scroll
= msg_save
;
734 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
739 * Don't allow the autocommands to change the current buffer.
740 * Try to re-open the file.
742 if (!read_stdin
&& (curbuf
!= old_curbuf
743 || (fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0)) < 0))
746 msg_scroll
= msg_save
;
748 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
750 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
751 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
755 #endif /* FEAT_AUTOCMD */
757 /* Autocommands may add lines to the file, need to check if it is empty */
758 wasempty
= (curbuf
->b_ml
.ml_flags
& ML_EMPTY
);
760 if (!recoverymode
&& !filtering
&& !(flags
& READ_DUMMY
))
763 * Show the user that we are busy reading the input. Sometimes this
764 * may take a while. When reading from stdin another program may
765 * still be running, don't move the cursor to the last line, unless
766 * always using the GUI.
770 #ifndef ALWAYS_USE_GUI
771 mch_msg(_("Vim: Reading from stdin...\n"));
774 /* Also write a message in the GUI window, if there is one. */
775 if (gui
.in_use
&& !gui
.dying
&& !gui
.starting
)
777 p
= (char_u
*)_("Reading from stdin...");
778 gui_write(p
, (int)STRLEN(p
));
782 else if (!read_buffer
)
783 filemess(curbuf
, sfname
, (char_u
*)"", 0);
786 msg_scroll
= FALSE
; /* overwrite the file message */
789 * Set linecnt now, before the "retry" caused by a wrong guess for
790 * fileformat, and after the autocommands, which may change them.
792 linecnt
= curbuf
->b_ml
.ml_line_count
;
795 /* "++bad=" argument. */
796 if (eap
!= NULL
&& eap
->bad_char
!= 0)
798 bad_char_behavior
= eap
->bad_char
;
800 curbuf
->b_bad_char
= eap
->bad_char
;
803 curbuf
->b_bad_char
= 0;
806 * Decide which 'encoding' to use or use first.
808 if (eap
!= NULL
&& eap
->force_enc
!= 0)
810 fenc
= enc_canonize(eap
->cmd
+ eap
->force_enc
);
812 keep_dest_enc
= TRUE
;
814 else if (curbuf
->b_p_bin
)
816 fenc
= (char_u
*)""; /* binary: don't convert */
817 fenc_alloced
= FALSE
;
819 else if (curbuf
->b_help
)
821 char_u firstline
[80];
824 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
825 * fails it must be latin1.
826 * Always do this when 'encoding' is "utf-8". Otherwise only do
827 * this when needed to avoid [converted] remarks all the time.
828 * It is needed when the first line contains non-ASCII characters.
829 * That is only in *.??x files. */
830 fenc
= (char_u
*)"latin1";
832 if (!c
&& !read_stdin
)
834 fc
= fname
[STRLEN(fname
) - 1];
835 if (TOLOWER_ASC(fc
) == 'x')
837 /* Read the first line (and a bit more). Immediately rewind to
838 * the start of the file. If the read() fails "len" is -1. */
839 len
= vim_read(fd
, firstline
, 80);
840 lseek(fd
, (off_t
)0L, SEEK_SET
);
841 for (p
= firstline
; p
< firstline
+ len
; ++p
)
853 fenc
= (char_u
*)"utf-8";
855 /* When the file is utf-8 but a character doesn't fit in
856 * 'encoding' don't retry. In help text editing utf-8 bytes
857 * doesn't make sense. */
859 keep_dest_enc
= TRUE
;
861 fenc_alloced
= FALSE
;
863 else if (*p_fencs
== NUL
)
865 fenc
= curbuf
->b_p_fenc
; /* use format from buffer */
866 fenc_alloced
= FALSE
;
870 fenc_next
= p_fencs
; /* try items in 'fileencodings' */
871 fenc
= next_fenc(&fenc_next
);
877 * Jump back here to retry reading the file in different ways.
879 * - encoding conversion failed: try another one from "fenc_next"
880 * - BOM detected and fenc was set, need to setup conversion
881 * - "fileformat" check failed: try another
883 * Variables set for special retry actions:
884 * "file_rewind" Rewind the file to start reading it again.
885 * "advance_fenc" Advance "fenc" using "fenc_next".
886 * "skip_read" Re-use already read bytes (BOM detected).
887 * "did_iconv" iconv() conversion failed, try 'charconvert'.
888 * "keep_fileformat" Don't reset "fileformat".
890 * Other status indicators:
891 * "tmpname" When != NULL did conversion with 'charconvert'.
892 * Output file has to be deleted afterwards.
893 * "iconv_fd" When != -1 did conversion with iconv().
904 else if (read_stdin
|| lseek(fd
, (off_t
)0L, SEEK_SET
) != 0)
906 /* Can't rewind the file, give up. */
910 /* Delete the previously read lines. */
912 ml_delete(lnum
--, FALSE
);
917 curbuf
->b_p_bomb
= FALSE
;
918 curbuf
->b_start_bomb
= FALSE
;
925 * When retrying with another "fenc" and the first time "fileformat"
929 keep_fileformat
= FALSE
;
932 if (eap
!= NULL
&& eap
->force_ff
!= 0)
933 fileformat
= get_fileformat_force(curbuf
, eap
);
934 else if (curbuf
->b_p_bin
)
935 fileformat
= EOL_UNIX
; /* binary: use Unix format */
936 else if (*p_ffs
== NUL
)
937 fileformat
= get_fileformat(curbuf
);/* use format from buffer */
939 fileformat
= EOL_UNKNOWN
; /* detect from file */
944 if (iconv_fd
!= (iconv_t
)-1)
946 /* aborted conversion with iconv(), close the descriptor */
947 iconv_close(iconv_fd
);
948 iconv_fd
= (iconv_t
)-1;
955 * Try the next entry in 'fileencodings'.
957 advance_fenc
= FALSE
;
959 if (eap
!= NULL
&& eap
->force_enc
!= 0)
961 /* Conversion given with "++cc=" wasn't possible, read
962 * without conversion. */
968 fenc_alloced
= FALSE
;
974 if (fenc_next
!= NULL
)
976 fenc
= next_fenc(&fenc_next
);
977 fenc_alloced
= (fenc_next
!= NULL
);
982 fenc_alloced
= FALSE
;
987 mch_remove(tmpname
); /* delete converted file */
994 * Conversion is required when the encoding of the file is different
995 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4 (requires
996 * conversion to UTF-8).
999 converted
= (*fenc
!= NUL
&& !same_encoding(p_enc
, fenc
));
1000 if (converted
|| enc_unicode
!= 0)
1003 /* "ucs-bom" means we need to check the first bytes of the file
1005 if (STRCMP(fenc
, ENC_UCSBOM
) == 0)
1006 fio_flags
= FIO_UCSBOM
;
1009 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
1010 * done. This is handled below after read(). Prepare the
1011 * fio_flags to avoid having to parse the string each time.
1012 * Also check for Unicode to Latin1 conversion, because iconv()
1013 * appears not to handle this correctly. This works just like
1014 * conversion to UTF-8 except how the resulting character is put in
1017 else if (enc_utf8
|| STRCMP(p_enc
, "latin1") == 0)
1018 fio_flags
= get_fio_flags(fenc
);
1022 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1023 * is handled with MultiByteToWideChar().
1026 fio_flags
= get_win_fio_flags(fenc
);
1030 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1032 fio_flags
= get_mac_fio_flags(fenc
);
1037 * Try using iconv() if we can't convert internally.
1044 iconv_fd
= (iconv_t
)my_iconv_open(
1045 enc_utf8
? (char_u
*)"utf-8" : p_enc
, fenc
);
1050 * Use the 'charconvert' expression when conversion is required
1051 * and we can't do it internally or with iconv().
1053 if (fio_flags
== 0 && !read_stdin
&& !read_buffer
&& *p_ccv
!= NUL
1055 && iconv_fd
== (iconv_t
)-1
1062 /* Skip conversion when it's already done (retry for wrong
1064 if (tmpname
== NULL
)
1066 tmpname
= readfile_charconvert(fname
, fenc
, &fd
);
1067 if (tmpname
== NULL
)
1069 /* Conversion failed. Try another one. */
1070 advance_fenc
= TRUE
;
1073 /* Re-opening the original file failed! */
1074 EMSG(_("E202: Conversion made file unreadable!"));
1087 && iconv_fd
== (iconv_t
)-1
1091 /* Conversion wanted but we can't.
1092 * Try the next conversion in 'fileencodings' */
1093 advance_fenc
= TRUE
;
1099 /* Set "can_retry" when it's possible to rewind the file and try with
1100 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1101 * stdin or fixed at a specific encoding. */
1102 can_retry
= (*fenc
!= NUL
&& !read_stdin
&& !keep_dest_enc
);
1109 skip_count
= lines_to_skip
;
1110 read_count
= lines_to_read
;
1116 while (!error
&& !got_int
)
1119 * We allocate as much space for the file as we can get, plus
1120 * space for the old line plus room for one terminating NUL.
1121 * The amount is limited by the fact that read() only can read
1122 * upto max_unsigned characters (and other things).
1125 if (linerest
>= 0x7ff0)
1128 *ptr
= NL
; /* split line by inserting a NL */
1137 # if defined(SSIZE_MAX) && (SSIZE_MAX < 0x10000L)
1138 size
= SSIZE_MAX
; /* use max I/O size, 52K */
1140 size
= 0x10000L
; /* use buffer >= 64K */
1143 size
= 0x7ff0L
- linerest
; /* limit buffer to 32K */
1146 for ( ; size
>= 10; size
= (long)((long_u
)size
>> 1))
1148 if ((new_buffer
= lalloc((long_u
)(size
+ linerest
+ 1),
1152 if (new_buffer
== NULL
)
1154 do_outofmem_msg((long_u
)(size
* 2 + linerest
+ 1));
1158 if (linerest
) /* copy characters from the previous buffer */
1159 mch_memmove(new_buffer
, ptr
- linerest
, (size_t)linerest
);
1161 buffer
= new_buffer
;
1162 ptr
= buffer
+ linerest
;
1163 line_start
= buffer
;
1166 /* May need room to translate into.
1167 * For iconv() we don't really know the required space, use a
1168 * factor ICONV_MULT.
1169 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1170 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1171 * become up to 4 bytes, size must be multiple of 2
1172 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1174 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1176 real_size
= (int)size
;
1178 if (iconv_fd
!= (iconv_t
)-1)
1179 size
= size
/ ICONV_MULT
;
1182 if (fio_flags
& FIO_LATIN1
)
1184 else if (fio_flags
& (FIO_UCS2
| FIO_UTF16
))
1185 size
= (size
* 2 / 3) & ~1;
1186 else if (fio_flags
& FIO_UCS4
)
1187 size
= (size
* 2 / 3) & ~3;
1188 else if (fio_flags
== FIO_UCSBOM
)
1189 size
= size
/ ICONV_MULT
; /* worst case */
1191 else if (fio_flags
& FIO_CODEPAGE
)
1192 size
= size
/ ICONV_MULT
; /* also worst case */
1195 else if (fio_flags
& FIO_MACROMAN
)
1196 size
= size
/ ICONV_MULT
; /* also worst case */
1201 if (conv_restlen
> 0)
1203 /* Insert unconverted bytes from previous line. */
1204 mch_memmove(ptr
, conv_rest
, conv_restlen
);
1205 ptr
+= conv_restlen
;
1206 size
-= conv_restlen
;
1213 * Read bytes from curbuf. Used for converting text read
1216 if (read_buf_lnum
> from
)
1226 p
= ml_get(read_buf_lnum
) + read_buf_col
;
1228 if ((int)tlen
+ n
+ 1 > size
)
1230 /* Filled up to "size", append partial line.
1231 * Change NL to NUL to reverse the effect done
1233 n
= (int)(size
- tlen
);
1234 for (ni
= 0; ni
< n
; ++ni
)
1239 ptr
[tlen
++] = p
[ni
];
1246 /* Append whole line and new-line. Change NL
1247 * to NUL to reverse the effect done below. */
1248 for (ni
= 0; ni
< n
; ++ni
)
1253 ptr
[tlen
++] = p
[ni
];
1257 if (++read_buf_lnum
> from
)
1259 /* When the last line didn't have an
1260 * end-of-line don't add it now either. */
1261 if (!curbuf
->b_p_eol
)
1273 * Read bytes from the file.
1275 size
= vim_read(fd
, ptr
, size
);
1280 if (size
< 0) /* read error */
1283 else if (conv_restlen
> 0)
1285 /* Reached end-of-file but some trailing bytes could
1286 * not be converted. Truncated file? */
1287 if (conv_error
== 0)
1288 conv_error
= linecnt
;
1289 if (bad_char_behavior
!= BAD_DROP
)
1291 fio_flags
= 0; /* don't convert this */
1293 if (iconv_fd
!= (iconv_t
)-1)
1295 iconv_close(iconv_fd
);
1296 iconv_fd
= (iconv_t
)-1;
1299 if (bad_char_behavior
== BAD_KEEP
)
1301 /* Keep the trailing bytes as-is. */
1302 size
= conv_restlen
;
1303 ptr
-= conv_restlen
;
1307 /* Replace the trailing bytes with the
1308 * replacement character. */
1310 *--ptr
= bad_char_behavior
;
1320 * At start of file: Check for magic number of encryption.
1323 cryptkey
= check_for_cryptkey(cryptkey
, ptr
, &size
,
1324 &filesize
, newfile
);
1326 * Decrypt the read bytes.
1328 if (cryptkey
!= NULL
&& size
> 0)
1329 for (p
= ptr
; p
< ptr
+ size
; ++p
)
1337 * At start of file (or after crypt magic number): Check for BOM.
1338 * Also check for a BOM for other Unicode encodings, but not after
1339 * converting with 'charconvert' or when a BOM has already been
1344 || (filesize
== CRYPT_MAGIC_LEN
&& cryptkey
!= NULL
)
1347 && (fio_flags
== FIO_UCSBOM
1348 || (!curbuf
->b_p_bomb
1350 && (*fenc
== 'u' || (*fenc
== NUL
&& enc_utf8
)))))
1355 /* no BOM detection in a short file or in binary mode */
1356 if (size
< 2 || curbuf
->b_p_bin
)
1359 ccname
= check_for_bom(ptr
, size
, &blen
,
1360 fio_flags
== FIO_UCSBOM
? FIO_ALL
: get_fio_flags(fenc
));
1363 /* Remove BOM from the text */
1366 mch_memmove(ptr
, ptr
+ blen
, (size_t)size
);
1369 curbuf
->b_p_bomb
= TRUE
;
1370 curbuf
->b_start_bomb
= TRUE
;
1374 if (fio_flags
== FIO_UCSBOM
)
1378 /* No BOM detected: retry with next encoding. */
1379 advance_fenc
= TRUE
;
1383 /* BOM detected: set "fenc" and jump back */
1387 fenc_alloced
= FALSE
;
1389 /* retry reading without getting new bytes or rewinding */
1396 * Break here for a read error or end-of-file.
1403 /* Include not converted bytes. */
1404 ptr
-= conv_restlen
;
1405 size
+= conv_restlen
;
1409 if (iconv_fd
!= (iconv_t
)-1)
1412 * Attempt conversion of the read bytes to 'encoding' using
1420 fromp
= (char *)ptr
;
1424 to_size
= real_size
- size
;
1427 * If there is conversion error or not enough room try using
1428 * another conversion. Except for when there is no
1429 * alternative (help files).
1431 while ((iconv(iconv_fd
, (void *)&fromp
, &from_size
,
1433 == (size_t)-1 && ICONV_ERRNO
!= ICONV_EINVAL
)
1434 || from_size
> CONV_RESTLEN
)
1438 if (conv_error
== 0)
1439 conv_error
= readfile_linenr(linecnt
,
1440 ptr
, (char_u
*)top
);
1442 /* Deal with a bad byte and continue with the next. */
1445 if (bad_char_behavior
== BAD_KEEP
)
1447 *top
++ = *(fromp
- 1);
1450 else if (bad_char_behavior
!= BAD_DROP
)
1452 *top
++ = bad_char_behavior
;
1459 /* Some remaining characters, keep them for the next
1461 mch_memmove(conv_rest
, (char_u
*)fromp
, from_size
);
1462 conv_restlen
= (int)from_size
;
1465 /* move the linerest to before the converted characters */
1466 line_start
= ptr
- linerest
;
1467 mch_memmove(line_start
, buffer
, (size_t)linerest
);
1468 size
= (long)((char_u
*)top
- ptr
);
1473 if (fio_flags
& FIO_CODEPAGE
)
1478 int codepage
= FIO_GET_CP(fio_flags
);
1484 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1485 * a codepage, using standard MS-Windows functions. This
1486 * requires two steps:
1487 * 1. convert from 'fileencoding' to ucs-2
1488 * 2. convert from ucs-2 to 'encoding'
1490 * Because there may be illegal bytes AND an incomplete byte
1491 * sequence at the end, we may have to do the conversion one
1492 * character at a time to get it right.
1495 /* Replacement string for WideCharToMultiByte(). */
1496 if (bad_char_behavior
> 0)
1497 replstr
[0] = bad_char_behavior
;
1503 * Move the bytes to the end of the buffer, so that we have
1504 * room to put the result at the start.
1506 src
= ptr
+ real_size
- size
;
1507 mch_memmove(src
, ptr
, size
);
1510 * Do the conversion.
1518 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1519 if (codepage
== CP_UTF8
)
1521 /* Handle CP_UTF8 input ourselves to be able to handle
1522 * trailing bytes properly.
1523 * Get one UTF-8 character from src. */
1524 bytelen
= (int)utf_ptr2len_len(src
, size
);
1527 /* Only got some bytes of a character. Normally
1528 * it's put in "conv_rest", but if it's too long
1529 * deal with it as if they were illegal bytes. */
1530 if (bytelen
<= CONV_RESTLEN
)
1533 /* weird overlong byte sequence */
1539 int u8c
= utf_ptr2char(src
);
1541 if (u8c
> 0xffff || (*src
>= 0x80 && bytelen
== 1))
1550 /* We don't know how long the byte sequence is, try
1551 * from one to three bytes. */
1552 for (bytelen
= 1; bytelen
<= size
&& bytelen
<= 3;
1555 ucs2len
= MultiByteToWideChar(codepage
,
1556 MB_ERR_INVALID_CHARS
,
1557 (LPCSTR
)src
, bytelen
,
1564 /* If we have only one byte then it's probably an
1565 * incomplete byte sequence. Otherwise discard
1566 * one byte as a bad character. */
1578 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1581 /* From UCS-2 to UTF-8. Cannot fail. */
1582 for (i
= 0; i
< ucs2len
; ++i
)
1583 dst
+= utf_char2bytes(ucs2buf
[i
], dst
);
1590 /* From UCS-2 to "enc_codepage". If the
1591 * conversion uses the default character "?",
1592 * the data doesn't fit in this encoding. */
1593 dstlen
= WideCharToMultiByte(enc_codepage
, 0,
1594 (LPCWSTR
)ucs2buf
, ucs2len
,
1595 (LPSTR
)dst
, (int)(src
- dst
),
1606 /* Deal with bytes we can't convert. */
1609 if (conv_error
== 0)
1610 conv_error
= readfile_linenr(linecnt
, ptr
, dst
);
1611 if (bad_char_behavior
!= BAD_DROP
)
1613 if (bad_char_behavior
== BAD_KEEP
)
1615 mch_memmove(dst
, src
, bytelen
);
1619 *dst
++ = bad_char_behavior
;
1629 /* An incomplete byte sequence remaining. */
1630 mch_memmove(conv_rest
, src
, size
);
1631 conv_restlen
= size
;
1634 /* The new size is equal to how much "dst" was advanced. */
1635 size
= (long)(dst
- ptr
);
1639 # ifdef MACOS_CONVERT
1640 if (fio_flags
& FIO_MACROMAN
)
1643 * Conversion from Apple MacRoman char encoding to UTF-8 or
1644 * latin1. This is in os_mac_conv.c.
1646 if (macroman2enc(ptr
, &size
, real_size
) == FAIL
)
1655 char_u
*tail
= NULL
;
1658 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1659 * "enc_utf8" not set: Convert Unicode to Latin1.
1660 * Go from end to start through the buffer, because the number
1661 * of bytes may increase.
1662 * "dest" points to after where the UTF-8 bytes go, "p" points
1663 * to after the next character to convert.
1665 dest
= ptr
+ real_size
;
1666 if (fio_flags
== FIO_LATIN1
|| fio_flags
== FIO_UTF8
)
1669 if (fio_flags
== FIO_UTF8
)
1671 /* Check for a trailing incomplete UTF-8 sequence */
1672 tail
= ptr
+ size
- 1;
1673 while (tail
> ptr
&& (*tail
& 0xc0) == 0x80)
1675 if (tail
+ utf_byte2len(*tail
) <= ptr
+ size
)
1681 else if (fio_flags
& (FIO_UCS2
| FIO_UTF16
))
1683 /* Check for a trailing byte */
1684 p
= ptr
+ (size
& ~1);
1687 if ((fio_flags
& FIO_UTF16
) && p
> ptr
)
1689 /* Check for a trailing leading word */
1690 if (fio_flags
& FIO_ENDIAN_L
)
1700 if (u8c
>= 0xd800 && u8c
<= 0xdbff)
1708 /* Check for trailing 1, 2 or 3 bytes */
1709 p
= ptr
+ (size
& ~3);
1714 /* If there is a trailing incomplete sequence move it to
1718 conv_restlen
= (int)((ptr
+ size
) - tail
);
1719 mch_memmove(conv_rest
, (char_u
*)tail
, conv_restlen
);
1720 size
-= conv_restlen
;
1726 if (fio_flags
& FIO_LATIN1
)
1728 else if (fio_flags
& (FIO_UCS2
| FIO_UTF16
))
1730 if (fio_flags
& FIO_ENDIAN_L
)
1740 if ((fio_flags
& FIO_UTF16
)
1741 && u8c
>= 0xdc00 && u8c
<= 0xdfff)
1747 /* Missing leading word. */
1750 if (conv_error
== 0)
1751 conv_error
= readfile_linenr(linecnt
,
1753 if (bad_char_behavior
== BAD_DROP
)
1755 if (bad_char_behavior
!= BAD_KEEP
)
1756 u8c
= bad_char_behavior
;
1759 /* found second word of double-word, get the first
1760 * word and compute the resulting character */
1761 if (fio_flags
& FIO_ENDIAN_L
)
1769 u16c
+= (*--p
<< 8);
1771 u8c
= 0x10000 + ((u16c
& 0x3ff) << 10)
1774 /* Check if the word is indeed a leading word. */
1775 if (u16c
< 0xd800 || u16c
> 0xdbff)
1779 if (conv_error
== 0)
1780 conv_error
= readfile_linenr(linecnt
,
1782 if (bad_char_behavior
== BAD_DROP
)
1784 if (bad_char_behavior
!= BAD_KEEP
)
1785 u8c
= bad_char_behavior
;
1789 else if (fio_flags
& FIO_UCS4
)
1791 if (fio_flags
& FIO_ENDIAN_L
)
1794 u8c
+= (*--p
<< 16);
1798 else /* big endian */
1802 u8c
+= (*--p
<< 16);
1803 u8c
+= (*--p
<< 24);
1812 len
= utf_head_off(ptr
, p
);
1814 u8c
= utf_ptr2char(p
);
1817 /* Not a valid UTF-8 character, retry with
1818 * another fenc when possible, otherwise just
1819 * report the error. */
1822 if (conv_error
== 0)
1823 conv_error
= readfile_linenr(linecnt
,
1825 if (bad_char_behavior
== BAD_DROP
)
1827 if (bad_char_behavior
!= BAD_KEEP
)
1828 u8c
= bad_char_behavior
;
1832 if (enc_utf8
) /* produce UTF-8 */
1834 dest
-= utf_char2len(u8c
);
1835 (void)utf_char2bytes(u8c
, dest
);
1837 else /* produce Latin1 */
1842 /* character doesn't fit in latin1, retry with
1843 * another fenc when possible, otherwise just
1844 * report the error. */
1847 if (conv_error
== 0)
1848 conv_error
= readfile_linenr(linecnt
, ptr
, p
);
1849 if (bad_char_behavior
== BAD_DROP
)
1851 else if (bad_char_behavior
== BAD_KEEP
)
1853 else if (eap
!= NULL
&& eap
->bad_char
!= 0)
1854 *dest
= bad_char_behavior
;
1863 /* move the linerest to before the converted characters */
1864 line_start
= dest
- linerest
;
1865 mch_memmove(line_start
, buffer
, (size_t)linerest
);
1866 size
= (long)((ptr
+ real_size
) - dest
);
1869 else if (enc_utf8
&& conv_error
== 0 && !curbuf
->b_p_bin
)
1871 /* Reading UTF-8: Check if the bytes are valid UTF-8.
1872 * Need to start before "ptr" when part of the character was
1873 * read in the previous read() call. */
1874 for (p
= ptr
- utf_head_off(buffer
, ptr
); ; ++p
)
1876 int todo
= (int)((ptr
+ size
) - p
);
1883 /* A length of 1 means it's an illegal byte. Accept
1884 * an incomplete character at the end though, the next
1885 * read() will get the next bytes, we'll check it
1887 l
= utf_ptr2len_len(p
, todo
);
1890 /* Incomplete byte sequence, the next read()
1891 * should get them and check the bytes. */
1897 /* Illegal byte. If we can try another encoding
1902 /* Remember the first linenr with an illegal byte */
1903 if (illegal_byte
== 0)
1904 illegal_byte
= readfile_linenr(linecnt
, ptr
, p
);
1906 /* When we did a conversion report an error. */
1907 if (iconv_fd
!= (iconv_t
)-1 && conv_error
== 0)
1908 conv_error
= readfile_linenr(linecnt
, ptr
, p
);
1911 /* Drop, keep or replace the bad byte. */
1912 if (bad_char_behavior
== BAD_DROP
)
1914 mch_memmove(p
, p
+1, todo
- 1);
1918 else if (bad_char_behavior
!= BAD_KEEP
)
1919 *p
= bad_char_behavior
;
1926 /* Detected a UTF-8 error. */
1928 /* Retry reading with another conversion. */
1929 # if defined(FEAT_EVAL) && defined(USE_ICONV)
1930 if (*p_ccv
!= NUL
&& iconv_fd
!= (iconv_t
)-1)
1931 /* iconv() failed, try 'charconvert' */
1935 /* use next item from 'fileencodings' */
1936 advance_fenc
= TRUE
;
1943 /* count the number of characters (after conversion!) */
1947 * when reading the first part of a file: guess EOL type
1949 if (fileformat
== EOL_UNKNOWN
)
1951 /* First try finding a NL, for Dos and Unix */
1952 if (try_dos
|| try_unix
)
1954 for (p
= ptr
; p
< ptr
+ size
; ++p
)
1959 || (try_dos
&& p
> ptr
&& p
[-1] == CAR
))
1960 fileformat
= EOL_DOS
;
1962 fileformat
= EOL_UNIX
;
1967 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
1968 if (fileformat
== EOL_UNIX
&& try_mac
)
1970 /* Need to reset the counters when retrying fenc. */
1973 for (; p
>= ptr
&& *p
!= CAR
; p
--)
1977 for (p
= ptr
; p
< ptr
+ size
; ++p
)
1984 if (try_mac
> try_unix
)
1985 fileformat
= EOL_MAC
;
1990 /* No NL found: may use Mac format */
1991 if (fileformat
== EOL_UNKNOWN
&& try_mac
)
1992 fileformat
= EOL_MAC
;
1994 /* Still nothing found? Use first format in 'ffs' */
1995 if (fileformat
== EOL_UNKNOWN
)
1996 fileformat
= default_fileformat();
1998 /* if editing a new file: may set p_tx and p_ff */
2000 set_fileformat(fileformat
, OPT_LOCAL
);
2005 * This loop is executed once for every character read.
2008 if (fileformat
== EOL_MAC
)
2011 while (++ptr
, --size
>= 0)
2013 /* catch most common case first */
2014 if ((c
= *ptr
) != NUL
&& c
!= CAR
&& c
!= NL
)
2017 *ptr
= NL
; /* NULs are replaced by newlines! */
2019 *ptr
= CAR
; /* NLs are replaced by CRs! */
2022 if (skip_count
== 0)
2024 *ptr
= NUL
; /* end of line */
2025 len
= (colnr_T
) (ptr
- line_start
+ 1);
2026 if (ml_append(lnum
, line_start
, len
, newfile
) == FAIL
)
2032 if (--read_count
== 0)
2034 error
= TRUE
; /* break loop */
2035 line_start
= ptr
; /* nothing left to write */
2041 line_start
= ptr
+ 1;
2048 while (++ptr
, --size
>= 0)
2050 if ((c
= *ptr
) != NUL
&& c
!= NL
) /* catch most common case */
2053 *ptr
= NL
; /* NULs are replaced by newlines! */
2056 if (skip_count
== 0)
2058 *ptr
= NUL
; /* end of line */
2059 len
= (colnr_T
)(ptr
- line_start
+ 1);
2060 if (fileformat
== EOL_DOS
)
2062 if (ptr
[-1] == CAR
) /* remove CR */
2068 * Reading in Dos format, but no CR-LF found!
2069 * When 'fileformats' includes "unix", delete all
2070 * the lines read so far and start all over again.
2071 * Otherwise give an error message later.
2073 else if (ff_error
!= EOL_DOS
)
2078 || lseek(fd
, (off_t
)0L, SEEK_SET
) == 0))
2080 fileformat
= EOL_UNIX
;
2082 set_fileformat(EOL_UNIX
, OPT_LOCAL
);
2084 keep_fileformat
= TRUE
;
2090 if (ml_append(lnum
, line_start
, len
, newfile
) == FAIL
)
2096 if (--read_count
== 0)
2098 error
= TRUE
; /* break loop */
2099 line_start
= ptr
; /* nothing left to write */
2105 line_start
= ptr
+ 1;
2109 linerest
= (long)(ptr
- line_start
);
2114 /* not an error, max. number of lines reached */
2115 if (error
&& read_count
== 0)
2119 * If we get EOF in the middle of a line, note the fact and
2120 * complete the line ourselves.
2121 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2126 && !(!curbuf
->b_p_bin
2127 && fileformat
== EOL_DOS
2128 && *line_start
== Ctrl_Z
2129 && ptr
== line_start
+ 1))
2131 /* remember for when writing */
2133 curbuf
->b_p_eol
= FALSE
;
2135 if (ml_append(lnum
, line_start
,
2136 (colnr_T
)(ptr
- line_start
+ 1), newfile
) == FAIL
)
2139 read_no_eol_lnum
= ++lnum
;
2143 save_file_ff(curbuf
); /* remember the current file format */
2146 if (cryptkey
!= curbuf
->b_p_key
)
2151 /* If editing a new file: set 'fenc' for the current buffer.
2152 * Also for ":read ++edit file". */
2154 set_string_option_direct((char_u
*)"fenc", -1, fenc
,
2155 OPT_FREE
|OPT_LOCAL
, 0);
2159 if (iconv_fd
!= (iconv_t
)-1)
2161 iconv_close(iconv_fd
);
2162 iconv_fd
= (iconv_t
)-1;
2167 if (!read_buffer
&& !read_stdin
)
2168 close(fd
); /* errors are ignored */
2174 /* Use stderr for stdin, makes shell commands work. */
2181 if (tmpname
!= NULL
)
2183 mch_remove(tmpname
); /* delete converted file */
2187 --no_wait_return
; /* may wait for return now */
2190 * In recovery mode everything but autocommands is skipped.
2194 /* need to delete the last line, which comes from the empty buffer */
2195 if (newfile
&& wasempty
&& !(curbuf
->b_ml
.ml_flags
& ML_EMPTY
))
2197 #ifdef FEAT_NETBEANS_INTG
2198 netbeansFireChanges
= 0;
2200 ml_delete(curbuf
->b_ml
.ml_line_count
, FALSE
);
2201 #ifdef FEAT_NETBEANS_INTG
2202 netbeansFireChanges
= 1;
2206 linecnt
= curbuf
->b_ml
.ml_line_count
- linecnt
;
2209 if (newfile
|| read_buffer
)
2211 redraw_curbuf_later(NOT_VALID
);
2213 /* After reading the text into the buffer the diff info needs to
2215 diff_invalidate(curbuf
);
2218 /* All folds in the window are invalid now. Mark them for update
2219 * before triggering autocommands. */
2220 foldUpdateAll(curwin
);
2223 else if (linecnt
) /* appended at least one line */
2224 appended_lines_mark(from
, linecnt
);
2226 #ifndef ALWAYS_USE_GUI
2228 * If we were reading from the same terminal as where messages go,
2229 * the screen will have been messed up.
2230 * Switch on raw mode now and clear the screen.
2234 settmode(TMODE_RAW
); /* set to raw mode */
2242 if (!(flags
& READ_DUMMY
))
2244 filemess(curbuf
, sfname
, (char_u
*)_(e_interr
), 0);
2246 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
2248 msg_scroll
= msg_save
;
2252 return OK
; /* an interrupt isn't really an error */
2255 if (!filtering
&& !(flags
& READ_DUMMY
))
2257 msg_add_fname(curbuf
, sfname
); /* fname in IObuff with quotes */
2262 if (S_ISFIFO(perm
)) /* fifo or socket */
2264 STRCAT(IObuff
, _("[fifo/socket]"));
2269 if ((perm
& S_IFMT
) == S_IFIFO
) /* fifo */
2271 STRCAT(IObuff
, _("[fifo]"));
2276 if ((perm
& S_IFMT
) == S_IFSOCK
) /* or socket */
2278 STRCAT(IObuff
, _("[socket]"));
2283 # ifdef OPEN_CHR_FILES
2284 if (S_ISCHR(perm
)) /* or character special */
2286 STRCAT(IObuff
, _("[character special]"));
2293 STRCAT(IObuff
, shortmess(SHM_RO
) ? _("[RO]") : _("[readonly]"));
2296 if (read_no_eol_lnum
)
2301 if (ff_error
== EOL_DOS
)
2303 STRCAT(IObuff
, _("[CR missing]"));
2306 if (ff_error
== EOL_MAC
)
2308 STRCAT(IObuff
, _("[NL found]"));
2313 STRCAT(IObuff
, _("[long lines split]"));
2319 STRCAT(IObuff
, _("[NOT converted]"));
2324 STRCAT(IObuff
, _("[converted]"));
2329 if (cryptkey
!= NULL
)
2331 STRCAT(IObuff
, _("[crypted]"));
2336 if (conv_error
!= 0)
2338 sprintf((char *)IObuff
+ STRLEN(IObuff
),
2339 _("[CONVERSION ERROR in line %ld]"), (long)conv_error
);
2342 else if (illegal_byte
> 0)
2344 sprintf((char *)IObuff
+ STRLEN(IObuff
),
2345 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte
);
2352 STRCAT(IObuff
, _("[READ ERRORS]"));
2355 if (msg_add_fileformat(fileformat
))
2358 if (cryptkey
!= NULL
)
2359 msg_add_lines(c
, (long)linecnt
, filesize
- CRYPT_MAGIC_LEN
);
2362 msg_add_lines(c
, (long)linecnt
, filesize
);
2366 msg_scrolled_ign
= TRUE
;
2367 #ifdef ALWAYS_USE_GUI
2368 /* Don't show the message when reading stdin, it would end up in a
2369 * message box (which might be shown when exiting!) */
2370 if (read_stdin
|| read_buffer
)
2371 p
= msg_may_trunc(FALSE
, IObuff
);
2374 p
= msg_trunc_attr(IObuff
, FALSE
, 0);
2375 if (read_stdin
|| read_buffer
|| restart_edit
!= 0
2376 || (msg_scrolled
!= 0 && !need_wait_return
))
2377 /* Need to repeat the message after redrawing when:
2378 * - When reading from stdin (the screen will be cleared next).
2379 * - When restart_edit is set (otherwise there will be a delay
2380 * before redrawing).
2381 * - When the screen was scrolled but there is no wait-return
2384 msg_scrolled_ign
= FALSE
;
2387 /* with errors writing the file requires ":w!" */
2388 if (newfile
&& (error
2391 || (illegal_byte
> 0 && bad_char_behavior
!= BAD_KEEP
)
2394 curbuf
->b_p_ro
= TRUE
;
2396 u_clearline(); /* cannot use "U" command after adding lines */
2399 * In Ex mode: cursor at last new line.
2400 * Otherwise: cursor at first new line.
2403 curwin
->w_cursor
.lnum
= from
+ linecnt
;
2405 curwin
->w_cursor
.lnum
= from
+ 1;
2406 check_cursor_lnum();
2407 beginline(BL_WHITE
| BL_FIX
); /* on first non-blank */
2410 * Set '[ and '] marks to the newly read lines.
2412 curbuf
->b_op_start
.lnum
= from
+ 1;
2413 curbuf
->b_op_start
.col
= 0;
2414 curbuf
->b_op_end
.lnum
= from
+ linecnt
;
2415 curbuf
->b_op_end
.col
= 0;
2419 * Work around a weird problem: When a file has two links (only
2420 * possible on NTFS) and we write through one link, then stat() it
2421 * throught the other link, the timestamp information may be wrong.
2422 * It's correct again after reading the file, thus reset the timestamp
2425 if (newfile
&& !read_stdin
&& !read_buffer
2426 && mch_stat((char *)fname
, &st
) >= 0)
2428 buf_store_time(curbuf
, &st
, fname
);
2429 curbuf
->b_mtime_read
= curbuf
->b_mtime
;
2433 msg_scroll
= msg_save
;
2437 * Get the marks before executing autocommands, so they can be used there.
2443 * Trick: We remember if the last line of the read didn't have
2444 * an eol for when writing it again. This is required for
2445 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2447 write_no_eol_lnum
= read_no_eol_lnum
;
2450 if (!read_stdin
&& !read_buffer
)
2453 int n
= msg_scrolled
;
2455 /* Save the fileformat now, otherwise the buffer will be considered
2456 * modified if the format/encoding was automatically detected. */
2458 save_file_ff(curbuf
);
2461 * The output from the autocommands should not overwrite anything and
2462 * should not be overwritten: Set msg_scroll, restore its value if no
2467 apply_autocmds_exarg(EVENT_FILTERREADPOST
, NULL
, sfname
,
2468 FALSE
, curbuf
, eap
);
2470 apply_autocmds_exarg(EVENT_BUFREADPOST
, NULL
, sfname
,
2471 FALSE
, curbuf
, eap
);
2473 apply_autocmds_exarg(EVENT_FILEREADPOST
, sfname
, sfname
,
2475 if (msg_scrolled
== n
)
2478 if (aborting()) /* autocmds may abort script processing */
2484 if (recoverymode
&& error
)
2489 #ifdef OPEN_CHR_FILES
2491 * Returns TRUE if the file name argument is of the form "/dev/fd/\d\+",
2492 * which is the name of files used for process substitution output by
2493 * some shells on some operating systems, e.g., bash on SunOS.
2494 * Do not accept "/dev/fd/[012]", opening these may hang Vim.
2497 is_dev_fd_file(fname
)
2500 return (STRNCMP(fname
, "/dev/fd/", 8) == 0
2501 && VIM_ISDIGIT(fname
[8])
2502 && *skipdigits(fname
+ 9) == NUL
2504 || (fname
[8] != '0' && fname
[8] != '1' && fname
[8] != '2')));
2511 * From the current line count and characters read after that, estimate the
2512 * line number where we are now.
2513 * Used for error messages that include a line number.
2516 readfile_linenr(linecnt
, p
, endp
)
2517 linenr_T linecnt
; /* line count before reading more bytes */
2518 char_u
*p
; /* start of more bytes read */
2519 char_u
*endp
; /* end of more bytes read */
2524 lnum
= curbuf
->b_ml
.ml_line_count
- linecnt
+ 1;
2525 for (s
= p
; s
< endp
; ++s
)
2533 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2534 * equal to the buffer "buf". Used for calling readfile().
2535 * Returns OK or FAIL.
2538 prep_exarg(eap
, buf
)
2542 eap
->cmd
= alloc((unsigned)(STRLEN(buf
->b_p_ff
)
2544 + STRLEN(buf
->b_p_fenc
)
2547 if (eap
->cmd
== NULL
)
2551 sprintf((char *)eap
->cmd
, "e ++ff=%s ++enc=%s", buf
->b_p_ff
, buf
->b_p_fenc
);
2552 eap
->force_enc
= 14 + (int)STRLEN(buf
->b_p_ff
);
2553 eap
->bad_char
= buf
->b_bad_char
;
2555 sprintf((char *)eap
->cmd
, "e ++ff=%s", buf
->b_p_ff
);
2559 eap
->force_bin
= buf
->b_p_bin
? FORCE_BIN
: FORCE_NOBIN
;
2560 eap
->read_edit
= FALSE
;
2561 eap
->forceit
= FALSE
;
2567 * Find next fileencoding to use from 'fileencodings'.
2568 * "pp" points to fenc_next. It's advanced to the next item.
2569 * When there are no more items, an empty string is returned and *pp is set to
2571 * When *pp is not set to NULL, the result is in allocated memory.
2583 return (char_u
*)"";
2585 p
= vim_strchr(*pp
, ',');
2588 r
= enc_canonize(*pp
);
2593 r
= vim_strnsave(*pp
, (int)(p
- *pp
));
2597 p
= enc_canonize(r
);
2602 if (r
== NULL
) /* out of memory */
2612 * Convert a file with the 'charconvert' expression.
2613 * This closes the file which is to be read, converts it and opens the
2614 * resulting file for reading.
2615 * Returns name of the resulting converted file (the caller should delete it
2616 * after reading it).
2617 * Returns NULL if the conversion failed ("*fdp" is not set) .
2620 readfile_charconvert(fname
, fenc
, fdp
)
2621 char_u
*fname
; /* name of input file */
2622 char_u
*fenc
; /* converted from */
2623 int *fdp
; /* in/out: file descriptor of file */
2626 char_u
*errmsg
= NULL
;
2628 tmpname
= vim_tempname('r');
2629 if (tmpname
== NULL
)
2630 errmsg
= (char_u
*)_("Can't find temp file for conversion");
2633 close(*fdp
); /* close the input file, ignore errors */
2635 if (eval_charconvert(fenc
, enc_utf8
? (char_u
*)"utf-8" : p_enc
,
2636 fname
, tmpname
) == FAIL
)
2637 errmsg
= (char_u
*)_("Conversion with 'charconvert' failed");
2638 if (errmsg
== NULL
&& (*fdp
= mch_open((char *)tmpname
,
2639 O_RDONLY
| O_EXTRA
, 0)) < 0)
2640 errmsg
= (char_u
*)_("can't read output of 'charconvert'");
2645 /* Don't use emsg(), it breaks mappings, the retry with
2646 * another type of conversion might still work. */
2648 if (tmpname
!= NULL
)
2650 mch_remove(tmpname
); /* delete converted file */
2656 /* If the input file is closed, open it (caller should check for error). */
2658 *fdp
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0);
2668 * Read marks for the current buffer from the viminfo file, when we support
2669 * buffer marks and the buffer has a name.
2674 if (!curbuf
->b_marks_read
&& get_viminfo_parameter('\'') > 0
2675 && curbuf
->b_ffname
!= NULL
)
2676 read_viminfo(NULL
, FALSE
, TRUE
, FALSE
);
2678 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2679 * the ' parameter after opening a buffer. */
2680 curbuf
->b_marks_read
= TRUE
;
2686 * Check for magic number used for encryption.
2687 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2688 * *filesizep are updated.
2689 * Return the (new) encryption key, NULL for no encryption.
2692 check_for_cryptkey(cryptkey
, ptr
, sizep
, filesizep
, newfile
)
2693 char_u
*cryptkey
; /* previous encryption key or NULL */
2694 char_u
*ptr
; /* pointer to read bytes */
2695 long *sizep
; /* length of read bytes */
2696 long *filesizep
; /* nr of bytes used from file */
2697 int newfile
; /* editing a new buffer */
2699 if (*sizep
>= CRYPT_MAGIC_LEN
2700 && STRNCMP(ptr
, CRYPT_MAGIC
, CRYPT_MAGIC_LEN
) == 0)
2702 if (cryptkey
== NULL
)
2704 if (*curbuf
->b_p_key
)
2705 cryptkey
= curbuf
->b_p_key
;
2708 /* When newfile is TRUE, store the typed key
2709 * in the 'key' option and don't free it. */
2710 cryptkey
= get_crypt_key(newfile
, FALSE
);
2711 /* check if empty key entered */
2712 if (cryptkey
!= NULL
&& *cryptkey
== NUL
)
2714 if (cryptkey
!= curbuf
->b_p_key
)
2721 if (cryptkey
!= NULL
)
2723 crypt_init_keys(cryptkey
);
2725 /* Remove magic number from the text */
2726 *filesizep
+= CRYPT_MAGIC_LEN
;
2727 *sizep
-= CRYPT_MAGIC_LEN
;
2728 mch_memmove(ptr
, ptr
+ CRYPT_MAGIC_LEN
, (size_t)*sizep
);
2731 /* When starting to edit a new file which does not have
2732 * encryption, clear the 'key' option, except when
2733 * starting up (called with -x argument) */
2734 else if (newfile
&& *curbuf
->b_p_key
&& !starting
)
2735 set_option_value((char_u
*)"key", 0L, (char_u
*)"", OPT_LOCAL
);
2743 set_file_time(fname
, atime
, mtime
)
2745 time_t atime
; /* access time */
2746 time_t mtime
; /* modification time */
2748 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2752 buf
.modtime
= mtime
;
2753 (void)utime((char *)fname
, &buf
);
2755 # if defined(HAVE_UTIMES)
2756 struct timeval tvp
[2];
2758 tvp
[0].tv_sec
= atime
;
2760 tvp
[1].tv_sec
= mtime
;
2763 (void)utimes((char *)fname
, tvp
);
2765 (void)utimes((char *)fname
, (const struct timeval
*)&tvp
);
2772 #if defined(VMS) && !defined(MIN)
2773 /* Older DECC compiler for VAX doesn't define MIN() */
2774 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2778 * Return TRUE if a file appears to be read-only from the file permissions.
2781 check_file_readonly(fname
, perm
)
2782 char_u
*fname
; /* full path to file */
2783 int perm
; /* known permissions on file */
2785 #ifndef USE_MCH_ACCESS
2790 #ifdef USE_MCH_ACCESS
2792 (perm
& 0222) == 0 ||
2794 mch_access((char *)fname
, W_OK
)
2796 (fd
= mch_open((char *)fname
, O_RDWR
| O_EXTRA
, 0)) < 0
2797 ? TRUE
: (close(fd
), FALSE
)
2804 * buf_write() - write to file "fname" lines "start" through "end"
2806 * We do our own buffering here because fwrite() is so slow.
2808 * If "forceit" is true, we don't care for errors when attempting backups.
2809 * In case of an error everything possible is done to restore the original
2810 * file. But when "forceit" is TRUE, we risk loosing it.
2812 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2813 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2815 * This function must NOT use NameBuff (because it's called by autowrite()).
2817 * return FAIL for failure, OK otherwise
2820 buf_write(buf
, fname
, sfname
, start
, end
, eap
, append
, forceit
,
2821 reset_changed
, filtering
)
2825 linenr_T start
, end
;
2826 exarg_T
*eap
; /* for forced 'ff' and 'fenc', can be
2828 int append
; /* append to the file */
2834 char_u
*backup
= NULL
;
2835 int backup_copy
= FALSE
; /* copy the original file? */
2838 char_u
*wfname
= NULL
; /* name of file to write to */
2845 char_u
*errmsg
= NULL
;
2846 char_u
*errnum
= NULL
;
2848 char_u smallbuf
[SMBUFSIZE
];
2851 long perm
; /* file permissions */
2853 int newfile
= FALSE
; /* TRUE if file doesn't exist yet */
2854 int msg_save
= msg_scroll
;
2855 int overwriting
; /* TRUE if writing over original */
2856 int no_eol
= FALSE
; /* no end-of-line written */
2857 int device
= FALSE
; /* writing to a device */
2859 int prev_got_int
= got_int
;
2860 int file_readonly
= FALSE
; /* overwritten file is read-only */
2861 static char *err_readonly
= "is read-only (cannot override: \"W\" in 'cpoptions')";
2862 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2863 int made_writable
= FALSE
; /* 'w' bit has been set */
2865 /* writing everything */
2866 int whole
= (start
== 1 && end
== buf
->b_ml
.ml_line_count
);
2868 linenr_T old_line_count
= buf
->b_ml
.ml_line_count
;
2873 struct bw_info write_info
; /* info for buf_write_bytes() */
2875 int converted
= FALSE
;
2876 int notconverted
= FALSE
;
2877 char_u
*fenc
; /* effective 'fileencoding' */
2878 char_u
*fenc_tofree
= NULL
; /* allocated "fenc" */
2884 vim_acl_T acl
= NULL
; /* ACL copied from original file to
2885 backup or new file */
2888 if (fname
== NULL
|| *fname
== NUL
) /* safety check */
2892 * Disallow writing from .exrc and .vimrc in current directory for
2898 /* Avoid a crash for a long name. */
2899 if (STRLEN(fname
) >= MAXPATHL
)
2901 EMSG(_(e_longname
));
2906 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
2907 write_info
.bw_conv_buf
= NULL
;
2908 write_info
.bw_conv_error
= FALSE
;
2909 write_info
.bw_restlen
= 0;
2911 write_info
.bw_iconv_fd
= (iconv_t
)-1;
2915 /* After writing a file changedtick changes but we don't want to display
2917 ex_no_reprint
= TRUE
;
2920 * If there is no file name yet, use the one for the written file.
2921 * BF_NOTEDITED is set to reflect this (in case the write fails).
2922 * Don't do this when the write is for a filter command.
2923 * Don't do this when appending.
2924 * Only do this when 'cpoptions' contains the 'F' flag.
2926 if (buf
->b_ffname
== NULL
2930 #ifdef FEAT_QUICKFIX
2934 && (!append
|| vim_strchr(p_cpo
, CPO_FNAMEAPP
) != NULL
)
2935 && vim_strchr(p_cpo
, CPO_FNAMEW
) != NULL
)
2937 if (set_rw_fname(fname
, sfname
) == FAIL
)
2939 buf
= curbuf
; /* just in case autocmds made "buf" invalid */
2945 * For Unix: Use the short file name whenever possible.
2946 * Avoids problems with networks and when directory names are changed.
2947 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
2948 * another directory, which we don't detect
2950 ffname
= fname
; /* remember full fname */
2955 if (buf
->b_ffname
!= NULL
&& fnamecmp(ffname
, buf
->b_ffname
) == 0)
2958 overwriting
= FALSE
;
2961 settmode(TMODE_COOK
); /* when exiting allow typahead now */
2963 ++no_wait_return
; /* don't wait for return yet */
2966 * Set '[ and '] marks to the lines to be written.
2968 buf
->b_op_start
.lnum
= start
;
2969 buf
->b_op_start
.col
= 0;
2970 buf
->b_op_end
.lnum
= end
;
2971 buf
->b_op_end
.col
= 0;
2976 int buf_ffname
= FALSE
;
2977 int buf_sfname
= FALSE
;
2978 int buf_fname_f
= FALSE
;
2979 int buf_fname_s
= FALSE
;
2980 int did_cmd
= FALSE
;
2981 int nofile_err
= FALSE
;
2982 int empty_memline
= (buf
->b_ml
.ml_mfp
== NULL
);
2985 * Apply PRE aucocommands.
2986 * Set curbuf to the buffer to be written.
2987 * Careful: The autocommands may call buf_write() recursively!
2989 if (ffname
== buf
->b_ffname
)
2991 if (sfname
== buf
->b_sfname
)
2993 if (fname
== buf
->b_ffname
)
2995 if (fname
== buf
->b_sfname
)
2998 /* set curwin/curbuf to buf and save a few things */
2999 aucmd_prepbuf(&aco
, buf
);
3003 if (!(did_cmd
= apply_autocmds_exarg(EVENT_FILEAPPENDCMD
,
3004 sfname
, sfname
, FALSE
, curbuf
, eap
)))
3006 #ifdef FEAT_QUICKFIX
3007 if (overwriting
&& bt_nofile(curbuf
))
3011 apply_autocmds_exarg(EVENT_FILEAPPENDPRE
,
3012 sfname
, sfname
, FALSE
, curbuf
, eap
);
3017 apply_autocmds_exarg(EVENT_FILTERWRITEPRE
,
3018 NULL
, sfname
, FALSE
, curbuf
, eap
);
3020 else if (reset_changed
&& whole
)
3022 if (!(did_cmd
= apply_autocmds_exarg(EVENT_BUFWRITECMD
,
3023 sfname
, sfname
, FALSE
, curbuf
, eap
)))
3025 #ifdef FEAT_QUICKFIX
3026 if (overwriting
&& bt_nofile(curbuf
))
3030 apply_autocmds_exarg(EVENT_BUFWRITEPRE
,
3031 sfname
, sfname
, FALSE
, curbuf
, eap
);
3036 if (!(did_cmd
= apply_autocmds_exarg(EVENT_FILEWRITECMD
,
3037 sfname
, sfname
, FALSE
, curbuf
, eap
)))
3039 #ifdef FEAT_QUICKFIX
3040 if (overwriting
&& bt_nofile(curbuf
))
3044 apply_autocmds_exarg(EVENT_FILEWRITEPRE
,
3045 sfname
, sfname
, FALSE
, curbuf
, eap
);
3049 /* restore curwin/curbuf and a few other things */
3050 aucmd_restbuf(&aco
);
3053 * In three situations we return here and don't write the file:
3054 * 1. the autocommands deleted or unloaded the buffer.
3055 * 2. The autocommands abort script processing.
3056 * 3. If one of the "Cmd" autocommands was executed.
3058 if (!buf_valid(buf
))
3060 if (buf
== NULL
|| (buf
->b_ml
.ml_mfp
== NULL
&& !empty_memline
)
3061 || did_cmd
|| nofile_err
3068 msg_scroll
= msg_save
;
3070 EMSG(_("E676: No matching autocommands for acwrite buffer"));
3077 /* An aborting error, interrupt or exception in the
3083 /* The buffer was deleted. We assume it was written
3084 * (can't retry anyway). */
3088 /* Assume the buffer was written, update the timestamp. */
3091 buf
->b_flags
&= ~BF_NEW
;
3093 buf
->b_flags
&= ~BF_WRITE_MASK
;
3095 if (reset_changed
&& buf
->b_changed
&& !append
3096 && (overwriting
|| vim_strchr(p_cpo
, CPO_PLUS
) != NULL
))
3097 /* Buffer still changed, the autocommands didn't work
3105 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3110 * The autocommands may have changed the number of lines in the file.
3111 * When writing the whole file, adjust the end.
3112 * When writing part of the file, assume that the autocommands only
3113 * changed the number of lines that are to be written (tricky!).
3115 if (buf
->b_ml
.ml_line_count
!= old_line_count
)
3117 if (whole
) /* write all */
3118 end
= buf
->b_ml
.ml_line_count
;
3119 else if (buf
->b_ml
.ml_line_count
> old_line_count
) /* more lines */
3120 end
+= buf
->b_ml
.ml_line_count
- old_line_count
;
3121 else /* less lines */
3123 end
-= old_line_count
- buf
->b_ml
.ml_line_count
;
3127 msg_scroll
= msg_save
;
3128 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3135 * The autocommands may have changed the name of the buffer, which may
3136 * be kept in fname, ffname and sfname.
3139 ffname
= buf
->b_ffname
;
3141 sfname
= buf
->b_sfname
;
3143 fname
= buf
->b_ffname
;
3145 fname
= buf
->b_sfname
;
3149 #ifdef FEAT_NETBEANS_INTG
3150 if (usingNetbeans
&& isNetbeansBuffer(buf
))
3155 * b_changed can be 0 after an undo, but we still need to write
3156 * the buffer to NetBeans.
3158 if (buf
->b_changed
|| isNetbeansModified(buf
))
3160 --no_wait_return
; /* may wait for return now */
3161 msg_scroll
= msg_save
;
3162 netbeans_save_buffer(buf
); /* no error checking... */
3167 errnum
= (char_u
*)"E656: ";
3168 errmsg
= (char_u
*)_("NetBeans dissallows writes of unmodified buffers");
3175 errnum
= (char_u
*)"E657: ";
3176 errmsg
= (char_u
*)_("Partial writes disallowed for NetBeans buffers");
3183 if (shortmess(SHM_OVER
) && !exiting
)
3184 msg_scroll
= FALSE
; /* overwrite previous file message */
3186 msg_scroll
= TRUE
; /* don't overwrite previous file message */
3194 (char_u
*)"", 0); /* show that we are busy */
3195 msg_scroll
= FALSE
; /* always overwrite the file message now */
3197 buffer
= alloc(BUFSIZE
);
3198 if (buffer
== NULL
) /* can't allocate big buffer, use small
3199 * one (to be able to write when out of
3203 bufsize
= SMBUFSIZE
;
3209 * Get information about original file (if there is one).
3211 #if defined(UNIX) && !defined(ARCHIE)
3212 st_old
.st_dev
= st_old
.st_ino
= 0;
3214 if (mch_stat((char *)fname
, &st_old
) < 0)
3218 perm
= st_old
.st_mode
;
3219 if (!S_ISREG(st_old
.st_mode
)) /* not a file */
3221 if (S_ISDIR(st_old
.st_mode
))
3223 errnum
= (char_u
*)"E502: ";
3224 errmsg
= (char_u
*)_("is a directory");
3227 if (mch_nodetype(fname
) != NODE_WRITABLE
)
3229 errnum
= (char_u
*)"E503: ";
3230 errmsg
= (char_u
*)_("is not a file or writable device");
3233 /* It's a device of some kind (or a fifo) which we can write to
3234 * but for which we can't make a backup. */
3242 * Check for a writable device name.
3244 c
= mch_nodetype(fname
);
3245 if (c
== NODE_OTHER
)
3247 errnum
= (char_u
*)"E503: ";
3248 errmsg
= (char_u
*)_("is not a file or writable device");
3251 if (c
== NODE_WRITABLE
)
3253 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3254 /* MS-Windows allows opening a device, but we will probably get stuck
3255 * trying to write to it. */
3258 errnum
= (char_u
*)"E796: ";
3259 errmsg
= (char_u
*)_("writing to device disabled with 'opendevice' option");
3269 perm
= mch_getperm(fname
);
3272 else if (mch_isdir(fname
))
3274 errnum
= (char_u
*)"E502: ";
3275 errmsg
= (char_u
*)_("is a directory");
3279 (void)mch_stat((char *)fname
, &st_old
);
3283 if (!device
&& !newfile
)
3286 * Check if the file is really writable (when renaming the file to
3287 * make a backup we won't discover it later).
3289 file_readonly
= check_file_readonly(fname
, (int)perm
);
3291 if (!forceit
&& file_readonly
)
3293 if (vim_strchr(p_cpo
, CPO_FWRITE
) != NULL
)
3295 errnum
= (char_u
*)"E504: ";
3296 errmsg
= (char_u
*)_(err_readonly
);
3300 errnum
= (char_u
*)"E505: ";
3301 errmsg
= (char_u
*)_("is read-only (add ! to override)");
3307 * Check if the timestamp hasn't changed since reading the file.
3311 retval
= check_mtime(buf
, &st_old
);
3319 * For systems that support ACL: get the ACL from the original file.
3322 acl
= mch_get_acl(fname
);
3326 * If 'backupskip' is not empty, don't make a backup for some files.
3328 dobackup
= (p_wb
|| p_bk
|| *p_pm
!= NUL
);
3330 if (dobackup
&& *p_bsk
!= NUL
&& match_file_list(p_bsk
, sfname
, ffname
))
3335 * Save the value of got_int and reset it. We don't want a previous
3336 * interruption cancel writing, only hitting CTRL-C while writing should
3339 prev_got_int
= got_int
;
3342 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3343 buf
->b_saving
= TRUE
;
3346 * If we are not appending or filtering, the file exists, and the
3347 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3348 * When 'patchmode' is set also make a backup when appending.
3350 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3351 * off. This helps when editing large files on almost-full disks.
3353 if (!(append
&& *p_pm
== NUL
) && !filtering
&& perm
>= 0 && dobackup
)
3355 #if defined(UNIX) || defined(WIN32)
3359 if ((bkc_flags
& BKC_YES
) || append
) /* "yes" */
3361 #if defined(UNIX) || defined(WIN32)
3362 else if ((bkc_flags
& BKC_AUTO
)) /* "auto" */
3368 * Don't rename the file when:
3369 * - it's a hard link
3370 * - it's a symbolic link
3371 * - we don't have write permission in the directory
3372 * - we can't set the owner/group of the new file
3374 if (st_old
.st_nlink
> 1
3375 || mch_lstat((char *)fname
, &st
) < 0
3376 || st
.st_dev
!= st_old
.st_dev
3377 || st
.st_ino
!= st_old
.st_ino
3378 # ifndef HAVE_FCHOWN
3379 || st
.st_uid
!= st_old
.st_uid
3380 || st
.st_gid
!= st_old
.st_gid
3387 /* On NTFS file systems hard links are possible. */
3388 if (mch_is_linked(fname
))
3395 * Check if we can create a file and set the owner/group to
3396 * the ones from the original file.
3397 * First find a file name that doesn't exist yet (use some
3398 * arbitrary numbers).
3400 STRCPY(IObuff
, fname
);
3401 for (i
= 4913; ; i
+= 123)
3403 sprintf((char *)gettail(IObuff
), "%d", i
);
3404 if (mch_lstat((char *)IObuff
, &st
) < 0)
3407 fd
= mch_open((char *)IObuff
,
3408 O_CREAT
|O_WRONLY
|O_EXCL
|O_NOFOLLOW
, perm
);
3409 if (fd
< 0) /* can't write in directory */
3415 fchown(fd
, st_old
.st_uid
, st_old
.st_gid
);
3417 if (mch_stat((char *)IObuff
, &st
) < 0
3418 || st
.st_uid
!= st_old
.st_uid
3419 || st
.st_gid
!= st_old
.st_gid
3420 || st
.st_mode
!= perm
)
3423 /* Close the file before removing it, on MS-Windows we
3424 * can't delete an open file. */
3433 * Break symlinks and/or hardlinks if we've been asked to.
3435 if ((bkc_flags
& BKC_BREAKSYMLINK
) || (bkc_flags
& BKC_BREAKHARDLINK
))
3439 lstat_res
= mch_lstat((char *)fname
, &st
);
3442 if ((bkc_flags
& BKC_BREAKSYMLINK
)
3444 && st
.st_ino
!= st_old
.st_ino
)
3445 backup_copy
= FALSE
;
3448 if ((bkc_flags
& BKC_BREAKHARDLINK
)
3449 && st_old
.st_nlink
> 1
3450 && (lstat_res
!= 0 || st
.st_ino
== st_old
.st_ino
))
3451 backup_copy
= FALSE
;
3457 /* make sure we have a valid backup extension to use */
3461 backup_ext
= (char_u
*)"/bak";
3463 backup_ext
= (char_u
*)".bak";
3470 && (fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0)) >= 0)
3473 char_u
*copybuf
, *wp
;
3474 int some_error
= FALSE
;
3478 #if defined(UNIX) && !defined(SHORT_FNAME)
3479 int did_set_shortname
;
3482 copybuf
= alloc(BUFSIZE
+ 1);
3483 if (copybuf
== NULL
)
3485 some_error
= TRUE
; /* out of memory */
3490 * Try to make the backup in each directory in the 'bdir' option.
3492 * Unix semantics has it, that we may have a writable file,
3493 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3494 * - the directory is not writable,
3495 * - the file may be a symbolic link,
3496 * - the file may belong to another user/group, etc.
3498 * For these reasons, the existing writable file must be truncated
3499 * and reused. Creation of a backup COPY will be attempted.
3511 * Isolate one directory name, using an entry in 'bdir'.
3513 (void)copy_option_part(&dirp
, copybuf
, BUFSIZE
, ",");
3514 rootname
= get_file_in_dir(fname
, copybuf
);
3515 if (rootname
== NULL
)
3517 some_error
= TRUE
; /* out of memory */
3521 #if defined(UNIX) && !defined(SHORT_FNAME)
3522 did_set_shortname
= FALSE
;
3526 * May try twice if 'shortname' not set.
3531 * Make backup file name.
3533 backup
= buf_modname(
3537 (buf
->b_p_sn
|| buf
->b_shortname
),
3539 rootname
, backup_ext
, FALSE
);
3543 some_error
= TRUE
; /* out of memory */
3548 * Check if backup file already exists.
3550 if (mch_stat((char *)backup
, &st_new
) >= 0)
3554 * Check if backup file is same as original file.
3555 * May happen when modname() gave the same file back.
3556 * E.g. silly link, or file name-length reached.
3557 * If we don't check here, we either ruin the file
3558 * when copying or erase it after writing. jw.
3560 if (st_new
.st_dev
== st_old
.st_dev
3561 && st_new
.st_ino
== st_old
.st_ino
)
3564 backup
= NULL
; /* no backup file to delete */
3565 # ifndef SHORT_FNAME
3567 * may try again with 'shortname' set
3569 if (!(buf
->b_shortname
|| buf
->b_p_sn
))
3571 buf
->b_shortname
= TRUE
;
3572 did_set_shortname
= TRUE
;
3575 /* setting shortname didn't help */
3576 if (did_set_shortname
)
3577 buf
->b_shortname
= FALSE
;
3584 * If we are not going to keep the backup file, don't
3585 * delete an existing one, try to use another name.
3586 * Change one character, just before the extension.
3590 wp
= backup
+ STRLEN(backup
) - 1
3591 - STRLEN(backup_ext
);
3592 if (wp
< backup
) /* empty file name ??? */
3596 && mch_stat((char *)backup
, &st_new
) >= 0)
3598 /* They all exist??? Must be something wrong. */
3611 * Try to create the backup file
3615 /* remove old backup, if present */
3617 /* Open with O_EXCL to avoid the file being created while
3618 * we were sleeping (symlink hacker attack?) */
3619 bfd
= mch_open((char *)backup
,
3620 O_WRONLY
|O_CREAT
|O_EXTRA
|O_EXCL
|O_NOFOLLOW
,
3629 /* set file protection same as original file, but
3631 (void)mch_setperm(backup
, perm
& 0777);
3635 * Try to set the group of the backup same as the
3636 * original file. If this fails, set the protection
3637 * bits for the group same as the protection bits for
3640 if (st_new
.st_gid
!= st_old
.st_gid
3641 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3642 && fchown(bfd
, (uid_t
)-1, st_old
.st_gid
) != 0
3646 (perm
& 0707) | ((perm
& 07) << 3));
3652 write_info
.bw_fd
= bfd
;
3653 write_info
.bw_buf
= copybuf
;
3655 write_info
.bw_flags
= FIO_NOCONVERT
;
3657 while ((write_info
.bw_len
= vim_read(fd
, copybuf
,
3660 if (buf_write_bytes(&write_info
) == FAIL
)
3662 errmsg
= (char_u
*)_("E506: Can't write to backup file (add ! to override)");
3668 errmsg
= (char_u
*)_(e_interr
);
3673 if (close(bfd
) < 0 && errmsg
== NULL
)
3674 errmsg
= (char_u
*)_("E507: Close error for backup file (add ! to override)");
3675 if (write_info
.bw_len
< 0)
3676 errmsg
= (char_u
*)_("E508: Can't read file for backup (add ! to override)");
3678 set_file_time(backup
, st_old
.st_atime
, st_old
.st_mtime
);
3681 mch_set_acl(backup
, acl
);
3688 close(fd
); /* ignore errors for closing read file */
3691 if (backup
== NULL
&& errmsg
== NULL
)
3692 errmsg
= (char_u
*)_("E509: Cannot create backup file (add ! to override)");
3693 /* ignore errors when forceit is TRUE */
3694 if ((some_error
|| errmsg
!= NULL
) && !forceit
)
3708 * Make a backup by renaming the original file.
3711 * If 'cpoptions' includes the "W" flag, we don't want to
3712 * overwrite a read-only file. But rename may be possible
3713 * anyway, thus we need an extra check here.
3715 if (file_readonly
&& vim_strchr(p_cpo
, CPO_FWRITE
) != NULL
)
3717 errnum
= (char_u
*)"E504: ";
3718 errmsg
= (char_u
*)_(err_readonly
);
3724 * Form the backup file name - change path/fo.o.h to
3725 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3726 * that works is used.
3732 * Isolate one directory name and make the backup file name.
3734 (void)copy_option_part(&dirp
, IObuff
, IOSIZE
, ",");
3735 rootname
= get_file_in_dir(fname
, IObuff
);
3736 if (rootname
== NULL
)
3740 backup
= buf_modname(
3744 (buf
->b_p_sn
|| buf
->b_shortname
),
3746 rootname
, backup_ext
, FALSE
);
3753 * If we are not going to keep the backup file, don't
3754 * delete an existing one, try to use another name.
3755 * Change one character, just before the extension.
3757 if (!p_bk
&& mch_getperm(backup
) >= 0)
3759 p
= backup
+ STRLEN(backup
) - 1 - STRLEN(backup_ext
);
3760 if (p
< backup
) /* empty file name ??? */
3763 while (*p
> 'a' && mch_getperm(backup
) >= 0)
3765 /* They all exist??? Must be something wrong! */
3776 * Delete any existing backup and move the current version
3777 * to the backup. For safety, we don't remove the backup
3778 * until the write has finished successfully. And if the
3779 * 'backup' option is set, leave it around.
3782 * If the renaming of the original file to the backup file
3785 if (vim_rename(fname
, backup
) == 0)
3788 vim_free(backup
); /* don't do the rename below */
3792 if (backup
== NULL
&& !forceit
)
3794 errmsg
= (char_u
*)_("E510: Can't make backup file (add ! to override)");
3800 #if defined(UNIX) && !defined(ARCHIE)
3801 /* When using ":w!" and the file was read-only: make it writable */
3802 if (forceit
&& perm
>= 0 && !(perm
& 0200) && st_old
.st_uid
== getuid()
3803 && vim_strchr(p_cpo
, CPO_FWRITE
) == NULL
)
3806 (void)mch_setperm(fname
, perm
);
3807 made_writable
= TRUE
;
3811 /* When using ":w!" and writing to the current file, 'readonly' makes no
3812 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3813 if (forceit
&& overwriting
&& vim_strchr(p_cpo
, CPO_KEEPRO
) == NULL
)
3815 buf
->b_p_ro
= FALSE
;
3817 need_maketitle
= TRUE
; /* set window title later */
3820 status_redraw_all(); /* redraw status lines later */
3824 if (end
> buf
->b_ml
.ml_line_count
)
3825 end
= buf
->b_ml
.ml_line_count
;
3826 if (buf
->b_ml
.ml_flags
& ML_EMPTY
)
3830 * If the original file is being overwritten, there is a small chance that
3831 * we crash in the middle of writing. Therefore the file is preserved now.
3832 * This makes all block numbers positive so that recovery does not need
3833 * the original file.
3834 * Don't do this if there is a backup file and we are exiting.
3836 if (reset_changed
&& !newfile
&& overwriting
3837 && !(exiting
&& backup
!= NULL
))
3839 ml_preserve(buf
, FALSE
);
3842 errmsg
= (char_u
*)_(e_interr
);
3843 goto restore_backup
;
3847 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3849 * Before risking to lose the original file verify if there's
3850 * a resource fork to preserve, and if cannot be done warn
3851 * the users. This happens when overwriting without backups.
3853 if (backup
== NULL
&& overwriting
&& !append
)
3854 if (mch_has_resource_fork(fname
))
3856 errmsg
= (char_u
*)_("E460: The resource fork would be lost (add ! to override)");
3857 goto restore_backup
;
3862 vms_remove_version(fname
); /* remove version */
3864 /* Default: write the the file directly. May write to a temp file for
3865 * multi-byte conversion. */
3869 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3870 if (eap
!= NULL
&& eap
->force_enc
!= 0)
3872 fenc
= eap
->cmd
+ eap
->force_enc
;
3873 fenc
= enc_canonize(fenc
);
3877 fenc
= buf
->b_p_fenc
;
3880 * The file needs to be converted when 'fileencoding' is set and
3881 * 'fileencoding' differs from 'encoding'.
3883 converted
= (*fenc
!= NUL
&& !same_encoding(p_enc
, fenc
));
3886 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3887 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3888 * Prepare the flags for it and allocate bw_conv_buf when needed.
3890 if (converted
&& (enc_utf8
|| STRCMP(p_enc
, "latin1") == 0))
3892 wb_flags
= get_fio_flags(fenc
);
3893 if (wb_flags
& (FIO_UCS2
| FIO_UCS4
| FIO_UTF16
| FIO_UTF8
))
3895 /* Need to allocate a buffer to translate into. */
3896 if (wb_flags
& (FIO_UCS2
| FIO_UTF16
| FIO_UTF8
))
3897 write_info
.bw_conv_buflen
= bufsize
* 2;
3899 write_info
.bw_conv_buflen
= bufsize
* 4;
3900 write_info
.bw_conv_buf
3901 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3902 if (write_info
.bw_conv_buf
== NULL
)
3908 if (converted
&& wb_flags
== 0 && (wb_flags
= get_win_fio_flags(fenc
)) != 0)
3910 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
3911 write_info
.bw_conv_buflen
= bufsize
* 4;
3912 write_info
.bw_conv_buf
3913 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3914 if (write_info
.bw_conv_buf
== NULL
)
3920 if (converted
&& wb_flags
== 0 && (wb_flags
= get_mac_fio_flags(fenc
)) != 0)
3922 write_info
.bw_conv_buflen
= bufsize
* 3;
3923 write_info
.bw_conv_buf
3924 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3925 if (write_info
.bw_conv_buf
== NULL
)
3930 # if defined(FEAT_EVAL) || defined(USE_ICONV)
3931 if (converted
&& wb_flags
== 0)
3935 * Use iconv() conversion when conversion is needed and it's not done
3938 write_info
.bw_iconv_fd
= (iconv_t
)my_iconv_open(fenc
,
3939 enc_utf8
? (char_u
*)"utf-8" : p_enc
);
3940 if (write_info
.bw_iconv_fd
!= (iconv_t
)-1)
3942 /* We're going to use iconv(), allocate a buffer to convert in. */
3943 write_info
.bw_conv_buflen
= bufsize
* ICONV_MULT
;
3944 write_info
.bw_conv_buf
3945 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3946 if (write_info
.bw_conv_buf
== NULL
)
3948 write_info
.bw_first
= TRUE
;
3957 * When the file needs to be converted with 'charconvert' after
3958 * writing, write to a temp file instead and let the conversion
3959 * overwrite the original file.
3963 wfname
= vim_tempname('w');
3964 if (wfname
== NULL
) /* Can't write without a tempfile! */
3966 errmsg
= (char_u
*)_("E214: Can't find temp file for writing");
3967 goto restore_backup
;
3973 if (converted
&& wb_flags
== 0
3975 && write_info
.bw_iconv_fd
== (iconv_t
)-1
3984 errmsg
= (char_u
*)_("E213: Cannot convert (add ! to write without conversion)");
3985 goto restore_backup
;
3987 notconverted
= TRUE
;
3992 * Open the file "wfname" for writing.
3993 * We may try to open the file twice: If we can't write to the
3994 * file and forceit is TRUE we delete the existing file and try to create
3995 * a new one. If this still fails we may have lost the original file!
3996 * (this may happen when the user reached his quotum for number of files).
3997 * Appending will fail if the file does not exist and forceit is FALSE.
3999 while ((fd
= mch_open((char *)wfname
, O_WRONLY
| O_EXTRA
| (append
4000 ? (forceit
? (O_APPEND
| O_CREAT
) : O_APPEND
)
4001 : (O_CREAT
| O_TRUNC
))
4002 , perm
< 0 ? 0666 : (perm
& 0777))) < 0)
4005 * A forced write will try to create a new file if the old one is
4006 * still readonly. This may also happen when the directory is
4007 * read-only. In that case the mch_remove() will fail.
4014 /* Don't delete the file when it's a hard or symbolic link. */
4015 if ((!newfile
&& st_old
.st_nlink
> 1)
4016 || (mch_lstat((char *)fname
, &st
) == 0
4017 && (st
.st_dev
!= st_old
.st_dev
4018 || st
.st_ino
!= st_old
.st_ino
)))
4019 errmsg
= (char_u
*)_("E166: Can't open linked file for writing");
4023 errmsg
= (char_u
*)_("E212: Can't open file for writing");
4024 if (forceit
&& vim_strchr(p_cpo
, CPO_FWRITE
) == NULL
4028 /* we write to the file, thus it should be marked
4029 writable after all */
4031 made_writable
= TRUE
;
4033 if (st_old
.st_uid
!= getuid() || st_old
.st_gid
!= getgid())
4036 if (!append
) /* don't remove when appending */
4048 * If we failed to open the file, we don't need a backup. Throw it
4049 * away. If we moved or removed the original file try to put the
4050 * backup in its place.
4052 if (backup
!= NULL
&& wfname
== fname
)
4057 * There is a small chance that we removed the original,
4058 * try to move the copy in its place.
4059 * This may not work if the vim_rename() fails.
4060 * In that case we leave the copy around.
4062 /* If file does not exist, put the copy in its place */
4063 if (mch_stat((char *)fname
, &st
) < 0)
4064 vim_rename(backup
, fname
);
4065 /* if original file does exist throw away the copy */
4066 if (mch_stat((char *)fname
, &st
) >= 0)
4071 /* try to put the original file back */
4072 vim_rename(backup
, fname
);
4076 /* if original file no longer exists give an extra warning */
4077 if (!newfile
&& mch_stat((char *)fname
, &st
) < 0)
4082 if (wfname
!= fname
)
4089 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4090 /* TODO: Is it need for MACOS_X? (Dany) */
4092 * On macintosh copy the original files attributes (i.e. the backup)
4093 * This is done in order to preserve the resource fork and the
4094 * Finder attribute (label, comments, custom icons, file creator)
4096 if (backup
!= NULL
&& overwriting
&& !append
)
4099 (void)mch_copy_file_attribute(wfname
, backup
);
4101 (void)mch_copy_file_attribute(backup
, wfname
);
4104 if (!overwriting
&& !append
)
4106 if (buf
->b_ffname
!= NULL
)
4107 (void)mch_copy_file_attribute(buf
->b_ffname
, wfname
);
4108 /* Should copy resource fork */
4112 write_info
.bw_fd
= fd
;
4115 if (*buf
->b_p_key
&& !filtering
)
4117 crypt_init_keys(buf
->b_p_key
);
4118 /* Write magic number, so that Vim knows that this file is encrypted
4119 * when reading it again. This also undergoes utf-8 to ucs-2/4
4120 * conversion when needed. */
4121 write_info
.bw_buf
= (char_u
*)CRYPT_MAGIC
;
4122 write_info
.bw_len
= CRYPT_MAGIC_LEN
;
4123 write_info
.bw_flags
= FIO_NOCONVERT
;
4124 if (buf_write_bytes(&write_info
) == FAIL
)
4126 wb_flags
|= FIO_ENCRYPTED
;
4130 write_info
.bw_buf
= buffer
;
4133 /* use "++bin", "++nobin" or 'binary' */
4134 if (eap
!= NULL
&& eap
->force_bin
!= 0)
4135 write_bin
= (eap
->force_bin
== FORCE_BIN
);
4137 write_bin
= buf
->b_p_bin
;
4141 * The BOM is written just after the encryption magic number.
4142 * Skip it when appending and the file already existed, the BOM only makes
4143 * sense at the start of the file.
4145 if (buf
->b_p_bomb
&& !write_bin
&& (!append
|| perm
< 0))
4147 write_info
.bw_len
= make_bom(buffer
, fenc
);
4148 if (write_info
.bw_len
> 0)
4150 /* don't convert, do encryption */
4151 write_info
.bw_flags
= FIO_NOCONVERT
| wb_flags
;
4152 if (buf_write_bytes(&write_info
) == FAIL
)
4155 nchars
+= write_info
.bw_len
;
4160 write_info
.bw_len
= bufsize
;
4162 write_info
.bw_flags
= wb_flags
;
4164 fileformat
= get_fileformat_force(buf
, eap
);
4167 for (lnum
= start
; lnum
<= end
; ++lnum
)
4170 * The next while loop is done once for each character written.
4173 ptr
= ml_get_buf(buf
, lnum
, FALSE
) - 1;
4174 while ((c
= *++ptr
) != NUL
)
4177 *s
= NUL
; /* replace newlines with NULs */
4178 else if (c
== CAR
&& fileformat
== EOL_MAC
)
4179 *s
= NL
; /* Mac: replace CRs with NLs */
4183 if (++len
!= bufsize
)
4185 if (buf_write_bytes(&write_info
) == FAIL
)
4187 end
= 0; /* write error: break loop */
4194 /* write failed or last line has no EOL: stop here */
4198 && (lnum
== write_no_eol_lnum
4199 || (lnum
== buf
->b_ml
.ml_line_count
&& !buf
->b_p_eol
))))
4201 ++lnum
; /* written the line, count it */
4205 if (fileformat
== EOL_UNIX
)
4209 *s
++ = CAR
; /* EOL_MAC or EOL_DOS: write CR */
4210 if (fileformat
== EOL_DOS
) /* write CR-NL */
4212 if (++len
== bufsize
)
4214 if (buf_write_bytes(&write_info
) == FAIL
)
4216 end
= 0; /* write error: break loop */
4226 if (++len
== bufsize
&& end
)
4228 if (buf_write_bytes(&write_info
) == FAIL
)
4230 end
= 0; /* write error: break loop */
4240 end
= 0; /* Interrupted, break loop */
4246 * On VMS there is a problem: newlines get added when writing blocks
4247 * at a time. Fix it by writing a line at a time.
4248 * This is much slower!
4249 * Explanation: VAX/DECC RTL insists that records in some RMS
4250 * structures end with a newline (carriage return) character, and if
4251 * they don't it adds one.
4252 * With other RMS structures it works perfect without this fix.
4254 if ((buf
->b_fab_rat
& (FAB$M_FTN
| FAB$M_CR
)) != 0)
4258 buf
->b_fab_mrs
= (buf
->b_fab_mrs
== 0
4259 ? MIN(4096, bufsize
)
4260 : MIN(buf
->b_fab_mrs
, bufsize
));
4265 write_info
.bw_len
= MIN(b2write
, buf
->b_fab_mrs
);
4266 if (buf_write_bytes(&write_info
) == FAIL
)
4271 b2write
-= MIN(b2write
, buf
->b_fab_mrs
);
4273 write_info
.bw_len
= bufsize
;
4280 if (len
> 0 && end
> 0)
4282 write_info
.bw_len
= len
;
4283 if (buf_write_bytes(&write_info
) == FAIL
)
4284 end
= 0; /* write error */
4288 #if defined(UNIX) && defined(HAVE_FSYNC)
4289 /* On many journalling file systems there is a bug that causes both the
4290 * original and the backup file to be lost when halting the system right
4291 * after writing the file. That's because only the meta-data is
4292 * journalled. Syncing the file slows down the system, but assures it has
4293 * been written to disk and we don't lose it.
4294 * For a device do try the fsync() but don't complain if it does not work
4295 * (could be a pipe).
4296 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4297 if (p_fs
&& fsync(fd
) != 0 && !device
)
4299 errmsg
= (char_u
*)_("E667: Fsync failed");
4305 /* When creating a new file, set its owner/group to that of the original
4306 * file. Get the new device and inode number. */
4307 if (backup
!= NULL
&& !backup_copy
)
4312 /* don't change the owner when it's already OK, some systems remove
4313 * permission or ACL stuff */
4314 if (mch_stat((char *)wfname
, &st
) < 0
4315 || st
.st_uid
!= st_old
.st_uid
4316 || st
.st_gid
!= st_old
.st_gid
)
4318 fchown(fd
, st_old
.st_uid
, st_old
.st_gid
);
4319 if (perm
>= 0) /* set permission again, may have changed */
4320 (void)mch_setperm(wfname
, perm
);
4325 else if (buf
->b_dev
< 0)
4326 /* Set the inode when creating a new file. */
4332 errmsg
= (char_u
*)_("E512: Close failed");
4338 perm
&= ~0200; /* reset 'w' bit for security reasons */
4340 if (perm
>= 0) /* set perm. of new file same as old file */
4341 (void)mch_setperm(wfname
, perm
);
4343 if (!append
&& !filtering
)
4344 /* Set the filetype after writing the file. */
4345 mch_set_filetype(wfname
, buf
->b_p_oft
);
4348 /* Probably need to set the ACL before changing the user (can't set the
4349 * ACL on a file the user doesn't own). */
4351 mch_set_acl(wfname
, acl
);
4355 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4356 if (wfname
!= fname
)
4359 * The file was written to a temp file, now it needs to be converted
4360 * with 'charconvert' to (overwrite) the output file.
4364 if (eval_charconvert(enc_utf8
? (char_u
*)"utf-8" : p_enc
, fenc
,
4365 wfname
, fname
) == FAIL
)
4367 write_info
.bw_conv_error
= TRUE
;
4381 if (write_info
.bw_conv_error
)
4382 errmsg
= (char_u
*)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4386 errmsg
= (char_u
*)_(e_interr
);
4388 errmsg
= (char_u
*)_("E514: write error (file system full?)");
4392 * If we have a backup file, try to put it in place of the new file,
4393 * because the new file is probably corrupt. This avoids loosing the
4394 * original file when trying to make a backup when writing the file a
4396 * When "backup_copy" is set we need to copy the backup over the new
4397 * file. Otherwise rename the backup file.
4398 * If this is OK, don't give the extra warning message.
4404 /* This may take a while, if we were interrupted let the user
4405 * know we got the message. */
4411 if ((fd
= mch_open((char *)backup
, O_RDONLY
| O_EXTRA
, 0)) >= 0)
4413 if ((write_info
.bw_fd
= mch_open((char *)fname
,
4414 O_WRONLY
| O_CREAT
| O_TRUNC
| O_EXTRA
,
4417 /* copy the file. */
4418 write_info
.bw_buf
= smallbuf
;
4420 write_info
.bw_flags
= FIO_NOCONVERT
;
4422 while ((write_info
.bw_len
= vim_read(fd
, smallbuf
,
4424 if (buf_write_bytes(&write_info
) == FAIL
)
4427 if (close(write_info
.bw_fd
) >= 0
4428 && write_info
.bw_len
== 0)
4429 end
= 1; /* success */
4431 close(fd
); /* ignore errors for closing read file */
4436 if (vim_rename(backup
, fname
) == 0)
4443 lnum
-= start
; /* compute number of written lines */
4444 --no_wait_return
; /* may wait for return now */
4446 #if !(defined(UNIX) || defined(VMS))
4447 fname
= sfname
; /* use shortname now, for the messages */
4451 msg_add_fname(buf
, fname
); /* put fname in IObuff with quotes */
4454 if (write_info
.bw_conv_error
)
4456 STRCAT(IObuff
, _(" CONVERSION ERROR"));
4459 else if (notconverted
)
4461 STRCAT(IObuff
, _("[NOT converted]"));
4466 STRCAT(IObuff
, _("[converted]"));
4472 STRCAT(IObuff
, _("[Device]"));
4477 STRCAT(IObuff
, shortmess(SHM_NEW
) ? _("[New]") : _("[New File]"));
4485 /* may add [unix/dos/mac] */
4486 if (msg_add_fileformat(fileformat
))
4489 if (wb_flags
& FIO_ENCRYPTED
)
4491 STRCAT(IObuff
, _("[crypted]"));
4495 msg_add_lines(c
, (long)lnum
, nchars
); /* add line/char count */
4496 if (!shortmess(SHM_WRITE
))
4499 STRCAT(IObuff
, shortmess(SHM_WRI
) ? _(" [a]") : _(" appended"));
4501 STRCAT(IObuff
, shortmess(SHM_WRI
) ? _(" [w]") : _(" written"));
4504 set_keep_msg(msg_trunc_attr(IObuff
, FALSE
, 0), 0);
4507 /* When written everything correctly: reset 'modified'. Unless not
4508 * writing to the original file and '+' is not in 'cpoptions'. */
4509 if (reset_changed
&& whole
&& !append
4511 && !write_info
.bw_conv_error
4513 && (overwriting
|| vim_strchr(p_cpo
, CPO_PLUS
) != NULL
)
4516 unchanged(buf
, TRUE
);
4521 * If written to the current file, update the timestamp of the swap file
4522 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4528 buf
->b_flags
&= ~BF_NEW
;
4530 buf
->b_flags
&= ~BF_WRITE_MASK
;
4534 * If we kept a backup until now, and we are in patch mode, then we make
4535 * the backup file our 'original' file.
4537 if (*p_pm
&& dobackup
)
4539 char *org
= (char *)buf_modname(
4543 (buf
->b_p_sn
|| buf
->b_shortname
),
4545 fname
, p_pm
, FALSE
);
4552 * If the original file does not exist yet
4553 * the current backup file becomes the original file
4556 EMSG(_("E205: Patchmode: can't save original file"));
4557 else if (mch_stat(org
, &st
) < 0)
4559 vim_rename(backup
, (char_u
*)org
);
4560 vim_free(backup
); /* don't delete the file */
4563 set_file_time((char_u
*)org
, st_old
.st_atime
, st_old
.st_mtime
);
4568 * If there is no backup file, remember that a (new) file was
4576 || (empty_fd
= mch_open(org
,
4577 O_CREAT
| O_EXTRA
| O_EXCL
| O_NOFOLLOW
,
4578 perm
< 0 ? 0666 : (perm
& 0777))) < 0)
4579 EMSG(_("E206: patchmode: can't touch empty original file"));
4585 mch_setperm((char_u
*)org
, mch_getperm(fname
) & 0777);
4591 * Remove the backup unless 'backup' option is set
4593 if (!p_bk
&& backup
!= NULL
&& mch_remove(backup
) != 0)
4594 EMSG(_("E207: Can't delete backup file"));
4596 #ifdef FEAT_SUN_WORKSHOP
4597 if (usingSunWorkShop
)
4598 workshop_file_saved((char *) ffname
);
4604 * Finish up. We get here either after failure or success.
4607 --no_wait_return
; /* may wait for return now */
4610 /* Done saving, we accept changed buffer warnings again */
4611 buf
->b_saving
= FALSE
;
4614 if (buffer
!= smallbuf
)
4617 vim_free(fenc_tofree
);
4618 vim_free(write_info
.bw_conv_buf
);
4620 if (write_info
.bw_iconv_fd
!= (iconv_t
)-1)
4622 iconv_close(write_info
.bw_iconv_fd
);
4623 write_info
.bw_iconv_fd
= (iconv_t
)-1;
4633 int numlen
= errnum
!= NULL
? (int)STRLEN(errnum
) : 0;
4635 attr
= hl_attr(HLF_E
); /* set highlight for error messages */
4642 ); /* put file name in IObuff with quotes */
4643 if (STRLEN(IObuff
) + STRLEN(errmsg
) + numlen
>= IOSIZE
)
4644 IObuff
[IOSIZE
- STRLEN(errmsg
) - numlen
- 1] = NUL
;
4645 /* If the error message has the form "is ...", put the error number in
4646 * front of the file name. */
4649 mch_memmove(IObuff
+ numlen
, IObuff
, STRLEN(IObuff
) + 1);
4650 mch_memmove(IObuff
, errnum
, (size_t)numlen
);
4652 STRCAT(IObuff
, errmsg
);
4658 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4660 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4663 /* Update the timestamp to avoid an "overwrite changed file"
4664 * prompt when writing again. */
4665 if (mch_stat((char *)fname
, &st_old
) >= 0)
4667 buf_store_time(buf
, &st_old
, fname
);
4668 buf
->b_mtime_read
= buf
->b_mtime
;
4672 msg_scroll
= msg_save
;
4676 if (!should_abort(retval
))
4683 write_no_eol_lnum
= 0; /* in case it was set by the previous read */
4686 * Apply POST autocommands.
4687 * Careful: The autocommands may call buf_write() recursively!
4689 aucmd_prepbuf(&aco
, buf
);
4692 apply_autocmds_exarg(EVENT_FILEAPPENDPOST
, fname
, fname
,
4693 FALSE
, curbuf
, eap
);
4695 apply_autocmds_exarg(EVENT_FILTERWRITEPOST
, NULL
, fname
,
4696 FALSE
, curbuf
, eap
);
4697 else if (reset_changed
&& whole
)
4698 apply_autocmds_exarg(EVENT_BUFWRITEPOST
, fname
, fname
,
4699 FALSE
, curbuf
, eap
);
4701 apply_autocmds_exarg(EVENT_FILEWRITEPOST
, fname
, fname
,
4702 FALSE
, curbuf
, eap
);
4704 /* restore curwin/curbuf and a few other things */
4705 aucmd_restbuf(&aco
);
4708 if (aborting()) /* autocmds may abort script processing */
4714 got_int
|= prev_got_int
;
4716 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4717 /* Update machine specific information. */
4718 mch_post_buffer_write(buf
);
4724 * Set the name of the current buffer. Use when the buffer doesn't have a
4725 * name and a ":r" or ":w" command with a file name is used.
4728 set_rw_fname(fname
, sfname
)
4733 /* It's like the unnamed buffer is deleted.... */
4735 apply_autocmds(EVENT_BUFDELETE
, NULL
, NULL
, FALSE
, curbuf
);
4736 apply_autocmds(EVENT_BUFWIPEOUT
, NULL
, NULL
, FALSE
, curbuf
);
4738 if (aborting()) /* autocmds may abort script processing */
4743 if (setfname(curbuf
, fname
, sfname
, FALSE
) == OK
)
4744 curbuf
->b_flags
|= BF_NOTEDITED
;
4747 /* ....and a new named one is created */
4748 apply_autocmds(EVENT_BUFNEW
, NULL
, NULL
, FALSE
, curbuf
);
4750 apply_autocmds(EVENT_BUFADD
, NULL
, NULL
, FALSE
, curbuf
);
4752 if (aborting()) /* autocmds may abort script processing */
4756 /* Do filetype detection now if 'filetype' is empty. */
4757 if (*curbuf
->b_p_ft
== NUL
)
4759 if (au_has_group((char_u
*)"filetypedetect"))
4760 (void)do_doautocmd((char_u
*)"filetypedetect BufRead", FALSE
);
4769 * Put file name into IObuff with quotes.
4772 msg_add_fname(buf
, fname
)
4777 fname
= (char_u
*)"-stdin-";
4778 home_replace(buf
, fname
, IObuff
+ 1, IOSIZE
- 4, TRUE
);
4780 STRCAT(IObuff
, "\" ");
4784 * Append message for text mode to IObuff.
4785 * Return TRUE if something appended.
4788 msg_add_fileformat(eol_type
)
4792 if (eol_type
== EOL_DOS
)
4794 STRCAT(IObuff
, shortmess(SHM_TEXT
) ? _("[dos]") : _("[dos format]"));
4799 if (eol_type
== EOL_MAC
)
4801 STRCAT(IObuff
, shortmess(SHM_TEXT
) ? _("[mac]") : _("[mac format]"));
4805 #if defined(USE_CRNL) || defined(USE_CR)
4806 if (eol_type
== EOL_UNIX
)
4808 STRCAT(IObuff
, shortmess(SHM_TEXT
) ? _("[unix]") : _("[unix format]"));
4816 * Append line and character count to IObuff.
4819 msg_add_lines(insert_space
, lnum
, nchars
)
4826 p
= IObuff
+ STRLEN(IObuff
);
4830 if (shortmess(SHM_LINES
))
4831 sprintf((char *)p
, "%ldL, %ldC", lnum
, nchars
);
4835 STRCPY(p
, _("1 line, "));
4837 sprintf((char *)p
, _("%ld lines, "), lnum
);
4840 STRCPY(p
, _("1 character"));
4842 sprintf((char *)p
, _("%ld characters"), nchars
);
4847 * Append message for missing line separator to IObuff.
4852 STRCAT(IObuff
, shortmess(SHM_LAST
) ? _("[noeol]") : _("[Incomplete last line]"));
4856 * Check modification time of file, before writing to it.
4857 * The size isn't checked, because using a tool like "gzip" takes care of
4858 * using the same timestamp but can't set the size.
4861 check_mtime(buf
, st
)
4865 if (buf
->b_mtime_read
!= 0
4866 && time_differs((long)st
->st_mtime
, buf
->b_mtime_read
))
4868 msg_scroll
= TRUE
; /* don't overwrite messages here */
4869 msg_silent
= 0; /* must give this prompt */
4870 /* don't use emsg() here, don't want to flush the buffers */
4871 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
4873 if (ask_yesno((char_u
*)_("Do you really want to write to it"),
4876 msg_scroll
= FALSE
; /* always overwrite the file message now */
4882 time_differs(t1
, t2
)
4885 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
4886 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
4887 * the seconds. Since the roundoff is done when flushing the inode, the
4888 * time may change unexpectedly by one second!!! */
4889 return (t1
- t2
> 1 || t2
- t1
> 1);
4896 * Call write() to write a number of bytes to the file.
4897 * Also handles encryption and 'encoding' conversion.
4899 * Return FAIL for failure, OK otherwise.
4906 char_u
*buf
= ip
->bw_buf
; /* data to write */
4907 int len
= ip
->bw_len
; /* length of data */
4909 int flags
= ip
->bw_flags
; /* extra flags */
4914 * Skip conversion when writing the crypt magic number or the BOM.
4916 if (!(flags
& FIO_NOCONVERT
))
4922 if (flags
& FIO_UTF8
)
4925 * Convert latin1 in the buffer to UTF-8 in the file.
4927 p
= ip
->bw_conv_buf
; /* translate to buffer */
4928 for (wlen
= 0; wlen
< len
; ++wlen
)
4929 p
+= utf_char2bytes(buf
[wlen
], p
);
4930 buf
= ip
->bw_conv_buf
;
4931 len
= (int)(p
- ip
->bw_conv_buf
);
4933 else if (flags
& (FIO_UCS4
| FIO_UTF16
| FIO_UCS2
| FIO_LATIN1
))
4936 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
4937 * Latin1 chars in the file.
4939 if (flags
& FIO_LATIN1
)
4940 p
= buf
; /* translate in-place (can only get shorter) */
4942 p
= ip
->bw_conv_buf
; /* translate to buffer */
4943 for (wlen
= 0; wlen
< len
; wlen
+= n
)
4945 if (wlen
== 0 && ip
->bw_restlen
!= 0)
4949 /* Use remainder of previous call. Append the start of
4950 * buf[] to get a full sequence. Might still be too
4952 l
= CONV_RESTLEN
- ip
->bw_restlen
;
4955 mch_memmove(ip
->bw_rest
+ ip
->bw_restlen
, buf
, (size_t)l
);
4956 n
= utf_ptr2len_len(ip
->bw_rest
, ip
->bw_restlen
+ l
);
4957 if (n
> ip
->bw_restlen
+ len
)
4959 /* We have an incomplete byte sequence at the end to
4960 * be written. We can't convert it without the
4961 * remaining bytes. Keep them for the next call. */
4962 if (ip
->bw_restlen
+ len
> CONV_RESTLEN
)
4964 ip
->bw_restlen
+= len
;
4968 c
= utf_ptr2char(ip
->bw_rest
);
4971 if (n
>= ip
->bw_restlen
)
4973 n
-= ip
->bw_restlen
;
4978 ip
->bw_restlen
-= n
;
4979 mch_memmove(ip
->bw_rest
, ip
->bw_rest
+ n
,
4980 (size_t)ip
->bw_restlen
);
4986 n
= utf_ptr2len_len(buf
+ wlen
, len
- wlen
);
4989 /* We have an incomplete byte sequence at the end to
4990 * be written. We can't convert it without the
4991 * remaining bytes. Keep them for the next call. */
4992 if (len
- wlen
> CONV_RESTLEN
)
4994 ip
->bw_restlen
= len
- wlen
;
4995 mch_memmove(ip
->bw_rest
, buf
+ wlen
,
4996 (size_t)ip
->bw_restlen
);
5000 c
= utf_ptr2char(buf
+ wlen
);
5005 ip
->bw_conv_error
|= ucs2bytes(c
, &p
, flags
);
5007 if (flags
& FIO_LATIN1
)
5008 len
= (int)(p
- buf
);
5011 buf
= ip
->bw_conv_buf
;
5012 len
= (int)(p
- ip
->bw_conv_buf
);
5017 else if (flags
& FIO_CODEPAGE
)
5020 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
5030 if (ip
->bw_restlen
> 0)
5032 /* Need to concatenate the remainder of the previous call and
5033 * the bytes of the current call. Use the end of the
5034 * conversion buffer for this. */
5035 fromlen
= len
+ ip
->bw_restlen
;
5036 from
= ip
->bw_conv_buf
+ ip
->bw_conv_buflen
- fromlen
;
5037 mch_memmove(from
, ip
->bw_rest
, (size_t)ip
->bw_restlen
);
5038 mch_memmove(from
+ ip
->bw_restlen
, buf
, (size_t)len
);
5046 to
= ip
->bw_conv_buf
;
5049 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
5050 * The buffer has been allocated to be big enough. */
5053 n
= (int)utf_ptr2len_len(from
, (int)fromlen
);
5054 if (n
> (int)fromlen
) /* incomplete byte sequence */
5056 u8c
= utf_ptr2char(from
);
5057 *to
++ = (u8c
& 0xff);
5063 /* Copy remainder to ip->bw_rest[] to be used for the next
5065 if (fromlen
> CONV_RESTLEN
)
5067 /* weird overlong sequence */
5068 ip
->bw_conv_error
= TRUE
;
5071 mch_memmove(ip
->bw_rest
, from
, fromlen
);
5072 ip
->bw_restlen
= (int)fromlen
;
5076 /* Convert from enc_codepage to UCS-2, to the start of the
5077 * buffer. The buffer has been allocated to be big enough. */
5079 needed
= MultiByteToWideChar(enc_codepage
,
5080 MB_ERR_INVALID_CHARS
, (LPCSTR
)from
, (int)fromlen
,
5084 /* When conversion fails there may be a trailing byte. */
5085 needed
= MultiByteToWideChar(enc_codepage
,
5086 MB_ERR_INVALID_CHARS
, (LPCSTR
)from
, (int)fromlen
- 1,
5090 /* Conversion doesn't work. */
5091 ip
->bw_conv_error
= TRUE
;
5094 /* Save the trailing byte for the next call. */
5095 ip
->bw_rest
[0] = from
[fromlen
- 1];
5098 needed
= MultiByteToWideChar(enc_codepage
, MB_ERR_INVALID_CHARS
,
5099 (LPCSTR
)from
, (int)(fromlen
- ip
->bw_restlen
),
5100 (LPWSTR
)to
, needed
);
5103 /* Safety check: Conversion doesn't work. */
5104 ip
->bw_conv_error
= TRUE
;
5110 fromlen
= to
- ip
->bw_conv_buf
;
5112 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5113 if (FIO_GET_CP(flags
) == CP_UTF8
)
5115 /* Convert from UCS-2 to UTF-8, using the remainder of the
5116 * conversion buffer. Fails when out of space. */
5117 for (from
= ip
->bw_conv_buf
; fromlen
> 1; fromlen
-= 2)
5120 u8c
+= (*from
++ << 8);
5121 to
+= utf_char2bytes(u8c
, to
);
5122 if (to
+ 6 >= ip
->bw_conv_buf
+ ip
->bw_conv_buflen
)
5124 ip
->bw_conv_error
= TRUE
;
5128 len
= (int)(to
- buf
);
5133 /* Convert from UCS-2 to the codepage, using the remainder of
5134 * the conversion buffer. If the conversion uses the default
5135 * character "0", the data doesn't fit in this encoding, so
5137 len
= WideCharToMultiByte(FIO_GET_CP(flags
), 0,
5138 (LPCWSTR
)ip
->bw_conv_buf
, (int)fromlen
/ sizeof(WCHAR
),
5139 (LPSTR
)to
, (int)(ip
->bw_conv_buflen
- fromlen
), 0,
5143 ip
->bw_conv_error
= TRUE
;
5150 # ifdef MACOS_CONVERT
5151 else if (flags
& FIO_MACROMAN
)
5154 * Convert UTF-8 or latin1 to Apple MacRoman.
5159 if (ip
->bw_restlen
> 0)
5161 /* Need to concatenate the remainder of the previous call and
5162 * the bytes of the current call. Use the end of the
5163 * conversion buffer for this. */
5164 fromlen
= len
+ ip
->bw_restlen
;
5165 from
= ip
->bw_conv_buf
+ ip
->bw_conv_buflen
- fromlen
;
5166 mch_memmove(from
, ip
->bw_rest
, (size_t)ip
->bw_restlen
);
5167 mch_memmove(from
+ ip
->bw_restlen
, buf
, (size_t)len
);
5175 if (enc2macroman(from
, fromlen
,
5176 ip
->bw_conv_buf
, &len
, ip
->bw_conv_buflen
,
5177 ip
->bw_rest
, &ip
->bw_restlen
) == FAIL
)
5179 ip
->bw_conv_error
= TRUE
;
5182 buf
= ip
->bw_conv_buf
;
5187 if (ip
->bw_iconv_fd
!= (iconv_t
)-1)
5194 /* Convert with iconv(). */
5195 if (ip
->bw_restlen
> 0)
5197 /* Need to concatenate the remainder of the previous call and
5198 * the bytes of the current call. Use the end of the
5199 * conversion buffer for this. */
5200 fromlen
= len
+ ip
->bw_restlen
;
5201 from
= (char *)ip
->bw_conv_buf
+ ip
->bw_conv_buflen
- fromlen
;
5202 mch_memmove((void *)from
, ip
->bw_rest
, (size_t)ip
->bw_restlen
);
5203 mch_memmove((void *)(from
+ ip
->bw_restlen
), buf
, (size_t)len
);
5204 tolen
= ip
->bw_conv_buflen
- fromlen
;
5208 from
= (const char *)buf
;
5210 tolen
= ip
->bw_conv_buflen
;
5212 to
= (char *)ip
->bw_conv_buf
;
5216 size_t save_len
= tolen
;
5218 /* output the initial shift state sequence */
5219 (void)iconv(ip
->bw_iconv_fd
, NULL
, NULL
, &to
, &tolen
);
5221 /* There is a bug in iconv() on Linux (which appears to be
5222 * wide-spread) which sets "to" to NULL and messes up "tolen".
5226 to
= (char *)ip
->bw_conv_buf
;
5229 ip
->bw_first
= FALSE
;
5233 * If iconv() has an error or there is not enough room, fail.
5235 if ((iconv(ip
->bw_iconv_fd
, (void *)&from
, &fromlen
, &to
, &tolen
)
5236 == (size_t)-1 && ICONV_ERRNO
!= ICONV_EINVAL
)
5237 || fromlen
> CONV_RESTLEN
)
5239 ip
->bw_conv_error
= TRUE
;
5243 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5245 mch_memmove(ip
->bw_rest
, (void *)from
, fromlen
);
5246 ip
->bw_restlen
= (int)fromlen
;
5248 buf
= ip
->bw_conv_buf
;
5249 len
= (int)((char_u
*)to
- ip
->bw_conv_buf
);
5253 #endif /* FEAT_MBYTE */
5256 if (flags
& FIO_ENCRYPTED
) /* encrypt the data */
5260 for (i
= 0; i
< len
; i
++)
5263 buf
[i
] = ZENCODE(ztemp
, t
);
5268 /* Repeat the write(), it may be interrupted by a signal. */
5271 wlen
= vim_write(ip
->bw_fd
, buf
, len
);
5272 if (wlen
<= 0) /* error! */
5282 * Convert a Unicode character to bytes.
5285 ucs2bytes(c
, pp
, flags
)
5286 unsigned c
; /* in: character */
5287 char_u
**pp
; /* in/out: pointer to result */
5288 int flags
; /* FIO_ flags */
5295 if (flags
& FIO_UCS4
)
5297 if (flags
& FIO_ENDIAN_L
)
5312 else if (flags
& (FIO_UCS2
| FIO_UTF16
))
5316 if (flags
& FIO_UTF16
)
5318 /* Make two words, ten bits of the character in each. First
5319 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5323 cc
= ((c
>> 10) & 0x3ff) + 0xd800;
5324 if (flags
& FIO_ENDIAN_L
)
5327 *p
++ = ((unsigned)cc
>> 8);
5331 *p
++ = ((unsigned)cc
>> 8);
5334 c
= (c
& 0x3ff) + 0xdc00;
5339 if (flags
& FIO_ENDIAN_L
)
5366 * Return TRUE if "a" and "b" are the same 'encoding'.
5367 * Ignores difference between "ansi" and "latin1", "ucs-4" and "ucs-4be", etc.
5376 if (STRCMP(a
, b
) == 0)
5378 f
= get_fio_flags(a
);
5379 return (f
!= 0 && get_fio_flags(b
) == f
);
5383 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5384 * internal conversion.
5385 * if "ptr" is an empty string, use 'encoding'.
5396 prop
= enc_canon_props(ptr
);
5397 if (prop
& ENC_UNICODE
)
5399 if (prop
& ENC_2BYTE
)
5401 if (prop
& ENC_ENDIAN_L
)
5402 return FIO_UCS2
| FIO_ENDIAN_L
;
5405 if (prop
& ENC_4BYTE
)
5407 if (prop
& ENC_ENDIAN_L
)
5408 return FIO_UCS4
| FIO_ENDIAN_L
;
5411 if (prop
& ENC_2WORD
)
5413 if (prop
& ENC_ENDIAN_L
)
5414 return FIO_UTF16
| FIO_ENDIAN_L
;
5419 if (prop
& ENC_LATIN1
)
5421 /* must be ENC_DBCS, requires iconv() */
5427 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5428 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5429 * Used for conversion between 'encoding' and 'fileencoding'.
5432 get_win_fio_flags(ptr
)
5437 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5438 if (!enc_utf8
&& enc_codepage
<= 0)
5441 cp
= encname2codepage(ptr
);
5444 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5445 if (STRCMP(ptr
, "utf-8") == 0)
5451 return FIO_PUT_CP(cp
) | FIO_CODEPAGE
;
5457 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5458 * needed for the internal conversion to/from utf-8 or latin1.
5461 get_mac_fio_flags(ptr
)
5464 if ((enc_utf8
|| STRCMP(p_enc
, "latin1") == 0)
5465 && (enc_canon_props(ptr
) & ENC_MACROMAN
))
5466 return FIO_MACROMAN
;
5472 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5473 * "size" must be at least 2.
5474 * Return the name of the encoding and set "*lenp" to the length.
5475 * Returns NULL when no BOM found.
5478 check_for_bom(p
, size
, lenp
, flags
)
5487 if (p
[0] == 0xef && p
[1] == 0xbb && size
>= 3 && p
[2] == 0xbf
5488 && (flags
== FIO_ALL
|| flags
== 0))
5490 name
= "utf-8"; /* EF BB BF */
5493 else if (p
[0] == 0xff && p
[1] == 0xfe)
5495 if (size
>= 4 && p
[2] == 0 && p
[3] == 0
5496 && (flags
== FIO_ALL
|| flags
== (FIO_UCS4
| FIO_ENDIAN_L
)))
5498 name
= "ucs-4le"; /* FF FE 00 00 */
5501 else if (flags
== FIO_ALL
|| flags
== (FIO_UCS2
| FIO_ENDIAN_L
))
5502 name
= "ucs-2le"; /* FF FE */
5503 else if (flags
== (FIO_UTF16
| FIO_ENDIAN_L
))
5504 name
= "utf-16le"; /* FF FE */
5506 else if (p
[0] == 0xfe && p
[1] == 0xff
5507 && (flags
== FIO_ALL
|| flags
== FIO_UCS2
|| flags
== FIO_UTF16
))
5509 if (flags
== FIO_UTF16
)
5510 name
= "utf-16"; /* FE FF */
5512 name
= "ucs-2"; /* FE FF */
5514 else if (size
>= 4 && p
[0] == 0 && p
[1] == 0 && p
[2] == 0xfe
5515 && p
[3] == 0xff && (flags
== FIO_ALL
|| flags
== FIO_UCS4
))
5517 name
= "ucs-4"; /* 00 00 FE FF */
5522 return (char_u
*)name
;
5526 * Generate a BOM in "buf[4]" for encoding "name".
5527 * Return the length of the BOM (zero when no BOM).
5537 flags
= get_fio_flags(name
);
5539 /* Can't put a BOM in a non-Unicode file. */
5540 if (flags
== FIO_LATIN1
|| flags
== 0)
5543 if (flags
== FIO_UTF8
) /* UTF-8 */
5551 (void)ucs2bytes(0xfeff, &p
, flags
);
5552 return (int)(p
- buf
);
5557 * Try to find a shortname by comparing the fullname with the current
5559 * Returns NULL if not shorter name possible, pointer into "full_path"
5563 shorten_fname(full_path
, dir_name
)
5570 if (full_path
== NULL
)
5572 len
= (int)STRLEN(dir_name
);
5573 if (fnamencmp(dir_name
, full_path
, len
) == 0)
5575 p
= full_path
+ len
;
5576 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5578 * MSDOS: when a file is in the root directory, dir_name will end in a
5579 * slash, since C: by itself does not define a specific dir. In this
5580 * case p may already be correct. <negri>
5582 if (!((len
> 2) && (*(p
- 2) == ':')))
5585 if (vim_ispathsep(*p
))
5587 #ifndef VMS /* the path separator is always part of the path */
5593 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5595 * When using a file in the current drive, remove the drive name:
5596 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5597 * a floppy from "A:\dir" to "B:\dir".
5600 && TOUPPER_LOC(full_path
[0]) == TOUPPER_LOC(dir_name
[0])
5601 && full_path
[1] == ':'
5602 && vim_ispathsep(full_path
[2]))
5611 * Shorten filenames for all buffers.
5612 * When "force" is TRUE: Use full path from now on for files currently being
5613 * edited, both for file name and swap file name. Try to shorten the file
5614 * names a bit, if safe to do so.
5615 * When "force" is FALSE: Only try to shorten absolute file names.
5616 * For buffers that have buftype "nofile" or "scratch": never change the file
5620 shorten_fnames(force
)
5623 char_u dirname
[MAXPATHL
];
5627 mch_dirname(dirname
, MAXPATHL
);
5628 for (buf
= firstbuf
; buf
!= NULL
; buf
= buf
->b_next
)
5630 if (buf
->b_fname
!= NULL
5631 #ifdef FEAT_QUICKFIX
5634 && !path_with_url(buf
->b_fname
)
5636 || buf
->b_sfname
== NULL
5637 || mch_isFullName(buf
->b_sfname
)))
5639 vim_free(buf
->b_sfname
);
5640 buf
->b_sfname
= NULL
;
5641 p
= shorten_fname(buf
->b_ffname
, dirname
);
5644 buf
->b_sfname
= vim_strsave(p
);
5645 buf
->b_fname
= buf
->b_sfname
;
5647 if (p
== NULL
|| buf
->b_fname
== NULL
)
5648 buf
->b_fname
= buf
->b_ffname
;
5651 /* Always make the swap file name a full path, a "nofile" buffer may
5652 * also have a swap file. */
5653 mf_fullname(buf
->b_ml
.ml_mfp
);
5656 status_redraw_all();
5657 redraw_tabline
= TRUE
;
5661 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5662 || defined(FEAT_GUI_MSWIN) \
5663 || defined(FEAT_GUI_MAC) \
5666 * Shorten all filenames in "fnames[count]" by current directory.
5669 shorten_filenames(fnames
, count
)
5674 char_u dirname
[MAXPATHL
];
5677 if (fnames
== NULL
|| count
< 1)
5679 mch_dirname(dirname
, sizeof(dirname
));
5680 for (i
= 0; i
< count
; ++i
)
5682 if ((p
= shorten_fname(fnames
[i
], dirname
)) != NULL
)
5684 /* shorten_fname() returns pointer in given "fnames[i]". If free
5685 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5686 * "p" first then free fnames[i]. */
5688 vim_free(fnames
[i
]);
5696 * add extention to file name - change path/fo.o.h to path/fo.o.h.ext or
5697 * fo_o_h.ext for MSDOS or when shortname option set.
5699 * Assumed that fname is a valid name found in the filesystem we assure that
5700 * the return value is a different name and ends in 'ext'.
5701 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5702 * characters otherwise.
5703 * Space for the returned name is allocated, must be freed later.
5704 * Returns NULL when out of memory.
5707 modname(fname
, ext
, prepend_dot
)
5708 char_u
*fname
, *ext
;
5709 int prepend_dot
; /* may prepend a '.' to file name */
5715 (curbuf
->b_p_sn
|| curbuf
->b_shortname
),
5717 fname
, ext
, prepend_dot
);
5721 buf_modname(shortname
, fname
, ext
, prepend_dot
)
5722 int shortname
; /* use 8.3 file name */
5723 char_u
*fname
, *ext
;
5724 int prepend_dot
; /* may prepend a '.' to file name */
5730 int fnamelen
, extlen
;
5732 extlen
= (int)STRLEN(ext
);
5735 * If there is no file name we must get the name of the current directory
5736 * (we need the full path in case :cd is used).
5738 if (fname
== NULL
|| *fname
== NUL
)
5740 retval
= alloc((unsigned)(MAXPATHL
+ extlen
+ 3));
5743 if (mch_dirname(retval
, MAXPATHL
) == FAIL
||
5744 (fnamelen
= (int)STRLEN(retval
)) == 0)
5749 if (!after_pathsep(retval
, retval
+ fnamelen
))
5751 retval
[fnamelen
++] = PATHSEP
;
5752 retval
[fnamelen
] = NUL
;
5755 prepend_dot
= FALSE
; /* nothing to prepend a dot to */
5760 fnamelen
= (int)STRLEN(fname
);
5761 retval
= alloc((unsigned)(fnamelen
+ extlen
+ 3));
5764 STRCPY(retval
, fname
);
5766 vms_remove_version(retval
); /* we do not need versions here */
5771 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5772 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5773 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5774 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5776 for (ptr
= retval
+ fnamelen
; ptr
> retval
; mb_ptr_back(retval
, ptr
))
5780 # ifdef USE_LONG_FNAME
5781 && (!USE_LONG_FNAME
|| shortname
)
5783 # ifndef SHORT_FNAME
5788 if (*ptr
== '.') /* replace '.' by '_' */
5791 if (vim_ispathsep(*ptr
))
5798 /* the file name has at most BASENAMELEN characters. */
5800 if (STRLEN(ptr
) > (unsigned)BASENAMELEN
)
5801 ptr
[BASENAMELEN
] = '\0';
5804 s
= ptr
+ STRLEN(ptr
);
5807 * For 8.3 file names we may have to reduce the length.
5809 #ifdef USE_LONG_FNAME
5810 if (!USE_LONG_FNAME
|| shortname
)
5812 # ifndef SHORT_FNAME
5818 * If there is no file name, or the file name ends in '/', and the
5819 * extension starts with '.', put a '_' before the dot, because just
5820 * ".ext" is invalid.
5822 if (fname
== NULL
|| *fname
== NUL
5823 || vim_ispathsep(fname
[STRLEN(fname
) - 1]))
5833 * If the extension starts with '.', truncate the base name at 8
5837 /* We normally use '/', but swap files are '_' */
5838 else if (*ext
== '/' || *ext
== '_')
5840 else if (*ext
== '.')
5843 if (s
- ptr
> (size_t)8)
5850 * If the extension doesn't start with '.', and the file name
5851 * doesn't have an extension yet, append a '.'
5854 else if ((e
= vim_strchr(ptr
, '/')) == NULL
)
5857 else if ((e
= vim_strchr(ptr
, '.')) == NULL
)
5861 * If the extension doesn't start with '.', and there already is an
5862 * extension, it may need to be truncated
5864 else if ((int)STRLEN(e
) + extlen
> 4)
5867 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
5869 * If there is no file name, and the extension starts with '.', put a
5870 * '_' before the dot, because just ".ext" may be invalid if it's on a
5871 * FAT partition, and on HPFS it doesn't matter.
5873 else if ((fname
== NULL
|| *fname
== NUL
) && *ext
== '.')
5878 * Append the extention.
5879 * ext can start with '.' and cannot exceed 3 more characters.
5887 if (prepend_dot
&& !shortname
&& *(e
= gettail(retval
)) !=
5893 #ifdef USE_LONG_FNAME
5898 mch_memmove(e
+ 1, e
, STRLEN(e
) + 1);
5908 * Check that, after appending the extension, the file name is really
5911 if (fname
!= NULL
&& STRCMP(fname
, retval
) == 0)
5913 /* we search for a character that can be replaced by '_' */
5922 if (s
< ptr
) /* fname was "________.<ext>", how tricky! */
5929 * Like fgets(), but if the file line is too long, it is truncated and the
5930 * rest of the line is thrown away. Returns TRUE for end-of-file.
5933 vim_fgets(buf
, size
, fp
)
5939 #define FGETS_SIZE 200
5940 char tbuf
[FGETS_SIZE
];
5942 buf
[size
- 2] = NUL
;
5944 eof
= fgets_cr((char *)buf
, size
, fp
);
5946 eof
= fgets((char *)buf
, size
, fp
);
5948 if (buf
[size
- 2] != NUL
&& buf
[size
- 2] != '\n')
5950 buf
[size
- 1] = NUL
; /* Truncate the line */
5952 /* Now throw away the rest of the line: */
5955 tbuf
[FGETS_SIZE
- 2] = NUL
;
5957 fgets_cr((char *)tbuf
, FGETS_SIZE
, fp
);
5959 fgets((char *)tbuf
, FGETS_SIZE
, fp
);
5961 } while (tbuf
[FGETS_SIZE
- 2] != NUL
&& tbuf
[FGETS_SIZE
- 2] != '\n');
5963 return (eof
== NULL
);
5966 #if defined(USE_CR) || defined(PROTO)
5968 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
5969 * Returns TRUE for end-of-file.
5970 * Only used for the Mac, because it's much slower than vim_fgets().
5973 tag_fgets(buf
, size
, fp
)
5992 /* Always store a NL for end-of-line. */
5996 if (c
!= '\n') /* Macintosh format: single CR. */
6011 * rename() only works if both files are on the same file system, this
6012 * function will (attempts to?) copy the file across if rename fails -- webb
6013 * Return -1 for failure, 0 for success.
6016 vim_rename(from
, to
)
6023 char *errmsg
= NULL
;
6031 vim_acl_T acl
; /* ACL from original file */
6035 * When the names are identical, there is nothing to do.
6037 if (fnamecmp(from
, to
) == 0)
6041 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
6043 if (mch_stat((char *)from
, &st
) < 0)
6047 * Delete the "to" file, this is required on some systems to make the
6048 * mch_rename() work, on other systems it makes sure that we don't have
6049 * two files when the mch_rename() fails.
6054 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
6055 * that the name of the "to" file is the same as the "from" file, even
6056 * though the names are different. To avoid the chance of accidentally
6057 * deleting the "from" file (horror!) we lock it during the remove.
6059 * When used for making a backup before writing the file: This should not
6060 * happen with ":w", because startscript() should detect this problem and
6061 * set buf->b_shortname, causing modname() to return a correct ".bak" file
6062 * name. This problem does exist with ":w filename", but then the
6063 * original file will be somewhere else so the backup isn't really
6064 * important. If autoscripting is off the rename may fail.
6066 flock
= Lock((UBYTE
*)from
, (long)ACCESS_READ
);
6075 * First try a normal rename, return if it works.
6077 if (mch_rename((char *)from
, (char *)to
) == 0)
6081 * Rename() failed, try copying the file.
6083 perm
= mch_getperm(from
);
6085 /* For systems that support ACL: get the ACL from the original file. */
6086 acl
= mch_get_acl(from
);
6088 fd_in
= mch_open((char *)from
, O_RDONLY
|O_EXTRA
, 0);
6092 /* Create the new file with same permissions as the original. */
6093 fd_out
= mch_open((char *)to
,
6094 O_CREAT
|O_EXCL
|O_WRONLY
|O_EXTRA
|O_NOFOLLOW
, (int)perm
);
6101 buffer
= (char *)alloc(BUFSIZE
);
6109 while ((n
= vim_read(fd_in
, buffer
, BUFSIZE
)) > 0)
6110 if (vim_write(fd_out
, buffer
, n
) != n
)
6112 errmsg
= _("E208: Error writing to \"%s\"");
6118 if (close(fd_out
) < 0)
6119 errmsg
= _("E209: Error closing \"%s\"");
6122 errmsg
= _("E210: Error reading \"%s\"");
6125 #ifndef UNIX /* for Unix mch_open() already set the permission */
6126 mch_setperm(to
, perm
);
6129 mch_set_acl(to
, acl
);
6140 static int already_warned
= FALSE
;
6143 * Check if any not hidden buffer has been changed.
6144 * Postpone the check if there are characters in the stuff buffer, a global
6145 * command is being executed, a mapping is being executed or an autocommand is
6147 * Returns TRUE if some message was written (screen should be redrawn and
6148 * cursor positioned).
6151 check_timestamps(focus
)
6152 int focus
; /* called for GUI focus event */
6158 /* Don't check timestamps while system() or another low-level function may
6159 * cause us to lose and gain focus. */
6160 if (no_check_timestamps
> 0)
6163 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6164 * event and we would keep on checking if the file is steadily growing.
6165 * Do check again after typing something. */
6166 if (focus
&& did_check_timestamps
)
6168 need_check_timestamps
= TRUE
;
6172 if (!stuff_empty() || global_busy
|| !typebuf_typed()
6174 || autocmd_busy
|| curbuf_lock
> 0
6177 need_check_timestamps
= TRUE
; /* check later */
6181 did_check_timestamps
= TRUE
;
6182 already_warned
= FALSE
;
6183 for (buf
= firstbuf
; buf
!= NULL
; )
6185 /* Only check buffers in a window. */
6186 if (buf
->b_nwindows
> 0)
6188 n
= buf_check_timestamp(buf
, focus
);
6191 if (n
> 0 && !buf_valid(buf
))
6193 /* Autocommands have removed the buffer, start at the
6194 * first one again. */
6202 need_check_timestamps
= FALSE
;
6203 if (need_wait_return
&& didit
== 2)
6205 /* make sure msg isn't overwritten */
6206 msg_puts((char_u
*)"\n");
6214 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6215 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6219 move_lines(frombuf
, tobuf
)
6223 buf_T
*tbuf
= curbuf
;
6228 /* Copy the lines in "frombuf" to "tobuf". */
6230 for (lnum
= 1; lnum
<= frombuf
->b_ml
.ml_line_count
; ++lnum
)
6232 p
= vim_strsave(ml_get_buf(frombuf
, lnum
, FALSE
));
6233 if (p
== NULL
|| ml_append(lnum
- 1, p
, 0, FALSE
) == FAIL
)
6242 /* Delete all the lines in "frombuf". */
6246 for (lnum
= curbuf
->b_ml
.ml_line_count
; lnum
> 0; --lnum
)
6247 if (ml_delete(lnum
, FALSE
) == FAIL
)
6249 /* Oops! We could try putting back the saved lines, but that
6250 * might fail again... */
6261 * Check if buffer "buf" has been changed.
6262 * Also check if the file for a new buffer unexpectedly appeared.
6263 * return 1 if a changed buffer was found.
6264 * return 2 if a message has been displayed.
6265 * return 0 otherwise.
6269 buf_check_timestamp(buf
, focus
)
6271 int focus
; /* called for GUI focus event */
6280 int helpmesg
= FALSE
;
6282 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6283 int can_reload
= FALSE
;
6285 size_t orig_size
= buf
->b_orig_size
;
6286 int orig_mode
= buf
->b_orig_mode
;
6288 int save_mouse_correct
= need_mouse_correct
;
6291 static int busy
= FALSE
;
6297 /* If there is no file name, the buffer is not loaded, 'buftype' is
6298 * set, we are in the middle of a save or being called recursively: ignore
6300 if (buf
->b_ffname
== NULL
6301 || buf
->b_ml
.ml_mfp
== NULL
6302 #if defined(FEAT_QUICKFIX)
6303 || *buf
->b_p_bt
!= NUL
6309 #ifdef FEAT_NETBEANS_INTG
6310 || isNetbeansBuffer(buf
)
6315 if ( !(buf
->b_flags
& BF_NOTEDITED
)
6316 && buf
->b_mtime
!= 0
6317 && ((stat_res
= mch_stat((char *)buf
->b_ffname
, &st
)) < 0
6318 || time_differs((long)st
.st_mtime
, buf
->b_mtime
)
6320 || (int)st
.st_mode
!= buf
->b_orig_mode
6322 || mch_getperm(buf
->b_ffname
) != buf
->b_orig_mode
6328 /* set b_mtime to stop further warnings (e.g., when executing
6329 * FileChangedShell autocmd) */
6333 buf
->b_orig_size
= 0;
6334 buf
->b_orig_mode
= 0;
6337 buf_store_time(buf
, &st
, buf
->b_ffname
);
6339 /* Don't do anything for a directory. Might contain the file
6341 if (mch_isdir(buf
->b_fname
))
6345 * If 'autoread' is set, the buffer has no changes and the file still
6346 * exists, reload the buffer. Use the buffer-local option value if it
6347 * was set, the global option value otherwise.
6349 else if ((buf
->b_p_ar
>= 0 ? buf
->b_p_ar
: p_ar
)
6350 && !bufIsChanged(buf
) && stat_res
>= 0)
6356 else if (bufIsChanged(buf
))
6357 reason
= "conflict";
6358 else if (orig_size
!= buf
->b_orig_size
|| buf_contents_changed(buf
))
6360 else if (orig_mode
!= buf
->b_orig_mode
)
6367 * Only give the warning if there are no FileChangedShell
6369 * Avoid being called recursively by setting "busy".
6373 set_vim_var_string(VV_FCS_REASON
, (char_u
*)reason
, -1);
6374 set_vim_var_string(VV_FCS_CHOICE
, (char_u
*)"", -1);
6376 n
= apply_autocmds(EVENT_FILECHANGEDSHELL
,
6377 buf
->b_fname
, buf
->b_fname
, FALSE
, buf
);
6381 if (!buf_valid(buf
))
6382 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6384 s
= get_vim_var_str(VV_FCS_CHOICE
);
6385 if (STRCMP(s
, "reload") == 0 && *reason
!= 'd')
6387 else if (STRCMP(s
, "ask") == 0)
6397 mesg
= _("E211: File \"%s\" no longer available");
6401 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6405 * Check if the file contents really changed to avoid
6406 * giving a warning when only the timestamp was set (e.g.,
6407 * checked out of CVS). Always warn when the buffer was
6410 if (reason
[2] == 'n')
6412 mesg
= _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6413 mesg2
= _("See \":help W12\" for more info.");
6415 else if (reason
[1] == 'h')
6417 mesg
= _("W11: Warning: File \"%s\" has changed since editing started");
6418 mesg2
= _("See \":help W11\" for more info.");
6420 else if (*reason
== 'm')
6422 mesg
= _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6423 mesg2
= _("See \":help W16\" for more info.");
6425 /* Else: only timestamp changed, ignored */
6431 else if ((buf
->b_flags
& BF_NEW
) && !(buf
->b_flags
& BF_NEW_W
)
6432 && vim_fexists(buf
->b_ffname
))
6435 mesg
= _("W13: Warning: File \"%s\" has been created after editing started");
6436 buf
->b_flags
|= BF_NEW_W
;
6437 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6444 path
= home_replace_save(buf
, buf
->b_fname
);
6449 tbuf
= alloc((unsigned)(STRLEN(path
) + STRLEN(mesg
)
6450 + STRLEN(mesg2
) + 2));
6451 sprintf((char *)tbuf
, mesg
, path
);
6452 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6458 STRCAT(tbuf
, mesg2
);
6460 if (do_dialog(VIM_WARNING
, (char_u
*)_("Warning"), tbuf
,
6461 (char_u
*)_("&OK\n&Load File"), 1, NULL
) == 2)
6466 if (State
> NORMAL_BUSY
|| (State
& CMDLINE
) || already_warned
)
6471 STRCAT(tbuf
, mesg2
);
6478 # ifdef FEAT_AUTOCMD
6483 msg_puts_attr(tbuf
, hl_attr(HLF_E
) + MSG_HIST
);
6485 msg_puts_attr((char_u
*)mesg2
,
6486 hl_attr(HLF_W
) + MSG_HIST
);
6489 if (emsg_silent
== 0)
6495 /* give the user some time to think about it */
6496 ui_delay(1000L, TRUE
);
6498 /* don't redraw and erase the message */
6499 redraw_cmdline
= FALSE
;
6502 already_warned
= TRUE
;
6511 /* Reload the buffer. */
6512 buf_reload(buf
, orig_mode
);
6516 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST
,
6517 buf
->b_fname
, buf
->b_fname
, FALSE
, buf
);
6520 /* restore this in case an autocommand has set it; it would break
6522 need_mouse_correct
= save_mouse_correct
;
6529 * Reload a buffer that is already loaded.
6530 * Used when the file was changed outside of Vim.
6531 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6532 * buf->b_orig_mode may have been reset already.
6535 buf_reload(buf
, orig_mode
)
6541 linenr_T old_topline
;
6542 int old_ro
= buf
->b_p_ro
;
6547 /* set curwin/curbuf for "buf" and save some things */
6548 aucmd_prepbuf(&aco
, buf
);
6550 /* We only want to read the text from the file, not reset the syntax
6551 * highlighting, clear marks, diff status, etc. Force the fileformat
6552 * and encoding to be the same. */
6553 if (prep_exarg(&ea
, buf
) == OK
)
6555 old_cursor
= curwin
->w_cursor
;
6556 old_topline
= curwin
->w_topline
;
6559 * To behave like when a new file is edited (matters for
6560 * BufReadPost autocommands) we first need to delete the current
6561 * buffer contents. But if reading the file fails we should keep
6562 * the old contents. Can't use memory only, the file might be
6563 * too big. Use a hidden buffer to move the buffer contents to.
6569 /* Allocate a buffer without putting it in the buffer list. */
6570 savebuf
= buflist_new(NULL
, NULL
, (linenr_T
)1, BLN_DUMMY
);
6571 if (savebuf
!= NULL
&& buf
== curbuf
)
6573 /* Open the memline. */
6575 curwin
->w_buffer
= savebuf
;
6576 saved
= ml_open(curbuf
);
6578 curwin
->w_buffer
= buf
;
6580 if (savebuf
== NULL
|| saved
== FAIL
|| buf
!= curbuf
6581 || move_lines(buf
, savebuf
) == FAIL
)
6583 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6591 curbuf
->b_flags
|= BF_CHECK_RO
; /* check for RO again */
6593 keep_filetype
= TRUE
; /* don't detect 'filetype' */
6595 if (readfile(buf
->b_ffname
, buf
->b_fname
, (linenr_T
)0,
6597 (linenr_T
)MAXLNUM
, &ea
, READ_NEW
) == FAIL
)
6599 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6602 EMSG2(_("E321: Could not reload \"%s\""), buf
->b_fname
);
6603 if (savebuf
!= NULL
&& buf_valid(savebuf
) && buf
== curbuf
)
6605 /* Put the text back from the save buffer. First
6606 * delete any lines that readfile() added. */
6608 if (ml_delete(buf
->b_ml
.ml_line_count
, FALSE
) == FAIL
)
6610 (void)move_lines(savebuf
, buf
);
6613 else if (buf
== curbuf
)
6615 /* Mark the buffer as unmodified and free undo info. */
6616 unchanged(buf
, TRUE
);
6623 if (savebuf
!= NULL
&& buf_valid(savebuf
))
6624 wipe_buffer(savebuf
, FALSE
);
6627 /* Invalidate diff info if necessary. */
6628 diff_invalidate(curbuf
);
6631 /* Restore the topline and cursor position and check it (lines may
6632 * have been removed). */
6633 if (old_topline
> curbuf
->b_ml
.ml_line_count
)
6634 curwin
->w_topline
= curbuf
->b_ml
.ml_line_count
;
6636 curwin
->w_topline
= old_topline
;
6637 curwin
->w_cursor
= old_cursor
;
6641 keep_filetype
= FALSE
;
6647 /* Update folds unless they are defined manually. */
6649 if (wp
->w_buffer
== curwin
->w_buffer
6650 && !foldmethodIsManual(wp
))
6654 /* If the mode didn't change and 'readonly' was set, keep the old
6655 * value; the user probably used the ":view" command. But don't
6656 * reset it, might have had a read error. */
6657 if (orig_mode
== curbuf
->b_orig_mode
)
6658 curbuf
->b_p_ro
|= old_ro
;
6661 /* restore curwin/curbuf and a few other things */
6662 aucmd_restbuf(&aco
);
6663 /* Careful: autocommands may have made "buf" invalid! */
6668 buf_store_time(buf
, st
, fname
)
6673 buf
->b_mtime
= (long)st
->st_mtime
;
6674 buf
->b_orig_size
= (size_t)st
->st_size
;
6676 buf
->b_orig_mode
= (int)st
->st_mode
;
6678 buf
->b_orig_mode
= mch_getperm(fname
);
6683 * Adjust the line with missing eol, used for the next write.
6684 * Used for do_filter(), when the input lines for the filter are deleted.
6687 write_lnum_adjust(offset
)
6690 if (write_no_eol_lnum
!= 0) /* only if there is a missing eol */
6691 write_no_eol_lnum
+= offset
;
6694 #if defined(TEMPDIRNAMES) || defined(PROTO)
6695 static long temp_count
= 0; /* Temp filename counter. */
6698 * Delete the temp directory and all files it contains.
6707 if (vim_tempdir
!= NULL
)
6709 sprintf((char *)NameBuff
, "%s*", vim_tempdir
);
6710 if (gen_expand_wildcards(1, &NameBuff
, &file_count
, &files
,
6711 EW_DIR
|EW_FILE
|EW_SILENT
) == OK
)
6713 for (i
= 0; i
< file_count
; ++i
)
6714 mch_remove(files
[i
]);
6715 FreeWild(file_count
, files
);
6717 gettail(NameBuff
)[-1] = NUL
;
6718 (void)mch_rmdir(NameBuff
);
6720 vim_free(vim_tempdir
);
6727 * vim_tempname(): Return a unique name that can be used for a temp file.
6729 * The temp file is NOT created.
6731 * The returned pointer is to allocated memory.
6732 * The returned pointer is NULL if no valid name was found.
6736 vim_tempname(extra_char
)
6737 int extra_char
; /* character to use in the name instead of '?' */
6740 char_u itmp
[L_tmpnam
]; /* use tmpnam() */
6742 char_u itmp
[TEMPNAMELEN
];
6746 static char *(tempdirs
[]) = {TEMPDIRNAMES
};
6755 * This will create a directory for private use by this instance of Vim.
6756 * This is done once, and the same directory is used for all temp files.
6757 * This method avoids security problems because of symlink attacks et al.
6758 * It's also a bit faster, because we only need to check for an existing
6759 * file when creating the directory and not for each temp file.
6761 if (vim_tempdir
== NULL
)
6764 * Try the entries in TEMPDIRNAMES to create the temp directory.
6766 for (i
= 0; i
< sizeof(tempdirs
) / sizeof(char *); ++i
)
6768 /* expand $TMP, leave room for "/v1100000/999999999" */
6769 expand_env((char_u
*)tempdirs
[i
], itmp
, TEMPNAMELEN
- 20);
6770 if (mch_isdir(itmp
)) /* directory exists */
6773 /* If $TMP contains a forward slash (perhaps using bash or
6774 * tcsh), don't add a backslash, use a forward slash!
6775 * Adding 2 backslashes didn't work. */
6776 if (vim_strchr(itmp
, '/') != NULL
)
6782 /* Get an arbitrary number of up to 6 digits. When it's
6783 * unlikely that it already exists it will be faster,
6784 * otherwise it doesn't matter. The use of mkdir() avoids any
6785 * security problems because of the predictable number. */
6786 nr
= (mch_get_pid() + (long)time(NULL
)) % 1000000L;
6788 /* Try up to 10000 different values until we find a name that
6790 for (off
= 0; off
< 10000L; ++off
)
6793 #if defined(UNIX) || defined(VMS)
6797 sprintf((char *)itmp
+ STRLEN(itmp
), "v%ld", nr
+ off
);
6799 /* If mkdir() does not set errno to EEXIST, check for
6800 * existing file here. There is a race condition then,
6801 * although it's fail-safe. */
6802 if (mch_stat((char *)itmp
, &st
) >= 0)
6805 #if defined(UNIX) || defined(VMS)
6806 /* Make sure the umask doesn't remove the executable bit.
6807 * "repl" has been reported to use "177". */
6808 umask_save
= umask(077);
6810 r
= vim_mkdir(itmp
, 0700);
6811 #if defined(UNIX) || defined(VMS)
6812 (void)umask(umask_save
);
6818 /* Directory was created, use this name.
6819 * Expand to full path; When using the current
6820 * directory a ":cd" would confuse us. */
6821 buf
= alloc((unsigned)MAXPATHL
+ 1);
6824 if (vim_FullName(itmp
, buf
, MAXPATHL
, FALSE
)
6828 if (vim_strchr(buf
, '/') != NULL
)
6833 vim_tempdir
= vim_strsave(buf
);
6839 /* If the mkdir() didn't fail because the file/dir exists,
6840 * we probably can't create any dir here, try another
6842 if (errno
!= EEXIST
)
6846 if (vim_tempdir
!= NULL
)
6852 if (vim_tempdir
!= NULL
)
6854 /* There is no need to check if the file exists, because we own the
6855 * directory and nobody else creates a file in it. */
6856 sprintf((char *)itmp
, "%s%ld", vim_tempdir
, temp_count
++);
6857 return vim_strsave(itmp
);
6862 #else /* TEMPDIRNAMES */
6865 char szTempFile
[_MAX_PATH
+ 1];
6871 if (GetTempPath(_MAX_PATH
, szTempFile
) == 0)
6872 szTempFile
[0] = NUL
; /* GetTempPath() failed, use current dir */
6873 strcpy(buf4
, "VIM");
6874 buf4
[2] = extra_char
; /* make it "VIa", "VIb", etc. */
6875 if (GetTempFileName(szTempFile
, buf4
, 0, itmp
) == 0)
6877 /* GetTempFileName() will create the file, we don't want that */
6878 (void)DeleteFile(itmp
);
6880 /* Backslashes in a temp file name cause problems when filtering with
6881 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
6882 * didn't set 'shellslash'. */
6883 retval
= vim_strsave(itmp
);
6884 if (*p_shcf
== '-' || p_ssl
)
6885 for (p
= retval
; *p
; ++p
)
6890 # else /* WIN3264 */
6893 /* tmpnam() will make its own name */
6894 if (*tmpnam((char *)itmp
) == NUL
)
6900 /* mktemp() is not working on VMS. It seems to be
6901 * a do-nothing function. Therefore we use tempnam().
6903 sprintf((char *)itmp
, "VIM%c", extra_char
);
6904 p
= (char_u
*)tempnam("tmp:", (char *)itmp
);
6907 /* VMS will use '.LOG' if we don't explicitly specify an extension,
6908 * and VIM will then be unable to find the file later */
6910 STRCAT(itmp
, ".txt");
6916 STRCPY(itmp
, TEMPNAME
);
6917 if ((p
= vim_strchr(itmp
, '?')) != NULL
)
6919 if (mktemp((char *)itmp
) == NULL
)
6924 return vim_strsave(itmp
);
6925 # endif /* WIN3264 */
6926 #endif /* TEMPDIRNAMES */
6929 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
6931 * Convert all backslashes in fname to forward slashes in-place.
6934 forward_slash(fname
)
6939 for (p
= fname
; *p
!= NUL
; ++p
)
6941 /* The Big5 encoding can have '\' in the trail byte. */
6942 if (enc_dbcs
!= 0 && (*mb_ptr2len
)(p
) > 1)
6953 * Code for automatic commands.
6955 * Only included when "FEAT_AUTOCMD" has been defined.
6958 #if defined(FEAT_AUTOCMD) || defined(PROTO)
6961 * The autocommands are stored in a list for each event.
6962 * Autocommands for the same pattern, that are consecutive, are joined
6963 * together, to avoid having to match the pattern too often.
6964 * The result is an array of Autopat lists, which point to AutoCmd lists:
6966 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
6967 * Autopat.cmds Autopat.cmds
6970 * AutoCmd.next AutoCmd.next
6978 * first_autopat[1] --> Autopat.next --> NULL
6988 * The order of AutoCmds is important, this is the order in which they were
6989 * defined and will have to be executed.
6991 typedef struct AutoCmd
6993 char_u
*cmd
; /* The command to be executed (NULL
6994 when command has been removed) */
6995 char nested
; /* If autocommands nest here */
6996 char last
; /* last command in list */
6998 scid_T scriptID
; /* script ID where defined */
7000 struct AutoCmd
*next
; /* Next AutoCmd in list */
7003 typedef struct AutoPat
7005 int group
; /* group ID */
7006 char_u
*pat
; /* pattern as typed (NULL when pattern
7007 has been removed) */
7008 int patlen
; /* strlen() of pat */
7009 regprog_T
*reg_prog
; /* compiled regprog for pattern */
7010 char allow_dirs
; /* Pattern may match whole path */
7011 char last
; /* last pattern for apply_autocmds() */
7012 AutoCmd
*cmds
; /* list of commands to do */
7013 struct AutoPat
*next
; /* next AutoPat in AutoPat list */
7014 int buflocal_nr
; /* !=0 for buffer-local AutoPat */
7017 static struct event_name
7019 char *name
; /* event name */
7020 event_T event
; /* event number */
7023 {"BufAdd", EVENT_BUFADD
},
7024 {"BufCreate", EVENT_BUFADD
},
7025 {"BufDelete", EVENT_BUFDELETE
},
7026 {"BufEnter", EVENT_BUFENTER
},
7027 {"BufFilePost", EVENT_BUFFILEPOST
},
7028 {"BufFilePre", EVENT_BUFFILEPRE
},
7029 {"BufHidden", EVENT_BUFHIDDEN
},
7030 {"BufLeave", EVENT_BUFLEAVE
},
7031 {"BufNew", EVENT_BUFNEW
},
7032 {"BufNewFile", EVENT_BUFNEWFILE
},
7033 {"BufRead", EVENT_BUFREADPOST
},
7034 {"BufReadCmd", EVENT_BUFREADCMD
},
7035 {"BufReadPost", EVENT_BUFREADPOST
},
7036 {"BufReadPre", EVENT_BUFREADPRE
},
7037 {"BufUnload", EVENT_BUFUNLOAD
},
7038 {"BufWinEnter", EVENT_BUFWINENTER
},
7039 {"BufWinLeave", EVENT_BUFWINLEAVE
},
7040 {"BufWipeout", EVENT_BUFWIPEOUT
},
7041 {"BufWrite", EVENT_BUFWRITEPRE
},
7042 {"BufWritePost", EVENT_BUFWRITEPOST
},
7043 {"BufWritePre", EVENT_BUFWRITEPRE
},
7044 {"BufWriteCmd", EVENT_BUFWRITECMD
},
7045 {"CmdwinEnter", EVENT_CMDWINENTER
},
7046 {"CmdwinLeave", EVENT_CMDWINLEAVE
},
7047 {"ColorScheme", EVENT_COLORSCHEME
},
7048 {"CursorHold", EVENT_CURSORHOLD
},
7049 {"CursorHoldI", EVENT_CURSORHOLDI
},
7050 {"CursorMoved", EVENT_CURSORMOVED
},
7051 {"CursorMovedI", EVENT_CURSORMOVEDI
},
7052 {"EncodingChanged", EVENT_ENCODINGCHANGED
},
7053 {"FileEncoding", EVENT_ENCODINGCHANGED
},
7054 {"FileAppendPost", EVENT_FILEAPPENDPOST
},
7055 {"FileAppendPre", EVENT_FILEAPPENDPRE
},
7056 {"FileAppendCmd", EVENT_FILEAPPENDCMD
},
7057 {"FileChangedShell",EVENT_FILECHANGEDSHELL
},
7058 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST
},
7059 {"FileChangedRO", EVENT_FILECHANGEDRO
},
7060 {"FileReadPost", EVENT_FILEREADPOST
},
7061 {"FileReadPre", EVENT_FILEREADPRE
},
7062 {"FileReadCmd", EVENT_FILEREADCMD
},
7063 {"FileType", EVENT_FILETYPE
},
7064 {"FileWritePost", EVENT_FILEWRITEPOST
},
7065 {"FileWritePre", EVENT_FILEWRITEPRE
},
7066 {"FileWriteCmd", EVENT_FILEWRITECMD
},
7067 {"FilterReadPost", EVENT_FILTERREADPOST
},
7068 {"FilterReadPre", EVENT_FILTERREADPRE
},
7069 {"FilterWritePost", EVENT_FILTERWRITEPOST
},
7070 {"FilterWritePre", EVENT_FILTERWRITEPRE
},
7071 {"FocusGained", EVENT_FOCUSGAINED
},
7072 {"FocusLost", EVENT_FOCUSLOST
},
7073 {"FuncUndefined", EVENT_FUNCUNDEFINED
},
7074 {"GUIEnter", EVENT_GUIENTER
},
7075 {"GUIFailed", EVENT_GUIFAILED
},
7076 {"InsertChange", EVENT_INSERTCHANGE
},
7077 {"InsertEnter", EVENT_INSERTENTER
},
7078 {"InsertLeave", EVENT_INSERTLEAVE
},
7079 {"MenuPopup", EVENT_MENUPOPUP
},
7080 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST
},
7081 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE
},
7082 {"RemoteReply", EVENT_REMOTEREPLY
},
7083 {"SessionLoadPost", EVENT_SESSIONLOADPOST
},
7084 {"ShellCmdPost", EVENT_SHELLCMDPOST
},
7085 {"ShellFilterPost", EVENT_SHELLFILTERPOST
},
7086 {"SourcePre", EVENT_SOURCEPRE
},
7087 {"SourceCmd", EVENT_SOURCECMD
},
7088 {"SpellFileMissing",EVENT_SPELLFILEMISSING
},
7089 {"StdinReadPost", EVENT_STDINREADPOST
},
7090 {"StdinReadPre", EVENT_STDINREADPRE
},
7091 {"SwapExists", EVENT_SWAPEXISTS
},
7092 {"Syntax", EVENT_SYNTAX
},
7093 {"TabEnter", EVENT_TABENTER
},
7094 {"TabLeave", EVENT_TABLEAVE
},
7095 {"TermChanged", EVENT_TERMCHANGED
},
7096 {"TermResponse", EVENT_TERMRESPONSE
},
7097 {"User", EVENT_USER
},
7098 {"VimEnter", EVENT_VIMENTER
},
7099 {"VimLeave", EVENT_VIMLEAVE
},
7100 {"VimLeavePre", EVENT_VIMLEAVEPRE
},
7101 {"WinEnter", EVENT_WINENTER
},
7102 {"WinLeave", EVENT_WINLEAVE
},
7103 {"VimResized", EVENT_VIMRESIZED
},
7107 static AutoPat
*first_autopat
[NUM_EVENTS
] =
7109 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7110 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7111 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7112 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7113 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7114 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
7118 * struct used to keep status while executing autocommands for an event.
7120 typedef struct AutoPatCmd
7122 AutoPat
*curpat
; /* next AutoPat to examine */
7123 AutoCmd
*nextcmd
; /* next AutoCmd to execute */
7124 int group
; /* group being used */
7125 char_u
*fname
; /* fname to match with */
7126 char_u
*sfname
; /* sfname to match with */
7127 char_u
*tail
; /* tail of fname */
7128 event_T event
; /* current event */
7129 int arg_bufnr
; /* initially equal to <abuf>, set to zero when
7131 struct AutoPatCmd
*next
; /* chain of active apc-s for auto-invalidation*/
7134 static AutoPatCmd
*active_apc_list
= NULL
; /* stack of active autocommands */
7137 * augroups stores a list of autocmd group names.
7139 static garray_T augroups
= {0, 0, sizeof(char_u
*), 10, NULL
};
7140 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7143 * The ID of the current group. Group 0 is the default one.
7145 static int current_augroup
= AUGROUP_DEFAULT
;
7147 static int au_need_clean
= FALSE
; /* need to delete marked patterns */
7149 static void show_autocmd
__ARGS((AutoPat
*ap
, event_T event
));
7150 static void au_remove_pat
__ARGS((AutoPat
*ap
));
7151 static void au_remove_cmds
__ARGS((AutoPat
*ap
));
7152 static void au_cleanup
__ARGS((void));
7153 static int au_new_group
__ARGS((char_u
*name
));
7154 static void au_del_group
__ARGS((char_u
*name
));
7155 static event_T event_name2nr
__ARGS((char_u
*start
, char_u
**end
));
7156 static char_u
*event_nr2name
__ARGS((event_T event
));
7157 static char_u
*find_end_event
__ARGS((char_u
*arg
, int have_group
));
7158 static int event_ignored
__ARGS((event_T event
));
7159 static int au_get_grouparg
__ARGS((char_u
**argp
));
7160 static int do_autocmd_event
__ARGS((event_T event
, char_u
*pat
, int nested
, char_u
*cmd
, int forceit
, int group
));
7161 static char_u
*getnextac
__ARGS((int c
, void *cookie
, int indent
));
7162 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
));
7163 static void auto_next_pat
__ARGS((AutoPatCmd
*apc
, int stop_at_last
));
7166 static event_T last_event
;
7167 static int last_group
;
7170 * Show the autocommands for one AutoPat.
7173 show_autocmd(ap
, event
)
7179 /* Check for "got_int" (here and at various places below), which is set
7180 * when "q" has been hit for the "--more--" prompt */
7183 if (ap
->pat
== NULL
) /* pattern has been removed */
7189 if (event
!= last_event
|| ap
->group
!= last_group
)
7191 if (ap
->group
!= AUGROUP_DEFAULT
)
7193 if (AUGROUP_NAME(ap
->group
) == NULL
)
7194 msg_puts_attr((char_u
*)_("--Deleted--"), hl_attr(HLF_E
));
7196 msg_puts_attr(AUGROUP_NAME(ap
->group
), hl_attr(HLF_T
));
7197 msg_puts((char_u
*)" ");
7199 msg_puts_attr(event_nr2name(event
), hl_attr(HLF_T
));
7201 last_group
= ap
->group
;
7207 msg_outtrans(ap
->pat
);
7209 for (ac
= ap
->cmds
; ac
!= NULL
; ac
= ac
->next
)
7211 if (ac
->cmd
!= NULL
) /* skip removed commands */
7218 msg_outtrans(ac
->cmd
);
7221 last_set_msg(ac
->scriptID
);
7225 if (ac
->next
!= NULL
)
7236 * Mark an autocommand pattern for deletion.
7244 ap
->buflocal_nr
= -1;
7245 au_need_clean
= TRUE
;
7249 * Mark all commands for a pattern for deletion.
7257 for (ac
= ap
->cmds
; ac
!= NULL
; ac
= ac
->next
)
7262 au_need_clean
= TRUE
;
7266 * Cleanup autocommands and patterns that have been deleted.
7267 * This is only done when not executing autocommands.
7272 AutoPat
*ap
, **prev_ap
;
7273 AutoCmd
*ac
, **prev_ac
;
7276 if (autocmd_busy
|| !au_need_clean
)
7279 /* loop over all events */
7280 for (event
= (event_T
)0; (int)event
< (int)NUM_EVENTS
;
7281 event
= (event_T
)((int)event
+ 1))
7283 /* loop over all autocommand patterns */
7284 prev_ap
= &(first_autopat
[(int)event
]);
7285 for (ap
= *prev_ap
; ap
!= NULL
; ap
= *prev_ap
)
7287 /* loop over all commands for this pattern */
7288 prev_ac
= &(ap
->cmds
);
7289 for (ac
= *prev_ac
; ac
!= NULL
; ac
= *prev_ac
)
7291 /* remove the command if the pattern is to be deleted or when
7292 * the command has been marked for deletion */
7293 if (ap
->pat
== NULL
|| ac
->cmd
== NULL
)
7295 *prev_ac
= ac
->next
;
7300 prev_ac
= &(ac
->next
);
7303 /* remove the pattern if it has been marked for deletion */
7304 if (ap
->pat
== NULL
)
7306 *prev_ap
= ap
->next
;
7307 vim_free(ap
->reg_prog
);
7311 prev_ap
= &(ap
->next
);
7315 au_need_clean
= FALSE
;
7319 * Called when buffer is freed, to remove/invalidate related buffer-local
7323 aubuflocal_remove(buf
)
7330 /* invalidate currently executing autocommands */
7331 for (apc
= active_apc_list
; apc
; apc
= apc
->next
)
7332 if (buf
->b_fnum
== apc
->arg_bufnr
)
7335 /* invalidate buflocals looping through events */
7336 for (event
= (event_T
)0; (int)event
< (int)NUM_EVENTS
;
7337 event
= (event_T
)((int)event
+ 1))
7338 /* loop over all autocommand patterns */
7339 for (ap
= first_autopat
[(int)event
]; ap
!= NULL
; ap
= ap
->next
)
7340 if (ap
->buflocal_nr
== buf
->b_fnum
)
7347 _("auto-removing autocommand: %s <buffer=%d>"),
7348 event_nr2name(event
), buf
->b_fnum
);
7356 * Add an autocmd group name.
7357 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7365 i
= au_find_group(name
);
7366 if (i
== AUGROUP_ERROR
) /* the group doesn't exist yet, add it */
7368 /* First try using a free entry. */
7369 for (i
= 0; i
< augroups
.ga_len
; ++i
)
7370 if (AUGROUP_NAME(i
) == NULL
)
7372 if (i
== augroups
.ga_len
&& ga_grow(&augroups
, 1) == FAIL
)
7373 return AUGROUP_ERROR
;
7375 AUGROUP_NAME(i
) = vim_strsave(name
);
7376 if (AUGROUP_NAME(i
) == NULL
)
7377 return AUGROUP_ERROR
;
7378 if (i
== augroups
.ga_len
)
7391 i
= au_find_group(name
);
7392 if (i
== AUGROUP_ERROR
) /* the group doesn't exist */
7393 EMSG2(_("E367: No such group: \"%s\""), name
);
7396 vim_free(AUGROUP_NAME(i
));
7397 AUGROUP_NAME(i
) = NULL
;
7402 * Find the ID of an autocmd group name.
7403 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7411 for (i
= 0; i
< augroups
.ga_len
; ++i
)
7412 if (AUGROUP_NAME(i
) != NULL
&& STRCMP(AUGROUP_NAME(i
), name
) == 0)
7414 return AUGROUP_ERROR
;
7418 * Return TRUE if augroup "name" exists.
7424 return au_find_group(name
) != AUGROUP_ERROR
;
7428 * ":augroup {name}".
7431 do_augroup(arg
, del_group
)
7444 else if (STRICMP(arg
, "end") == 0) /* ":aug end": back to group 0 */
7445 current_augroup
= AUGROUP_DEFAULT
;
7446 else if (*arg
) /* ":aug xxx": switch to group xxx */
7448 i
= au_new_group(arg
);
7449 if (i
!= AUGROUP_ERROR
)
7450 current_augroup
= i
;
7452 else /* ":aug": list the group names */
7455 for (i
= 0; i
< augroups
.ga_len
; ++i
)
7457 if (AUGROUP_NAME(i
) != NULL
)
7459 msg_puts(AUGROUP_NAME(i
));
7460 msg_puts((char_u
*)" ");
7468 #if defined(EXITFREE) || defined(PROTO)
7472 for (current_augroup
= -1; current_augroup
< augroups
.ga_len
;
7474 do_autocmd((char_u
*)"", TRUE
);
7475 ga_clear_strings(&augroups
);
7480 * Return the event number for event name "start".
7481 * Return NUM_EVENTS if the event name was not found.
7482 * Return a pointer to the next event name in "end".
7485 event_name2nr(start
, end
)
7493 /* the event name ends with end of line, a blank or a comma */
7494 for (p
= start
; *p
&& !vim_iswhite(*p
) && *p
!= ','; ++p
)
7496 for (i
= 0; event_names
[i
].name
!= NULL
; ++i
)
7498 len
= (int)STRLEN(event_names
[i
].name
);
7499 if (len
== p
- start
&& STRNICMP(event_names
[i
].name
, start
, len
) == 0)
7505 if (event_names
[i
].name
== NULL
)
7507 return event_names
[i
].event
;
7511 * Return the name for event "event".
7514 event_nr2name(event
)
7519 for (i
= 0; event_names
[i
].name
!= NULL
; ++i
)
7520 if (event_names
[i
].event
== event
)
7521 return (char_u
*)event_names
[i
].name
;
7522 return (char_u
*)"Unknown";
7526 * Scan over the events. "*" stands for all events.
7529 find_end_event(arg
, have_group
)
7531 int have_group
; /* TRUE when group name was found */
7538 if (arg
[1] && !vim_iswhite(arg
[1]))
7540 EMSG2(_("E215: Illegal character after *: %s"), arg
);
7547 for (pat
= arg
; *pat
&& !vim_iswhite(*pat
); pat
= p
)
7549 if ((int)event_name2nr(pat
, &p
) >= (int)NUM_EVENTS
)
7552 EMSG2(_("E216: No such event: %s"), pat
);
7554 EMSG2(_("E216: No such group or event: %s"), pat
);
7563 * Return TRUE if "event" is included in 'eventignore'.
7566 event_ignored(event
)
7573 if (STRNICMP(p
, "all", 3) == 0 && (p
[3] == NUL
|| p
[3] == ','))
7575 if (event_name2nr(p
, &p
) == event
)
7583 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7592 if (STRNICMP(p
, "all", 3) == 0 && (p
[3] == NUL
|| p
[3] == ','))
7598 else if (event_name2nr(p
, &p
) == NUM_EVENTS
)
7605 # if defined(FEAT_SYN_HL) || defined(PROTO)
7608 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7609 * buffer loaded into the window. "what" must start with a comma.
7610 * Returns the old value of 'eventignore' in allocated memory.
7613 au_event_disable(what
)
7619 save_ei
= vim_strsave(p_ei
);
7620 if (save_ei
!= NULL
)
7622 new_ei
= vim_strnsave(p_ei
, (int)(STRLEN(p_ei
) + STRLEN(what
)));
7625 STRCAT(new_ei
, what
);
7626 set_string_option_direct((char_u
*)"ei", -1, new_ei
,
7627 OPT_FREE
, SID_NONE
);
7635 au_event_restore(old_ei
)
7640 set_string_option_direct((char_u
*)"ei", -1, old_ei
,
7641 OPT_FREE
, SID_NONE
);
7645 # endif /* FEAT_SYN_HL */
7648 * do_autocmd() -- implements the :autocmd command. Can be used in the
7651 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7652 * will be automatically executed for <event>
7653 * when editing a file matching <pat>, in
7654 * the current group.
7655 * :autocmd <event> <pat> Show the auto-commands associated with
7656 * <event> and <pat>.
7657 * :autocmd <event> Show the auto-commands associated with
7659 * :autocmd Show all auto-commands.
7660 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7661 * <event> and <pat>, and add the command
7662 * <cmd>, for the current group.
7663 * :autocmd! <event> <pat> Remove all auto-commands associated with
7664 * <event> and <pat> for the current group.
7665 * :autocmd! <event> Remove all auto-commands associated with
7666 * <event> for the current group.
7667 * :autocmd! Remove ALL auto-commands for the current
7670 * Multiple events and patterns may be given separated by commas. Here are
7672 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
7673 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
7675 * :autocmd * *.c show all autocommands for *.c files.
7677 * Mostly a {group} argument can optionally appear before <event>.
7680 do_autocmd(arg
, forceit
)
7685 char_u
*envpat
= NULL
;
7688 int need_free
= FALSE
;
7693 * Check for a legal group name. If not, use AUGROUP_ALL.
7695 group
= au_get_grouparg(&arg
);
7696 if (arg
== NULL
) /* out of memory */
7700 * Scan over the events.
7701 * If we find an illegal name, return here, don't do anything.
7703 pat
= find_end_event(arg
, group
!= AUGROUP_ALL
);
7708 * Scan over the pattern. Put a NUL at the end.
7710 pat
= skipwhite(pat
);
7712 while (*cmd
&& (!vim_iswhite(*cmd
) || cmd
[-1] == '\\'))
7717 /* Expand environment variables in the pattern. Set 'shellslash', we want
7718 * forward slashes here. */
7719 if (vim_strchr(pat
, '$') != NULL
|| vim_strchr(pat
, '~') != NULL
)
7721 #ifdef BACKSLASH_IN_FILENAME
7722 int p_ssl_save
= p_ssl
;
7726 envpat
= expand_env_save(pat
);
7727 #ifdef BACKSLASH_IN_FILENAME
7735 * Check for "nested" flag.
7737 cmd
= skipwhite(cmd
);
7738 if (*cmd
!= NUL
&& STRNCMP(cmd
, "nested", 6) == 0 && vim_iswhite(cmd
[6]))
7741 cmd
= skipwhite(cmd
+ 6);
7745 * Find the start of the commands.
7746 * Expand <sfile> in it.
7750 cmd
= expand_sfile(cmd
);
7751 if (cmd
== NULL
) /* some error */
7757 * Print header when showing autocommands.
7759 if (!forceit
&& *cmd
== NUL
)
7761 /* Highlight title */
7762 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
7766 * Loop over the events.
7768 last_event
= (event_T
)-1; /* for listing the event name */
7769 last_group
= AUGROUP_ERROR
; /* for listing the group name */
7770 if (*arg
== '*' || *arg
== NUL
)
7772 for (event
= (event_T
)0; (int)event
< (int)NUM_EVENTS
;
7773 event
= (event_T
)((int)event
+ 1))
7774 if (do_autocmd_event(event
, pat
,
7775 nested
, cmd
, forceit
, group
) == FAIL
)
7780 while (*arg
&& !vim_iswhite(*arg
))
7781 if (do_autocmd_event(event_name2nr(arg
, &arg
), pat
,
7782 nested
, cmd
, forceit
, group
) == FAIL
)
7792 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
7793 * The "argp" argument is advanced to the following argument.
7795 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
7798 au_get_grouparg(argp
)
7803 char_u
*arg
= *argp
;
7804 int group
= AUGROUP_ALL
;
7806 p
= skiptowhite(arg
);
7809 group_name
= vim_strnsave(arg
, (int)(p
- arg
));
7810 if (group_name
== NULL
) /* out of memory */
7811 return AUGROUP_ERROR
;
7812 group
= au_find_group(group_name
);
7813 if (group
== AUGROUP_ERROR
)
7814 group
= AUGROUP_ALL
; /* no match, use all groups */
7816 *argp
= skipwhite(p
); /* match, skip over group name */
7817 vim_free(group_name
);
7823 * do_autocmd() for one event.
7824 * If *pat == NUL do for all patterns.
7825 * If *cmd == NUL show entries.
7826 * If forceit == TRUE delete entries.
7827 * If group is not AUGROUP_ALL, only use this group.
7830 do_autocmd_event(event
, pat
, nested
, cmd
, forceit
, group
)
7849 char_u buflocal_pat
[25]; /* for "<buffer=X>" */
7851 if (group
== AUGROUP_ALL
)
7852 findgroup
= current_augroup
;
7855 allgroups
= (group
== AUGROUP_ALL
&& !forceit
&& *cmd
== NUL
);
7858 * Show or delete all patterns for an event.
7862 for (ap
= first_autopat
[(int)event
]; ap
!= NULL
; ap
= ap
->next
)
7864 if (forceit
) /* delete the AutoPat, if it's in the current group */
7866 if (ap
->group
== findgroup
)
7869 else if (group
== AUGROUP_ALL
|| ap
->group
== group
)
7870 show_autocmd(ap
, event
);
7875 * Loop through all the specified patterns.
7877 for ( ; *pat
; pat
= (*endpat
== ',' ? endpat
+ 1 : endpat
))
7880 * Find end of the pattern.
7881 * Watch out for a comma in braces, like "*.\{obj,o\}".
7884 for (endpat
= pat
; *endpat
&& (*endpat
!= ',' || brace_level
7885 || endpat
[-1] == '\\'); ++endpat
)
7889 else if (*endpat
== '}')
7892 if (pat
== endpat
) /* ignore single comma */
7894 patlen
= (int)(endpat
- pat
);
7897 * detect special <buflocal[=X]> buffer-local patterns
7899 is_buflocal
= FALSE
;
7902 if (patlen
>= 7 && STRNCMP(pat
, "<buffer", 7) == 0
7903 && pat
[patlen
- 1] == '>')
7905 /* Error will be printed only for addition. printing and removing
7906 * will proceed silently. */
7909 buflocal_nr
= curbuf
->b_fnum
;
7910 else if (patlen
> 9 && pat
[7] == '=')
7913 if (patlen
== 13 && STRNICMP(pat
, "<buffer=abuf>", 13))
7914 buflocal_nr
= autocmd_bufnr
;
7916 else if (skipdigits(pat
+ 8) == pat
+ patlen
- 1)
7917 buflocal_nr
= atoi((char *)pat
+ 8);
7923 /* normalize pat into standard "<buffer>#N" form */
7924 sprintf((char *)buflocal_pat
, "<buffer=%d>", buflocal_nr
);
7925 pat
= buflocal_pat
; /* can modify pat and patlen */
7926 patlen
= (int)STRLEN(buflocal_pat
); /* but not endpat */
7930 * Find AutoPat entries with this pattern.
7932 prev_ap
= &first_autopat
[(int)event
];
7933 while ((ap
= *prev_ap
) != NULL
)
7935 if (ap
->pat
!= NULL
)
7937 /* Accept a pattern when:
7938 * - a group was specified and it's that group, or a group was
7939 * not specified and it's the current group, or a group was
7940 * not specified and we are listing
7941 * - the length of the pattern matches
7942 * - the pattern matches.
7943 * For <buffer[=X]>, this condition works because we normalize
7944 * all buffer-local patterns.
7946 if ((allgroups
|| ap
->group
== findgroup
)
7947 && ap
->patlen
== patlen
7948 && STRNCMP(pat
, ap
->pat
, patlen
) == 0)
7951 * Remove existing autocommands.
7952 * If adding any new autocmd's for this AutoPat, don't
7953 * delete the pattern from the autopat list, append to
7958 if (*cmd
!= NUL
&& ap
->next
== NULL
)
7967 * Show autocmd's for this autopat, or buflocals <buffer=X>
7969 else if (*cmd
== NUL
)
7970 show_autocmd(ap
, event
);
7973 * Add autocmd to this autopat, if it's the last one.
7975 else if (ap
->next
== NULL
)
7979 prev_ap
= &ap
->next
;
7983 * Add a new command.
7988 * If the pattern we want to add a command to does appear at the
7989 * end of the list (or not is not in the list at all), add the
7990 * pattern at the end of the list.
7994 /* refuse to add buffer-local ap if buffer number is invalid */
7995 if (is_buflocal
&& (buflocal_nr
== 0
7996 || buflist_findnr(buflocal_nr
) == NULL
))
7998 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
8003 ap
= (AutoPat
*)alloc((unsigned)sizeof(AutoPat
));
8006 ap
->pat
= vim_strnsave(pat
, patlen
);
8007 ap
->patlen
= patlen
;
8008 if (ap
->pat
== NULL
)
8016 ap
->buflocal_nr
= buflocal_nr
;
8017 ap
->reg_prog
= NULL
;
8023 ap
->buflocal_nr
= 0;
8024 reg_pat
= file_pat_to_reg_pat(pat
, endpat
,
8025 &ap
->allow_dirs
, TRUE
);
8026 if (reg_pat
!= NULL
)
8027 ap
->reg_prog
= vim_regcomp(reg_pat
, RE_MAGIC
);
8029 if (reg_pat
== NULL
|| ap
->reg_prog
== NULL
)
8039 if (group
== AUGROUP_ALL
)
8040 ap
->group
= current_augroup
;
8046 * Add the autocmd at the end of the AutoCmd list.
8048 prev_ac
= &(ap
->cmds
);
8049 while ((ac
= *prev_ac
) != NULL
)
8050 prev_ac
= &ac
->next
;
8051 ac
= (AutoCmd
*)alloc((unsigned)sizeof(AutoCmd
));
8054 ac
->cmd
= vim_strsave(cmd
);
8056 ac
->scriptID
= current_SID
;
8058 if (ac
->cmd
== NULL
)
8065 ac
->nested
= nested
;
8069 au_cleanup(); /* may really delete removed patterns/commands now */
8074 * Implementation of ":doautocmd [group] event [fname]".
8075 * Return OK for success, FAIL for failure;
8078 do_doautocmd(arg
, do_msg
)
8080 int do_msg
; /* give message for no matching autocmds? */
8083 int nothing_done
= TRUE
;
8087 * Check for a legal group name. If not, use AUGROUP_ALL.
8089 group
= au_get_grouparg(&arg
);
8090 if (arg
== NULL
) /* out of memory */
8095 EMSG(_("E217: Can't execute autocommands for ALL events"));
8100 * Scan over the events.
8101 * If we find an illegal name, return here, don't do anything.
8103 fname
= find_end_event(arg
, group
!= AUGROUP_ALL
);
8107 fname
= skipwhite(fname
);
8110 * Loop over the events.
8112 while (*arg
&& !vim_iswhite(*arg
))
8113 if (apply_autocmds_group(event_name2nr(arg
, &arg
),
8114 fname
, NULL
, TRUE
, group
, curbuf
, NULL
))
8115 nothing_done
= FALSE
;
8117 if (nothing_done
&& do_msg
)
8118 MSG(_("No matching autocommands"));
8121 return aborting() ? FAIL
: OK
;
8128 * ":doautoall": execute autocommands for each loaded buffer.
8139 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8140 * equal to curbuf, but for some buffers there may not be a window.
8141 * So we change the buffer for the current window for a moment. This
8142 * gives problems when the autocommands make changes to the list of
8143 * buffers or windows...
8145 for (buf
= firstbuf
; buf
!= NULL
; buf
= buf
->b_next
)
8147 if (curbuf
->b_ml
.ml_mfp
!= NULL
)
8149 /* find a window for this buffer and save some values */
8150 aucmd_prepbuf(&aco
, buf
);
8152 /* execute the autocommands for this buffer */
8153 retval
= do_doautocmd(eap
->arg
, FALSE
);
8155 /* Execute the modeline settings, but don't set window-local
8156 * options if we are using the current window for another buffer. */
8157 do_modelines(aco
.save_curwin
== NULL
? OPT_NOWIN
: 0);
8159 /* restore the current window */
8160 aucmd_restbuf(&aco
);
8162 /* stop if there is some error or buffer was deleted */
8163 if (retval
== FAIL
|| !buf_valid(buf
))
8168 check_cursor(); /* just in case lines got deleted */
8172 * Prepare for executing autocommands for (hidden) buffer "buf".
8173 * Search a window for the current buffer. Save the cursor position and
8175 * Set "curbuf" and "curwin" to match "buf".
8176 * When FEAT_AUTOCMD is not defined another version is used, see below.
8179 aucmd_prepbuf(aco
, buf
)
8180 aco_save_T
*aco
; /* structure to save values in */
8181 buf_T
*buf
; /* new curbuf */
8185 aco
->new_curbuf
= buf
;
8187 /* Find a window that is for the new buffer */
8188 if (buf
== curbuf
) /* be quick when buf is curbuf */
8192 for (win
= firstwin
; win
!= NULL
; win
= win
->w_next
)
8193 if (win
->w_buffer
== buf
)
8200 * Prefer to use an existing window for the buffer, it has the least side
8201 * effects (esp. if "buf" is curbuf).
8202 * Otherwise, use curwin for "buf". It might make some items in the
8203 * window invalid. At least save the cursor and topline.
8207 /* there is a window for "buf", make it the curwin */
8208 aco
->save_curwin
= curwin
;
8210 aco
->save_buf
= win
->w_buffer
;
8211 aco
->new_curwin
= win
;
8215 /* there is no window for "buf", use curwin */
8216 aco
->save_curwin
= NULL
;
8217 aco
->save_buf
= curbuf
;
8218 --curbuf
->b_nwindows
;
8219 curwin
->w_buffer
= buf
;
8222 /* save cursor and topline, set them to safe values */
8223 aco
->save_cursor
= curwin
->w_cursor
;
8224 curwin
->w_cursor
.lnum
= 1;
8225 curwin
->w_cursor
.col
= 0;
8226 aco
->save_topline
= curwin
->w_topline
;
8227 curwin
->w_topline
= 1;
8229 aco
->save_topfill
= curwin
->w_topfill
;
8230 curwin
->w_topfill
= 0;
8238 * Cleanup after executing autocommands for a (hidden) buffer.
8239 * Restore the window as it was (if possible).
8240 * When FEAT_AUTOCMD is not defined another version is used, see below.
8244 aco_save_T
*aco
; /* structure holding saved values */
8246 if (aco
->save_curwin
!= NULL
)
8248 /* restore curwin */
8250 if (win_valid(aco
->save_curwin
))
8253 /* restore the buffer which was previously edited by curwin, if
8254 * it's still the same window and it's valid */
8255 if (curwin
== aco
->new_curwin
8256 && buf_valid(aco
->save_buf
)
8257 && aco
->save_buf
->b_ml
.ml_mfp
!= NULL
)
8259 --curbuf
->b_nwindows
;
8260 curbuf
= aco
->save_buf
;
8261 curwin
->w_buffer
= curbuf
;
8262 ++curbuf
->b_nwindows
;
8265 curwin
= aco
->save_curwin
;
8266 curbuf
= curwin
->w_buffer
;
8271 /* restore buffer for curwin if it still exists and is loaded */
8272 if (buf_valid(aco
->save_buf
) && aco
->save_buf
->b_ml
.ml_mfp
!= NULL
)
8274 --curbuf
->b_nwindows
;
8275 curbuf
= aco
->save_buf
;
8276 curwin
->w_buffer
= curbuf
;
8277 ++curbuf
->b_nwindows
;
8278 curwin
->w_cursor
= aco
->save_cursor
;
8280 /* check topline < line_count, in case lines got deleted */
8281 if (aco
->save_topline
<= curbuf
->b_ml
.ml_line_count
)
8283 curwin
->w_topline
= aco
->save_topline
;
8285 curwin
->w_topfill
= aco
->save_topfill
;
8290 curwin
->w_topline
= curbuf
->b_ml
.ml_line_count
;
8292 curwin
->w_topfill
= 0;
8299 static int autocmd_nested
= FALSE
;
8302 * Execute autocommands for "event" and file name "fname".
8303 * Return TRUE if some commands were executed.
8306 apply_autocmds(event
, fname
, fname_io
, force
, buf
)
8308 char_u
*fname
; /* NULL or empty means use actual file name */
8309 char_u
*fname_io
; /* fname to use for <afile> on cmdline */
8310 int force
; /* when TRUE, ignore autocmd_busy */
8311 buf_T
*buf
; /* buffer for <abuf> */
8313 return apply_autocmds_group(event
, fname
, fname_io
, force
,
8314 AUGROUP_ALL
, buf
, NULL
);
8318 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8319 * setting v:filearg.
8322 apply_autocmds_exarg(event
, fname
, fname_io
, force
, buf
, eap
)
8330 return apply_autocmds_group(event
, fname
, fname_io
, force
,
8331 AUGROUP_ALL
, buf
, eap
);
8335 * Like apply_autocmds(), but handles the caller's retval. If the script
8336 * processing is being aborted or if retval is FAIL when inside a try
8337 * conditional, no autocommands are executed. If otherwise the autocommands
8338 * cause the script to be aborted, retval is set to FAIL.
8341 apply_autocmds_retval(event
, fname
, fname_io
, force
, buf
, retval
)
8343 char_u
*fname
; /* NULL or empty means use actual file name */
8344 char_u
*fname_io
; /* fname to use for <afile> on cmdline */
8345 int force
; /* when TRUE, ignore autocmd_busy */
8346 buf_T
*buf
; /* buffer for <abuf> */
8347 int *retval
; /* pointer to caller's retval */
8352 if (should_abort(*retval
))
8356 did_cmd
= apply_autocmds_group(event
, fname
, fname_io
, force
,
8357 AUGROUP_ALL
, buf
, NULL
);
8368 * Return TRUE when there is a CursorHold autocommand defined.
8373 return (first_autopat
[(int)(get_real_state() == NORMAL_BUSY
8374 ? EVENT_CURSORHOLD
: EVENT_CURSORHOLDI
)] != NULL
);
8378 * Return TRUE if the CursorHold event can be triggered.
8381 trigger_cursorhold()
8385 if (!did_cursorhold
&& has_cursorhold() && !Recording
8386 #ifdef FEAT_INS_EXPAND
8387 && !ins_compl_active()
8391 state
= get_real_state();
8392 if (state
== NORMAL_BUSY
|| (state
& INSERT
) != 0)
8399 * Return TRUE when there is a CursorMoved autocommand defined.
8404 return (first_autopat
[(int)EVENT_CURSORMOVED
] != NULL
);
8408 * Return TRUE when there is a CursorMovedI autocommand defined.
8413 return (first_autopat
[(int)EVENT_CURSORMOVEDI
] != NULL
);
8417 apply_autocmds_group(event
, fname
, fname_io
, force
, group
, buf
, eap
)
8419 char_u
*fname
; /* NULL or empty means use actual file name */
8420 char_u
*fname_io
; /* fname to use for <afile> on cmdline, NULL means
8422 int force
; /* when TRUE, ignore autocmd_busy */
8423 int group
; /* group ID, or AUGROUP_ALL */
8424 buf_T
*buf
; /* buffer for <abuf> */
8425 exarg_T
*eap
; /* command arguments */
8427 char_u
*sfname
= NULL
; /* short file name */
8432 char_u
*save_sourcing_name
;
8433 linenr_T save_sourcing_lnum
;
8434 char_u
*save_autocmd_fname
;
8435 int save_autocmd_bufnr
;
8436 char_u
*save_autocmd_match
;
8437 int save_autocmd_busy
;
8438 int save_autocmd_nested
;
8439 static int nesting
= 0;
8443 scid_T save_current_SID
;
8444 void *save_funccalp
;
8445 char_u
*save_cmdarg
;
8448 static int filechangeshell_busy
= FALSE
;
8450 proftime_T wait_time
;
8454 * Quickly return if there are no autocommands for this event or
8455 * autocommands are blocked.
8457 if (first_autopat
[(int)event
] == NULL
|| autocmd_block
> 0)
8461 * When autocommands are busy, new autocommands are only executed when
8462 * explicitly enabled with the "nested" flag.
8464 if (autocmd_busy
&& !(force
|| autocmd_nested
))
8469 * Quickly return when immediately aborting on error, or when an interrupt
8470 * occurred or an exception was thrown but not caught.
8477 * FileChangedShell never nests, because it can create an endless loop.
8479 if (filechangeshell_busy
&& (event
== EVENT_FILECHANGEDSHELL
8480 || event
== EVENT_FILECHANGEDSHELLPOST
))
8484 * Ignore events in 'eventignore'.
8486 if (event_ignored(event
))
8490 * Allow nesting of autocommands, but restrict the depth, because it's
8491 * possible to create an endless loop.
8495 EMSG(_("E218: autocommand nesting too deep"));
8500 * Check if these autocommands are disabled. Used when doing ":all" or
8503 if ( (autocmd_no_enter
8504 && (event
== EVENT_WINENTER
|| event
== EVENT_BUFENTER
))
8505 || (autocmd_no_leave
8506 && (event
== EVENT_WINLEAVE
|| event
== EVENT_BUFLEAVE
)))
8510 * Save the autocmd_* variables and info about the current buffer.
8512 save_autocmd_fname
= autocmd_fname
;
8513 save_autocmd_bufnr
= autocmd_bufnr
;
8514 save_autocmd_match
= autocmd_match
;
8515 save_autocmd_busy
= autocmd_busy
;
8516 save_autocmd_nested
= autocmd_nested
;
8517 save_changed
= curbuf
->b_changed
;
8518 old_curbuf
= curbuf
;
8521 * Set the file name to be used for <afile>.
8523 if (fname_io
== NULL
)
8525 if (fname
!= NULL
&& *fname
!= NUL
)
8526 autocmd_fname
= fname
;
8527 else if (buf
!= NULL
)
8528 autocmd_fname
= buf
->b_fname
;
8530 autocmd_fname
= NULL
;
8533 autocmd_fname
= fname_io
;
8536 * Set the buffer number to be used for <abuf>.
8541 autocmd_bufnr
= buf
->b_fnum
;
8544 * When the file name is NULL or empty, use the file name of buffer "buf".
8545 * Always use the full path of the file name to match with, in case
8546 * "allow_dirs" is set.
8548 if (fname
== NULL
|| *fname
== NUL
)
8555 if (event
== EVENT_SYNTAX
)
8556 fname
= buf
->b_p_syn
;
8559 if (event
== EVENT_FILETYPE
)
8560 fname
= buf
->b_p_ft
;
8563 if (buf
->b_sfname
!= NULL
)
8564 sfname
= vim_strsave(buf
->b_sfname
);
8565 fname
= buf
->b_ffname
;
8569 fname
= (char_u
*)"";
8570 fname
= vim_strsave(fname
); /* make a copy, so we can change it */
8574 sfname
= vim_strsave(fname
);
8575 /* Don't try expanding FileType, Syntax, WindowID or QuickFixCmd* */
8576 if (event
== EVENT_FILETYPE
8577 || event
== EVENT_SYNTAX
8578 || event
== EVENT_REMOTEREPLY
8579 || event
== EVENT_SPELLFILEMISSING
8580 || event
== EVENT_QUICKFIXCMDPRE
8581 || event
== EVENT_QUICKFIXCMDPOST
)
8582 fname
= vim_strsave(fname
);
8584 fname
= FullName_save(fname
, FALSE
);
8586 if (fname
== NULL
) /* out of memory */
8593 #ifdef BACKSLASH_IN_FILENAME
8595 * Replace all backslashes with forward slashes. This makes the
8596 * autocommand patterns portable between Unix and MS-DOS.
8599 forward_slash(sfname
);
8600 forward_slash(fname
);
8604 /* remove version for correct match */
8606 vms_remove_version(sfname
);
8607 vms_remove_version(fname
);
8611 * Set the name to be used for <amatch>.
8613 autocmd_match
= fname
;
8616 /* Don't redraw while doing auto commands. */
8617 ++RedrawingDisabled
;
8618 save_sourcing_name
= sourcing_name
;
8619 sourcing_name
= NULL
; /* don't free this one */
8620 save_sourcing_lnum
= sourcing_lnum
;
8621 sourcing_lnum
= 0; /* no line number here */
8624 save_current_SID
= current_SID
;
8626 # ifdef FEAT_PROFILE
8627 if (do_profiling
== PROF_YES
)
8628 prof_child_enter(&wait_time
); /* doesn't count for the caller itself */
8631 /* Don't use local function variables, if called from a function */
8632 save_funccalp
= save_funccal();
8636 * When starting to execute autocommands, save the search patterns.
8640 save_search_patterns();
8642 did_filetype
= keep_filetype
;
8646 * Note that we are applying autocmds. Some commands need to know.
8648 autocmd_busy
= TRUE
;
8649 filechangeshell_busy
= (event
== EVENT_FILECHANGEDSHELL
);
8650 ++nesting
; /* see matching decrement below */
8652 /* Remember that FileType was triggered. Used for did_filetype(). */
8653 if (event
== EVENT_FILETYPE
)
8654 did_filetype
= TRUE
;
8656 tail
= gettail(fname
);
8658 /* Find first autocommand that matches */
8659 patcmd
.curpat
= first_autopat
[(int)event
];
8660 patcmd
.nextcmd
= NULL
;
8661 patcmd
.group
= group
;
8662 patcmd
.fname
= fname
;
8663 patcmd
.sfname
= sfname
;
8665 patcmd
.event
= event
;
8666 patcmd
.arg_bufnr
= autocmd_bufnr
;
8668 auto_next_pat(&patcmd
, FALSE
);
8670 /* found one, start executing the autocommands */
8671 if (patcmd
.curpat
!= NULL
)
8673 /* add to active_apc_list */
8674 patcmd
.next
= active_apc_list
;
8675 active_apc_list
= &patcmd
;
8678 /* set v:cmdarg (only when there is a matching pattern) */
8679 save_cmdbang
= get_vim_var_nr(VV_CMDBANG
);
8682 save_cmdarg
= set_cmdarg(eap
, NULL
);
8683 set_vim_var_nr(VV_CMDBANG
, (long)eap
->forceit
);
8686 save_cmdarg
= NULL
; /* avoid gcc warning */
8689 /* mark the last pattern, to avoid an endless loop when more patterns
8690 * are added when executing autocommands */
8691 for (ap
= patcmd
.curpat
; ap
->next
!= NULL
; ap
= ap
->next
)
8694 check_lnums(TRUE
); /* make sure cursor and topline are valid */
8695 do_cmdline(NULL
, getnextac
, (void *)&patcmd
,
8696 DOCMD_NOWAIT
|DOCMD_VERBOSE
|DOCMD_REPEAT
);
8700 (void)set_cmdarg(NULL
, save_cmdarg
);
8701 set_vim_var_nr(VV_CMDBANG
, save_cmdbang
);
8704 /* delete from active_apc_list */
8705 if (active_apc_list
== &patcmd
) /* just in case */
8706 active_apc_list
= patcmd
.next
;
8709 --RedrawingDisabled
;
8710 autocmd_busy
= save_autocmd_busy
;
8711 filechangeshell_busy
= FALSE
;
8712 autocmd_nested
= save_autocmd_nested
;
8713 vim_free(sourcing_name
);
8714 sourcing_name
= save_sourcing_name
;
8715 sourcing_lnum
= save_sourcing_lnum
;
8716 autocmd_fname
= save_autocmd_fname
;
8717 autocmd_bufnr
= save_autocmd_bufnr
;
8718 autocmd_match
= save_autocmd_match
;
8720 current_SID
= save_current_SID
;
8721 restore_funccal(save_funccalp
);
8722 # ifdef FEAT_PROFILE
8723 if (do_profiling
== PROF_YES
)
8724 prof_child_exit(&wait_time
);
8729 --nesting
; /* see matching increment above */
8732 * When stopping to execute autocommands, restore the search patterns and
8737 restore_search_patterns();
8739 did_filetype
= FALSE
;
8743 * Some events don't set or reset the Changed flag.
8744 * Check if still in the same buffer!
8746 if (curbuf
== old_curbuf
8747 && (event
== EVENT_BUFREADPOST
8748 || event
== EVENT_BUFWRITEPOST
8749 || event
== EVENT_FILEAPPENDPOST
8750 || event
== EVENT_VIMLEAVE
8751 || event
== EVENT_VIMLEAVEPRE
))
8754 if (curbuf
->b_changed
!= save_changed
)
8755 need_maketitle
= TRUE
;
8757 curbuf
->b_changed
= save_changed
;
8760 au_cleanup(); /* may really delete removed patterns/commands now */
8763 /* When wiping out a buffer make sure all its buffer-local autocommands
8765 if (event
== EVENT_BUFWIPEOUT
&& buf
!= NULL
)
8766 aubuflocal_remove(buf
);
8772 * Find next autocommand pattern that matches.
8775 auto_next_pat(apc
, stop_at_last
)
8777 int stop_at_last
; /* stop when 'last' flag is set */
8784 vim_free(sourcing_name
);
8785 sourcing_name
= NULL
;
8787 for (ap
= apc
->curpat
; ap
!= NULL
&& !got_int
; ap
= ap
->next
)
8791 /* only use a pattern when it has not been removed, has commands and
8792 * the group matches. For buffer-local autocommands only check the
8794 if (ap
->pat
!= NULL
&& ap
->cmds
!= NULL
8795 && (apc
->group
== AUGROUP_ALL
|| apc
->group
== ap
->group
))
8797 /* execution-condition */
8798 if (ap
->buflocal_nr
== 0
8799 ? (match_file_pat(NULL
, ap
->reg_prog
, apc
->fname
,
8800 apc
->sfname
, apc
->tail
, ap
->allow_dirs
))
8801 : ap
->buflocal_nr
== apc
->arg_bufnr
)
8803 name
= event_nr2name(apc
->event
);
8804 s
= _("%s Auto commands for \"%s\"");
8805 sourcing_name
= alloc((unsigned)(STRLEN(s
)
8806 + STRLEN(name
) + ap
->patlen
+ 1));
8807 if (sourcing_name
!= NULL
)
8809 sprintf((char *)sourcing_name
, s
,
8810 (char *)name
, (char *)ap
->pat
);
8814 smsg((char_u
*)_("Executing %s"), sourcing_name
);
8820 apc
->nextcmd
= ap
->cmds
;
8821 /* mark last command */
8822 for (cp
= ap
->cmds
; cp
->next
!= NULL
; cp
= cp
->next
)
8827 if (apc
->curpat
!= NULL
) /* found a match */
8830 if (stop_at_last
&& ap
->last
)
8836 * Get next autocommand command.
8837 * Called by do_cmdline() to get the next line for ":if".
8838 * Returns allocated string, or NULL for end of autocommands.
8842 getnextac(c
, cookie
, indent
)
8843 int c
; /* not used */
8845 int indent
; /* not used */
8847 AutoPatCmd
*acp
= (AutoPatCmd
*)cookie
;
8851 /* Can be called again after returning the last line. */
8852 if (acp
->curpat
== NULL
)
8855 /* repeat until we find an autocommand to execute */
8858 /* skip removed commands */
8859 while (acp
->nextcmd
!= NULL
&& acp
->nextcmd
->cmd
== NULL
)
8860 if (acp
->nextcmd
->last
)
8861 acp
->nextcmd
= NULL
;
8863 acp
->nextcmd
= acp
->nextcmd
->next
;
8865 if (acp
->nextcmd
!= NULL
)
8868 /* at end of commands, find next pattern that matches */
8869 if (acp
->curpat
->last
)
8872 acp
->curpat
= acp
->curpat
->next
;
8873 if (acp
->curpat
!= NULL
)
8874 auto_next_pat(acp
, TRUE
);
8875 if (acp
->curpat
== NULL
)
8883 verbose_enter_scroll();
8884 smsg((char_u
*)_("autocommand %s"), ac
->cmd
);
8885 msg_puts((char_u
*)"\n"); /* don't overwrite this either */
8886 verbose_leave_scroll();
8888 retval
= vim_strsave(ac
->cmd
);
8889 autocmd_nested
= ac
->nested
;
8891 current_SID
= ac
->scriptID
;
8894 acp
->nextcmd
= NULL
;
8896 acp
->nextcmd
= ac
->next
;
8901 * Return TRUE if there is a matching autocommand for "fname".
8902 * To account for buffer-local autocommands, function needs to know
8903 * in which buffer the file will be opened.
8906 has_autocmd(event
, sfname
, buf
)
8913 char_u
*tail
= gettail(sfname
);
8916 fname
= FullName_save(sfname
, FALSE
);
8920 #ifdef BACKSLASH_IN_FILENAME
8922 * Replace all backslashes with forward slashes. This makes the
8923 * autocommand patterns portable between Unix and MS-DOS.
8925 sfname
= vim_strsave(sfname
);
8927 forward_slash(sfname
);
8928 forward_slash(fname
);
8931 for (ap
= first_autopat
[(int)event
]; ap
!= NULL
; ap
= ap
->next
)
8932 if (ap
->pat
!= NULL
&& ap
->cmds
!= NULL
8933 && (ap
->buflocal_nr
== 0
8934 ? match_file_pat(NULL
, ap
->reg_prog
,
8935 fname
, sfname
, tail
, ap
->allow_dirs
)
8936 : buf
!= NULL
&& ap
->buflocal_nr
== buf
->b_fnum
8944 #ifdef BACKSLASH_IN_FILENAME
8951 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
8953 * Function given to ExpandGeneric() to obtain the list of autocommand group
8958 get_augroup_name(xp
, idx
)
8962 if (idx
== augroups
.ga_len
) /* add "END" add the end */
8963 return (char_u
*)"END";
8964 if (idx
>= augroups
.ga_len
) /* end of list */
8966 if (AUGROUP_NAME(idx
) == NULL
) /* skip deleted entries */
8967 return (char_u
*)"";
8968 return AUGROUP_NAME(idx
); /* return a name */
8971 static int include_groups
= FALSE
;
8974 set_context_in_autocmd(xp
, arg
, doautocmd
)
8977 int doautocmd
; /* TRUE for :doautocmd, FALSE for :autocmd */
8982 /* check for a group name, skip it if present */
8983 include_groups
= FALSE
;
8985 group
= au_get_grouparg(&arg
);
8986 if (group
== AUGROUP_ERROR
)
8988 /* If there only is a group name that's what we expand. */
8989 if (*arg
== NUL
&& group
!= AUGROUP_ALL
&& !vim_iswhite(arg
[-1]))
8992 group
= AUGROUP_ALL
;
8995 /* skip over event name */
8996 for (p
= arg
; *p
!= NUL
&& !vim_iswhite(*p
); ++p
)
9001 if (group
== AUGROUP_ALL
)
9002 include_groups
= TRUE
;
9003 xp
->xp_context
= EXPAND_EVENTS
; /* expand event name */
9004 xp
->xp_pattern
= arg
;
9008 /* skip over pattern */
9010 while (*arg
&& (!vim_iswhite(*arg
) || arg
[-1] == '\\'))
9013 return arg
; /* expand (next) command */
9016 xp
->xp_context
= EXPAND_FILES
; /* expand file names */
9018 xp
->xp_context
= EXPAND_NOTHING
; /* pattern is not expanded */
9023 * Function given to ExpandGeneric() to obtain the list of event names.
9027 get_event_name(xp
, idx
)
9031 if (idx
< augroups
.ga_len
) /* First list group names, if wanted */
9033 if (!include_groups
|| AUGROUP_NAME(idx
) == NULL
)
9034 return (char_u
*)""; /* skip deleted entries */
9035 return AUGROUP_NAME(idx
); /* return a name */
9037 return (char_u
*)event_names
[idx
- augroups
.ga_len
].name
;
9040 #endif /* FEAT_CMDL_COMPL */
9043 * Return TRUE if autocmd is supported.
9046 autocmd_supported(name
)
9051 return (event_name2nr(name
, &p
) != NUM_EVENTS
);
9055 * Return TRUE if an autocommand is defined for a group, event and
9056 * pattern: The group can be omitted to accept any group. "event" and "pattern"
9057 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
9058 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
9060 * exists("#Group") or
9061 * exists("#Group#Event") or
9062 * exists("#Group#Event#pat") or
9063 * exists("#Event") or
9064 * exists("#Event#pat")
9071 char_u
*pattern
= NULL
;
9076 buf_T
*buflocal_buf
= NULL
;
9080 /* Make a copy so that we can change the '#' chars to a NUL. */
9081 arg_save
= vim_strsave(arg
);
9082 if (arg_save
== NULL
)
9084 p
= vim_strchr(arg_save
, '#');
9088 /* First, look for an autocmd group name */
9089 group
= au_find_group(arg_save
);
9090 if (group
== AUGROUP_ERROR
)
9092 /* Didn't match a group name, assume the first argument is an event. */
9093 group
= AUGROUP_ALL
;
9094 event_name
= arg_save
;
9100 /* "Group": group name is present and it's recognized */
9105 /* Must be "Group#Event" or "Group#Event#pat". */
9107 p
= vim_strchr(event_name
, '#');
9109 *p
++ = NUL
; /* "Group#Event#pat" */
9112 pattern
= p
; /* "pattern" is NULL when there is no pattern */
9114 /* find the index (enum) for the event name */
9115 event
= event_name2nr(event_name
, &p
);
9117 /* return FALSE if the event name is not recognized */
9118 if (event
== NUM_EVENTS
)
9121 /* Find the first autocommand for this event.
9122 * If there isn't any, return FALSE;
9123 * If there is one and no pattern given, return TRUE; */
9124 ap
= first_autopat
[(int)event
];
9127 if (pattern
== NULL
)
9133 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9134 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9135 if (STRICMP(pattern
, "<buffer>") == 0)
9136 buflocal_buf
= curbuf
;
9138 /* Check if there is an autocommand with the given pattern. */
9139 for ( ; ap
!= NULL
; ap
= ap
->next
)
9140 /* only use a pattern when it has not been removed and has commands. */
9141 /* For buffer-local autocommands, fnamecmp() works fine. */
9142 if (ap
->pat
!= NULL
&& ap
->cmds
!= NULL
9143 && (group
== AUGROUP_ALL
|| ap
->group
== group
)
9144 && (buflocal_buf
== NULL
9145 ? fnamecmp(ap
->pat
, pattern
) == 0
9146 : ap
->buflocal_nr
== buflocal_buf
->b_fnum
))
9157 #else /* FEAT_AUTOCMD */
9160 * Prepare for executing commands for (hidden) buffer "buf".
9161 * This is the non-autocommand version, it simply saves "curbuf" and sets
9162 * "curbuf" and "curwin" to match "buf".
9165 aucmd_prepbuf(aco
, buf
)
9166 aco_save_T
*aco
; /* structure to save values in */
9167 buf_T
*buf
; /* new curbuf */
9169 aco
->save_buf
= buf
;
9171 curwin
->w_buffer
= buf
;
9175 * Restore after executing commands for a (hidden) buffer.
9176 * This is the non-autocommand version.
9180 aco_save_T
*aco
; /* structure holding saved values */
9182 curbuf
= aco
->save_buf
;
9183 curwin
->w_buffer
= curbuf
;
9186 #endif /* FEAT_AUTOCMD */
9189 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9191 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9192 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9193 * vim_regcomp() often.
9194 * Used for autocommands and 'wildignore'.
9195 * Returns TRUE if there is a match, FALSE otherwise.
9198 match_file_pat(pattern
, prog
, fname
, sfname
, tail
, allow_dirs
)
9199 char_u
*pattern
; /* pattern to match with */
9200 regprog_T
*prog
; /* pre-compiled regprog or NULL */
9201 char_u
*fname
; /* full path of file name */
9202 char_u
*sfname
; /* short file name or NULL */
9203 char_u
*tail
; /* tail of path */
9204 int allow_dirs
; /* allow matching with dir */
9206 regmatch_T regmatch
;
9208 #ifdef FEAT_OSFILETYPE
9209 int no_pattern
= FALSE
; /* TRUE if check is filetype only */
9215 #ifdef CASE_INSENSITIVE_FILENAME
9216 regmatch
.rm_ic
= TRUE
; /* Always ignore case */
9218 regmatch
.rm_ic
= FALSE
; /* Don't ever ignore case */
9220 #ifdef FEAT_OSFILETYPE
9221 if (*pattern
== '<')
9223 /* There is a filetype condition specified with this pattern.
9224 * Check the filetype matches first. If not, don't bother with the
9225 * pattern (set regprog to NULL).
9226 * Always use magic for the regexp.
9229 for (type_start
= pattern
+ 1; (c
= *pattern
); pattern
++)
9231 if ((c
== ';' || c
== '>') && match
== FALSE
)
9233 *pattern
= NUL
; /* Terminate the string */
9234 match
= mch_check_filetype(fname
, type_start
);
9235 *pattern
= c
; /* Restore the terminator */
9236 type_start
= pattern
+ 1;
9242 /* (c should never be NUL, but check anyway) */
9243 if (match
== FALSE
|| c
== NUL
)
9244 regmatch
.regprog
= NULL
; /* Doesn't match - don't check pat. */
9245 else if (*pattern
== NUL
)
9247 regmatch
.regprog
= NULL
; /* Vim will try to free regprog later */
9248 no_pattern
= TRUE
; /* Always matches - don't check pat. */
9251 regmatch
.regprog
= vim_regcomp(pattern
+ 1, RE_MAGIC
);
9257 regmatch
.regprog
= prog
;
9259 regmatch
.regprog
= vim_regcomp(pattern
, RE_MAGIC
);
9263 * Try for a match with the pattern with:
9264 * 1. the full file name, when the pattern has a '/'.
9265 * 2. the short file name, when the pattern has a '/'.
9266 * 3. the tail of the file name, when the pattern has no '/'.
9269 #ifdef FEAT_OSFILETYPE
9270 /* If the check is for a filetype only and we don't care
9271 * about the path then skip all the regexp stuff.
9275 (regmatch
.regprog
!= NULL
9277 && (vim_regexec(®match
, fname
, (colnr_T
)0)
9279 && vim_regexec(®match
, sfname
, (colnr_T
)0))))
9280 || (!allow_dirs
&& vim_regexec(®match
, tail
, (colnr_T
)0)))))
9284 vim_free(regmatch
.regprog
);
9289 #if defined(FEAT_WILDIGN) || defined(PROTO)
9291 * Return TRUE if a file matches with a pattern in "list".
9292 * "list" is a comma-separated list of patterns, like 'wildignore'.
9293 * "sfname" is the short file name or NULL, "ffname" the long file name.
9296 match_file_list(list
, sfname
, ffname
)
9308 tail
= gettail(sfname
);
9310 /* try all patterns in 'wildignore' */
9314 copy_option_part(&p
, buf
, 100, ",");
9315 regpat
= file_pat_to_reg_pat(buf
, NULL
, &allow_dirs
, FALSE
);
9318 match
= match_file_pat(regpat
, NULL
, ffname
, sfname
,
9319 tail
, (int)allow_dirs
);
9329 * Convert the given pattern "pat" which has shell style wildcards in it, into
9330 * a regular expression, and return the result in allocated memory. If there
9331 * is a directory path separator to be matched, then TRUE is put in
9332 * allow_dirs, otherwise FALSE is put there -- webb.
9333 * Handle backslashes before special characters, like "\*" and "\ ".
9335 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9336 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9338 * Returns NULL when out of memory.
9342 file_pat_to_reg_pat(pat
, pat_end
, allow_dirs
, no_bslash
)
9344 char_u
*pat_end
; /* first char after pattern or NULL */
9345 char *allow_dirs
; /* Result passed back out in here */
9346 int no_bslash
; /* Don't use a backward slash as pathsep */
9354 int add_dollar
= TRUE
;
9355 #ifdef FEAT_OSFILETYPE
9356 int check_length
= 0;
9359 if (allow_dirs
!= NULL
)
9360 *allow_dirs
= FALSE
;
9361 if (pat_end
== NULL
)
9362 pat_end
= pat
+ STRLEN(pat
);
9364 #ifdef FEAT_OSFILETYPE
9365 /* Find out how much of the string is the filetype check */
9368 /* Count chars until the next '>' */
9369 for (p
= pat
+ 1; p
< pat_end
&& *p
!= '>'; p
++)
9373 /* Pattern is of the form <.*>.* */
9374 check_length
= p
- pat
+ 1;
9375 if (p
+ 1 >= pat_end
)
9377 /* The 'pattern' is a filetype check ONLY */
9378 reg_pat
= (char_u
*)alloc(check_length
+ 1);
9379 if (reg_pat
!= NULL
)
9381 mch_memmove(reg_pat
, pat
, (size_t)check_length
);
9382 reg_pat
[check_length
] = NUL
;
9387 /* else: there was no closing '>' - assume it was a normal pattern */
9390 pat
+= check_length
;
9391 size
= 2 + check_length
;
9393 size
= 2; /* '^' at start, '$' at end */
9396 for (p
= pat
; p
< pat_end
; p
++)
9406 size
+= 2; /* extra backslash */
9408 #ifdef BACKSLASH_IN_FILENAME
9411 size
+= 4; /* could become "[\/]" */
9417 if (enc_dbcs
!= 0 && (*mb_ptr2len
)(p
) > 1)
9426 reg_pat
= alloc(size
+ 1);
9427 if (reg_pat
== NULL
)
9430 #ifdef FEAT_OSFILETYPE
9431 /* Copy the type check in to the start. */
9433 mch_memmove(reg_pat
, pat
- check_length
, (size_t)check_length
);
9440 while (pat
[0] == '*' && pat
< pat_end
- 1)
9447 while (endp
- pat
> 0 && *endp
== '*')
9451 for (p
= pat
; *p
&& nested
>= 0 && p
<= endp
; p
++)
9458 while (p
[1] == '*') /* "**" matches like "*" */
9463 if (allow_dirs
!= NULL
)
9468 reg_pat
[i
++] = '\\';
9480 #ifdef BACKSLASH_IN_FILENAME
9484 * "\x" to "\\x" e.g., "dir\file"
9485 * "\*" to "\\.*" e.g., "dir\*.c"
9486 * "\?" to "\\." e.g., "dir\??.c"
9487 * "\+" to "\+" e.g., "fileX\+.c"
9489 if ((vim_isfilec(p
[1]) || p
[1] == '*' || p
[1] == '?')
9493 reg_pat
[i
++] = '\\';
9496 if (allow_dirs
!= NULL
)
9503 #ifdef BACKSLASH_IN_FILENAME
9513 if (allow_dirs
!= NULL
&& vim_ispathsep(*p
)
9514 #ifdef BACKSLASH_IN_FILENAME
9515 && (!no_bslash
|| *p
!= '\\')
9519 reg_pat
[i
++] = '\\';
9523 #ifdef BACKSLASH_IN_FILENAME
9526 reg_pat
[i
++] = '\\';
9529 if (allow_dirs
!= NULL
)
9534 reg_pat
[i
++] = '\\';
9539 reg_pat
[i
++] = '\\';
9546 reg_pat
[i
++] = '\\';
9554 if (enc_dbcs
!= 0 && (*mb_ptr2len
)(p
) > 1)
9555 reg_pat
[i
++] = *p
++;
9558 if (allow_dirs
!= NULL
&& vim_ispathsep(*p
))
9570 EMSG(_("E219: Missing {."));
9572 EMSG(_("E220: Missing }."));