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 */
25 # include <limits.h> /* for SSIZE_MAX */
28 #if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
29 # include <utime.h> /* for struct utimbuf */
32 #define BUFSIZE 8192 /* size of normal write buffer */
33 #define SMBUFSIZE 256 /* size of emergency write buffer */
36 # define CRYPT_MAGIC "VimCrypt~01!" /* "01" is the version nr */
37 # define CRYPT_MAGIC_LEN 12 /* must be multiple of 4! */
40 /* Is there any system that doesn't have access()? */
41 #define USE_MCH_ACCESS
43 #if defined(sun) && defined(S_ISCHR)
44 # define OPEN_CHR_FILES
45 static int is_dev_fd_file(char_u
*fname
);
48 static char_u
*next_fenc
__ARGS((char_u
**pp
));
50 static char_u
*readfile_charconvert
__ARGS((char_u
*fname
, char_u
*fenc
, int *fdp
));
54 static void check_marks_read
__ARGS((void));
57 static char_u
*check_for_cryptkey
__ARGS((char_u
*cryptkey
, char_u
*ptr
, long *sizep
, long *filesizep
, int newfile
));
60 static void set_file_time
__ARGS((char_u
*fname
, time_t atime
, time_t mtime
));
62 static int set_rw_fname
__ARGS((char_u
*fname
, char_u
*sfname
));
63 static int msg_add_fileformat
__ARGS((int eol_type
));
64 static void msg_add_eol
__ARGS((void));
65 static int check_mtime
__ARGS((buf_T
*buf
, struct stat
*s
));
66 static int time_differs
__ARGS((long t1
, long t2
));
68 static int apply_autocmds_exarg
__ARGS((event_T event
, char_u
*fname
, char_u
*fname_io
, int force
, buf_T
*buf
, exarg_T
*eap
));
69 static int au_find_group
__ARGS((char_u
*name
));
71 # define AUGROUP_DEFAULT -1 /* default autocmd group */
72 # define AUGROUP_ERROR -2 /* errornouse autocmd group */
73 # define AUGROUP_ALL -3 /* all autocmd groups */
76 #if defined(FEAT_CRYPT) || defined(FEAT_MBYTE)
78 # define FIO_LATIN1 0x01 /* convert Latin1 */
79 # define FIO_UTF8 0x02 /* convert UTF-8 */
80 # define FIO_UCS2 0x04 /* convert UCS-2 */
81 # define FIO_UCS4 0x08 /* convert UCS-4 */
82 # define FIO_UTF16 0x10 /* convert UTF-16 */
84 # define FIO_CODEPAGE 0x20 /* convert MS-Windows codepage */
85 # define FIO_PUT_CP(x) (((x) & 0xffff) << 16) /* put codepage in top word */
86 # define FIO_GET_CP(x) (((x)>>16) & 0xffff) /* get codepage from top word */
89 # define FIO_MACROMAN 0x20 /* convert MacRoman */
91 # define FIO_ENDIAN_L 0x80 /* little endian */
92 # define FIO_ENCRYPTED 0x1000 /* encrypt written bytes */
93 # define FIO_NOCONVERT 0x2000 /* skip encoding conversion */
94 # define FIO_UCSBOM 0x4000 /* check for BOM at start of file */
95 # define FIO_ALL -1 /* allow all formats */
98 /* When converting, a read() or write() may leave some bytes to be converted
99 * for the next call. The value is guessed... */
100 #define CONV_RESTLEN 30
102 /* We have to guess how much a sequence of bytes may expand when converting
103 * with iconv() to be able to allocate a buffer. */
107 * Structure to pass arguments from buf_write() to buf_write_bytes().
111 int bw_fd
; /* file descriptor */
112 char_u
*bw_buf
; /* buffer with data to be written */
113 int bw_len
; /* length of data */
115 int bw_flags
; /* FIO_ flags */
118 char_u bw_rest
[CONV_RESTLEN
]; /* not converted bytes */
119 int bw_restlen
; /* nr of bytes in bw_rest[] */
120 int bw_first
; /* first write call */
121 char_u
*bw_conv_buf
; /* buffer for writing converted chars */
122 int bw_conv_buflen
; /* size of bw_conv_buf */
123 int bw_conv_error
; /* set for conversion error */
125 iconv_t bw_iconv_fd
; /* descriptor for iconv() or -1 */
130 static int buf_write_bytes
__ARGS((struct bw_info
*ip
));
133 static linenr_T readfile_linenr
__ARGS((linenr_T linecnt
, char_u
*p
, char_u
*endp
));
134 static int ucs2bytes
__ARGS((unsigned c
, char_u
**pp
, int flags
));
135 static int same_encoding
__ARGS((char_u
*a
, char_u
*b
));
136 static int get_fio_flags
__ARGS((char_u
*ptr
));
137 static char_u
*check_for_bom
__ARGS((char_u
*p
, long size
, int *lenp
, int flags
));
138 static int make_bom
__ARGS((char_u
*buf
, char_u
*name
));
140 static int get_win_fio_flags
__ARGS((char_u
*ptr
));
143 static int get_mac_fio_flags
__ARGS((char_u
*ptr
));
146 static int move_lines
__ARGS((buf_T
*frombuf
, buf_T
*tobuf
));
150 filemess(buf
, name
, s
, attr
)
160 msg_add_fname(buf
, name
); /* put file name in IObuff with quotes */
161 /* If it's extremely long, truncate it. */
162 if (STRLEN(IObuff
) > IOSIZE
- 80)
163 IObuff
[IOSIZE
- 80] = NUL
;
166 * For the first message may have to start a new line.
167 * For further ones overwrite the previous one, reset msg_scroll before
168 * calling filemess().
170 msg_scroll_save
= msg_scroll
;
171 if (shortmess(SHM_OVERALL
) && !exiting
&& p_verbose
== 0)
173 if (!msg_scroll
) /* wait a bit when overwriting an error msg */
174 check_for_delay(FALSE
);
176 msg_scroll
= msg_scroll_save
;
177 msg_scrolled_ign
= TRUE
;
178 /* may truncate the message to avoid a hit-return prompt */
179 msg_outtrans_attr(msg_may_trunc(FALSE
, IObuff
), attr
);
182 msg_scrolled_ign
= FALSE
;
186 * Read lines from file "fname" into the buffer after line "from".
188 * 1. We allocate blocks with lalloc, as big as possible.
189 * 2. Each block is filled with characters from the file with a single read().
190 * 3. The lines are inserted in the buffer with ml_append().
192 * (caller must check that fname != NULL, unless READ_STDIN is used)
194 * "lines_to_skip" is the number of lines that must be skipped
195 * "lines_to_read" is the number of lines that are appended
196 * When not recovering lines_to_skip is 0 and lines_to_read MAXLNUM.
199 * READ_NEW starting to edit a new buffer
200 * READ_FILTER reading filter output
201 * READ_STDIN read from stdin instead of a file
202 * READ_BUFFER read from curbuf instead of a file (converting after reading
204 * READ_DUMMY read into a dummy buffer (to check if file contents changed)
206 * return FAIL for failure, OK otherwise
209 readfile(fname
, sfname
, from
, lines_to_skip
, lines_to_read
, eap
, flags
)
213 linenr_T lines_to_skip
;
214 linenr_T lines_to_read
;
215 exarg_T
*eap
; /* can be NULL! */
219 int newfile
= (flags
& READ_NEW
);
221 int filtering
= (flags
& READ_FILTER
);
222 int read_stdin
= (flags
& READ_STDIN
);
223 int read_buffer
= (flags
& READ_BUFFER
);
224 int set_options
= newfile
|| read_buffer
225 || (eap
!= NULL
&& eap
->read_edit
);
226 linenr_T read_buf_lnum
= 1; /* next line to read from curbuf */
227 colnr_T read_buf_col
= 0; /* next char to read from this line */
229 linenr_T lnum
= from
;
230 char_u
*ptr
= NULL
; /* pointer into read buffer */
231 char_u
*buffer
= NULL
; /* read buffer */
232 char_u
*new_buffer
= NULL
; /* init to shut up gcc */
233 char_u
*line_start
= NULL
; /* init to shut up gcc */
234 int wasempty
; /* buffer was empty before reading */
239 int skip_read
= FALSE
;
241 char_u
*cryptkey
= NULL
;
243 int split
= 0; /* number of split lines */
244 #define UNKNOWN 0x0fffffff /* file size is unknown */
246 int error
= FALSE
; /* errors encountered */
247 int ff_error
= EOL_UNKNOWN
; /* file format with errors */
248 long linerest
= 0; /* remaining chars in line */
251 int swap_mode
= -1; /* protection bits for swap file */
255 int fileformat
= 0; /* end-of-line format */
256 int keep_fileformat
= FALSE
;
259 linenr_T skip_count
= 0;
260 linenr_T read_count
= 0;
261 int msg_save
= msg_scroll
;
262 linenr_T read_no_eol_lnum
= 0; /* non-zero lnum when last line of
263 * last read was missing the eol */
264 int try_mac
= (vim_strchr(p_ffs
, 'm') != NULL
);
265 int try_dos
= (vim_strchr(p_ffs
, 'd') != NULL
);
266 int try_unix
= (vim_strchr(p_ffs
, 'x') != NULL
);
267 int file_rewind
= FALSE
;
270 linenr_T conv_error
= 0; /* line nr with conversion error */
271 linenr_T illegal_byte
= 0; /* line nr with illegal byte */
272 int keep_dest_enc
= FALSE
; /* don't retry when char doesn't fit
273 in destination encoding */
274 int bad_char_behavior
= BAD_REPLACE
;
275 /* BAD_KEEP, BAD_DROP or character to
277 char_u
*tmpname
= NULL
; /* name of 'charconvert' output file */
279 char_u
*fenc
; /* fileencoding to use */
280 int fenc_alloced
; /* fenc_next is in allocated memory */
281 char_u
*fenc_next
= NULL
; /* next item in 'fencs' or NULL */
282 int advance_fenc
= FALSE
;
285 iconv_t iconv_fd
= (iconv_t
)-1; /* descriptor for iconv() or -1 */
287 int did_iconv
= FALSE
; /* TRUE when iconv() failed and trying
288 'charconvert' next */
291 int converted
= FALSE
; /* TRUE if conversion done */
292 int notconverted
= FALSE
; /* TRUE if conversion wanted but it
294 char_u conv_rest
[CONV_RESTLEN
];
295 int conv_restlen
= 0; /* nr of bytes in conv_rest[] */
298 write_no_eol_lnum
= 0; /* in case it was set by the previous read */
301 * If there is no file name yet, use the one for the read file.
302 * BF_NOTEDITED is set to reflect this.
303 * Don't do this for a read from a filter.
304 * Only do this when 'cpoptions' contains the 'f' flag.
306 if (curbuf
->b_ffname
== NULL
309 && vim_strchr(p_cpo
, CPO_FNAMER
) != NULL
310 && !(flags
& READ_DUMMY
))
312 if (set_rw_fname(fname
, sfname
) == FAIL
)
316 /* After reading a file the cursor line changes but we don't want to
317 * display the line. */
318 ex_no_reprint
= TRUE
;
320 /* don't display the file info for another buffer now */
321 need_fileinfo
= FALSE
;
324 * For Unix: Use the short file name whenever possible.
325 * Avoids problems with networks and when directory names are changed.
326 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
327 * another directory, which we don't detect.
331 #if defined(UNIX) || defined(__EMX__)
337 * The BufReadCmd and FileReadCmd events intercept the reading process by
338 * executing the associated commands instead.
340 if (!filtering
&& !read_stdin
&& !read_buffer
)
344 pos
= curbuf
->b_op_start
;
346 /* Set '[ mark to the line above where the lines go (line 1 if zero). */
347 curbuf
->b_op_start
.lnum
= ((from
== 0) ? 1 : from
);
348 curbuf
->b_op_start
.col
= 0;
352 if (apply_autocmds_exarg(EVENT_BUFREADCMD
, NULL
, sfname
,
355 return aborting() ? FAIL
: OK
;
360 else if (apply_autocmds_exarg(EVENT_FILEREADCMD
, sfname
, sfname
,
363 return aborting() ? FAIL
: OK
;
368 curbuf
->b_op_start
= pos
;
372 if ((shortmess(SHM_OVER
) || curbuf
->b_help
) && p_verbose
== 0)
373 msg_scroll
= FALSE
; /* overwrite previous file message */
375 msg_scroll
= TRUE
; /* don't overwrite previous file message */
378 * If the name ends in a path separator, we can't open it. Check here,
379 * because reading the file may actually work, but then creating the swap
380 * file may destroy it! Reported on MS-DOS and Win 95.
381 * If the name is too long we might crash further on, quit here.
383 if (fname
!= NULL
&& *fname
!= NUL
)
385 p
= fname
+ STRLEN(fname
);
386 if (after_pathsep(fname
, p
) || STRLEN(fname
) >= MAXPATHL
)
388 filemess(curbuf
, fname
, (char_u
*)_("Illegal file name"), 0);
390 msg_scroll
= msg_save
;
397 * On Unix it is possible to read a directory, so we have to
398 * check for it before the mch_open().
400 if (!read_stdin
&& !read_buffer
)
402 perm
= mch_getperm(fname
);
403 if (perm
>= 0 && !S_ISREG(perm
) /* not a regular file ... */
405 && !S_ISFIFO(perm
) /* ... or fifo */
408 && !S_ISSOCK(perm
) /* ... or socket */
410 # ifdef OPEN_CHR_FILES
411 && !(S_ISCHR(perm
) && is_dev_fd_file(fname
))
412 /* ... or a character special file named /dev/fd/<n> */
417 filemess(curbuf
, fname
, (char_u
*)_("is a directory"), 0);
419 filemess(curbuf
, fname
, (char_u
*)_("is not a file"), 0);
421 msg_scroll
= msg_save
;
425 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
427 * MS-Windows allows opening a device, but we will probably get stuck
430 if (!p_odev
&& mch_nodetype(fname
) == NODE_WRITABLE
)
432 filemess(curbuf
, fname
, (char_u
*)_("is a device (disabled with 'opendevice' option)"), 0);
434 msg_scroll
= msg_save
;
441 /* set default 'fileformat' */
444 if (eap
!= NULL
&& eap
->force_ff
!= 0)
445 set_fileformat(get_fileformat_force(curbuf
, eap
), OPT_LOCAL
);
446 else if (*p_ffs
!= NUL
)
447 set_fileformat(default_fileformat(), OPT_LOCAL
);
450 /* set or reset 'binary' */
451 if (eap
!= NULL
&& eap
->force_bin
!= 0)
453 int oldval
= curbuf
->b_p_bin
;
455 curbuf
->b_p_bin
= (eap
->force_bin
== FORCE_BIN
);
456 set_options_bin(oldval
, curbuf
->b_p_bin
, OPT_LOCAL
);
460 * When opening a new file we take the readonly flag from the file.
461 * Default is r/w, can be set to r/o below.
462 * Don't reset it when in readonly mode
463 * Only set/reset b_p_ro when BF_CHECK_RO is set.
465 check_readonly
= (newfile
&& (curbuf
->b_flags
& BF_CHECK_RO
));
466 if (check_readonly
&& !readonlymode
)
467 curbuf
->b_p_ro
= FALSE
;
469 if (newfile
&& !read_stdin
&& !read_buffer
)
471 /* Remember time of file.
472 * For RISCOS, also remember the filetype.
474 if (mch_stat((char *)fname
, &st
) >= 0)
476 buf_store_time(curbuf
, &st
, fname
);
477 curbuf
->b_mtime_read
= curbuf
->b_mtime
;
479 #if defined(RISCOS) && defined(FEAT_OSFILETYPE)
480 /* Read the filetype into the buffer local filetype option. */
481 mch_read_filetype(fname
);
485 * Use the protection bits of the original file for the swap file.
486 * This makes it possible for others to read the name of the
487 * edited file from the swapfile, but only if they can read the
489 * Remove the "write" and "execute" bits for group and others
490 * (they must not write the swapfile).
491 * Add the "read" and "write" bits for the user, otherwise we may
492 * not be able to write to the file ourselves.
493 * Setting the bits is done below, after creating the swap file.
495 swap_mode
= (st
.st_mode
& 0644) | 0600;
497 #ifdef FEAT_CW_EDITOR
498 /* Get the FSSpec on MacOS
499 * TODO: Update it properly when the buffer name changes
501 (void)GetFSSpecFromPath(curbuf
->b_ffname
, &curbuf
->b_FSSpec
);
504 curbuf
->b_fab_rfm
= st
.st_fab_rfm
;
505 curbuf
->b_fab_rat
= st
.st_fab_rat
;
506 curbuf
->b_fab_mrs
= st
.st_fab_mrs
;
512 curbuf
->b_mtime_read
= 0;
513 curbuf
->b_orig_size
= 0;
514 curbuf
->b_orig_mode
= 0;
517 /* Reset the "new file" flag. It will be set again below when the
518 * file doesn't exist. */
519 curbuf
->b_flags
&= ~(BF_NEW
| BF_NEW_W
);
523 * for UNIX: check readonly with perm and mch_access()
524 * for RISCOS: same as Unix, otherwise file gets re-datestamped!
525 * for MSDOS and Amiga: check readonly by trying to open the file for writing
527 file_readonly
= FALSE
;
530 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
531 /* Force binary I/O on stdin to avoid CR-LF -> LF conversion. */
532 setmode(0, O_BINARY
);
535 else if (!read_buffer
)
537 #ifdef USE_MCH_ACCESS
542 mch_access((char *)fname
, W_OK
))
543 file_readonly
= TRUE
;
544 fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0);
548 || (fd
= mch_open((char *)fname
, O_RDWR
| O_EXTRA
, 0)) < 0)
550 file_readonly
= TRUE
;
552 fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0);
557 if (fd
< 0) /* cannot open at all */
562 msg_scroll
= msg_save
;
565 * On MSDOS and Amiga we can't open a directory, check here.
567 isdir_f
= (mch_isdir(fname
));
568 perm
= mch_getperm(fname
); /* check if the file exists */
571 filemess(curbuf
, sfname
, (char_u
*)_("is a directory"), 0);
572 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
581 * Set the 'new-file' flag, so that when the file has
582 * been created by someone else, a ":w" will complain.
584 curbuf
->b_flags
|= BF_NEW
;
586 /* Create a swap file now, so that other Vims are warned
587 * that we are editing this file. Don't do this for a
588 * "nofile" or "nowrite" buffer type. */
590 if (!bt_dontwrite(curbuf
))
592 check_need_swap(newfile
);
593 if (dir_of_file_exists(fname
))
594 filemess(curbuf
, sfname
, (char_u
*)_("[New File]"), 0);
596 filemess(curbuf
, sfname
,
597 (char_u
*)_("[New DIRECTORY]"), 0);
599 /* Even though this is a new file, it might have been
600 * edited before and deleted. Get the old marks. */
604 if (eap
!= NULL
&& eap
->force_enc
!= 0)
606 /* set forced 'fileencoding' */
607 fenc
= enc_canonize(eap
->cmd
+ eap
->force_enc
);
609 set_string_option_direct((char_u
*)"fenc", -1,
610 fenc
, OPT_FREE
|OPT_LOCAL
, 0);
615 apply_autocmds_exarg(EVENT_BUFNEWFILE
, sfname
, sfname
,
618 /* remember the current fileformat */
619 save_file_ff(curbuf
);
621 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
622 if (aborting()) /* autocmds may abort script processing */
625 return OK
; /* a new file is not an error */
629 filemess(curbuf
, sfname
, (char_u
*)(
631 (errno
== EFBIG
) ? _("[File too big]") :
633 _("[Permission Denied]")), 0);
634 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
642 * Only set the 'ro' flag for readonly files the first time they are
643 * loaded. Help files always get readonly mode
645 if ((check_readonly
&& file_readonly
) || curbuf
->b_help
)
646 curbuf
->b_p_ro
= TRUE
;
650 /* Don't change 'eol' if reading from buffer as it will already be
651 * correctly set when reading stdin. */
654 curbuf
->b_p_eol
= TRUE
;
655 curbuf
->b_start_eol
= TRUE
;
658 curbuf
->b_p_bomb
= FALSE
;
659 curbuf
->b_start_bomb
= FALSE
;
663 /* Create a swap file now, so that other Vims are warned that we are
665 * Don't do this for a "nofile" or "nowrite" buffer type. */
667 if (!bt_dontwrite(curbuf
))
670 check_need_swap(newfile
);
672 /* Set swap file protection bits after creating it. */
673 if (swap_mode
> 0 && curbuf
->b_ml
.ml_mfp
->mf_fname
!= NULL
)
674 (void)mch_setperm(curbuf
->b_ml
.ml_mfp
->mf_fname
, (long)swap_mode
);
678 #if defined(HAS_SWAP_EXISTS_ACTION)
679 /* If "Quit" selected at ATTENTION dialog, don't load the file */
680 if (swap_exists_action
== SEA_QUIT
)
682 if (!read_buffer
&& !read_stdin
)
688 ++no_wait_return
; /* don't wait for return yet */
691 * Set '[ mark to the line above where the lines go (line 1 if zero).
693 curbuf
->b_op_start
.lnum
= ((from
== 0) ? 1 : from
);
694 curbuf
->b_op_start
.col
= 0;
700 int n
= msg_scrolled
;
701 buf_T
*old_curbuf
= curbuf
;
704 * The file must be closed again, the autocommands may want to change
705 * the file before reading it.
708 close(fd
); /* ignore errors */
711 * The output from the autocommands should not overwrite anything and
712 * should not be overwritten: Set msg_scroll, restore its value if no
717 apply_autocmds_exarg(EVENT_FILTERREADPRE
, NULL
, sfname
,
720 apply_autocmds_exarg(EVENT_STDINREADPRE
, NULL
, sfname
,
723 apply_autocmds_exarg(EVENT_BUFREADPRE
, NULL
, sfname
,
726 apply_autocmds_exarg(EVENT_FILEREADPRE
, sfname
, sfname
,
728 if (msg_scrolled
== n
)
732 if (aborting()) /* autocmds may abort script processing */
735 msg_scroll
= msg_save
;
736 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
741 * Don't allow the autocommands to change the current buffer.
742 * Try to re-open the file.
744 if (!read_stdin
&& (curbuf
!= old_curbuf
745 || (fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0)) < 0))
748 msg_scroll
= msg_save
;
750 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
752 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
753 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
757 #endif /* FEAT_AUTOCMD */
759 /* Autocommands may add lines to the file, need to check if it is empty */
760 wasempty
= (curbuf
->b_ml
.ml_flags
& ML_EMPTY
);
762 if (!recoverymode
&& !filtering
&& !(flags
& READ_DUMMY
))
765 * Show the user that we are busy reading the input. Sometimes this
766 * may take a while. When reading from stdin another program may
767 * still be running, don't move the cursor to the last line, unless
768 * always using the GUI.
772 #ifndef ALWAYS_USE_GUI
773 mch_msg(_("Vim: Reading from stdin...\n"));
776 /* Also write a message in the GUI window, if there is one. */
777 if (gui
.in_use
&& !gui
.dying
&& !gui
.starting
)
779 p
= (char_u
*)_("Reading from stdin...");
780 gui_write(p
, (int)STRLEN(p
));
784 else if (!read_buffer
)
785 filemess(curbuf
, sfname
, (char_u
*)"", 0);
788 msg_scroll
= FALSE
; /* overwrite the file message */
791 * Set linecnt now, before the "retry" caused by a wrong guess for
792 * fileformat, and after the autocommands, which may change them.
794 linecnt
= curbuf
->b_ml
.ml_line_count
;
797 /* "++bad=" argument. */
798 if (eap
!= NULL
&& eap
->bad_char
!= 0)
800 bad_char_behavior
= eap
->bad_char
;
802 curbuf
->b_bad_char
= eap
->bad_char
;
805 curbuf
->b_bad_char
= 0;
808 * Decide which 'encoding' to use or use first.
810 if (eap
!= NULL
&& eap
->force_enc
!= 0)
812 fenc
= enc_canonize(eap
->cmd
+ eap
->force_enc
);
814 keep_dest_enc
= TRUE
;
816 else if (curbuf
->b_p_bin
)
818 fenc
= (char_u
*)""; /* binary: don't convert */
819 fenc_alloced
= FALSE
;
821 else if (curbuf
->b_help
)
823 char_u firstline
[80];
826 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
827 * fails it must be latin1.
828 * Always do this when 'encoding' is "utf-8". Otherwise only do
829 * this when needed to avoid [converted] remarks all the time.
830 * It is needed when the first line contains non-ASCII characters.
831 * That is only in *.??x files. */
832 fenc
= (char_u
*)"latin1";
834 if (!c
&& !read_stdin
)
836 fc
= fname
[STRLEN(fname
) - 1];
837 if (TOLOWER_ASC(fc
) == 'x')
839 /* Read the first line (and a bit more). Immediately rewind to
840 * the start of the file. If the read() fails "len" is -1. */
841 len
= vim_read(fd
, firstline
, 80);
842 lseek(fd
, (off_t
)0L, SEEK_SET
);
843 for (p
= firstline
; p
< firstline
+ len
; ++p
)
855 fenc
= (char_u
*)"utf-8";
857 /* When the file is utf-8 but a character doesn't fit in
858 * 'encoding' don't retry. In help text editing utf-8 bytes
859 * doesn't make sense. */
861 keep_dest_enc
= TRUE
;
863 fenc_alloced
= FALSE
;
865 else if (*p_fencs
== NUL
)
867 fenc
= curbuf
->b_p_fenc
; /* use format from buffer */
868 fenc_alloced
= FALSE
;
872 fenc_next
= p_fencs
; /* try items in 'fileencodings' */
873 fenc
= next_fenc(&fenc_next
);
879 * Jump back here to retry reading the file in different ways.
881 * - encoding conversion failed: try another one from "fenc_next"
882 * - BOM detected and fenc was set, need to setup conversion
883 * - "fileformat" check failed: try another
885 * Variables set for special retry actions:
886 * "file_rewind" Rewind the file to start reading it again.
887 * "advance_fenc" Advance "fenc" using "fenc_next".
888 * "skip_read" Re-use already read bytes (BOM detected).
889 * "did_iconv" iconv() conversion failed, try 'charconvert'.
890 * "keep_fileformat" Don't reset "fileformat".
892 * Other status indicators:
893 * "tmpname" When != NULL did conversion with 'charconvert'.
894 * Output file has to be deleted afterwards.
895 * "iconv_fd" When != -1 did conversion with iconv().
906 else if (read_stdin
|| lseek(fd
, (off_t
)0L, SEEK_SET
) != 0)
908 /* Can't rewind the file, give up. */
912 /* Delete the previously read lines. */
914 ml_delete(lnum
--, FALSE
);
919 curbuf
->b_p_bomb
= FALSE
;
920 curbuf
->b_start_bomb
= FALSE
;
927 * When retrying with another "fenc" and the first time "fileformat"
931 keep_fileformat
= FALSE
;
934 if (eap
!= NULL
&& eap
->force_ff
!= 0)
936 fileformat
= get_fileformat_force(curbuf
, eap
);
937 try_unix
= try_dos
= try_mac
= FALSE
;
939 else if (curbuf
->b_p_bin
)
940 fileformat
= EOL_UNIX
; /* binary: use Unix format */
941 else if (*p_ffs
== NUL
)
942 fileformat
= get_fileformat(curbuf
);/* use format from buffer */
944 fileformat
= EOL_UNKNOWN
; /* detect from file */
949 if (iconv_fd
!= (iconv_t
)-1)
951 /* aborted conversion with iconv(), close the descriptor */
952 iconv_close(iconv_fd
);
953 iconv_fd
= (iconv_t
)-1;
960 * Try the next entry in 'fileencodings'.
962 advance_fenc
= FALSE
;
964 if (eap
!= NULL
&& eap
->force_enc
!= 0)
966 /* Conversion given with "++cc=" wasn't possible, read
967 * without conversion. */
973 fenc_alloced
= FALSE
;
979 if (fenc_next
!= NULL
)
981 fenc
= next_fenc(&fenc_next
);
982 fenc_alloced
= (fenc_next
!= NULL
);
987 fenc_alloced
= FALSE
;
992 mch_remove(tmpname
); /* delete converted file */
999 * Conversion is required when the encoding of the file is different
1000 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4 (requires
1001 * conversion to UTF-8).
1004 converted
= (*fenc
!= NUL
&& !same_encoding(p_enc
, fenc
));
1005 if (converted
|| enc_unicode
!= 0)
1008 /* "ucs-bom" means we need to check the first bytes of the file
1010 if (STRCMP(fenc
, ENC_UCSBOM
) == 0)
1011 fio_flags
= FIO_UCSBOM
;
1014 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
1015 * done. This is handled below after read(). Prepare the
1016 * fio_flags to avoid having to parse the string each time.
1017 * Also check for Unicode to Latin1 conversion, because iconv()
1018 * appears not to handle this correctly. This works just like
1019 * conversion to UTF-8 except how the resulting character is put in
1022 else if (enc_utf8
|| STRCMP(p_enc
, "latin1") == 0)
1023 fio_flags
= get_fio_flags(fenc
);
1027 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1028 * is handled with MultiByteToWideChar().
1031 fio_flags
= get_win_fio_flags(fenc
);
1035 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1037 fio_flags
= get_mac_fio_flags(fenc
);
1042 * Try using iconv() if we can't convert internally.
1049 iconv_fd
= (iconv_t
)my_iconv_open(
1050 enc_utf8
? (char_u
*)"utf-8" : p_enc
, fenc
);
1055 * Use the 'charconvert' expression when conversion is required
1056 * and we can't do it internally or with iconv().
1058 if (fio_flags
== 0 && !read_stdin
&& !read_buffer
&& *p_ccv
!= NUL
1060 && iconv_fd
== (iconv_t
)-1
1067 /* Skip conversion when it's already done (retry for wrong
1069 if (tmpname
== NULL
)
1071 tmpname
= readfile_charconvert(fname
, fenc
, &fd
);
1072 if (tmpname
== NULL
)
1074 /* Conversion failed. Try another one. */
1075 advance_fenc
= TRUE
;
1078 /* Re-opening the original file failed! */
1079 EMSG(_("E202: Conversion made file unreadable!"));
1092 && iconv_fd
== (iconv_t
)-1
1096 /* Conversion wanted but we can't.
1097 * Try the next conversion in 'fileencodings' */
1098 advance_fenc
= TRUE
;
1104 /* Set "can_retry" when it's possible to rewind the file and try with
1105 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1106 * stdin or fixed at a specific encoding. */
1107 can_retry
= (*fenc
!= NUL
&& !read_stdin
&& !keep_dest_enc
);
1114 skip_count
= lines_to_skip
;
1115 read_count
= lines_to_read
;
1121 while (!error
&& !got_int
)
1124 * We allocate as much space for the file as we can get, plus
1125 * space for the old line plus room for one terminating NUL.
1126 * The amount is limited by the fact that read() only can read
1127 * upto max_unsigned characters (and other things).
1130 if (linerest
>= 0x7ff0)
1133 *ptr
= NL
; /* split line by inserting a NL */
1142 # if defined(SSIZE_MAX) && (SSIZE_MAX < 0x10000L)
1143 size
= SSIZE_MAX
; /* use max I/O size, 52K */
1145 size
= 0x10000L
; /* use buffer >= 64K */
1148 size
= 0x7ff0L
- linerest
; /* limit buffer to 32K */
1151 for ( ; size
>= 10; size
= (long)((long_u
)size
>> 1))
1153 if ((new_buffer
= lalloc((long_u
)(size
+ linerest
+ 1),
1157 if (new_buffer
== NULL
)
1159 do_outofmem_msg((long_u
)(size
* 2 + linerest
+ 1));
1163 if (linerest
) /* copy characters from the previous buffer */
1164 mch_memmove(new_buffer
, ptr
- linerest
, (size_t)linerest
);
1166 buffer
= new_buffer
;
1167 ptr
= buffer
+ linerest
;
1168 line_start
= buffer
;
1171 /* May need room to translate into.
1172 * For iconv() we don't really know the required space, use a
1173 * factor ICONV_MULT.
1174 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1175 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1176 * become up to 4 bytes, size must be multiple of 2
1177 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1179 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1181 real_size
= (int)size
;
1183 if (iconv_fd
!= (iconv_t
)-1)
1184 size
= size
/ ICONV_MULT
;
1187 if (fio_flags
& FIO_LATIN1
)
1189 else if (fio_flags
& (FIO_UCS2
| FIO_UTF16
))
1190 size
= (size
* 2 / 3) & ~1;
1191 else if (fio_flags
& FIO_UCS4
)
1192 size
= (size
* 2 / 3) & ~3;
1193 else if (fio_flags
== FIO_UCSBOM
)
1194 size
= size
/ ICONV_MULT
; /* worst case */
1196 else if (fio_flags
& FIO_CODEPAGE
)
1197 size
= size
/ ICONV_MULT
; /* also worst case */
1200 else if (fio_flags
& FIO_MACROMAN
)
1201 size
= size
/ ICONV_MULT
; /* also worst case */
1206 if (conv_restlen
> 0)
1208 /* Insert unconverted bytes from previous line. */
1209 mch_memmove(ptr
, conv_rest
, conv_restlen
);
1210 ptr
+= conv_restlen
;
1211 size
-= conv_restlen
;
1218 * Read bytes from curbuf. Used for converting text read
1221 if (read_buf_lnum
> from
)
1231 p
= ml_get(read_buf_lnum
) + read_buf_col
;
1233 if ((int)tlen
+ n
+ 1 > size
)
1235 /* Filled up to "size", append partial line.
1236 * Change NL to NUL to reverse the effect done
1238 n
= (int)(size
- tlen
);
1239 for (ni
= 0; ni
< n
; ++ni
)
1244 ptr
[tlen
++] = p
[ni
];
1251 /* Append whole line and new-line. Change NL
1252 * to NUL to reverse the effect done below. */
1253 for (ni
= 0; ni
< n
; ++ni
)
1258 ptr
[tlen
++] = p
[ni
];
1262 if (++read_buf_lnum
> from
)
1264 /* When the last line didn't have an
1265 * end-of-line don't add it now either. */
1266 if (!curbuf
->b_p_eol
)
1278 * Read bytes from the file.
1280 size
= vim_read(fd
, ptr
, size
);
1285 if (size
< 0) /* read error */
1288 else if (conv_restlen
> 0)
1291 * Reached end-of-file but some trailing bytes could
1292 * not be converted. Truncated file?
1295 /* When we did a conversion report an error. */
1298 || iconv_fd
!= (iconv_t
)-1
1302 if (conv_error
== 0)
1303 conv_error
= curbuf
->b_ml
.ml_line_count
1306 /* Remember the first linenr with an illegal byte */
1307 else if (illegal_byte
== 0)
1308 illegal_byte
= curbuf
->b_ml
.ml_line_count
1310 if (bad_char_behavior
== BAD_DROP
)
1312 *(ptr
- conv_restlen
) = NUL
;
1317 /* Replace the trailing bytes with the replacement
1318 * character if we were converting; if we weren't,
1319 * leave the UTF8 checking code to do it, as it
1320 * works slightly differently. */
1321 if (bad_char_behavior
!= BAD_KEEP
&& (fio_flags
!= 0
1323 || iconv_fd
!= (iconv_t
)-1
1327 while (conv_restlen
> 0)
1329 *(--ptr
) = bad_char_behavior
;
1333 fio_flags
= 0; /* don't convert this */
1335 if (iconv_fd
!= (iconv_t
)-1)
1337 iconv_close(iconv_fd
);
1338 iconv_fd
= (iconv_t
)-1;
1348 * At start of file: Check for magic number of encryption.
1351 cryptkey
= check_for_cryptkey(cryptkey
, ptr
, &size
,
1352 &filesize
, newfile
);
1354 * Decrypt the read bytes.
1356 if (cryptkey
!= NULL
&& size
> 0)
1357 for (p
= ptr
; p
< ptr
+ size
; ++p
)
1365 * At start of file (or after crypt magic number): Check for BOM.
1366 * Also check for a BOM for other Unicode encodings, but not after
1367 * converting with 'charconvert' or when a BOM has already been
1372 || (filesize
== CRYPT_MAGIC_LEN
&& cryptkey
!= NULL
)
1375 && (fio_flags
== FIO_UCSBOM
1376 || (!curbuf
->b_p_bomb
1378 && (*fenc
== 'u' || (*fenc
== NUL
&& enc_utf8
)))))
1383 /* no BOM detection in a short file or in binary mode */
1384 if (size
< 2 || curbuf
->b_p_bin
)
1387 ccname
= check_for_bom(ptr
, size
, &blen
,
1388 fio_flags
== FIO_UCSBOM
? FIO_ALL
: get_fio_flags(fenc
));
1391 /* Remove BOM from the text */
1394 mch_memmove(ptr
, ptr
+ blen
, (size_t)size
);
1397 curbuf
->b_p_bomb
= TRUE
;
1398 curbuf
->b_start_bomb
= TRUE
;
1402 if (fio_flags
== FIO_UCSBOM
)
1406 /* No BOM detected: retry with next encoding. */
1407 advance_fenc
= TRUE
;
1411 /* BOM detected: set "fenc" and jump back */
1415 fenc_alloced
= FALSE
;
1417 /* retry reading without getting new bytes or rewinding */
1423 /* Include not converted bytes. */
1424 ptr
-= conv_restlen
;
1425 size
+= conv_restlen
;
1429 * Break here for a read error or end-of-file.
1437 if (iconv_fd
!= (iconv_t
)-1)
1440 * Attempt conversion of the read bytes to 'encoding' using
1448 fromp
= (char *)ptr
;
1452 to_size
= real_size
- size
;
1455 * If there is conversion error or not enough room try using
1456 * another conversion. Except for when there is no
1457 * alternative (help files).
1459 while ((iconv(iconv_fd
, (void *)&fromp
, &from_size
,
1461 == (size_t)-1 && ICONV_ERRNO
!= ICONV_EINVAL
)
1462 || from_size
> CONV_RESTLEN
)
1466 if (conv_error
== 0)
1467 conv_error
= readfile_linenr(linecnt
,
1468 ptr
, (char_u
*)top
);
1470 /* Deal with a bad byte and continue with the next. */
1473 if (bad_char_behavior
== BAD_KEEP
)
1475 *top
++ = *(fromp
- 1);
1478 else if (bad_char_behavior
!= BAD_DROP
)
1480 *top
++ = bad_char_behavior
;
1487 /* Some remaining characters, keep them for the next
1489 mch_memmove(conv_rest
, (char_u
*)fromp
, from_size
);
1490 conv_restlen
= (int)from_size
;
1493 /* move the linerest to before the converted characters */
1494 line_start
= ptr
- linerest
;
1495 mch_memmove(line_start
, buffer
, (size_t)linerest
);
1496 size
= (long)((char_u
*)top
- ptr
);
1501 if (fio_flags
& FIO_CODEPAGE
)
1506 int codepage
= FIO_GET_CP(fio_flags
);
1512 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1513 * a codepage, using standard MS-Windows functions. This
1514 * requires two steps:
1515 * 1. convert from 'fileencoding' to ucs-2
1516 * 2. convert from ucs-2 to 'encoding'
1518 * Because there may be illegal bytes AND an incomplete byte
1519 * sequence at the end, we may have to do the conversion one
1520 * character at a time to get it right.
1523 /* Replacement string for WideCharToMultiByte(). */
1524 if (bad_char_behavior
> 0)
1525 replstr
[0] = bad_char_behavior
;
1531 * Move the bytes to the end of the buffer, so that we have
1532 * room to put the result at the start.
1534 src
= ptr
+ real_size
- size
;
1535 mch_memmove(src
, ptr
, size
);
1538 * Do the conversion.
1546 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1547 if (codepage
== CP_UTF8
)
1549 /* Handle CP_UTF8 input ourselves to be able to handle
1550 * trailing bytes properly.
1551 * Get one UTF-8 character from src. */
1552 bytelen
= (int)utf_ptr2len_len(src
, size
);
1555 /* Only got some bytes of a character. Normally
1556 * it's put in "conv_rest", but if it's too long
1557 * deal with it as if they were illegal bytes. */
1558 if (bytelen
<= CONV_RESTLEN
)
1561 /* weird overlong byte sequence */
1567 int u8c
= utf_ptr2char(src
);
1569 if (u8c
> 0xffff || (*src
>= 0x80 && bytelen
== 1))
1578 /* We don't know how long the byte sequence is, try
1579 * from one to three bytes. */
1580 for (bytelen
= 1; bytelen
<= size
&& bytelen
<= 3;
1583 ucs2len
= MultiByteToWideChar(codepage
,
1584 MB_ERR_INVALID_CHARS
,
1585 (LPCSTR
)src
, bytelen
,
1592 /* If we have only one byte then it's probably an
1593 * incomplete byte sequence. Otherwise discard
1594 * one byte as a bad character. */
1606 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1609 /* From UCS-2 to UTF-8. Cannot fail. */
1610 for (i
= 0; i
< ucs2len
; ++i
)
1611 dst
+= utf_char2bytes(ucs2buf
[i
], dst
);
1618 /* From UCS-2 to "enc_codepage". If the
1619 * conversion uses the default character "?",
1620 * the data doesn't fit in this encoding. */
1621 dstlen
= WideCharToMultiByte(enc_codepage
, 0,
1622 (LPCWSTR
)ucs2buf
, ucs2len
,
1623 (LPSTR
)dst
, (int)(src
- dst
),
1634 /* Deal with bytes we can't convert. */
1637 if (conv_error
== 0)
1638 conv_error
= readfile_linenr(linecnt
, ptr
, dst
);
1639 if (bad_char_behavior
!= BAD_DROP
)
1641 if (bad_char_behavior
== BAD_KEEP
)
1643 mch_memmove(dst
, src
, bytelen
);
1647 *dst
++ = bad_char_behavior
;
1657 /* An incomplete byte sequence remaining. */
1658 mch_memmove(conv_rest
, src
, size
);
1659 conv_restlen
= size
;
1662 /* The new size is equal to how much "dst" was advanced. */
1663 size
= (long)(dst
- ptr
);
1667 # ifdef MACOS_CONVERT
1668 if (fio_flags
& FIO_MACROMAN
)
1671 * Conversion from Apple MacRoman char encoding to UTF-8 or
1672 * latin1. This is in os_mac_conv.c.
1674 if (macroman2enc(ptr
, &size
, real_size
) == FAIL
)
1683 char_u
*tail
= NULL
;
1686 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1687 * "enc_utf8" not set: Convert Unicode to Latin1.
1688 * Go from end to start through the buffer, because the number
1689 * of bytes may increase.
1690 * "dest" points to after where the UTF-8 bytes go, "p" points
1691 * to after the next character to convert.
1693 dest
= ptr
+ real_size
;
1694 if (fio_flags
== FIO_LATIN1
|| fio_flags
== FIO_UTF8
)
1697 if (fio_flags
== FIO_UTF8
)
1699 /* Check for a trailing incomplete UTF-8 sequence */
1700 tail
= ptr
+ size
- 1;
1701 while (tail
> ptr
&& (*tail
& 0xc0) == 0x80)
1703 if (tail
+ utf_byte2len(*tail
) <= ptr
+ size
)
1709 else if (fio_flags
& (FIO_UCS2
| FIO_UTF16
))
1711 /* Check for a trailing byte */
1712 p
= ptr
+ (size
& ~1);
1715 if ((fio_flags
& FIO_UTF16
) && p
> ptr
)
1717 /* Check for a trailing leading word */
1718 if (fio_flags
& FIO_ENDIAN_L
)
1728 if (u8c
>= 0xd800 && u8c
<= 0xdbff)
1736 /* Check for trailing 1, 2 or 3 bytes */
1737 p
= ptr
+ (size
& ~3);
1742 /* If there is a trailing incomplete sequence move it to
1746 conv_restlen
= (int)((ptr
+ size
) - tail
);
1747 mch_memmove(conv_rest
, (char_u
*)tail
, conv_restlen
);
1748 size
-= conv_restlen
;
1754 if (fio_flags
& FIO_LATIN1
)
1756 else if (fio_flags
& (FIO_UCS2
| FIO_UTF16
))
1758 if (fio_flags
& FIO_ENDIAN_L
)
1768 if ((fio_flags
& FIO_UTF16
)
1769 && u8c
>= 0xdc00 && u8c
<= 0xdfff)
1775 /* Missing leading word. */
1778 if (conv_error
== 0)
1779 conv_error
= readfile_linenr(linecnt
,
1781 if (bad_char_behavior
== BAD_DROP
)
1783 if (bad_char_behavior
!= BAD_KEEP
)
1784 u8c
= bad_char_behavior
;
1787 /* found second word of double-word, get the first
1788 * word and compute the resulting character */
1789 if (fio_flags
& FIO_ENDIAN_L
)
1797 u16c
+= (*--p
<< 8);
1799 u8c
= 0x10000 + ((u16c
& 0x3ff) << 10)
1802 /* Check if the word is indeed a leading word. */
1803 if (u16c
< 0xd800 || u16c
> 0xdbff)
1807 if (conv_error
== 0)
1808 conv_error
= readfile_linenr(linecnt
,
1810 if (bad_char_behavior
== BAD_DROP
)
1812 if (bad_char_behavior
!= BAD_KEEP
)
1813 u8c
= bad_char_behavior
;
1817 else if (fio_flags
& FIO_UCS4
)
1819 if (fio_flags
& FIO_ENDIAN_L
)
1822 u8c
+= (*--p
<< 16);
1826 else /* big endian */
1830 u8c
+= (*--p
<< 16);
1831 u8c
+= (*--p
<< 24);
1840 len
= utf_head_off(ptr
, p
);
1842 u8c
= utf_ptr2char(p
);
1845 /* Not a valid UTF-8 character, retry with
1846 * another fenc when possible, otherwise just
1847 * report the error. */
1850 if (conv_error
== 0)
1851 conv_error
= readfile_linenr(linecnt
,
1853 if (bad_char_behavior
== BAD_DROP
)
1855 if (bad_char_behavior
!= BAD_KEEP
)
1856 u8c
= bad_char_behavior
;
1860 if (enc_utf8
) /* produce UTF-8 */
1862 dest
-= utf_char2len(u8c
);
1863 (void)utf_char2bytes(u8c
, dest
);
1865 else /* produce Latin1 */
1870 /* character doesn't fit in latin1, retry with
1871 * another fenc when possible, otherwise just
1872 * report the error. */
1875 if (conv_error
== 0)
1876 conv_error
= readfile_linenr(linecnt
, ptr
, p
);
1877 if (bad_char_behavior
== BAD_DROP
)
1879 else if (bad_char_behavior
== BAD_KEEP
)
1881 else if (eap
!= NULL
&& eap
->bad_char
!= 0)
1882 *dest
= bad_char_behavior
;
1891 /* move the linerest to before the converted characters */
1892 line_start
= dest
- linerest
;
1893 mch_memmove(line_start
, buffer
, (size_t)linerest
);
1894 size
= (long)((ptr
+ real_size
) - dest
);
1897 else if (enc_utf8
&& !curbuf
->b_p_bin
)
1899 int incomplete_tail
= FALSE
;
1901 /* Reading UTF-8: Check if the bytes are valid UTF-8. */
1902 for (p
= ptr
; ; ++p
)
1904 int todo
= (int)((ptr
+ size
) - p
);
1911 /* A length of 1 means it's an illegal byte. Accept
1912 * an incomplete character at the end though, the next
1913 * read() will get the next bytes, we'll check it
1915 l
= utf_ptr2len_len(p
, todo
);
1916 if (l
> todo
&& !incomplete_tail
)
1918 /* Avoid retrying with a different encoding when
1919 * a truncated file is more likely, or attempting
1920 * to read the rest of an incomplete sequence when
1921 * we have already done so. */
1922 if (p
> ptr
|| filesize
> 0)
1923 incomplete_tail
= TRUE
;
1924 /* Incomplete byte sequence, move it to conv_rest[]
1925 * and try to read the rest of it, unless we've
1926 * already done so. */
1929 conv_restlen
= todo
;
1930 mch_memmove(conv_rest
, p
, conv_restlen
);
1931 size
-= conv_restlen
;
1935 if (l
== 1 || l
> todo
)
1937 /* Illegal byte. If we can try another encoding
1938 * do that, unless at EOF where a truncated
1939 * file is more likely than a conversion error. */
1940 if (can_retry
&& !incomplete_tail
)
1943 /* When we did a conversion report an error. */
1944 if (iconv_fd
!= (iconv_t
)-1 && conv_error
== 0)
1945 conv_error
= readfile_linenr(linecnt
, ptr
, p
);
1947 /* Remember the first linenr with an illegal byte */
1948 if (conv_error
== 0 && illegal_byte
== 0)
1949 illegal_byte
= readfile_linenr(linecnt
, ptr
, p
);
1951 /* Drop, keep or replace the bad byte. */
1952 if (bad_char_behavior
== BAD_DROP
)
1954 mch_memmove(p
, p
+ 1, todo
- 1);
1958 else if (bad_char_behavior
!= BAD_KEEP
)
1959 *p
= bad_char_behavior
;
1965 if (p
< ptr
+ size
&& !incomplete_tail
)
1967 /* Detected a UTF-8 error. */
1969 /* Retry reading with another conversion. */
1970 # if defined(FEAT_EVAL) && defined(USE_ICONV)
1971 if (*p_ccv
!= NUL
&& iconv_fd
!= (iconv_t
)-1)
1972 /* iconv() failed, try 'charconvert' */
1976 /* use next item from 'fileencodings' */
1977 advance_fenc
= TRUE
;
1984 /* count the number of characters (after conversion!) */
1988 * when reading the first part of a file: guess EOL type
1990 if (fileformat
== EOL_UNKNOWN
)
1992 /* First try finding a NL, for Dos and Unix */
1993 if (try_dos
|| try_unix
)
1995 for (p
= ptr
; p
< ptr
+ size
; ++p
)
2000 || (try_dos
&& p
> ptr
&& p
[-1] == CAR
))
2001 fileformat
= EOL_DOS
;
2003 fileformat
= EOL_UNIX
;
2008 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
2009 if (fileformat
== EOL_UNIX
&& try_mac
)
2011 /* Need to reset the counters when retrying fenc. */
2014 for (; p
>= ptr
&& *p
!= CAR
; p
--)
2018 for (p
= ptr
; p
< ptr
+ size
; ++p
)
2025 if (try_mac
> try_unix
)
2026 fileformat
= EOL_MAC
;
2031 /* No NL found: may use Mac format */
2032 if (fileformat
== EOL_UNKNOWN
&& try_mac
)
2033 fileformat
= EOL_MAC
;
2035 /* Still nothing found? Use first format in 'ffs' */
2036 if (fileformat
== EOL_UNKNOWN
)
2037 fileformat
= default_fileformat();
2039 /* if editing a new file: may set p_tx and p_ff */
2041 set_fileformat(fileformat
, OPT_LOCAL
);
2046 * This loop is executed once for every character read.
2049 if (fileformat
== EOL_MAC
)
2052 while (++ptr
, --size
>= 0)
2054 /* catch most common case first */
2055 if ((c
= *ptr
) != NUL
&& c
!= CAR
&& c
!= NL
)
2058 *ptr
= NL
; /* NULs are replaced by newlines! */
2060 *ptr
= CAR
; /* NLs are replaced by CRs! */
2063 if (skip_count
== 0)
2065 *ptr
= NUL
; /* end of line */
2066 len
= (colnr_T
) (ptr
- line_start
+ 1);
2067 if (ml_append(lnum
, line_start
, len
, newfile
) == FAIL
)
2073 if (--read_count
== 0)
2075 error
= TRUE
; /* break loop */
2076 line_start
= ptr
; /* nothing left to write */
2082 line_start
= ptr
+ 1;
2089 while (++ptr
, --size
>= 0)
2091 if ((c
= *ptr
) != NUL
&& c
!= NL
) /* catch most common case */
2094 *ptr
= NL
; /* NULs are replaced by newlines! */
2097 if (skip_count
== 0)
2099 *ptr
= NUL
; /* end of line */
2100 len
= (colnr_T
)(ptr
- line_start
+ 1);
2101 if (fileformat
== EOL_DOS
)
2103 if (ptr
[-1] == CAR
) /* remove CR */
2109 * Reading in Dos format, but no CR-LF found!
2110 * When 'fileformats' includes "unix", delete all
2111 * the lines read so far and start all over again.
2112 * Otherwise give an error message later.
2114 else if (ff_error
!= EOL_DOS
)
2119 || lseek(fd
, (off_t
)0L, SEEK_SET
) == 0))
2121 fileformat
= EOL_UNIX
;
2123 set_fileformat(EOL_UNIX
, OPT_LOCAL
);
2125 keep_fileformat
= TRUE
;
2131 if (ml_append(lnum
, line_start
, len
, newfile
) == FAIL
)
2137 if (--read_count
== 0)
2139 error
= TRUE
; /* break loop */
2140 line_start
= ptr
; /* nothing left to write */
2146 line_start
= ptr
+ 1;
2150 linerest
= (long)(ptr
- line_start
);
2155 /* not an error, max. number of lines reached */
2156 if (error
&& read_count
== 0)
2160 * If we get EOF in the middle of a line, note the fact and
2161 * complete the line ourselves.
2162 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2167 && !(!curbuf
->b_p_bin
2168 && fileformat
== EOL_DOS
2169 && *line_start
== Ctrl_Z
2170 && ptr
== line_start
+ 1))
2172 /* remember for when writing */
2174 curbuf
->b_p_eol
= FALSE
;
2176 if (ml_append(lnum
, line_start
,
2177 (colnr_T
)(ptr
- line_start
+ 1), newfile
) == FAIL
)
2180 read_no_eol_lnum
= ++lnum
;
2184 save_file_ff(curbuf
); /* remember the current file format */
2187 if (cryptkey
!= curbuf
->b_p_key
)
2192 /* If editing a new file: set 'fenc' for the current buffer.
2193 * Also for ":read ++edit file". */
2195 set_string_option_direct((char_u
*)"fenc", -1, fenc
,
2196 OPT_FREE
|OPT_LOCAL
, 0);
2200 if (iconv_fd
!= (iconv_t
)-1)
2202 iconv_close(iconv_fd
);
2203 iconv_fd
= (iconv_t
)-1;
2208 if (!read_buffer
&& !read_stdin
)
2209 close(fd
); /* errors are ignored */
2215 /* Use stderr for stdin, makes shell commands work. */
2222 if (tmpname
!= NULL
)
2224 mch_remove(tmpname
); /* delete converted file */
2228 --no_wait_return
; /* may wait for return now */
2231 * In recovery mode everything but autocommands is skipped.
2235 /* need to delete the last line, which comes from the empty buffer */
2236 if (newfile
&& wasempty
&& !(curbuf
->b_ml
.ml_flags
& ML_EMPTY
))
2238 #ifdef FEAT_NETBEANS_INTG
2239 netbeansFireChanges
= 0;
2241 ml_delete(curbuf
->b_ml
.ml_line_count
, FALSE
);
2242 #ifdef FEAT_NETBEANS_INTG
2243 netbeansFireChanges
= 1;
2247 linecnt
= curbuf
->b_ml
.ml_line_count
- linecnt
;
2250 if (newfile
|| read_buffer
)
2252 redraw_curbuf_later(NOT_VALID
);
2254 /* After reading the text into the buffer the diff info needs to
2256 diff_invalidate(curbuf
);
2259 /* All folds in the window are invalid now. Mark them for update
2260 * before triggering autocommands. */
2261 foldUpdateAll(curwin
);
2264 else if (linecnt
) /* appended at least one line */
2265 appended_lines_mark(from
, linecnt
);
2267 #ifndef ALWAYS_USE_GUI
2269 * If we were reading from the same terminal as where messages go,
2270 * the screen will have been messed up.
2271 * Switch on raw mode now and clear the screen.
2275 settmode(TMODE_RAW
); /* set to raw mode */
2283 if (!(flags
& READ_DUMMY
))
2285 filemess(curbuf
, sfname
, (char_u
*)_(e_interr
), 0);
2287 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
2289 msg_scroll
= msg_save
;
2293 return OK
; /* an interrupt isn't really an error */
2296 if (!filtering
&& !(flags
& READ_DUMMY
))
2298 msg_add_fname(curbuf
, sfname
); /* fname in IObuff with quotes */
2303 if (S_ISFIFO(perm
)) /* fifo or socket */
2305 STRCAT(IObuff
, _("[fifo/socket]"));
2310 if ((perm
& S_IFMT
) == S_IFIFO
) /* fifo */
2312 STRCAT(IObuff
, _("[fifo]"));
2317 if ((perm
& S_IFMT
) == S_IFSOCK
) /* or socket */
2319 STRCAT(IObuff
, _("[socket]"));
2324 # ifdef OPEN_CHR_FILES
2325 if (S_ISCHR(perm
)) /* or character special */
2327 STRCAT(IObuff
, _("[character special]"));
2334 STRCAT(IObuff
, shortmess(SHM_RO
) ? _("[RO]") : _("[readonly]"));
2337 if (read_no_eol_lnum
)
2342 if (ff_error
== EOL_DOS
)
2344 STRCAT(IObuff
, _("[CR missing]"));
2349 STRCAT(IObuff
, _("[long lines split]"));
2355 STRCAT(IObuff
, _("[NOT converted]"));
2360 STRCAT(IObuff
, _("[converted]"));
2365 if (cryptkey
!= NULL
)
2367 STRCAT(IObuff
, _("[crypted]"));
2372 if (conv_error
!= 0)
2374 sprintf((char *)IObuff
+ STRLEN(IObuff
),
2375 _("[CONVERSION ERROR in line %ld]"), (long)conv_error
);
2378 else if (illegal_byte
> 0)
2380 sprintf((char *)IObuff
+ STRLEN(IObuff
),
2381 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte
);
2388 STRCAT(IObuff
, _("[READ ERRORS]"));
2391 if (msg_add_fileformat(fileformat
))
2394 if (cryptkey
!= NULL
)
2395 msg_add_lines(c
, (long)linecnt
, filesize
- CRYPT_MAGIC_LEN
);
2398 msg_add_lines(c
, (long)linecnt
, filesize
);
2402 msg_scrolled_ign
= TRUE
;
2403 #ifdef ALWAYS_USE_GUI
2404 /* Don't show the message when reading stdin, it would end up in a
2405 * message box (which might be shown when exiting!) */
2406 if (read_stdin
|| read_buffer
)
2407 p
= msg_may_trunc(FALSE
, IObuff
);
2410 p
= msg_trunc_attr(IObuff
, FALSE
, 0);
2411 if (read_stdin
|| read_buffer
|| restart_edit
!= 0
2412 || (msg_scrolled
!= 0 && !need_wait_return
))
2413 /* Need to repeat the message after redrawing when:
2414 * - When reading from stdin (the screen will be cleared next).
2415 * - When restart_edit is set (otherwise there will be a delay
2416 * before redrawing).
2417 * - When the screen was scrolled but there is no wait-return
2420 msg_scrolled_ign
= FALSE
;
2423 /* with errors writing the file requires ":w!" */
2424 if (newfile
&& (error
2427 || (illegal_byte
> 0 && bad_char_behavior
!= BAD_KEEP
)
2430 curbuf
->b_p_ro
= TRUE
;
2432 u_clearline(); /* cannot use "U" command after adding lines */
2435 * In Ex mode: cursor at last new line.
2436 * Otherwise: cursor at first new line.
2439 curwin
->w_cursor
.lnum
= from
+ linecnt
;
2441 curwin
->w_cursor
.lnum
= from
+ 1;
2442 check_cursor_lnum();
2443 beginline(BL_WHITE
| BL_FIX
); /* on first non-blank */
2446 * Set '[ and '] marks to the newly read lines.
2448 curbuf
->b_op_start
.lnum
= from
+ 1;
2449 curbuf
->b_op_start
.col
= 0;
2450 curbuf
->b_op_end
.lnum
= from
+ linecnt
;
2451 curbuf
->b_op_end
.col
= 0;
2455 * Work around a weird problem: When a file has two links (only
2456 * possible on NTFS) and we write through one link, then stat() it
2457 * through the other link, the timestamp information may be wrong.
2458 * It's correct again after reading the file, thus reset the timestamp
2461 if (newfile
&& !read_stdin
&& !read_buffer
2462 && mch_stat((char *)fname
, &st
) >= 0)
2464 buf_store_time(curbuf
, &st
, fname
);
2465 curbuf
->b_mtime_read
= curbuf
->b_mtime
;
2469 msg_scroll
= msg_save
;
2473 * Get the marks before executing autocommands, so they can be used there.
2479 * Trick: We remember if the last line of the read didn't have
2480 * an eol for when writing it again. This is required for
2481 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2483 write_no_eol_lnum
= read_no_eol_lnum
;
2486 if (!read_stdin
&& !read_buffer
)
2489 int n
= msg_scrolled
;
2491 /* Save the fileformat now, otherwise the buffer will be considered
2492 * modified if the format/encoding was automatically detected. */
2494 save_file_ff(curbuf
);
2497 * The output from the autocommands should not overwrite anything and
2498 * should not be overwritten: Set msg_scroll, restore its value if no
2503 apply_autocmds_exarg(EVENT_FILTERREADPOST
, NULL
, sfname
,
2504 FALSE
, curbuf
, eap
);
2506 apply_autocmds_exarg(EVENT_BUFREADPOST
, NULL
, sfname
,
2507 FALSE
, curbuf
, eap
);
2509 apply_autocmds_exarg(EVENT_FILEREADPOST
, sfname
, sfname
,
2511 if (msg_scrolled
== n
)
2514 if (aborting()) /* autocmds may abort script processing */
2520 if (recoverymode
&& error
)
2525 #ifdef OPEN_CHR_FILES
2527 * Returns TRUE if the file name argument is of the form "/dev/fd/\d\+",
2528 * which is the name of files used for process substitution output by
2529 * some shells on some operating systems, e.g., bash on SunOS.
2530 * Do not accept "/dev/fd/[012]", opening these may hang Vim.
2533 is_dev_fd_file(fname
)
2536 return (STRNCMP(fname
, "/dev/fd/", 8) == 0
2537 && VIM_ISDIGIT(fname
[8])
2538 && *skipdigits(fname
+ 9) == NUL
2540 || (fname
[8] != '0' && fname
[8] != '1' && fname
[8] != '2')));
2547 * From the current line count and characters read after that, estimate the
2548 * line number where we are now.
2549 * Used for error messages that include a line number.
2552 readfile_linenr(linecnt
, p
, endp
)
2553 linenr_T linecnt
; /* line count before reading more bytes */
2554 char_u
*p
; /* start of more bytes read */
2555 char_u
*endp
; /* end of more bytes read */
2560 lnum
= curbuf
->b_ml
.ml_line_count
- linecnt
+ 1;
2561 for (s
= p
; s
< endp
; ++s
)
2569 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2570 * equal to the buffer "buf". Used for calling readfile().
2571 * Returns OK or FAIL.
2574 prep_exarg(eap
, buf
)
2578 eap
->cmd
= alloc((unsigned)(STRLEN(buf
->b_p_ff
)
2580 + STRLEN(buf
->b_p_fenc
)
2583 if (eap
->cmd
== NULL
)
2587 sprintf((char *)eap
->cmd
, "e ++ff=%s ++enc=%s", buf
->b_p_ff
, buf
->b_p_fenc
);
2588 eap
->force_enc
= 14 + (int)STRLEN(buf
->b_p_ff
);
2589 eap
->bad_char
= buf
->b_bad_char
;
2591 sprintf((char *)eap
->cmd
, "e ++ff=%s", buf
->b_p_ff
);
2595 eap
->force_bin
= buf
->b_p_bin
? FORCE_BIN
: FORCE_NOBIN
;
2596 eap
->read_edit
= FALSE
;
2597 eap
->forceit
= FALSE
;
2603 * Find next fileencoding to use from 'fileencodings'.
2604 * "pp" points to fenc_next. It's advanced to the next item.
2605 * When there are no more items, an empty string is returned and *pp is set to
2607 * When *pp is not set to NULL, the result is in allocated memory.
2619 return (char_u
*)"";
2621 p
= vim_strchr(*pp
, ',');
2624 r
= enc_canonize(*pp
);
2629 r
= vim_strnsave(*pp
, (int)(p
- *pp
));
2633 p
= enc_canonize(r
);
2638 if (r
== NULL
) /* out of memory */
2648 * Convert a file with the 'charconvert' expression.
2649 * This closes the file which is to be read, converts it and opens the
2650 * resulting file for reading.
2651 * Returns name of the resulting converted file (the caller should delete it
2652 * after reading it).
2653 * Returns NULL if the conversion failed ("*fdp" is not set) .
2656 readfile_charconvert(fname
, fenc
, fdp
)
2657 char_u
*fname
; /* name of input file */
2658 char_u
*fenc
; /* converted from */
2659 int *fdp
; /* in/out: file descriptor of file */
2662 char_u
*errmsg
= NULL
;
2664 tmpname
= vim_tempname('r');
2665 if (tmpname
== NULL
)
2666 errmsg
= (char_u
*)_("Can't find temp file for conversion");
2669 close(*fdp
); /* close the input file, ignore errors */
2671 if (eval_charconvert(fenc
, enc_utf8
? (char_u
*)"utf-8" : p_enc
,
2672 fname
, tmpname
) == FAIL
)
2673 errmsg
= (char_u
*)_("Conversion with 'charconvert' failed");
2674 if (errmsg
== NULL
&& (*fdp
= mch_open((char *)tmpname
,
2675 O_RDONLY
| O_EXTRA
, 0)) < 0)
2676 errmsg
= (char_u
*)_("can't read output of 'charconvert'");
2681 /* Don't use emsg(), it breaks mappings, the retry with
2682 * another type of conversion might still work. */
2684 if (tmpname
!= NULL
)
2686 mch_remove(tmpname
); /* delete converted file */
2692 /* If the input file is closed, open it (caller should check for error). */
2694 *fdp
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0);
2704 * Read marks for the current buffer from the viminfo file, when we support
2705 * buffer marks and the buffer has a name.
2710 if (!curbuf
->b_marks_read
&& get_viminfo_parameter('\'') > 0
2711 && curbuf
->b_ffname
!= NULL
)
2712 read_viminfo(NULL
, VIF_WANT_MARKS
);
2714 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2715 * the ' parameter after opening a buffer. */
2716 curbuf
->b_marks_read
= TRUE
;
2722 * Check for magic number used for encryption.
2723 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2724 * *filesizep are updated.
2725 * Return the (new) encryption key, NULL for no encryption.
2728 check_for_cryptkey(cryptkey
, ptr
, sizep
, filesizep
, newfile
)
2729 char_u
*cryptkey
; /* previous encryption key or NULL */
2730 char_u
*ptr
; /* pointer to read bytes */
2731 long *sizep
; /* length of read bytes */
2732 long *filesizep
; /* nr of bytes used from file */
2733 int newfile
; /* editing a new buffer */
2735 if (*sizep
>= CRYPT_MAGIC_LEN
2736 && STRNCMP(ptr
, CRYPT_MAGIC
, CRYPT_MAGIC_LEN
) == 0)
2738 if (cryptkey
== NULL
)
2740 if (*curbuf
->b_p_key
)
2741 cryptkey
= curbuf
->b_p_key
;
2744 /* When newfile is TRUE, store the typed key
2745 * in the 'key' option and don't free it. */
2746 cryptkey
= get_crypt_key(newfile
, FALSE
);
2747 /* check if empty key entered */
2748 if (cryptkey
!= NULL
&& *cryptkey
== NUL
)
2750 if (cryptkey
!= curbuf
->b_p_key
)
2757 if (cryptkey
!= NULL
)
2759 crypt_init_keys(cryptkey
);
2761 /* Remove magic number from the text */
2762 *filesizep
+= CRYPT_MAGIC_LEN
;
2763 *sizep
-= CRYPT_MAGIC_LEN
;
2764 mch_memmove(ptr
, ptr
+ CRYPT_MAGIC_LEN
, (size_t)*sizep
);
2767 /* When starting to edit a new file which does not have
2768 * encryption, clear the 'key' option, except when
2769 * starting up (called with -x argument) */
2770 else if (newfile
&& *curbuf
->b_p_key
&& !starting
)
2771 set_option_value((char_u
*)"key", 0L, (char_u
*)"", OPT_LOCAL
);
2779 set_file_time(fname
, atime
, mtime
)
2781 time_t atime
; /* access time */
2782 time_t mtime
; /* modification time */
2784 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2788 buf
.modtime
= mtime
;
2789 (void)utime((char *)fname
, &buf
);
2791 # if defined(HAVE_UTIMES)
2792 struct timeval tvp
[2];
2794 tvp
[0].tv_sec
= atime
;
2796 tvp
[1].tv_sec
= mtime
;
2799 (void)utimes((char *)fname
, tvp
);
2801 (void)utimes((char *)fname
, (const struct timeval
*)&tvp
);
2808 #if defined(VMS) && !defined(MIN)
2809 /* Older DECC compiler for VAX doesn't define MIN() */
2810 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2814 * Return TRUE if a file appears to be read-only from the file permissions.
2817 check_file_readonly(fname
, perm
)
2818 char_u
*fname
; /* full path to file */
2819 int perm
; /* known permissions on file */
2821 #ifndef USE_MCH_ACCESS
2826 #ifdef USE_MCH_ACCESS
2828 (perm
& 0222) == 0 ||
2830 mch_access((char *)fname
, W_OK
)
2832 (fd
= mch_open((char *)fname
, O_RDWR
| O_EXTRA
, 0)) < 0
2833 ? TRUE
: (close(fd
), FALSE
)
2840 * buf_write() - write to file "fname" lines "start" through "end"
2842 * We do our own buffering here because fwrite() is so slow.
2844 * If "forceit" is true, we don't care for errors when attempting backups.
2845 * In case of an error everything possible is done to restore the original
2846 * file. But when "forceit" is TRUE, we risk losing it.
2848 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2849 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2851 * This function must NOT use NameBuff (because it's called by autowrite()).
2853 * return FAIL for failure, OK otherwise
2856 buf_write(buf
, fname
, sfname
, start
, end
, eap
, append
, forceit
,
2857 reset_changed
, filtering
)
2861 linenr_T start
, end
;
2862 exarg_T
*eap
; /* for forced 'ff' and 'fenc', can be
2864 int append
; /* append to the file */
2870 char_u
*backup
= NULL
;
2871 int backup_copy
= FALSE
; /* copy the original file? */
2874 char_u
*wfname
= NULL
; /* name of file to write to */
2881 char_u
*errmsg
= NULL
;
2882 char_u
*errnum
= NULL
;
2884 char_u smallbuf
[SMBUFSIZE
];
2887 long perm
; /* file permissions */
2889 int newfile
= FALSE
; /* TRUE if file doesn't exist yet */
2890 int msg_save
= msg_scroll
;
2891 int overwriting
; /* TRUE if writing over original */
2892 int no_eol
= FALSE
; /* no end-of-line written */
2893 int device
= FALSE
; /* writing to a device */
2895 int prev_got_int
= got_int
;
2896 int file_readonly
= FALSE
; /* overwritten file is read-only */
2897 static char *err_readonly
= "is read-only (cannot override: \"W\" in 'cpoptions')";
2898 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2899 int made_writable
= FALSE
; /* 'w' bit has been set */
2901 /* writing everything */
2902 int whole
= (start
== 1 && end
== buf
->b_ml
.ml_line_count
);
2904 linenr_T old_line_count
= buf
->b_ml
.ml_line_count
;
2909 struct bw_info write_info
; /* info for buf_write_bytes() */
2911 int converted
= FALSE
;
2912 int notconverted
= FALSE
;
2913 char_u
*fenc
; /* effective 'fileencoding' */
2914 char_u
*fenc_tofree
= NULL
; /* allocated "fenc" */
2920 vim_acl_T acl
= NULL
; /* ACL copied from original file to
2921 backup or new file */
2924 if (fname
== NULL
|| *fname
== NUL
) /* safety check */
2928 * Disallow writing from .exrc and .vimrc in current directory for
2934 /* Avoid a crash for a long name. */
2935 if (STRLEN(fname
) >= MAXPATHL
)
2937 EMSG(_(e_longname
));
2942 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
2943 write_info
.bw_conv_buf
= NULL
;
2944 write_info
.bw_conv_error
= FALSE
;
2945 write_info
.bw_restlen
= 0;
2947 write_info
.bw_iconv_fd
= (iconv_t
)-1;
2951 /* After writing a file changedtick changes but we don't want to display
2953 ex_no_reprint
= TRUE
;
2956 * If there is no file name yet, use the one for the written file.
2957 * BF_NOTEDITED is set to reflect this (in case the write fails).
2958 * Don't do this when the write is for a filter command.
2959 * Don't do this when appending.
2960 * Only do this when 'cpoptions' contains the 'F' flag.
2962 if (buf
->b_ffname
== NULL
2966 #ifdef FEAT_QUICKFIX
2970 && (!append
|| vim_strchr(p_cpo
, CPO_FNAMEAPP
) != NULL
)
2971 && vim_strchr(p_cpo
, CPO_FNAMEW
) != NULL
)
2973 if (set_rw_fname(fname
, sfname
) == FAIL
)
2975 buf
= curbuf
; /* just in case autocmds made "buf" invalid */
2981 * For Unix: Use the short file name whenever possible.
2982 * Avoids problems with networks and when directory names are changed.
2983 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
2984 * another directory, which we don't detect
2986 ffname
= fname
; /* remember full fname */
2991 if (buf
->b_ffname
!= NULL
&& fnamecmp(ffname
, buf
->b_ffname
) == 0)
2994 overwriting
= FALSE
;
2997 settmode(TMODE_COOK
); /* when exiting allow typahead now */
2999 ++no_wait_return
; /* don't wait for return yet */
3002 * Set '[ and '] marks to the lines to be written.
3004 buf
->b_op_start
.lnum
= start
;
3005 buf
->b_op_start
.col
= 0;
3006 buf
->b_op_end
.lnum
= end
;
3007 buf
->b_op_end
.col
= 0;
3012 int buf_ffname
= FALSE
;
3013 int buf_sfname
= FALSE
;
3014 int buf_fname_f
= FALSE
;
3015 int buf_fname_s
= FALSE
;
3016 int did_cmd
= FALSE
;
3017 int nofile_err
= FALSE
;
3018 int empty_memline
= (buf
->b_ml
.ml_mfp
== NULL
);
3021 * Apply PRE aucocommands.
3022 * Set curbuf to the buffer to be written.
3023 * Careful: The autocommands may call buf_write() recursively!
3025 if (ffname
== buf
->b_ffname
)
3027 if (sfname
== buf
->b_sfname
)
3029 if (fname
== buf
->b_ffname
)
3031 if (fname
== buf
->b_sfname
)
3034 /* set curwin/curbuf to buf and save a few things */
3035 aucmd_prepbuf(&aco
, buf
);
3039 if (!(did_cmd
= apply_autocmds_exarg(EVENT_FILEAPPENDCMD
,
3040 sfname
, sfname
, FALSE
, curbuf
, eap
)))
3042 #ifdef FEAT_QUICKFIX
3043 if (overwriting
&& bt_nofile(curbuf
))
3047 apply_autocmds_exarg(EVENT_FILEAPPENDPRE
,
3048 sfname
, sfname
, FALSE
, curbuf
, eap
);
3053 apply_autocmds_exarg(EVENT_FILTERWRITEPRE
,
3054 NULL
, sfname
, FALSE
, curbuf
, eap
);
3056 else if (reset_changed
&& whole
)
3058 if (!(did_cmd
= apply_autocmds_exarg(EVENT_BUFWRITECMD
,
3059 sfname
, sfname
, FALSE
, curbuf
, eap
)))
3061 #ifdef FEAT_QUICKFIX
3062 if (overwriting
&& bt_nofile(curbuf
))
3066 apply_autocmds_exarg(EVENT_BUFWRITEPRE
,
3067 sfname
, sfname
, FALSE
, curbuf
, eap
);
3072 if (!(did_cmd
= apply_autocmds_exarg(EVENT_FILEWRITECMD
,
3073 sfname
, sfname
, FALSE
, curbuf
, eap
)))
3075 #ifdef FEAT_QUICKFIX
3076 if (overwriting
&& bt_nofile(curbuf
))
3080 apply_autocmds_exarg(EVENT_FILEWRITEPRE
,
3081 sfname
, sfname
, FALSE
, curbuf
, eap
);
3085 /* restore curwin/curbuf and a few other things */
3086 aucmd_restbuf(&aco
);
3089 * In three situations we return here and don't write the file:
3090 * 1. the autocommands deleted or unloaded the buffer.
3091 * 2. The autocommands abort script processing.
3092 * 3. If one of the "Cmd" autocommands was executed.
3094 if (!buf_valid(buf
))
3096 if (buf
== NULL
|| (buf
->b_ml
.ml_mfp
== NULL
&& !empty_memline
)
3097 || did_cmd
|| nofile_err
3104 msg_scroll
= msg_save
;
3106 EMSG(_("E676: No matching autocommands for acwrite buffer"));
3113 /* An aborting error, interrupt or exception in the
3119 /* The buffer was deleted. We assume it was written
3120 * (can't retry anyway). */
3124 /* Assume the buffer was written, update the timestamp. */
3127 buf
->b_flags
&= ~BF_NEW
;
3129 buf
->b_flags
&= ~BF_WRITE_MASK
;
3131 if (reset_changed
&& buf
->b_changed
&& !append
3132 && (overwriting
|| vim_strchr(p_cpo
, CPO_PLUS
) != NULL
))
3133 /* Buffer still changed, the autocommands didn't work
3141 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3146 * The autocommands may have changed the number of lines in the file.
3147 * When writing the whole file, adjust the end.
3148 * When writing part of the file, assume that the autocommands only
3149 * changed the number of lines that are to be written (tricky!).
3151 if (buf
->b_ml
.ml_line_count
!= old_line_count
)
3153 if (whole
) /* write all */
3154 end
= buf
->b_ml
.ml_line_count
;
3155 else if (buf
->b_ml
.ml_line_count
> old_line_count
) /* more lines */
3156 end
+= buf
->b_ml
.ml_line_count
- old_line_count
;
3157 else /* less lines */
3159 end
-= old_line_count
- buf
->b_ml
.ml_line_count
;
3163 msg_scroll
= msg_save
;
3164 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3171 * The autocommands may have changed the name of the buffer, which may
3172 * be kept in fname, ffname and sfname.
3175 ffname
= buf
->b_ffname
;
3177 sfname
= buf
->b_sfname
;
3179 fname
= buf
->b_ffname
;
3181 fname
= buf
->b_sfname
;
3185 #ifdef FEAT_NETBEANS_INTG
3186 if (usingNetbeans
&& isNetbeansBuffer(buf
))
3191 * b_changed can be 0 after an undo, but we still need to write
3192 * the buffer to NetBeans.
3194 if (buf
->b_changed
|| isNetbeansModified(buf
))
3196 --no_wait_return
; /* may wait for return now */
3197 msg_scroll
= msg_save
;
3198 netbeans_save_buffer(buf
); /* no error checking... */
3203 errnum
= (char_u
*)"E656: ";
3204 errmsg
= (char_u
*)_("NetBeans disallows writes of unmodified buffers");
3211 errnum
= (char_u
*)"E657: ";
3212 errmsg
= (char_u
*)_("Partial writes disallowed for NetBeans buffers");
3219 if (shortmess(SHM_OVER
) && !exiting
)
3220 msg_scroll
= FALSE
; /* overwrite previous file message */
3222 msg_scroll
= TRUE
; /* don't overwrite previous file message */
3230 (char_u
*)"", 0); /* show that we are busy */
3231 msg_scroll
= FALSE
; /* always overwrite the file message now */
3233 buffer
= alloc(BUFSIZE
);
3234 if (buffer
== NULL
) /* can't allocate big buffer, use small
3235 * one (to be able to write when out of
3239 bufsize
= SMBUFSIZE
;
3245 * Get information about original file (if there is one).
3247 #if defined(UNIX) && !defined(ARCHIE)
3251 if (mch_stat((char *)fname
, &st_old
) < 0)
3255 perm
= st_old
.st_mode
;
3256 if (!S_ISREG(st_old
.st_mode
)) /* not a file */
3258 if (S_ISDIR(st_old
.st_mode
))
3260 errnum
= (char_u
*)"E502: ";
3261 errmsg
= (char_u
*)_("is a directory");
3264 if (mch_nodetype(fname
) != NODE_WRITABLE
)
3266 errnum
= (char_u
*)"E503: ";
3267 errmsg
= (char_u
*)_("is not a file or writable device");
3270 /* It's a device of some kind (or a fifo) which we can write to
3271 * but for which we can't make a backup. */
3279 * Check for a writable device name.
3281 c
= mch_nodetype(fname
);
3282 if (c
== NODE_OTHER
)
3284 errnum
= (char_u
*)"E503: ";
3285 errmsg
= (char_u
*)_("is not a file or writable device");
3288 if (c
== NODE_WRITABLE
)
3290 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3291 /* MS-Windows allows opening a device, but we will probably get stuck
3292 * trying to write to it. */
3295 errnum
= (char_u
*)"E796: ";
3296 errmsg
= (char_u
*)_("writing to device disabled with 'opendevice' option");
3306 perm
= mch_getperm(fname
);
3309 else if (mch_isdir(fname
))
3311 errnum
= (char_u
*)"E502: ";
3312 errmsg
= (char_u
*)_("is a directory");
3316 (void)mch_stat((char *)fname
, &st_old
);
3320 if (!device
&& !newfile
)
3323 * Check if the file is really writable (when renaming the file to
3324 * make a backup we won't discover it later).
3326 file_readonly
= check_file_readonly(fname
, (int)perm
);
3328 if (!forceit
&& file_readonly
)
3330 if (vim_strchr(p_cpo
, CPO_FWRITE
) != NULL
)
3332 errnum
= (char_u
*)"E504: ";
3333 errmsg
= (char_u
*)_(err_readonly
);
3337 errnum
= (char_u
*)"E505: ";
3338 errmsg
= (char_u
*)_("is read-only (add ! to override)");
3344 * Check if the timestamp hasn't changed since reading the file.
3348 retval
= check_mtime(buf
, &st_old
);
3356 * For systems that support ACL: get the ACL from the original file.
3359 acl
= mch_get_acl(fname
);
3363 * If 'backupskip' is not empty, don't make a backup for some files.
3365 dobackup
= (p_wb
|| p_bk
|| *p_pm
!= NUL
);
3367 if (dobackup
&& *p_bsk
!= NUL
&& match_file_list(p_bsk
, sfname
, ffname
))
3372 * Save the value of got_int and reset it. We don't want a previous
3373 * interruption cancel writing, only hitting CTRL-C while writing should
3376 prev_got_int
= got_int
;
3379 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3380 buf
->b_saving
= TRUE
;
3383 * If we are not appending or filtering, the file exists, and the
3384 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3385 * When 'patchmode' is set also make a backup when appending.
3387 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3388 * off. This helps when editing large files on almost-full disks.
3390 if (!(append
&& *p_pm
== NUL
) && !filtering
&& perm
>= 0 && dobackup
)
3392 #if defined(UNIX) || defined(WIN32)
3396 if ((bkc_flags
& BKC_YES
) || append
) /* "yes" */
3398 #if defined(UNIX) || defined(WIN32)
3399 else if ((bkc_flags
& BKC_AUTO
)) /* "auto" */
3405 * Don't rename the file when:
3406 * - it's a hard link
3407 * - it's a symbolic link
3408 * - we don't have write permission in the directory
3409 * - we can't set the owner/group of the new file
3411 if (st_old
.st_nlink
> 1
3412 || mch_lstat((char *)fname
, &st
) < 0
3413 || st
.st_dev
!= st_old
.st_dev
3414 || st
.st_ino
!= st_old
.st_ino
3415 # ifndef HAVE_FCHOWN
3416 || st
.st_uid
!= st_old
.st_uid
3417 || st
.st_gid
!= st_old
.st_gid
3424 /* On NTFS file systems hard links are possible. */
3425 if (mch_is_linked(fname
))
3432 * Check if we can create a file and set the owner/group to
3433 * the ones from the original file.
3434 * First find a file name that doesn't exist yet (use some
3435 * arbitrary numbers).
3437 STRCPY(IObuff
, fname
);
3438 for (i
= 4913; ; i
+= 123)
3440 sprintf((char *)gettail(IObuff
), "%d", i
);
3441 if (mch_lstat((char *)IObuff
, &st
) < 0)
3444 fd
= mch_open((char *)IObuff
,
3445 O_CREAT
|O_WRONLY
|O_EXCL
|O_NOFOLLOW
, perm
);
3446 if (fd
< 0) /* can't write in directory */
3452 ignored
= fchown(fd
, st_old
.st_uid
, st_old
.st_gid
);
3454 if (mch_stat((char *)IObuff
, &st
) < 0
3455 || st
.st_uid
!= st_old
.st_uid
3456 || st
.st_gid
!= st_old
.st_gid
3457 || st
.st_mode
!= perm
)
3460 /* Close the file before removing it, on MS-Windows we
3461 * can't delete an open file. */
3470 * Break symlinks and/or hardlinks if we've been asked to.
3472 if ((bkc_flags
& BKC_BREAKSYMLINK
) || (bkc_flags
& BKC_BREAKHARDLINK
))
3476 lstat_res
= mch_lstat((char *)fname
, &st
);
3479 if ((bkc_flags
& BKC_BREAKSYMLINK
)
3481 && st
.st_ino
!= st_old
.st_ino
)
3482 backup_copy
= FALSE
;
3485 if ((bkc_flags
& BKC_BREAKHARDLINK
)
3486 && st_old
.st_nlink
> 1
3487 && (lstat_res
!= 0 || st
.st_ino
== st_old
.st_ino
))
3488 backup_copy
= FALSE
;
3494 /* make sure we have a valid backup extension to use */
3498 backup_ext
= (char_u
*)"/bak";
3500 backup_ext
= (char_u
*)".bak";
3507 && (fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0)) >= 0)
3510 char_u
*copybuf
, *wp
;
3511 int some_error
= FALSE
;
3515 #if defined(UNIX) && !defined(SHORT_FNAME)
3516 int did_set_shortname
;
3519 copybuf
= alloc(BUFSIZE
+ 1);
3520 if (copybuf
== NULL
)
3522 some_error
= TRUE
; /* out of memory */
3527 * Try to make the backup in each directory in the 'bdir' option.
3529 * Unix semantics has it, that we may have a writable file,
3530 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3531 * - the directory is not writable,
3532 * - the file may be a symbolic link,
3533 * - the file may belong to another user/group, etc.
3535 * For these reasons, the existing writable file must be truncated
3536 * and reused. Creation of a backup COPY will be attempted.
3548 * Isolate one directory name, using an entry in 'bdir'.
3550 (void)copy_option_part(&dirp
, copybuf
, BUFSIZE
, ",");
3551 rootname
= get_file_in_dir(fname
, copybuf
);
3552 if (rootname
== NULL
)
3554 some_error
= TRUE
; /* out of memory */
3558 #if defined(UNIX) && !defined(SHORT_FNAME)
3559 did_set_shortname
= FALSE
;
3563 * May try twice if 'shortname' not set.
3568 * Make backup file name.
3570 backup
= buf_modname(
3574 (buf
->b_p_sn
|| buf
->b_shortname
),
3576 rootname
, backup_ext
, FALSE
);
3580 some_error
= TRUE
; /* out of memory */
3585 * Check if backup file already exists.
3587 if (mch_stat((char *)backup
, &st_new
) >= 0)
3591 * Check if backup file is same as original file.
3592 * May happen when modname() gave the same file back.
3593 * E.g. silly link, or file name-length reached.
3594 * If we don't check here, we either ruin the file
3595 * when copying or erase it after writing. jw.
3597 if (st_new
.st_dev
== st_old
.st_dev
3598 && st_new
.st_ino
== st_old
.st_ino
)
3601 backup
= NULL
; /* no backup file to delete */
3602 # ifndef SHORT_FNAME
3604 * may try again with 'shortname' set
3606 if (!(buf
->b_shortname
|| buf
->b_p_sn
))
3608 buf
->b_shortname
= TRUE
;
3609 did_set_shortname
= TRUE
;
3612 /* setting shortname didn't help */
3613 if (did_set_shortname
)
3614 buf
->b_shortname
= FALSE
;
3621 * If we are not going to keep the backup file, don't
3622 * delete an existing one, try to use another name.
3623 * Change one character, just before the extension.
3627 wp
= backup
+ STRLEN(backup
) - 1
3628 - STRLEN(backup_ext
);
3629 if (wp
< backup
) /* empty file name ??? */
3633 && mch_stat((char *)backup
, &st_new
) >= 0)
3635 /* They all exist??? Must be something wrong. */
3648 * Try to create the backup file
3652 /* remove old backup, if present */
3654 /* Open with O_EXCL to avoid the file being created while
3655 * we were sleeping (symlink hacker attack?) */
3656 bfd
= mch_open((char *)backup
,
3657 O_WRONLY
|O_CREAT
|O_EXTRA
|O_EXCL
|O_NOFOLLOW
,
3666 /* set file protection same as original file, but
3668 (void)mch_setperm(backup
, perm
& 0777);
3672 * Try to set the group of the backup same as the
3673 * original file. If this fails, set the protection
3674 * bits for the group same as the protection bits for
3677 if (st_new
.st_gid
!= st_old
.st_gid
3678 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3679 && fchown(bfd
, (uid_t
)-1, st_old
.st_gid
) != 0
3683 (perm
& 0707) | ((perm
& 07) << 3));
3684 # ifdef HAVE_SELINUX
3685 mch_copy_sec(fname
, backup
);
3692 write_info
.bw_fd
= bfd
;
3693 write_info
.bw_buf
= copybuf
;
3695 write_info
.bw_flags
= FIO_NOCONVERT
;
3697 while ((write_info
.bw_len
= vim_read(fd
, copybuf
,
3700 if (buf_write_bytes(&write_info
) == FAIL
)
3702 errmsg
= (char_u
*)_("E506: Can't write to backup file (add ! to override)");
3708 errmsg
= (char_u
*)_(e_interr
);
3713 if (close(bfd
) < 0 && errmsg
== NULL
)
3714 errmsg
= (char_u
*)_("E507: Close error for backup file (add ! to override)");
3715 if (write_info
.bw_len
< 0)
3716 errmsg
= (char_u
*)_("E508: Can't read file for backup (add ! to override)");
3718 set_file_time(backup
, st_old
.st_atime
, st_old
.st_mtime
);
3721 mch_set_acl(backup
, acl
);
3724 mch_copy_sec(fname
, backup
);
3731 close(fd
); /* ignore errors for closing read file */
3734 if (backup
== NULL
&& errmsg
== NULL
)
3735 errmsg
= (char_u
*)_("E509: Cannot create backup file (add ! to override)");
3736 /* ignore errors when forceit is TRUE */
3737 if ((some_error
|| errmsg
!= NULL
) && !forceit
)
3751 * Make a backup by renaming the original file.
3754 * If 'cpoptions' includes the "W" flag, we don't want to
3755 * overwrite a read-only file. But rename may be possible
3756 * anyway, thus we need an extra check here.
3758 if (file_readonly
&& vim_strchr(p_cpo
, CPO_FWRITE
) != NULL
)
3760 errnum
= (char_u
*)"E504: ";
3761 errmsg
= (char_u
*)_(err_readonly
);
3767 * Form the backup file name - change path/fo.o.h to
3768 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3769 * that works is used.
3775 * Isolate one directory name and make the backup file name.
3777 (void)copy_option_part(&dirp
, IObuff
, IOSIZE
, ",");
3778 rootname
= get_file_in_dir(fname
, IObuff
);
3779 if (rootname
== NULL
)
3783 backup
= buf_modname(
3787 (buf
->b_p_sn
|| buf
->b_shortname
),
3789 rootname
, backup_ext
, FALSE
);
3796 * If we are not going to keep the backup file, don't
3797 * delete an existing one, try to use another name.
3798 * Change one character, just before the extension.
3800 if (!p_bk
&& mch_getperm(backup
) >= 0)
3802 p
= backup
+ STRLEN(backup
) - 1 - STRLEN(backup_ext
);
3803 if (p
< backup
) /* empty file name ??? */
3806 while (*p
> 'a' && mch_getperm(backup
) >= 0)
3808 /* They all exist??? Must be something wrong! */
3819 * Delete any existing backup and move the current version
3820 * to the backup. For safety, we don't remove the backup
3821 * until the write has finished successfully. And if the
3822 * 'backup' option is set, leave it around.
3825 * If the renaming of the original file to the backup file
3828 if (vim_rename(fname
, backup
) == 0)
3831 vim_free(backup
); /* don't do the rename below */
3835 if (backup
== NULL
&& !forceit
)
3837 errmsg
= (char_u
*)_("E510: Can't make backup file (add ! to override)");
3843 #if defined(UNIX) && !defined(ARCHIE)
3844 /* When using ":w!" and the file was read-only: make it writable */
3845 if (forceit
&& perm
>= 0 && !(perm
& 0200) && st_old
.st_uid
== getuid()
3846 && vim_strchr(p_cpo
, CPO_FWRITE
) == NULL
)
3849 (void)mch_setperm(fname
, perm
);
3850 made_writable
= TRUE
;
3854 /* When using ":w!" and writing to the current file, 'readonly' makes no
3855 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3856 if (forceit
&& overwriting
&& vim_strchr(p_cpo
, CPO_KEEPRO
) == NULL
)
3858 buf
->b_p_ro
= FALSE
;
3860 need_maketitle
= TRUE
; /* set window title later */
3863 status_redraw_all(); /* redraw status lines later */
3867 if (end
> buf
->b_ml
.ml_line_count
)
3868 end
= buf
->b_ml
.ml_line_count
;
3869 if (buf
->b_ml
.ml_flags
& ML_EMPTY
)
3873 * If the original file is being overwritten, there is a small chance that
3874 * we crash in the middle of writing. Therefore the file is preserved now.
3875 * This makes all block numbers positive so that recovery does not need
3876 * the original file.
3877 * Don't do this if there is a backup file and we are exiting.
3879 if (reset_changed
&& !newfile
&& overwriting
3880 && !(exiting
&& backup
!= NULL
))
3882 ml_preserve(buf
, FALSE
);
3885 errmsg
= (char_u
*)_(e_interr
);
3886 goto restore_backup
;
3890 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3892 * Before risking to lose the original file verify if there's
3893 * a resource fork to preserve, and if cannot be done warn
3894 * the users. This happens when overwriting without backups.
3896 if (backup
== NULL
&& overwriting
&& !append
)
3897 if (mch_has_resource_fork(fname
))
3899 errmsg
= (char_u
*)_("E460: The resource fork would be lost (add ! to override)");
3900 goto restore_backup
;
3905 vms_remove_version(fname
); /* remove version */
3907 /* Default: write the file directly. May write to a temp file for
3908 * multi-byte conversion. */
3912 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3913 if (eap
!= NULL
&& eap
->force_enc
!= 0)
3915 fenc
= eap
->cmd
+ eap
->force_enc
;
3916 fenc
= enc_canonize(fenc
);
3920 fenc
= buf
->b_p_fenc
;
3923 * The file needs to be converted when 'fileencoding' is set and
3924 * 'fileencoding' differs from 'encoding'.
3926 converted
= (*fenc
!= NUL
&& !same_encoding(p_enc
, fenc
));
3929 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3930 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3931 * Prepare the flags for it and allocate bw_conv_buf when needed.
3933 if (converted
&& (enc_utf8
|| STRCMP(p_enc
, "latin1") == 0))
3935 wb_flags
= get_fio_flags(fenc
);
3936 if (wb_flags
& (FIO_UCS2
| FIO_UCS4
| FIO_UTF16
| FIO_UTF8
))
3938 /* Need to allocate a buffer to translate into. */
3939 if (wb_flags
& (FIO_UCS2
| FIO_UTF16
| FIO_UTF8
))
3940 write_info
.bw_conv_buflen
= bufsize
* 2;
3942 write_info
.bw_conv_buflen
= bufsize
* 4;
3943 write_info
.bw_conv_buf
3944 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3945 if (write_info
.bw_conv_buf
== NULL
)
3951 if (converted
&& wb_flags
== 0 && (wb_flags
= get_win_fio_flags(fenc
)) != 0)
3953 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
3954 write_info
.bw_conv_buflen
= bufsize
* 4;
3955 write_info
.bw_conv_buf
3956 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3957 if (write_info
.bw_conv_buf
== NULL
)
3963 if (converted
&& wb_flags
== 0 && (wb_flags
= get_mac_fio_flags(fenc
)) != 0)
3965 write_info
.bw_conv_buflen
= bufsize
* 3;
3966 write_info
.bw_conv_buf
3967 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3968 if (write_info
.bw_conv_buf
== NULL
)
3973 # if defined(FEAT_EVAL) || defined(USE_ICONV)
3974 if (converted
&& wb_flags
== 0)
3978 * Use iconv() conversion when conversion is needed and it's not done
3981 write_info
.bw_iconv_fd
= (iconv_t
)my_iconv_open(fenc
,
3982 enc_utf8
? (char_u
*)"utf-8" : p_enc
);
3983 if (write_info
.bw_iconv_fd
!= (iconv_t
)-1)
3985 /* We're going to use iconv(), allocate a buffer to convert in. */
3986 write_info
.bw_conv_buflen
= bufsize
* ICONV_MULT
;
3987 write_info
.bw_conv_buf
3988 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3989 if (write_info
.bw_conv_buf
== NULL
)
3991 write_info
.bw_first
= TRUE
;
4000 * When the file needs to be converted with 'charconvert' after
4001 * writing, write to a temp file instead and let the conversion
4002 * overwrite the original file.
4006 wfname
= vim_tempname('w');
4007 if (wfname
== NULL
) /* Can't write without a tempfile! */
4009 errmsg
= (char_u
*)_("E214: Can't find temp file for writing");
4010 goto restore_backup
;
4016 if (converted
&& wb_flags
== 0
4018 && write_info
.bw_iconv_fd
== (iconv_t
)-1
4027 errmsg
= (char_u
*)_("E213: Cannot convert (add ! to write without conversion)");
4028 goto restore_backup
;
4030 notconverted
= TRUE
;
4035 * Open the file "wfname" for writing.
4036 * We may try to open the file twice: If we can't write to the
4037 * file and forceit is TRUE we delete the existing file and try to create
4038 * a new one. If this still fails we may have lost the original file!
4039 * (this may happen when the user reached his quotum for number of files).
4040 * Appending will fail if the file does not exist and forceit is FALSE.
4042 while ((fd
= mch_open((char *)wfname
, O_WRONLY
| O_EXTRA
| (append
4043 ? (forceit
? (O_APPEND
| O_CREAT
) : O_APPEND
)
4044 : (O_CREAT
| O_TRUNC
))
4045 , perm
< 0 ? 0666 : (perm
& 0777))) < 0)
4048 * A forced write will try to create a new file if the old one is
4049 * still readonly. This may also happen when the directory is
4050 * read-only. In that case the mch_remove() will fail.
4057 /* Don't delete the file when it's a hard or symbolic link. */
4058 if ((!newfile
&& st_old
.st_nlink
> 1)
4059 || (mch_lstat((char *)fname
, &st
) == 0
4060 && (st
.st_dev
!= st_old
.st_dev
4061 || st
.st_ino
!= st_old
.st_ino
)))
4062 errmsg
= (char_u
*)_("E166: Can't open linked file for writing");
4066 errmsg
= (char_u
*)_("E212: Can't open file for writing");
4067 if (forceit
&& vim_strchr(p_cpo
, CPO_FWRITE
) == NULL
4071 /* we write to the file, thus it should be marked
4072 writable after all */
4074 made_writable
= TRUE
;
4076 if (st_old
.st_uid
!= getuid() || st_old
.st_gid
!= getgid())
4079 if (!append
) /* don't remove when appending */
4091 * If we failed to open the file, we don't need a backup. Throw it
4092 * away. If we moved or removed the original file try to put the
4093 * backup in its place.
4095 if (backup
!= NULL
&& wfname
== fname
)
4100 * There is a small chance that we removed the original,
4101 * try to move the copy in its place.
4102 * This may not work if the vim_rename() fails.
4103 * In that case we leave the copy around.
4105 /* If file does not exist, put the copy in its place */
4106 if (mch_stat((char *)fname
, &st
) < 0)
4107 vim_rename(backup
, fname
);
4108 /* if original file does exist throw away the copy */
4109 if (mch_stat((char *)fname
, &st
) >= 0)
4114 /* try to put the original file back */
4115 vim_rename(backup
, fname
);
4119 /* if original file no longer exists give an extra warning */
4120 if (!newfile
&& mch_stat((char *)fname
, &st
) < 0)
4125 if (wfname
!= fname
)
4132 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4133 /* TODO: Is it need for MACOS_X? (Dany) */
4135 * On macintosh copy the original files attributes (i.e. the backup)
4136 * This is done in order to preserve the resource fork and the
4137 * Finder attribute (label, comments, custom icons, file creator)
4139 if (backup
!= NULL
&& overwriting
&& !append
)
4142 (void)mch_copy_file_attribute(wfname
, backup
);
4144 (void)mch_copy_file_attribute(backup
, wfname
);
4147 if (!overwriting
&& !append
)
4149 if (buf
->b_ffname
!= NULL
)
4150 (void)mch_copy_file_attribute(buf
->b_ffname
, wfname
);
4151 /* Should copy resource fork */
4155 write_info
.bw_fd
= fd
;
4158 if (*buf
->b_p_key
&& !filtering
)
4160 crypt_init_keys(buf
->b_p_key
);
4161 /* Write magic number, so that Vim knows that this file is encrypted
4162 * when reading it again. This also undergoes utf-8 to ucs-2/4
4163 * conversion when needed. */
4164 write_info
.bw_buf
= (char_u
*)CRYPT_MAGIC
;
4165 write_info
.bw_len
= CRYPT_MAGIC_LEN
;
4166 write_info
.bw_flags
= FIO_NOCONVERT
;
4167 if (buf_write_bytes(&write_info
) == FAIL
)
4169 wb_flags
|= FIO_ENCRYPTED
;
4173 write_info
.bw_buf
= buffer
;
4176 /* use "++bin", "++nobin" or 'binary' */
4177 if (eap
!= NULL
&& eap
->force_bin
!= 0)
4178 write_bin
= (eap
->force_bin
== FORCE_BIN
);
4180 write_bin
= buf
->b_p_bin
;
4184 * The BOM is written just after the encryption magic number.
4185 * Skip it when appending and the file already existed, the BOM only makes
4186 * sense at the start of the file.
4188 if (buf
->b_p_bomb
&& !write_bin
&& (!append
|| perm
< 0))
4190 write_info
.bw_len
= make_bom(buffer
, fenc
);
4191 if (write_info
.bw_len
> 0)
4193 /* don't convert, do encryption */
4194 write_info
.bw_flags
= FIO_NOCONVERT
| wb_flags
;
4195 if (buf_write_bytes(&write_info
) == FAIL
)
4198 nchars
+= write_info
.bw_len
;
4203 write_info
.bw_len
= bufsize
;
4205 write_info
.bw_flags
= wb_flags
;
4207 fileformat
= get_fileformat_force(buf
, eap
);
4210 for (lnum
= start
; lnum
<= end
; ++lnum
)
4213 * The next while loop is done once for each character written.
4216 ptr
= ml_get_buf(buf
, lnum
, FALSE
) - 1;
4217 while ((c
= *++ptr
) != NUL
)
4220 *s
= NUL
; /* replace newlines with NULs */
4221 else if (c
== CAR
&& fileformat
== EOL_MAC
)
4222 *s
= NL
; /* Mac: replace CRs with NLs */
4226 if (++len
!= bufsize
)
4228 if (buf_write_bytes(&write_info
) == FAIL
)
4230 end
= 0; /* write error: break loop */
4237 /* write failed or last line has no EOL: stop here */
4241 && (lnum
== write_no_eol_lnum
4242 || (lnum
== buf
->b_ml
.ml_line_count
&& !buf
->b_p_eol
))))
4244 ++lnum
; /* written the line, count it */
4248 if (fileformat
== EOL_UNIX
)
4252 *s
++ = CAR
; /* EOL_MAC or EOL_DOS: write CR */
4253 if (fileformat
== EOL_DOS
) /* write CR-NL */
4255 if (++len
== bufsize
)
4257 if (buf_write_bytes(&write_info
) == FAIL
)
4259 end
= 0; /* write error: break loop */
4269 if (++len
== bufsize
&& end
)
4271 if (buf_write_bytes(&write_info
) == FAIL
)
4273 end
= 0; /* write error: break loop */
4283 end
= 0; /* Interrupted, break loop */
4289 * On VMS there is a problem: newlines get added when writing blocks
4290 * at a time. Fix it by writing a line at a time.
4291 * This is much slower!
4292 * Explanation: VAX/DECC RTL insists that records in some RMS
4293 * structures end with a newline (carriage return) character, and if
4294 * they don't it adds one.
4295 * With other RMS structures it works perfect without this fix.
4297 if (buf
->b_fab_rfm
== FAB$C_VFC
4298 || ((buf
->b_fab_rat
& (FAB$M_FTN
| FAB$M_CR
)) != 0))
4302 buf
->b_fab_mrs
= (buf
->b_fab_mrs
== 0
4303 ? MIN(4096, bufsize
)
4304 : MIN(buf
->b_fab_mrs
, bufsize
));
4309 write_info
.bw_len
= MIN(b2write
, buf
->b_fab_mrs
);
4310 if (buf_write_bytes(&write_info
) == FAIL
)
4315 b2write
-= MIN(b2write
, buf
->b_fab_mrs
);
4317 write_info
.bw_len
= bufsize
;
4324 if (len
> 0 && end
> 0)
4326 write_info
.bw_len
= len
;
4327 if (buf_write_bytes(&write_info
) == FAIL
)
4328 end
= 0; /* write error */
4332 #if defined(UNIX) && defined(HAVE_FSYNC)
4333 /* On many journalling file systems there is a bug that causes both the
4334 * original and the backup file to be lost when halting the system right
4335 * after writing the file. That's because only the meta-data is
4336 * journalled. Syncing the file slows down the system, but assures it has
4337 * been written to disk and we don't lose it.
4338 * For a device do try the fsync() but don't complain if it does not work
4339 * (could be a pipe).
4340 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4341 if (p_fs
&& fsync(fd
) != 0 && !device
)
4343 errmsg
= (char_u
*)_("E667: Fsync failed");
4349 /* Probably need to set the security context. */
4351 mch_copy_sec(backup
, wfname
);
4355 /* When creating a new file, set its owner/group to that of the original
4356 * file. Get the new device and inode number. */
4357 if (backup
!= NULL
&& !backup_copy
)
4362 /* don't change the owner when it's already OK, some systems remove
4363 * permission or ACL stuff */
4364 if (mch_stat((char *)wfname
, &st
) < 0
4365 || st
.st_uid
!= st_old
.st_uid
4366 || st
.st_gid
!= st_old
.st_gid
)
4368 ignored
= fchown(fd
, st_old
.st_uid
, st_old
.st_gid
);
4369 if (perm
>= 0) /* set permission again, may have changed */
4370 (void)mch_setperm(wfname
, perm
);
4375 else if (buf
->b_dev
< 0)
4376 /* Set the inode when creating a new file. */
4382 errmsg
= (char_u
*)_("E512: Close failed");
4388 perm
&= ~0200; /* reset 'w' bit for security reasons */
4390 if (perm
>= 0) /* set perm. of new file same as old file */
4391 (void)mch_setperm(wfname
, perm
);
4393 if (!append
&& !filtering
)
4394 /* Set the filetype after writing the file. */
4395 mch_set_filetype(wfname
, buf
->b_p_oft
);
4398 /* Probably need to set the ACL before changing the user (can't set the
4399 * ACL on a file the user doesn't own). */
4401 mch_set_acl(wfname
, acl
);
4405 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4406 if (wfname
!= fname
)
4409 * The file was written to a temp file, now it needs to be converted
4410 * with 'charconvert' to (overwrite) the output file.
4414 if (eval_charconvert(enc_utf8
? (char_u
*)"utf-8" : p_enc
, fenc
,
4415 wfname
, fname
) == FAIL
)
4417 write_info
.bw_conv_error
= TRUE
;
4431 if (write_info
.bw_conv_error
)
4432 errmsg
= (char_u
*)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4436 errmsg
= (char_u
*)_(e_interr
);
4438 errmsg
= (char_u
*)_("E514: write error (file system full?)");
4442 * If we have a backup file, try to put it in place of the new file,
4443 * because the new file is probably corrupt. This avoids losing the
4444 * original file when trying to make a backup when writing the file a
4446 * When "backup_copy" is set we need to copy the backup over the new
4447 * file. Otherwise rename the backup file.
4448 * If this is OK, don't give the extra warning message.
4454 /* This may take a while, if we were interrupted let the user
4455 * know we got the message. */
4461 if ((fd
= mch_open((char *)backup
, O_RDONLY
| O_EXTRA
, 0)) >= 0)
4463 if ((write_info
.bw_fd
= mch_open((char *)fname
,
4464 O_WRONLY
| O_CREAT
| O_TRUNC
| O_EXTRA
,
4467 /* copy the file. */
4468 write_info
.bw_buf
= smallbuf
;
4470 write_info
.bw_flags
= FIO_NOCONVERT
;
4472 while ((write_info
.bw_len
= vim_read(fd
, smallbuf
,
4474 if (buf_write_bytes(&write_info
) == FAIL
)
4477 if (close(write_info
.bw_fd
) >= 0
4478 && write_info
.bw_len
== 0)
4479 end
= 1; /* success */
4481 close(fd
); /* ignore errors for closing read file */
4486 if (vim_rename(backup
, fname
) == 0)
4493 lnum
-= start
; /* compute number of written lines */
4494 --no_wait_return
; /* may wait for return now */
4496 #if !(defined(UNIX) || defined(VMS))
4497 fname
= sfname
; /* use shortname now, for the messages */
4501 msg_add_fname(buf
, fname
); /* put fname in IObuff with quotes */
4504 if (write_info
.bw_conv_error
)
4506 STRCAT(IObuff
, _(" CONVERSION ERROR"));
4509 else if (notconverted
)
4511 STRCAT(IObuff
, _("[NOT converted]"));
4516 STRCAT(IObuff
, _("[converted]"));
4522 STRCAT(IObuff
, _("[Device]"));
4527 STRCAT(IObuff
, shortmess(SHM_NEW
) ? _("[New]") : _("[New File]"));
4535 /* may add [unix/dos/mac] */
4536 if (msg_add_fileformat(fileformat
))
4539 if (wb_flags
& FIO_ENCRYPTED
)
4541 STRCAT(IObuff
, _("[crypted]"));
4545 msg_add_lines(c
, (long)lnum
, nchars
); /* add line/char count */
4546 if (!shortmess(SHM_WRITE
))
4549 STRCAT(IObuff
, shortmess(SHM_WRI
) ? _(" [a]") : _(" appended"));
4551 STRCAT(IObuff
, shortmess(SHM_WRI
) ? _(" [w]") : _(" written"));
4554 set_keep_msg(msg_trunc_attr(IObuff
, FALSE
, 0), 0);
4557 /* When written everything correctly: reset 'modified'. Unless not
4558 * writing to the original file and '+' is not in 'cpoptions'. */
4559 if (reset_changed
&& whole
&& !append
4561 && !write_info
.bw_conv_error
4563 && (overwriting
|| vim_strchr(p_cpo
, CPO_PLUS
) != NULL
)
4566 unchanged(buf
, TRUE
);
4571 * If written to the current file, update the timestamp of the swap file
4572 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4578 buf
->b_flags
&= ~BF_NEW
;
4580 buf
->b_flags
&= ~BF_WRITE_MASK
;
4584 * If we kept a backup until now, and we are in patch mode, then we make
4585 * the backup file our 'original' file.
4587 if (*p_pm
&& dobackup
)
4589 char *org
= (char *)buf_modname(
4593 (buf
->b_p_sn
|| buf
->b_shortname
),
4595 fname
, p_pm
, FALSE
);
4602 * If the original file does not exist yet
4603 * the current backup file becomes the original file
4606 EMSG(_("E205: Patchmode: can't save original file"));
4607 else if (mch_stat(org
, &st
) < 0)
4609 vim_rename(backup
, (char_u
*)org
);
4610 vim_free(backup
); /* don't delete the file */
4613 set_file_time((char_u
*)org
, st_old
.st_atime
, st_old
.st_mtime
);
4618 * If there is no backup file, remember that a (new) file was
4626 || (empty_fd
= mch_open(org
,
4627 O_CREAT
| O_EXTRA
| O_EXCL
| O_NOFOLLOW
,
4628 perm
< 0 ? 0666 : (perm
& 0777))) < 0)
4629 EMSG(_("E206: patchmode: can't touch empty original file"));
4635 mch_setperm((char_u
*)org
, mch_getperm(fname
) & 0777);
4641 * Remove the backup unless 'backup' option is set
4643 if (!p_bk
&& backup
!= NULL
&& mch_remove(backup
) != 0)
4644 EMSG(_("E207: Can't delete backup file"));
4646 #ifdef FEAT_SUN_WORKSHOP
4647 if (usingSunWorkShop
)
4648 workshop_file_saved((char *) ffname
);
4654 * Finish up. We get here either after failure or success.
4657 --no_wait_return
; /* may wait for return now */
4660 /* Done saving, we accept changed buffer warnings again */
4661 buf
->b_saving
= FALSE
;
4664 if (buffer
!= smallbuf
)
4667 vim_free(fenc_tofree
);
4668 vim_free(write_info
.bw_conv_buf
);
4670 if (write_info
.bw_iconv_fd
!= (iconv_t
)-1)
4672 iconv_close(write_info
.bw_iconv_fd
);
4673 write_info
.bw_iconv_fd
= (iconv_t
)-1;
4683 int numlen
= errnum
!= NULL
? (int)STRLEN(errnum
) : 0;
4685 attr
= hl_attr(HLF_E
); /* set highlight for error messages */
4692 ); /* put file name in IObuff with quotes */
4693 if (STRLEN(IObuff
) + STRLEN(errmsg
) + numlen
>= IOSIZE
)
4694 IObuff
[IOSIZE
- STRLEN(errmsg
) - numlen
- 1] = NUL
;
4695 /* If the error message has the form "is ...", put the error number in
4696 * front of the file name. */
4699 STRMOVE(IObuff
+ numlen
, IObuff
);
4700 mch_memmove(IObuff
, errnum
, (size_t)numlen
);
4702 STRCAT(IObuff
, errmsg
);
4708 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4710 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4713 /* Update the timestamp to avoid an "overwrite changed file"
4714 * prompt when writing again. */
4715 if (mch_stat((char *)fname
, &st_old
) >= 0)
4717 buf_store_time(buf
, &st_old
, fname
);
4718 buf
->b_mtime_read
= buf
->b_mtime
;
4722 msg_scroll
= msg_save
;
4726 if (!should_abort(retval
))
4733 write_no_eol_lnum
= 0; /* in case it was set by the previous read */
4736 * Apply POST autocommands.
4737 * Careful: The autocommands may call buf_write() recursively!
4739 aucmd_prepbuf(&aco
, buf
);
4742 apply_autocmds_exarg(EVENT_FILEAPPENDPOST
, fname
, fname
,
4743 FALSE
, curbuf
, eap
);
4745 apply_autocmds_exarg(EVENT_FILTERWRITEPOST
, NULL
, fname
,
4746 FALSE
, curbuf
, eap
);
4747 else if (reset_changed
&& whole
)
4748 apply_autocmds_exarg(EVENT_BUFWRITEPOST
, fname
, fname
,
4749 FALSE
, curbuf
, eap
);
4751 apply_autocmds_exarg(EVENT_FILEWRITEPOST
, fname
, fname
,
4752 FALSE
, curbuf
, eap
);
4754 /* restore curwin/curbuf and a few other things */
4755 aucmd_restbuf(&aco
);
4758 if (aborting()) /* autocmds may abort script processing */
4764 got_int
|= prev_got_int
;
4766 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4767 /* Update machine specific information. */
4768 mch_post_buffer_write(buf
);
4774 * Set the name of the current buffer. Use when the buffer doesn't have a
4775 * name and a ":r" or ":w" command with a file name is used.
4778 set_rw_fname(fname
, sfname
)
4783 /* It's like the unnamed buffer is deleted.... */
4785 apply_autocmds(EVENT_BUFDELETE
, NULL
, NULL
, FALSE
, curbuf
);
4786 apply_autocmds(EVENT_BUFWIPEOUT
, NULL
, NULL
, FALSE
, curbuf
);
4788 if (aborting()) /* autocmds may abort script processing */
4793 if (setfname(curbuf
, fname
, sfname
, FALSE
) == OK
)
4794 curbuf
->b_flags
|= BF_NOTEDITED
;
4797 /* ....and a new named one is created */
4798 apply_autocmds(EVENT_BUFNEW
, NULL
, NULL
, FALSE
, curbuf
);
4800 apply_autocmds(EVENT_BUFADD
, NULL
, NULL
, FALSE
, curbuf
);
4802 if (aborting()) /* autocmds may abort script processing */
4806 /* Do filetype detection now if 'filetype' is empty. */
4807 if (*curbuf
->b_p_ft
== NUL
)
4809 if (au_has_group((char_u
*)"filetypedetect"))
4810 (void)do_doautocmd((char_u
*)"filetypedetect BufRead", FALSE
);
4819 * Put file name into IObuff with quotes.
4822 msg_add_fname(buf
, fname
)
4827 fname
= (char_u
*)"-stdin-";
4828 home_replace(buf
, fname
, IObuff
+ 1, IOSIZE
- 4, TRUE
);
4830 STRCAT(IObuff
, "\" ");
4834 * Append message for text mode to IObuff.
4835 * Return TRUE if something appended.
4838 msg_add_fileformat(eol_type
)
4842 if (eol_type
== EOL_DOS
)
4844 STRCAT(IObuff
, shortmess(SHM_TEXT
) ? _("[dos]") : _("[dos format]"));
4849 if (eol_type
== EOL_MAC
)
4851 STRCAT(IObuff
, shortmess(SHM_TEXT
) ? _("[mac]") : _("[mac format]"));
4855 #if defined(USE_CRNL) || defined(USE_CR)
4856 if (eol_type
== EOL_UNIX
)
4858 STRCAT(IObuff
, shortmess(SHM_TEXT
) ? _("[unix]") : _("[unix format]"));
4866 * Append line and character count to IObuff.
4869 msg_add_lines(insert_space
, lnum
, nchars
)
4876 p
= IObuff
+ STRLEN(IObuff
);
4880 if (shortmess(SHM_LINES
))
4881 sprintf((char *)p
, "%ldL, %ldC", lnum
, nchars
);
4885 STRCPY(p
, _("1 line, "));
4887 sprintf((char *)p
, _("%ld lines, "), lnum
);
4890 STRCPY(p
, _("1 character"));
4892 sprintf((char *)p
, _("%ld characters"), nchars
);
4897 * Append message for missing line separator to IObuff.
4902 STRCAT(IObuff
, shortmess(SHM_LAST
) ? _("[noeol]") : _("[Incomplete last line]"));
4906 * Check modification time of file, before writing to it.
4907 * The size isn't checked, because using a tool like "gzip" takes care of
4908 * using the same timestamp but can't set the size.
4911 check_mtime(buf
, st
)
4915 if (buf
->b_mtime_read
!= 0
4916 && time_differs((long)st
->st_mtime
, buf
->b_mtime_read
))
4918 msg_scroll
= TRUE
; /* don't overwrite messages here */
4919 msg_silent
= 0; /* must give this prompt */
4920 /* don't use emsg() here, don't want to flush the buffers */
4921 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
4923 if (ask_yesno((char_u
*)_("Do you really want to write to it"),
4926 msg_scroll
= FALSE
; /* always overwrite the file message now */
4932 time_differs(t1
, t2
)
4935 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
4936 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
4937 * the seconds. Since the roundoff is done when flushing the inode, the
4938 * time may change unexpectedly by one second!!! */
4939 return (t1
- t2
> 1 || t2
- t1
> 1);
4946 * Call write() to write a number of bytes to the file.
4947 * Also handles encryption and 'encoding' conversion.
4949 * Return FAIL for failure, OK otherwise.
4956 char_u
*buf
= ip
->bw_buf
; /* data to write */
4957 int len
= ip
->bw_len
; /* length of data */
4959 int flags
= ip
->bw_flags
; /* extra flags */
4964 * Skip conversion when writing the crypt magic number or the BOM.
4966 if (!(flags
& FIO_NOCONVERT
))
4972 if (flags
& FIO_UTF8
)
4975 * Convert latin1 in the buffer to UTF-8 in the file.
4977 p
= ip
->bw_conv_buf
; /* translate to buffer */
4978 for (wlen
= 0; wlen
< len
; ++wlen
)
4979 p
+= utf_char2bytes(buf
[wlen
], p
);
4980 buf
= ip
->bw_conv_buf
;
4981 len
= (int)(p
- ip
->bw_conv_buf
);
4983 else if (flags
& (FIO_UCS4
| FIO_UTF16
| FIO_UCS2
| FIO_LATIN1
))
4986 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
4987 * Latin1 chars in the file.
4989 if (flags
& FIO_LATIN1
)
4990 p
= buf
; /* translate in-place (can only get shorter) */
4992 p
= ip
->bw_conv_buf
; /* translate to buffer */
4993 for (wlen
= 0; wlen
< len
; wlen
+= n
)
4995 if (wlen
== 0 && ip
->bw_restlen
!= 0)
4999 /* Use remainder of previous call. Append the start of
5000 * buf[] to get a full sequence. Might still be too
5002 l
= CONV_RESTLEN
- ip
->bw_restlen
;
5005 mch_memmove(ip
->bw_rest
+ ip
->bw_restlen
, buf
, (size_t)l
);
5006 n
= utf_ptr2len_len(ip
->bw_rest
, ip
->bw_restlen
+ l
);
5007 if (n
> ip
->bw_restlen
+ len
)
5009 /* We have an incomplete byte sequence at the end to
5010 * be written. We can't convert it without the
5011 * remaining bytes. Keep them for the next call. */
5012 if (ip
->bw_restlen
+ len
> CONV_RESTLEN
)
5014 ip
->bw_restlen
+= len
;
5018 c
= utf_ptr2char(ip
->bw_rest
);
5021 if (n
>= ip
->bw_restlen
)
5023 n
-= ip
->bw_restlen
;
5028 ip
->bw_restlen
-= n
;
5029 mch_memmove(ip
->bw_rest
, ip
->bw_rest
+ n
,
5030 (size_t)ip
->bw_restlen
);
5036 n
= utf_ptr2len_len(buf
+ wlen
, len
- wlen
);
5039 /* We have an incomplete byte sequence at the end to
5040 * be written. We can't convert it without the
5041 * remaining bytes. Keep them for the next call. */
5042 if (len
- wlen
> CONV_RESTLEN
)
5044 ip
->bw_restlen
= len
- wlen
;
5045 mch_memmove(ip
->bw_rest
, buf
+ wlen
,
5046 (size_t)ip
->bw_restlen
);
5050 c
= utf_ptr2char(buf
+ wlen
);
5055 ip
->bw_conv_error
|= ucs2bytes(c
, &p
, flags
);
5057 if (flags
& FIO_LATIN1
)
5058 len
= (int)(p
- buf
);
5061 buf
= ip
->bw_conv_buf
;
5062 len
= (int)(p
- ip
->bw_conv_buf
);
5067 else if (flags
& FIO_CODEPAGE
)
5070 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
5080 if (ip
->bw_restlen
> 0)
5082 /* Need to concatenate the remainder of the previous call and
5083 * the bytes of the current call. Use the end of the
5084 * conversion buffer for this. */
5085 fromlen
= len
+ ip
->bw_restlen
;
5086 from
= ip
->bw_conv_buf
+ ip
->bw_conv_buflen
- fromlen
;
5087 mch_memmove(from
, ip
->bw_rest
, (size_t)ip
->bw_restlen
);
5088 mch_memmove(from
+ ip
->bw_restlen
, buf
, (size_t)len
);
5096 to
= ip
->bw_conv_buf
;
5099 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
5100 * The buffer has been allocated to be big enough. */
5103 n
= (int)utf_ptr2len_len(from
, (int)fromlen
);
5104 if (n
> (int)fromlen
) /* incomplete byte sequence */
5106 u8c
= utf_ptr2char(from
);
5107 *to
++ = (u8c
& 0xff);
5113 /* Copy remainder to ip->bw_rest[] to be used for the next
5115 if (fromlen
> CONV_RESTLEN
)
5117 /* weird overlong sequence */
5118 ip
->bw_conv_error
= TRUE
;
5121 mch_memmove(ip
->bw_rest
, from
, fromlen
);
5122 ip
->bw_restlen
= (int)fromlen
;
5126 /* Convert from enc_codepage to UCS-2, to the start of the
5127 * buffer. The buffer has been allocated to be big enough. */
5129 needed
= MultiByteToWideChar(enc_codepage
,
5130 MB_ERR_INVALID_CHARS
, (LPCSTR
)from
, (int)fromlen
,
5134 /* When conversion fails there may be a trailing byte. */
5135 needed
= MultiByteToWideChar(enc_codepage
,
5136 MB_ERR_INVALID_CHARS
, (LPCSTR
)from
, (int)fromlen
- 1,
5140 /* Conversion doesn't work. */
5141 ip
->bw_conv_error
= TRUE
;
5144 /* Save the trailing byte for the next call. */
5145 ip
->bw_rest
[0] = from
[fromlen
- 1];
5148 needed
= MultiByteToWideChar(enc_codepage
, MB_ERR_INVALID_CHARS
,
5149 (LPCSTR
)from
, (int)(fromlen
- ip
->bw_restlen
),
5150 (LPWSTR
)to
, needed
);
5153 /* Safety check: Conversion doesn't work. */
5154 ip
->bw_conv_error
= TRUE
;
5160 fromlen
= to
- ip
->bw_conv_buf
;
5162 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5163 if (FIO_GET_CP(flags
) == CP_UTF8
)
5165 /* Convert from UCS-2 to UTF-8, using the remainder of the
5166 * conversion buffer. Fails when out of space. */
5167 for (from
= ip
->bw_conv_buf
; fromlen
> 1; fromlen
-= 2)
5170 u8c
+= (*from
++ << 8);
5171 to
+= utf_char2bytes(u8c
, to
);
5172 if (to
+ 6 >= ip
->bw_conv_buf
+ ip
->bw_conv_buflen
)
5174 ip
->bw_conv_error
= TRUE
;
5178 len
= (int)(to
- buf
);
5183 /* Convert from UCS-2 to the codepage, using the remainder of
5184 * the conversion buffer. If the conversion uses the default
5185 * character "0", the data doesn't fit in this encoding, so
5187 len
= WideCharToMultiByte(FIO_GET_CP(flags
), 0,
5188 (LPCWSTR
)ip
->bw_conv_buf
, (int)fromlen
/ sizeof(WCHAR
),
5189 (LPSTR
)to
, (int)(ip
->bw_conv_buflen
- fromlen
), 0,
5193 ip
->bw_conv_error
= TRUE
;
5200 # ifdef MACOS_CONVERT
5201 else if (flags
& FIO_MACROMAN
)
5204 * Convert UTF-8 or latin1 to Apple MacRoman.
5209 if (ip
->bw_restlen
> 0)
5211 /* Need to concatenate the remainder of the previous call and
5212 * the bytes of the current call. Use the end of the
5213 * conversion buffer for this. */
5214 fromlen
= len
+ ip
->bw_restlen
;
5215 from
= ip
->bw_conv_buf
+ ip
->bw_conv_buflen
- fromlen
;
5216 mch_memmove(from
, ip
->bw_rest
, (size_t)ip
->bw_restlen
);
5217 mch_memmove(from
+ ip
->bw_restlen
, buf
, (size_t)len
);
5225 if (enc2macroman(from
, fromlen
,
5226 ip
->bw_conv_buf
, &len
, ip
->bw_conv_buflen
,
5227 ip
->bw_rest
, &ip
->bw_restlen
) == FAIL
)
5229 ip
->bw_conv_error
= TRUE
;
5232 buf
= ip
->bw_conv_buf
;
5237 if (ip
->bw_iconv_fd
!= (iconv_t
)-1)
5244 /* Convert with iconv(). */
5245 if (ip
->bw_restlen
> 0)
5247 /* Need to concatenate the remainder of the previous call and
5248 * the bytes of the current call. Use the end of the
5249 * conversion buffer for this. */
5250 fromlen
= len
+ ip
->bw_restlen
;
5251 from
= (char *)ip
->bw_conv_buf
+ ip
->bw_conv_buflen
- fromlen
;
5252 mch_memmove((void *)from
, ip
->bw_rest
, (size_t)ip
->bw_restlen
);
5253 mch_memmove((void *)(from
+ ip
->bw_restlen
), buf
, (size_t)len
);
5254 tolen
= ip
->bw_conv_buflen
- fromlen
;
5258 from
= (const char *)buf
;
5260 tolen
= ip
->bw_conv_buflen
;
5262 to
= (char *)ip
->bw_conv_buf
;
5266 size_t save_len
= tolen
;
5268 /* output the initial shift state sequence */
5269 (void)iconv(ip
->bw_iconv_fd
, NULL
, NULL
, &to
, &tolen
);
5271 /* There is a bug in iconv() on Linux (which appears to be
5272 * wide-spread) which sets "to" to NULL and messes up "tolen".
5276 to
= (char *)ip
->bw_conv_buf
;
5279 ip
->bw_first
= FALSE
;
5283 * If iconv() has an error or there is not enough room, fail.
5285 if ((iconv(ip
->bw_iconv_fd
, (void *)&from
, &fromlen
, &to
, &tolen
)
5286 == (size_t)-1 && ICONV_ERRNO
!= ICONV_EINVAL
)
5287 || fromlen
> CONV_RESTLEN
)
5289 ip
->bw_conv_error
= TRUE
;
5293 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5295 mch_memmove(ip
->bw_rest
, (void *)from
, fromlen
);
5296 ip
->bw_restlen
= (int)fromlen
;
5298 buf
= ip
->bw_conv_buf
;
5299 len
= (int)((char_u
*)to
- ip
->bw_conv_buf
);
5303 #endif /* FEAT_MBYTE */
5306 if (flags
& FIO_ENCRYPTED
) /* encrypt the data */
5310 for (i
= 0; i
< len
; i
++)
5313 buf
[i
] = ZENCODE(ztemp
, t
);
5318 /* Repeat the write(), it may be interrupted by a signal. */
5321 wlen
= vim_write(ip
->bw_fd
, buf
, len
);
5322 if (wlen
<= 0) /* error! */
5332 * Convert a Unicode character to bytes.
5335 ucs2bytes(c
, pp
, flags
)
5336 unsigned c
; /* in: character */
5337 char_u
**pp
; /* in/out: pointer to result */
5338 int flags
; /* FIO_ flags */
5345 if (flags
& FIO_UCS4
)
5347 if (flags
& FIO_ENDIAN_L
)
5362 else if (flags
& (FIO_UCS2
| FIO_UTF16
))
5366 if (flags
& FIO_UTF16
)
5368 /* Make two words, ten bits of the character in each. First
5369 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5373 cc
= ((c
>> 10) & 0x3ff) + 0xd800;
5374 if (flags
& FIO_ENDIAN_L
)
5377 *p
++ = ((unsigned)cc
>> 8);
5381 *p
++ = ((unsigned)cc
>> 8);
5384 c
= (c
& 0x3ff) + 0xdc00;
5389 if (flags
& FIO_ENDIAN_L
)
5416 * Return TRUE if "a" and "b" are the same 'encoding'.
5417 * Ignores difference between "ansi" and "latin1", "ucs-4" and "ucs-4be", etc.
5426 if (STRCMP(a
, b
) == 0)
5428 f
= get_fio_flags(a
);
5429 return (f
!= 0 && get_fio_flags(b
) == f
);
5433 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5434 * internal conversion.
5435 * if "ptr" is an empty string, use 'encoding'.
5446 prop
= enc_canon_props(ptr
);
5447 if (prop
& ENC_UNICODE
)
5449 if (prop
& ENC_2BYTE
)
5451 if (prop
& ENC_ENDIAN_L
)
5452 return FIO_UCS2
| FIO_ENDIAN_L
;
5455 if (prop
& ENC_4BYTE
)
5457 if (prop
& ENC_ENDIAN_L
)
5458 return FIO_UCS4
| FIO_ENDIAN_L
;
5461 if (prop
& ENC_2WORD
)
5463 if (prop
& ENC_ENDIAN_L
)
5464 return FIO_UTF16
| FIO_ENDIAN_L
;
5469 if (prop
& ENC_LATIN1
)
5471 /* must be ENC_DBCS, requires iconv() */
5477 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5478 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5479 * Used for conversion between 'encoding' and 'fileencoding'.
5482 get_win_fio_flags(ptr
)
5487 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5488 if (!enc_utf8
&& enc_codepage
<= 0)
5491 cp
= encname2codepage(ptr
);
5494 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5495 if (STRCMP(ptr
, "utf-8") == 0)
5501 return FIO_PUT_CP(cp
) | FIO_CODEPAGE
;
5507 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5508 * needed for the internal conversion to/from utf-8 or latin1.
5511 get_mac_fio_flags(ptr
)
5514 if ((enc_utf8
|| STRCMP(p_enc
, "latin1") == 0)
5515 && (enc_canon_props(ptr
) & ENC_MACROMAN
))
5516 return FIO_MACROMAN
;
5522 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5523 * "size" must be at least 2.
5524 * Return the name of the encoding and set "*lenp" to the length.
5525 * Returns NULL when no BOM found.
5528 check_for_bom(p
, size
, lenp
, flags
)
5537 if (p
[0] == 0xef && p
[1] == 0xbb && size
>= 3 && p
[2] == 0xbf
5538 && (flags
== FIO_ALL
|| flags
== FIO_UTF8
|| flags
== 0))
5540 name
= "utf-8"; /* EF BB BF */
5543 else if (p
[0] == 0xff && p
[1] == 0xfe)
5545 if (size
>= 4 && p
[2] == 0 && p
[3] == 0
5546 && (flags
== FIO_ALL
|| flags
== (FIO_UCS4
| FIO_ENDIAN_L
)))
5548 name
= "ucs-4le"; /* FF FE 00 00 */
5551 else if (flags
== (FIO_UCS2
| FIO_ENDIAN_L
))
5552 name
= "ucs-2le"; /* FF FE */
5553 else if (flags
== FIO_ALL
|| flags
== (FIO_UTF16
| FIO_ENDIAN_L
))
5554 /* utf-16le is preferred, it also works for ucs-2le text */
5555 name
= "utf-16le"; /* FF FE */
5557 else if (p
[0] == 0xfe && p
[1] == 0xff
5558 && (flags
== FIO_ALL
|| flags
== FIO_UCS2
|| flags
== FIO_UTF16
))
5560 /* Default to utf-16, it works also for ucs-2 text. */
5561 if (flags
== FIO_UCS2
)
5562 name
= "ucs-2"; /* FE FF */
5564 name
= "utf-16"; /* FE FF */
5566 else if (size
>= 4 && p
[0] == 0 && p
[1] == 0 && p
[2] == 0xfe
5567 && p
[3] == 0xff && (flags
== FIO_ALL
|| flags
== FIO_UCS4
))
5569 name
= "ucs-4"; /* 00 00 FE FF */
5574 return (char_u
*)name
;
5578 * Generate a BOM in "buf[4]" for encoding "name".
5579 * Return the length of the BOM (zero when no BOM).
5589 flags
= get_fio_flags(name
);
5591 /* Can't put a BOM in a non-Unicode file. */
5592 if (flags
== FIO_LATIN1
|| flags
== 0)
5595 if (flags
== FIO_UTF8
) /* UTF-8 */
5603 (void)ucs2bytes(0xfeff, &p
, flags
);
5604 return (int)(p
- buf
);
5608 #if defined(FEAT_VIMINFO) || defined(FEAT_BROWSE) || \
5609 defined(FEAT_QUICKFIX) || defined(FEAT_AUTOCMD) || defined(PROTO)
5611 * Try to find a shortname by comparing the fullname with the current
5613 * Returns "full_path" or pointer into "full_path" if shortened.
5616 shorten_fname1(full_path
)
5619 char_u dirname
[MAXPATHL
];
5620 char_u
*p
= full_path
;
5622 if (mch_dirname(dirname
, MAXPATHL
) == OK
)
5624 p
= shorten_fname(full_path
, dirname
);
5625 if (p
== NULL
|| *p
== NUL
)
5633 * Try to find a shortname by comparing the fullname with the current
5635 * Returns NULL if not shorter name possible, pointer into "full_path"
5639 shorten_fname(full_path
, dir_name
)
5646 if (full_path
== NULL
)
5648 len
= (int)STRLEN(dir_name
);
5649 if (fnamencmp(dir_name
, full_path
, len
) == 0)
5651 p
= full_path
+ len
;
5652 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5654 * MSDOS: when a file is in the root directory, dir_name will end in a
5655 * slash, since C: by itself does not define a specific dir. In this
5656 * case p may already be correct. <negri>
5658 if (!((len
> 2) && (*(p
- 2) == ':')))
5661 if (vim_ispathsep(*p
))
5663 #ifndef VMS /* the path separator is always part of the path */
5669 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5671 * When using a file in the current drive, remove the drive name:
5672 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5673 * a floppy from "A:\dir" to "B:\dir".
5676 && TOUPPER_LOC(full_path
[0]) == TOUPPER_LOC(dir_name
[0])
5677 && full_path
[1] == ':'
5678 && vim_ispathsep(full_path
[2]))
5687 * Shorten filenames for all buffers.
5688 * When "force" is TRUE: Use full path from now on for files currently being
5689 * edited, both for file name and swap file name. Try to shorten the file
5690 * names a bit, if safe to do so.
5691 * When "force" is FALSE: Only try to shorten absolute file names.
5692 * For buffers that have buftype "nofile" or "scratch": never change the file
5696 shorten_fnames(force
)
5699 char_u dirname
[MAXPATHL
];
5703 mch_dirname(dirname
, MAXPATHL
);
5704 for (buf
= firstbuf
; buf
!= NULL
; buf
= buf
->b_next
)
5706 if (buf
->b_fname
!= NULL
5707 #ifdef FEAT_QUICKFIX
5710 && !path_with_url(buf
->b_fname
)
5712 || buf
->b_sfname
== NULL
5713 || mch_isFullName(buf
->b_sfname
)))
5715 vim_free(buf
->b_sfname
);
5716 buf
->b_sfname
= NULL
;
5717 p
= shorten_fname(buf
->b_ffname
, dirname
);
5720 buf
->b_sfname
= vim_strsave(p
);
5721 buf
->b_fname
= buf
->b_sfname
;
5723 if (p
== NULL
|| buf
->b_fname
== NULL
)
5724 buf
->b_fname
= buf
->b_ffname
;
5727 /* Always make the swap file name a full path, a "nofile" buffer may
5728 * also have a swap file. */
5729 mf_fullname(buf
->b_ml
.ml_mfp
);
5732 status_redraw_all();
5733 redraw_tabline
= TRUE
;
5737 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5738 || defined(FEAT_GUI_MSWIN) \
5739 || defined(FEAT_GUI_MAC) \
5742 * Shorten all filenames in "fnames[count]" by current directory.
5745 shorten_filenames(fnames
, count
)
5750 char_u dirname
[MAXPATHL
];
5753 if (fnames
== NULL
|| count
< 1)
5755 mch_dirname(dirname
, sizeof(dirname
));
5756 for (i
= 0; i
< count
; ++i
)
5758 if ((p
= shorten_fname(fnames
[i
], dirname
)) != NULL
)
5760 /* shorten_fname() returns pointer in given "fnames[i]". If free
5761 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5762 * "p" first then free fnames[i]. */
5764 vim_free(fnames
[i
]);
5772 * add extension to file name - change path/fo.o.h to path/fo.o.h.ext or
5773 * fo_o_h.ext for MSDOS or when shortname option set.
5775 * Assumed that fname is a valid name found in the filesystem we assure that
5776 * the return value is a different name and ends in 'ext'.
5777 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5778 * characters otherwise.
5779 * Space for the returned name is allocated, must be freed later.
5780 * Returns NULL when out of memory.
5783 modname(fname
, ext
, prepend_dot
)
5784 char_u
*fname
, *ext
;
5785 int prepend_dot
; /* may prepend a '.' to file name */
5791 (curbuf
->b_p_sn
|| curbuf
->b_shortname
),
5793 fname
, ext
, prepend_dot
);
5797 buf_modname(shortname
, fname
, ext
, prepend_dot
)
5798 int shortname
; /* use 8.3 file name */
5799 char_u
*fname
, *ext
;
5800 int prepend_dot
; /* may prepend a '.' to file name */
5806 int fnamelen
, extlen
;
5808 extlen
= (int)STRLEN(ext
);
5811 * If there is no file name we must get the name of the current directory
5812 * (we need the full path in case :cd is used).
5814 if (fname
== NULL
|| *fname
== NUL
)
5816 retval
= alloc((unsigned)(MAXPATHL
+ extlen
+ 3));
5819 if (mch_dirname(retval
, MAXPATHL
) == FAIL
||
5820 (fnamelen
= (int)STRLEN(retval
)) == 0)
5825 if (!after_pathsep(retval
, retval
+ fnamelen
))
5827 retval
[fnamelen
++] = PATHSEP
;
5828 retval
[fnamelen
] = NUL
;
5831 prepend_dot
= FALSE
; /* nothing to prepend a dot to */
5836 fnamelen
= (int)STRLEN(fname
);
5837 retval
= alloc((unsigned)(fnamelen
+ extlen
+ 3));
5840 STRCPY(retval
, fname
);
5842 vms_remove_version(retval
); /* we do not need versions here */
5847 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5848 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5849 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5850 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5852 for (ptr
= retval
+ fnamelen
; ptr
> retval
; mb_ptr_back(retval
, ptr
))
5856 # ifdef USE_LONG_FNAME
5857 && (!USE_LONG_FNAME
|| shortname
)
5859 # ifndef SHORT_FNAME
5864 if (*ptr
== '.') /* replace '.' by '_' */
5867 if (vim_ispathsep(*ptr
))
5874 /* the file name has at most BASENAMELEN characters. */
5876 if (STRLEN(ptr
) > (unsigned)BASENAMELEN
)
5877 ptr
[BASENAMELEN
] = '\0';
5880 s
= ptr
+ STRLEN(ptr
);
5883 * For 8.3 file names we may have to reduce the length.
5885 #ifdef USE_LONG_FNAME
5886 if (!USE_LONG_FNAME
|| shortname
)
5888 # ifndef SHORT_FNAME
5894 * If there is no file name, or the file name ends in '/', and the
5895 * extension starts with '.', put a '_' before the dot, because just
5896 * ".ext" is invalid.
5898 if (fname
== NULL
|| *fname
== NUL
5899 || vim_ispathsep(fname
[STRLEN(fname
) - 1]))
5909 * If the extension starts with '.', truncate the base name at 8
5913 /* We normally use '/', but swap files are '_' */
5914 else if (*ext
== '/' || *ext
== '_')
5916 else if (*ext
== '.')
5919 if (s
- ptr
> (size_t)8)
5926 * If the extension doesn't start with '.', and the file name
5927 * doesn't have an extension yet, append a '.'
5930 else if ((e
= vim_strchr(ptr
, '/')) == NULL
)
5933 else if ((e
= vim_strchr(ptr
, '.')) == NULL
)
5937 * If the extension doesn't start with '.', and there already is an
5938 * extension, it may need to be truncated
5940 else if ((int)STRLEN(e
) + extlen
> 4)
5943 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
5945 * If there is no file name, and the extension starts with '.', put a
5946 * '_' before the dot, because just ".ext" may be invalid if it's on a
5947 * FAT partition, and on HPFS it doesn't matter.
5949 else if ((fname
== NULL
|| *fname
== NUL
) && *ext
== '.')
5954 * Append the extension.
5955 * ext can start with '.' and cannot exceed 3 more characters.
5963 if (prepend_dot
&& !shortname
&& *(e
= gettail(retval
)) !=
5969 #ifdef USE_LONG_FNAME
5984 * Check that, after appending the extension, the file name is really
5987 if (fname
!= NULL
&& STRCMP(fname
, retval
) == 0)
5989 /* we search for a character that can be replaced by '_' */
5998 if (s
< ptr
) /* fname was "________.<ext>", how tricky! */
6005 * Like fgets(), but if the file line is too long, it is truncated and the
6006 * rest of the line is thrown away. Returns TRUE for end-of-file.
6009 vim_fgets(buf
, size
, fp
)
6015 #define FGETS_SIZE 200
6016 char tbuf
[FGETS_SIZE
];
6018 buf
[size
- 2] = NUL
;
6020 eof
= fgets_cr((char *)buf
, size
, fp
);
6022 eof
= fgets((char *)buf
, size
, fp
);
6024 if (buf
[size
- 2] != NUL
&& buf
[size
- 2] != '\n')
6026 buf
[size
- 1] = NUL
; /* Truncate the line */
6028 /* Now throw away the rest of the line: */
6031 tbuf
[FGETS_SIZE
- 2] = NUL
;
6033 ignoredp
= fgets_cr((char *)tbuf
, FGETS_SIZE
, fp
);
6035 ignoredp
= fgets((char *)tbuf
, FGETS_SIZE
, fp
);
6037 } while (tbuf
[FGETS_SIZE
- 2] != NUL
&& tbuf
[FGETS_SIZE
- 2] != '\n');
6039 return (eof
== NULL
);
6042 #if defined(USE_CR) || defined(PROTO)
6044 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
6045 * Returns TRUE for end-of-file.
6046 * Only used for the Mac, because it's much slower than vim_fgets().
6049 tag_fgets(buf
, size
, fp
)
6068 /* Always store a NL for end-of-line. */
6072 if (c
!= '\n') /* Macintosh format: single CR. */
6087 * rename() only works if both files are on the same file system, this
6088 * function will (attempts to?) copy the file across if rename fails -- webb
6089 * Return -1 for failure, 0 for success.
6092 vim_rename(from
, to
)
6099 char *errmsg
= NULL
;
6107 vim_acl_T acl
; /* ACL from original file */
6111 * When the names are identical, there is nothing to do.
6113 if (fnamecmp(from
, to
) == 0)
6117 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
6119 if (mch_stat((char *)from
, &st
) < 0)
6123 * Delete the "to" file, this is required on some systems to make the
6124 * mch_rename() work, on other systems it makes sure that we don't have
6125 * two files when the mch_rename() fails.
6130 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
6131 * that the name of the "to" file is the same as the "from" file, even
6132 * though the names are different. To avoid the chance of accidentally
6133 * deleting the "from" file (horror!) we lock it during the remove.
6135 * When used for making a backup before writing the file: This should not
6136 * happen with ":w", because startscript() should detect this problem and
6137 * set buf->b_shortname, causing modname() to return a correct ".bak" file
6138 * name. This problem does exist with ":w filename", but then the
6139 * original file will be somewhere else so the backup isn't really
6140 * important. If autoscripting is off the rename may fail.
6142 flock
= Lock((UBYTE
*)from
, (long)ACCESS_READ
);
6151 * First try a normal rename, return if it works.
6153 if (mch_rename((char *)from
, (char *)to
) == 0)
6157 * Rename() failed, try copying the file.
6159 perm
= mch_getperm(from
);
6161 /* For systems that support ACL: get the ACL from the original file. */
6162 acl
= mch_get_acl(from
);
6164 fd_in
= mch_open((char *)from
, O_RDONLY
|O_EXTRA
, 0);
6173 /* Create the new file with same permissions as the original. */
6174 fd_out
= mch_open((char *)to
,
6175 O_CREAT
|O_EXCL
|O_WRONLY
|O_EXTRA
|O_NOFOLLOW
, (int)perm
);
6185 buffer
= (char *)alloc(BUFSIZE
);
6196 while ((n
= vim_read(fd_in
, buffer
, BUFSIZE
)) > 0)
6197 if (vim_write(fd_out
, buffer
, n
) != n
)
6199 errmsg
= _("E208: Error writing to \"%s\"");
6205 if (close(fd_out
) < 0)
6206 errmsg
= _("E209: Error closing \"%s\"");
6209 errmsg
= _("E210: Error reading \"%s\"");
6212 #ifndef UNIX /* for Unix mch_open() already set the permission */
6213 mch_setperm(to
, perm
);
6216 mch_set_acl(to
, acl
);
6228 static int already_warned
= FALSE
;
6231 * Check if any not hidden buffer has been changed.
6232 * Postpone the check if there are characters in the stuff buffer, a global
6233 * command is being executed, a mapping is being executed or an autocommand is
6235 * Returns TRUE if some message was written (screen should be redrawn and
6236 * cursor positioned).
6239 check_timestamps(focus
)
6240 int focus
; /* called for GUI focus event */
6246 /* Don't check timestamps while system() or another low-level function may
6247 * cause us to lose and gain focus. */
6248 if (no_check_timestamps
> 0)
6251 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6252 * event and we would keep on checking if the file is steadily growing.
6253 * Do check again after typing something. */
6254 if (focus
&& did_check_timestamps
)
6256 need_check_timestamps
= TRUE
;
6260 if (!stuff_empty() || global_busy
|| !typebuf_typed()
6262 || autocmd_busy
|| curbuf_lock
> 0
6265 need_check_timestamps
= TRUE
; /* check later */
6269 did_check_timestamps
= TRUE
;
6270 already_warned
= FALSE
;
6271 for (buf
= firstbuf
; buf
!= NULL
; )
6273 /* Only check buffers in a window. */
6274 if (buf
->b_nwindows
> 0)
6276 n
= buf_check_timestamp(buf
, focus
);
6279 if (n
> 0 && !buf_valid(buf
))
6281 /* Autocommands have removed the buffer, start at the
6282 * first one again. */
6290 need_check_timestamps
= FALSE
;
6291 if (need_wait_return
&& didit
== 2)
6293 /* make sure msg isn't overwritten */
6294 msg_puts((char_u
*)"\n");
6302 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6303 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6307 move_lines(frombuf
, tobuf
)
6311 buf_T
*tbuf
= curbuf
;
6316 /* Copy the lines in "frombuf" to "tobuf". */
6318 for (lnum
= 1; lnum
<= frombuf
->b_ml
.ml_line_count
; ++lnum
)
6320 p
= vim_strsave(ml_get_buf(frombuf
, lnum
, FALSE
));
6321 if (p
== NULL
|| ml_append(lnum
- 1, p
, 0, FALSE
) == FAIL
)
6330 /* Delete all the lines in "frombuf". */
6334 for (lnum
= curbuf
->b_ml
.ml_line_count
; lnum
> 0; --lnum
)
6335 if (ml_delete(lnum
, FALSE
) == FAIL
)
6337 /* Oops! We could try putting back the saved lines, but that
6338 * might fail again... */
6349 * Check if buffer "buf" has been changed.
6350 * Also check if the file for a new buffer unexpectedly appeared.
6351 * return 1 if a changed buffer was found.
6352 * return 2 if a message has been displayed.
6353 * return 0 otherwise.
6357 buf_check_timestamp(buf
, focus
)
6359 int focus
; /* called for GUI focus event */
6368 int helpmesg
= FALSE
;
6370 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6371 int can_reload
= FALSE
;
6373 size_t orig_size
= buf
->b_orig_size
;
6374 int orig_mode
= buf
->b_orig_mode
;
6376 int save_mouse_correct
= need_mouse_correct
;
6379 static int busy
= FALSE
;
6385 /* If there is no file name, the buffer is not loaded, 'buftype' is
6386 * set, we are in the middle of a save or being called recursively: ignore
6388 if (buf
->b_ffname
== NULL
6389 || buf
->b_ml
.ml_mfp
== NULL
6390 #if defined(FEAT_QUICKFIX)
6391 || *buf
->b_p_bt
!= NUL
6397 #ifdef FEAT_NETBEANS_INTG
6398 || isNetbeansBuffer(buf
)
6403 if ( !(buf
->b_flags
& BF_NOTEDITED
)
6404 && buf
->b_mtime
!= 0
6405 && ((stat_res
= mch_stat((char *)buf
->b_ffname
, &st
)) < 0
6406 || time_differs((long)st
.st_mtime
, buf
->b_mtime
)
6408 || (int)st
.st_mode
!= buf
->b_orig_mode
6410 || mch_getperm(buf
->b_ffname
) != buf
->b_orig_mode
6416 /* set b_mtime to stop further warnings (e.g., when executing
6417 * FileChangedShell autocmd) */
6421 buf
->b_orig_size
= 0;
6422 buf
->b_orig_mode
= 0;
6425 buf_store_time(buf
, &st
, buf
->b_ffname
);
6427 /* Don't do anything for a directory. Might contain the file
6429 if (mch_isdir(buf
->b_fname
))
6433 * If 'autoread' is set, the buffer has no changes and the file still
6434 * exists, reload the buffer. Use the buffer-local option value if it
6435 * was set, the global option value otherwise.
6437 else if ((buf
->b_p_ar
>= 0 ? buf
->b_p_ar
: p_ar
)
6438 && !bufIsChanged(buf
) && stat_res
>= 0)
6444 else if (bufIsChanged(buf
))
6445 reason
= "conflict";
6446 else if (orig_size
!= buf
->b_orig_size
|| buf_contents_changed(buf
))
6448 else if (orig_mode
!= buf
->b_orig_mode
)
6455 * Only give the warning if there are no FileChangedShell
6457 * Avoid being called recursively by setting "busy".
6461 set_vim_var_string(VV_FCS_REASON
, (char_u
*)reason
, -1);
6462 set_vim_var_string(VV_FCS_CHOICE
, (char_u
*)"", -1);
6464 n
= apply_autocmds(EVENT_FILECHANGEDSHELL
,
6465 buf
->b_fname
, buf
->b_fname
, FALSE
, buf
);
6469 if (!buf_valid(buf
))
6470 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6472 s
= get_vim_var_str(VV_FCS_CHOICE
);
6473 if (STRCMP(s
, "reload") == 0 && *reason
!= 'd')
6475 else if (STRCMP(s
, "ask") == 0)
6485 mesg
= _("E211: File \"%s\" no longer available");
6489 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6493 * Check if the file contents really changed to avoid
6494 * giving a warning when only the timestamp was set (e.g.,
6495 * checked out of CVS). Always warn when the buffer was
6498 if (reason
[2] == 'n')
6500 mesg
= _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6501 mesg2
= _("See \":help W12\" for more info.");
6503 else if (reason
[1] == 'h')
6505 mesg
= _("W11: Warning: File \"%s\" has changed since editing started");
6506 mesg2
= _("See \":help W11\" for more info.");
6508 else if (*reason
== 'm')
6510 mesg
= _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6511 mesg2
= _("See \":help W16\" for more info.");
6513 /* Else: only timestamp changed, ignored */
6519 else if ((buf
->b_flags
& BF_NEW
) && !(buf
->b_flags
& BF_NEW_W
)
6520 && vim_fexists(buf
->b_ffname
))
6523 mesg
= _("W13: Warning: File \"%s\" has been created after editing started");
6524 buf
->b_flags
|= BF_NEW_W
;
6525 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6532 path
= home_replace_save(buf
, buf
->b_fname
);
6537 tbuf
= alloc((unsigned)(STRLEN(path
) + STRLEN(mesg
)
6538 + STRLEN(mesg2
) + 2));
6539 sprintf((char *)tbuf
, mesg
, path
);
6540 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6546 STRCAT(tbuf
, mesg2
);
6548 if (do_dialog(VIM_WARNING
, (char_u
*)_("Warning"), tbuf
,
6549 (char_u
*)_("&OK\n&Load File"), 1, NULL
) == 2)
6554 if (State
> NORMAL_BUSY
|| (State
& CMDLINE
) || already_warned
)
6559 STRCAT(tbuf
, mesg2
);
6566 # ifdef FEAT_AUTOCMD
6571 msg_puts_attr(tbuf
, hl_attr(HLF_E
) + MSG_HIST
);
6573 msg_puts_attr((char_u
*)mesg2
,
6574 hl_attr(HLF_W
) + MSG_HIST
);
6577 if (emsg_silent
== 0)
6583 /* give the user some time to think about it */
6584 ui_delay(1000L, TRUE
);
6586 /* don't redraw and erase the message */
6587 redraw_cmdline
= FALSE
;
6590 already_warned
= TRUE
;
6599 /* Reload the buffer. */
6600 buf_reload(buf
, orig_mode
);
6603 /* Trigger FileChangedShell when the file was changed in any way. */
6604 if (buf_valid(buf
) && retval
!= 0)
6605 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST
,
6606 buf
->b_fname
, buf
->b_fname
, FALSE
, buf
);
6609 /* restore this in case an autocommand has set it; it would break
6611 need_mouse_correct
= save_mouse_correct
;
6618 * Reload a buffer that is already loaded.
6619 * Used when the file was changed outside of Vim.
6620 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6621 * buf->b_orig_mode may have been reset already.
6624 buf_reload(buf
, orig_mode
)
6630 linenr_T old_topline
;
6631 int old_ro
= buf
->b_p_ro
;
6636 /* set curwin/curbuf for "buf" and save some things */
6637 aucmd_prepbuf(&aco
, buf
);
6639 /* We only want to read the text from the file, not reset the syntax
6640 * highlighting, clear marks, diff status, etc. Force the fileformat
6641 * and encoding to be the same. */
6642 if (prep_exarg(&ea
, buf
) == OK
)
6644 old_cursor
= curwin
->w_cursor
;
6645 old_topline
= curwin
->w_topline
;
6648 * To behave like when a new file is edited (matters for
6649 * BufReadPost autocommands) we first need to delete the current
6650 * buffer contents. But if reading the file fails we should keep
6651 * the old contents. Can't use memory only, the file might be
6652 * too big. Use a hidden buffer to move the buffer contents to.
6658 /* Allocate a buffer without putting it in the buffer list. */
6659 savebuf
= buflist_new(NULL
, NULL
, (linenr_T
)1, BLN_DUMMY
);
6660 if (savebuf
!= NULL
&& buf
== curbuf
)
6662 /* Open the memline. */
6664 curwin
->w_buffer
= savebuf
;
6665 saved
= ml_open(curbuf
);
6667 curwin
->w_buffer
= buf
;
6669 if (savebuf
== NULL
|| saved
== FAIL
|| buf
!= curbuf
6670 || move_lines(buf
, savebuf
) == FAIL
)
6672 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6680 curbuf
->b_flags
|= BF_CHECK_RO
; /* check for RO again */
6682 keep_filetype
= TRUE
; /* don't detect 'filetype' */
6684 if (readfile(buf
->b_ffname
, buf
->b_fname
, (linenr_T
)0,
6686 (linenr_T
)MAXLNUM
, &ea
, READ_NEW
) == FAIL
)
6688 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6691 EMSG2(_("E321: Could not reload \"%s\""), buf
->b_fname
);
6692 if (savebuf
!= NULL
&& buf_valid(savebuf
) && buf
== curbuf
)
6694 /* Put the text back from the save buffer. First
6695 * delete any lines that readfile() added. */
6697 if (ml_delete(buf
->b_ml
.ml_line_count
, FALSE
) == FAIL
)
6699 (void)move_lines(savebuf
, buf
);
6702 else if (buf
== curbuf
)
6704 /* Mark the buffer as unmodified and free undo info. */
6705 unchanged(buf
, TRUE
);
6712 if (savebuf
!= NULL
&& buf_valid(savebuf
))
6713 wipe_buffer(savebuf
, FALSE
);
6716 /* Invalidate diff info if necessary. */
6717 diff_invalidate(curbuf
);
6720 /* Restore the topline and cursor position and check it (lines may
6721 * have been removed). */
6722 if (old_topline
> curbuf
->b_ml
.ml_line_count
)
6723 curwin
->w_topline
= curbuf
->b_ml
.ml_line_count
;
6725 curwin
->w_topline
= old_topline
;
6726 curwin
->w_cursor
= old_cursor
;
6730 keep_filetype
= FALSE
;
6736 /* Update folds unless they are defined manually. */
6738 if (wp
->w_buffer
== curwin
->w_buffer
6739 && !foldmethodIsManual(wp
))
6743 /* If the mode didn't change and 'readonly' was set, keep the old
6744 * value; the user probably used the ":view" command. But don't
6745 * reset it, might have had a read error. */
6746 if (orig_mode
== curbuf
->b_orig_mode
)
6747 curbuf
->b_p_ro
|= old_ro
;
6750 /* restore curwin/curbuf and a few other things */
6751 aucmd_restbuf(&aco
);
6752 /* Careful: autocommands may have made "buf" invalid! */
6757 buf_store_time(buf
, st
, fname
)
6762 buf
->b_mtime
= (long)st
->st_mtime
;
6763 buf
->b_orig_size
= (size_t)st
->st_size
;
6765 buf
->b_orig_mode
= (int)st
->st_mode
;
6767 buf
->b_orig_mode
= mch_getperm(fname
);
6772 * Adjust the line with missing eol, used for the next write.
6773 * Used for do_filter(), when the input lines for the filter are deleted.
6776 write_lnum_adjust(offset
)
6779 if (write_no_eol_lnum
!= 0) /* only if there is a missing eol */
6780 write_no_eol_lnum
+= offset
;
6783 #if defined(TEMPDIRNAMES) || defined(PROTO)
6784 static long temp_count
= 0; /* Temp filename counter. */
6787 * Delete the temp directory and all files it contains.
6796 if (vim_tempdir
!= NULL
)
6798 sprintf((char *)NameBuff
, "%s*", vim_tempdir
);
6799 if (gen_expand_wildcards(1, &NameBuff
, &file_count
, &files
,
6800 EW_DIR
|EW_FILE
|EW_SILENT
) == OK
)
6802 for (i
= 0; i
< file_count
; ++i
)
6803 mch_remove(files
[i
]);
6804 FreeWild(file_count
, files
);
6806 gettail(NameBuff
)[-1] = NUL
;
6807 (void)mch_rmdir(NameBuff
);
6809 vim_free(vim_tempdir
);
6816 * vim_tempname(): Return a unique name that can be used for a temp file.
6818 * The temp file is NOT created.
6820 * The returned pointer is to allocated memory.
6821 * The returned pointer is NULL if no valid name was found.
6825 vim_tempname(extra_char
)
6826 int extra_char
; /* character to use in the name instead of '?' */
6829 char_u itmp
[L_tmpnam
]; /* use tmpnam() */
6831 char_u itmp
[TEMPNAMELEN
];
6835 static char *(tempdirs
[]) = {TEMPDIRNAMES
};
6844 * This will create a directory for private use by this instance of Vim.
6845 * This is done once, and the same directory is used for all temp files.
6846 * This method avoids security problems because of symlink attacks et al.
6847 * It's also a bit faster, because we only need to check for an existing
6848 * file when creating the directory and not for each temp file.
6850 if (vim_tempdir
== NULL
)
6853 * Try the entries in TEMPDIRNAMES to create the temp directory.
6855 for (i
= 0; i
< sizeof(tempdirs
) / sizeof(char *); ++i
)
6857 /* expand $TMP, leave room for "/v1100000/999999999" */
6858 expand_env((char_u
*)tempdirs
[i
], itmp
, TEMPNAMELEN
- 20);
6859 if (mch_isdir(itmp
)) /* directory exists */
6862 /* If $TMP contains a forward slash (perhaps using bash or
6863 * tcsh), don't add a backslash, use a forward slash!
6864 * Adding 2 backslashes didn't work. */
6865 if (vim_strchr(itmp
, '/') != NULL
)
6871 /* Get an arbitrary number of up to 6 digits. When it's
6872 * unlikely that it already exists it will be faster,
6873 * otherwise it doesn't matter. The use of mkdir() avoids any
6874 * security problems because of the predictable number. */
6875 nr
= (mch_get_pid() + (long)time(NULL
)) % 1000000L;
6877 /* Try up to 10000 different values until we find a name that
6879 for (off
= 0; off
< 10000L; ++off
)
6882 #if defined(UNIX) || defined(VMS)
6886 sprintf((char *)itmp
+ STRLEN(itmp
), "v%ld", nr
+ off
);
6888 /* If mkdir() does not set errno to EEXIST, check for
6889 * existing file here. There is a race condition then,
6890 * although it's fail-safe. */
6891 if (mch_stat((char *)itmp
, &st
) >= 0)
6894 #if defined(UNIX) || defined(VMS)
6895 /* Make sure the umask doesn't remove the executable bit.
6896 * "repl" has been reported to use "177". */
6897 umask_save
= umask(077);
6899 r
= vim_mkdir(itmp
, 0700);
6900 #if defined(UNIX) || defined(VMS)
6901 (void)umask(umask_save
);
6907 /* Directory was created, use this name.
6908 * Expand to full path; When using the current
6909 * directory a ":cd" would confuse us. */
6910 buf
= alloc((unsigned)MAXPATHL
+ 1);
6913 if (vim_FullName(itmp
, buf
, MAXPATHL
, FALSE
)
6917 if (vim_strchr(buf
, '/') != NULL
)
6922 vim_tempdir
= vim_strsave(buf
);
6928 /* If the mkdir() didn't fail because the file/dir exists,
6929 * we probably can't create any dir here, try another
6931 if (errno
!= EEXIST
)
6935 if (vim_tempdir
!= NULL
)
6941 if (vim_tempdir
!= NULL
)
6943 /* There is no need to check if the file exists, because we own the
6944 * directory and nobody else creates a file in it. */
6945 sprintf((char *)itmp
, "%s%ld", vim_tempdir
, temp_count
++);
6946 return vim_strsave(itmp
);
6951 #else /* TEMPDIRNAMES */
6954 char szTempFile
[_MAX_PATH
+ 1];
6960 if (GetTempPath(_MAX_PATH
, szTempFile
) == 0)
6961 szTempFile
[0] = NUL
; /* GetTempPath() failed, use current dir */
6962 strcpy(buf4
, "VIM");
6963 buf4
[2] = extra_char
; /* make it "VIa", "VIb", etc. */
6964 if (GetTempFileName(szTempFile
, buf4
, 0, itmp
) == 0)
6966 /* GetTempFileName() will create the file, we don't want that */
6967 (void)DeleteFile(itmp
);
6969 /* Backslashes in a temp file name cause problems when filtering with
6970 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
6971 * didn't set 'shellslash'. */
6972 retval
= vim_strsave(itmp
);
6973 if (*p_shcf
== '-' || p_ssl
)
6974 for (p
= retval
; *p
; ++p
)
6979 # else /* WIN3264 */
6982 /* tmpnam() will make its own name */
6983 if (*tmpnam((char *)itmp
) == NUL
)
6989 /* mktemp() is not working on VMS. It seems to be
6990 * a do-nothing function. Therefore we use tempnam().
6992 sprintf((char *)itmp
, "VIM%c", extra_char
);
6993 p
= (char_u
*)tempnam("tmp:", (char *)itmp
);
6996 /* VMS will use '.LOG' if we don't explicitly specify an extension,
6997 * and VIM will then be unable to find the file later */
6999 STRCAT(itmp
, ".txt");
7005 STRCPY(itmp
, TEMPNAME
);
7006 if ((p
= vim_strchr(itmp
, '?')) != NULL
)
7008 if (mktemp((char *)itmp
) == NULL
)
7013 return vim_strsave(itmp
);
7014 # endif /* WIN3264 */
7015 #endif /* TEMPDIRNAMES */
7018 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
7020 * Convert all backslashes in fname to forward slashes in-place.
7023 forward_slash(fname
)
7028 for (p
= fname
; *p
!= NUL
; ++p
)
7030 /* The Big5 encoding can have '\' in the trail byte. */
7031 if (enc_dbcs
!= 0 && (*mb_ptr2len
)(p
) > 1)
7042 * Code for automatic commands.
7044 * Only included when "FEAT_AUTOCMD" has been defined.
7047 #if defined(FEAT_AUTOCMD) || defined(PROTO)
7050 * The autocommands are stored in a list for each event.
7051 * Autocommands for the same pattern, that are consecutive, are joined
7052 * together, to avoid having to match the pattern too often.
7053 * The result is an array of Autopat lists, which point to AutoCmd lists:
7055 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
7056 * Autopat.cmds Autopat.cmds
7059 * AutoCmd.next AutoCmd.next
7067 * first_autopat[1] --> Autopat.next --> NULL
7077 * The order of AutoCmds is important, this is the order in which they were
7078 * defined and will have to be executed.
7080 typedef struct AutoCmd
7082 char_u
*cmd
; /* The command to be executed (NULL
7083 when command has been removed) */
7084 char nested
; /* If autocommands nest here */
7085 char last
; /* last command in list */
7087 scid_T scriptID
; /* script ID where defined */
7089 struct AutoCmd
*next
; /* Next AutoCmd in list */
7092 typedef struct AutoPat
7094 int group
; /* group ID */
7095 char_u
*pat
; /* pattern as typed (NULL when pattern
7096 has been removed) */
7097 int patlen
; /* strlen() of pat */
7098 regprog_T
*reg_prog
; /* compiled regprog for pattern */
7099 char allow_dirs
; /* Pattern may match whole path */
7100 char last
; /* last pattern for apply_autocmds() */
7101 AutoCmd
*cmds
; /* list of commands to do */
7102 struct AutoPat
*next
; /* next AutoPat in AutoPat list */
7103 int buflocal_nr
; /* !=0 for buffer-local AutoPat */
7106 static struct event_name
7108 char *name
; /* event name */
7109 event_T event
; /* event number */
7112 {"BufAdd", EVENT_BUFADD
},
7113 {"BufCreate", EVENT_BUFADD
},
7114 {"BufDelete", EVENT_BUFDELETE
},
7115 {"BufEnter", EVENT_BUFENTER
},
7116 {"BufFilePost", EVENT_BUFFILEPOST
},
7117 {"BufFilePre", EVENT_BUFFILEPRE
},
7118 {"BufHidden", EVENT_BUFHIDDEN
},
7119 {"BufLeave", EVENT_BUFLEAVE
},
7120 {"BufNew", EVENT_BUFNEW
},
7121 {"BufNewFile", EVENT_BUFNEWFILE
},
7122 {"BufRead", EVENT_BUFREADPOST
},
7123 {"BufReadCmd", EVENT_BUFREADCMD
},
7124 {"BufReadPost", EVENT_BUFREADPOST
},
7125 {"BufReadPre", EVENT_BUFREADPRE
},
7126 {"BufUnload", EVENT_BUFUNLOAD
},
7127 {"BufWinEnter", EVENT_BUFWINENTER
},
7128 {"BufWinLeave", EVENT_BUFWINLEAVE
},
7129 {"BufWipeout", EVENT_BUFWIPEOUT
},
7130 {"BufWrite", EVENT_BUFWRITEPRE
},
7131 {"BufWritePost", EVENT_BUFWRITEPOST
},
7132 {"BufWritePre", EVENT_BUFWRITEPRE
},
7133 {"BufWriteCmd", EVENT_BUFWRITECMD
},
7134 {"CmdwinEnter", EVENT_CMDWINENTER
},
7135 {"CmdwinLeave", EVENT_CMDWINLEAVE
},
7136 {"ColorScheme", EVENT_COLORSCHEME
},
7137 {"CursorHold", EVENT_CURSORHOLD
},
7138 {"CursorHoldI", EVENT_CURSORHOLDI
},
7139 {"CursorMoved", EVENT_CURSORMOVED
},
7140 {"CursorMovedI", EVENT_CURSORMOVEDI
},
7141 {"EncodingChanged", EVENT_ENCODINGCHANGED
},
7142 {"FileEncoding", EVENT_ENCODINGCHANGED
},
7143 {"FileAppendPost", EVENT_FILEAPPENDPOST
},
7144 {"FileAppendPre", EVENT_FILEAPPENDPRE
},
7145 {"FileAppendCmd", EVENT_FILEAPPENDCMD
},
7146 {"FileChangedShell",EVENT_FILECHANGEDSHELL
},
7147 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST
},
7148 {"FileChangedRO", EVENT_FILECHANGEDRO
},
7149 {"FileReadPost", EVENT_FILEREADPOST
},
7150 {"FileReadPre", EVENT_FILEREADPRE
},
7151 {"FileReadCmd", EVENT_FILEREADCMD
},
7152 {"FileType", EVENT_FILETYPE
},
7153 {"FileWritePost", EVENT_FILEWRITEPOST
},
7154 {"FileWritePre", EVENT_FILEWRITEPRE
},
7155 {"FileWriteCmd", EVENT_FILEWRITECMD
},
7156 {"FilterReadPost", EVENT_FILTERREADPOST
},
7157 {"FilterReadPre", EVENT_FILTERREADPRE
},
7158 {"FilterWritePost", EVENT_FILTERWRITEPOST
},
7159 {"FilterWritePre", EVENT_FILTERWRITEPRE
},
7160 {"FocusGained", EVENT_FOCUSGAINED
},
7161 {"FocusLost", EVENT_FOCUSLOST
},
7162 {"FuncUndefined", EVENT_FUNCUNDEFINED
},
7163 {"GUIEnter", EVENT_GUIENTER
},
7164 {"GUIFailed", EVENT_GUIFAILED
},
7165 {"InsertChange", EVENT_INSERTCHANGE
},
7166 {"InsertEnter", EVENT_INSERTENTER
},
7167 {"InsertLeave", EVENT_INSERTLEAVE
},
7168 {"MenuPopup", EVENT_MENUPOPUP
},
7169 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST
},
7170 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE
},
7171 {"RemoteReply", EVENT_REMOTEREPLY
},
7172 {"SessionLoadPost", EVENT_SESSIONLOADPOST
},
7173 {"ShellCmdPost", EVENT_SHELLCMDPOST
},
7174 {"ShellFilterPost", EVENT_SHELLFILTERPOST
},
7175 {"SourcePre", EVENT_SOURCEPRE
},
7176 {"SourceCmd", EVENT_SOURCECMD
},
7177 {"SpellFileMissing",EVENT_SPELLFILEMISSING
},
7178 {"StdinReadPost", EVENT_STDINREADPOST
},
7179 {"StdinReadPre", EVENT_STDINREADPRE
},
7180 {"SwapExists", EVENT_SWAPEXISTS
},
7181 {"Syntax", EVENT_SYNTAX
},
7182 {"TabEnter", EVENT_TABENTER
},
7183 {"TabLeave", EVENT_TABLEAVE
},
7184 {"TermChanged", EVENT_TERMCHANGED
},
7185 {"TermResponse", EVENT_TERMRESPONSE
},
7186 {"User", EVENT_USER
},
7187 {"VimEnter", EVENT_VIMENTER
},
7188 {"VimLeave", EVENT_VIMLEAVE
},
7189 {"VimLeavePre", EVENT_VIMLEAVEPRE
},
7190 {"WinEnter", EVENT_WINENTER
},
7191 {"WinLeave", EVENT_WINLEAVE
},
7192 {"VimResized", EVENT_VIMRESIZED
},
7196 static AutoPat
*first_autopat
[NUM_EVENTS
] =
7198 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7199 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7200 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7201 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7202 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7203 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
7207 * struct used to keep status while executing autocommands for an event.
7209 typedef struct AutoPatCmd
7211 AutoPat
*curpat
; /* next AutoPat to examine */
7212 AutoCmd
*nextcmd
; /* next AutoCmd to execute */
7213 int group
; /* group being used */
7214 char_u
*fname
; /* fname to match with */
7215 char_u
*sfname
; /* sfname to match with */
7216 char_u
*tail
; /* tail of fname */
7217 event_T event
; /* current event */
7218 int arg_bufnr
; /* initially equal to <abuf>, set to zero when
7220 struct AutoPatCmd
*next
; /* chain of active apc-s for auto-invalidation*/
7223 static AutoPatCmd
*active_apc_list
= NULL
; /* stack of active autocommands */
7226 * augroups stores a list of autocmd group names.
7228 static garray_T augroups
= {0, 0, sizeof(char_u
*), 10, NULL
};
7229 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7232 * The ID of the current group. Group 0 is the default one.
7234 static int current_augroup
= AUGROUP_DEFAULT
;
7236 static int au_need_clean
= FALSE
; /* need to delete marked patterns */
7238 static void show_autocmd
__ARGS((AutoPat
*ap
, event_T event
));
7239 static void au_remove_pat
__ARGS((AutoPat
*ap
));
7240 static void au_remove_cmds
__ARGS((AutoPat
*ap
));
7241 static void au_cleanup
__ARGS((void));
7242 static int au_new_group
__ARGS((char_u
*name
));
7243 static void au_del_group
__ARGS((char_u
*name
));
7244 static event_T event_name2nr
__ARGS((char_u
*start
, char_u
**end
));
7245 static char_u
*event_nr2name
__ARGS((event_T event
));
7246 static char_u
*find_end_event
__ARGS((char_u
*arg
, int have_group
));
7247 static int event_ignored
__ARGS((event_T event
));
7248 static int au_get_grouparg
__ARGS((char_u
**argp
));
7249 static int do_autocmd_event
__ARGS((event_T event
, char_u
*pat
, int nested
, char_u
*cmd
, int forceit
, int group
));
7250 static char_u
*getnextac
__ARGS((int c
, void *cookie
, int indent
));
7251 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
));
7252 static void auto_next_pat
__ARGS((AutoPatCmd
*apc
, int stop_at_last
));
7255 static event_T last_event
;
7256 static int last_group
;
7257 static int autocmd_blocked
= 0; /* block all autocmds */
7260 * Show the autocommands for one AutoPat.
7263 show_autocmd(ap
, event
)
7269 /* Check for "got_int" (here and at various places below), which is set
7270 * when "q" has been hit for the "--more--" prompt */
7273 if (ap
->pat
== NULL
) /* pattern has been removed */
7279 if (event
!= last_event
|| ap
->group
!= last_group
)
7281 if (ap
->group
!= AUGROUP_DEFAULT
)
7283 if (AUGROUP_NAME(ap
->group
) == NULL
)
7284 msg_puts_attr((char_u
*)_("--Deleted--"), hl_attr(HLF_E
));
7286 msg_puts_attr(AUGROUP_NAME(ap
->group
), hl_attr(HLF_T
));
7287 msg_puts((char_u
*)" ");
7289 msg_puts_attr(event_nr2name(event
), hl_attr(HLF_T
));
7291 last_group
= ap
->group
;
7297 msg_outtrans(ap
->pat
);
7299 for (ac
= ap
->cmds
; ac
!= NULL
; ac
= ac
->next
)
7301 if (ac
->cmd
!= NULL
) /* skip removed commands */
7308 msg_outtrans(ac
->cmd
);
7311 last_set_msg(ac
->scriptID
);
7315 if (ac
->next
!= NULL
)
7326 * Mark an autocommand pattern for deletion.
7334 ap
->buflocal_nr
= -1;
7335 au_need_clean
= TRUE
;
7339 * Mark all commands for a pattern for deletion.
7347 for (ac
= ap
->cmds
; ac
!= NULL
; ac
= ac
->next
)
7352 au_need_clean
= TRUE
;
7356 * Cleanup autocommands and patterns that have been deleted.
7357 * This is only done when not executing autocommands.
7362 AutoPat
*ap
, **prev_ap
;
7363 AutoCmd
*ac
, **prev_ac
;
7366 if (autocmd_busy
|| !au_need_clean
)
7369 /* loop over all events */
7370 for (event
= (event_T
)0; (int)event
< (int)NUM_EVENTS
;
7371 event
= (event_T
)((int)event
+ 1))
7373 /* loop over all autocommand patterns */
7374 prev_ap
= &(first_autopat
[(int)event
]);
7375 for (ap
= *prev_ap
; ap
!= NULL
; ap
= *prev_ap
)
7377 /* loop over all commands for this pattern */
7378 prev_ac
= &(ap
->cmds
);
7379 for (ac
= *prev_ac
; ac
!= NULL
; ac
= *prev_ac
)
7381 /* remove the command if the pattern is to be deleted or when
7382 * the command has been marked for deletion */
7383 if (ap
->pat
== NULL
|| ac
->cmd
== NULL
)
7385 *prev_ac
= ac
->next
;
7390 prev_ac
= &(ac
->next
);
7393 /* remove the pattern if it has been marked for deletion */
7394 if (ap
->pat
== NULL
)
7396 *prev_ap
= ap
->next
;
7397 vim_free(ap
->reg_prog
);
7401 prev_ap
= &(ap
->next
);
7405 au_need_clean
= FALSE
;
7409 * Called when buffer is freed, to remove/invalidate related buffer-local
7413 aubuflocal_remove(buf
)
7420 /* invalidate currently executing autocommands */
7421 for (apc
= active_apc_list
; apc
; apc
= apc
->next
)
7422 if (buf
->b_fnum
== apc
->arg_bufnr
)
7425 /* invalidate buflocals looping through events */
7426 for (event
= (event_T
)0; (int)event
< (int)NUM_EVENTS
;
7427 event
= (event_T
)((int)event
+ 1))
7428 /* loop over all autocommand patterns */
7429 for (ap
= first_autopat
[(int)event
]; ap
!= NULL
; ap
= ap
->next
)
7430 if (ap
->buflocal_nr
== buf
->b_fnum
)
7437 _("auto-removing autocommand: %s <buffer=%d>"),
7438 event_nr2name(event
), buf
->b_fnum
);
7446 * Add an autocmd group name.
7447 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7455 i
= au_find_group(name
);
7456 if (i
== AUGROUP_ERROR
) /* the group doesn't exist yet, add it */
7458 /* First try using a free entry. */
7459 for (i
= 0; i
< augroups
.ga_len
; ++i
)
7460 if (AUGROUP_NAME(i
) == NULL
)
7462 if (i
== augroups
.ga_len
&& ga_grow(&augroups
, 1) == FAIL
)
7463 return AUGROUP_ERROR
;
7465 AUGROUP_NAME(i
) = vim_strsave(name
);
7466 if (AUGROUP_NAME(i
) == NULL
)
7467 return AUGROUP_ERROR
;
7468 if (i
== augroups
.ga_len
)
7481 i
= au_find_group(name
);
7482 if (i
== AUGROUP_ERROR
) /* the group doesn't exist */
7483 EMSG2(_("E367: No such group: \"%s\""), name
);
7486 vim_free(AUGROUP_NAME(i
));
7487 AUGROUP_NAME(i
) = NULL
;
7492 * Find the ID of an autocmd group name.
7493 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7501 for (i
= 0; i
< augroups
.ga_len
; ++i
)
7502 if (AUGROUP_NAME(i
) != NULL
&& STRCMP(AUGROUP_NAME(i
), name
) == 0)
7504 return AUGROUP_ERROR
;
7508 * Return TRUE if augroup "name" exists.
7514 return au_find_group(name
) != AUGROUP_ERROR
;
7518 * ":augroup {name}".
7521 do_augroup(arg
, del_group
)
7534 else if (STRICMP(arg
, "end") == 0) /* ":aug end": back to group 0 */
7535 current_augroup
= AUGROUP_DEFAULT
;
7536 else if (*arg
) /* ":aug xxx": switch to group xxx */
7538 i
= au_new_group(arg
);
7539 if (i
!= AUGROUP_ERROR
)
7540 current_augroup
= i
;
7542 else /* ":aug": list the group names */
7545 for (i
= 0; i
< augroups
.ga_len
; ++i
)
7547 if (AUGROUP_NAME(i
) != NULL
)
7549 msg_puts(AUGROUP_NAME(i
));
7550 msg_puts((char_u
*)" ");
7558 #if defined(EXITFREE) || defined(PROTO)
7562 for (current_augroup
= -1; current_augroup
< augroups
.ga_len
;
7564 do_autocmd((char_u
*)"", TRUE
);
7565 ga_clear_strings(&augroups
);
7570 * Return the event number for event name "start".
7571 * Return NUM_EVENTS if the event name was not found.
7572 * Return a pointer to the next event name in "end".
7575 event_name2nr(start
, end
)
7583 /* the event name ends with end of line, a blank or a comma */
7584 for (p
= start
; *p
&& !vim_iswhite(*p
) && *p
!= ','; ++p
)
7586 for (i
= 0; event_names
[i
].name
!= NULL
; ++i
)
7588 len
= (int)STRLEN(event_names
[i
].name
);
7589 if (len
== p
- start
&& STRNICMP(event_names
[i
].name
, start
, len
) == 0)
7595 if (event_names
[i
].name
== NULL
)
7597 return event_names
[i
].event
;
7601 * Return the name for event "event".
7604 event_nr2name(event
)
7609 for (i
= 0; event_names
[i
].name
!= NULL
; ++i
)
7610 if (event_names
[i
].event
== event
)
7611 return (char_u
*)event_names
[i
].name
;
7612 return (char_u
*)"Unknown";
7616 * Scan over the events. "*" stands for all events.
7619 find_end_event(arg
, have_group
)
7621 int have_group
; /* TRUE when group name was found */
7628 if (arg
[1] && !vim_iswhite(arg
[1]))
7630 EMSG2(_("E215: Illegal character after *: %s"), arg
);
7637 for (pat
= arg
; *pat
&& !vim_iswhite(*pat
); pat
= p
)
7639 if ((int)event_name2nr(pat
, &p
) >= (int)NUM_EVENTS
)
7642 EMSG2(_("E216: No such event: %s"), pat
);
7644 EMSG2(_("E216: No such group or event: %s"), pat
);
7653 * Return TRUE if "event" is included in 'eventignore'.
7656 event_ignored(event
)
7663 if (STRNICMP(p
, "all", 3) == 0 && (p
[3] == NUL
|| p
[3] == ','))
7665 if (event_name2nr(p
, &p
) == event
)
7673 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7682 if (STRNICMP(p
, "all", 3) == 0 && (p
[3] == NUL
|| p
[3] == ','))
7688 else if (event_name2nr(p
, &p
) == NUM_EVENTS
)
7695 # if defined(FEAT_SYN_HL) || defined(PROTO)
7698 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7699 * buffer loaded into the window. "what" must start with a comma.
7700 * Returns the old value of 'eventignore' in allocated memory.
7703 au_event_disable(what
)
7709 save_ei
= vim_strsave(p_ei
);
7710 if (save_ei
!= NULL
)
7712 new_ei
= vim_strnsave(p_ei
, (int)(STRLEN(p_ei
) + STRLEN(what
)));
7715 STRCAT(new_ei
, what
);
7716 set_string_option_direct((char_u
*)"ei", -1, new_ei
,
7717 OPT_FREE
, SID_NONE
);
7725 au_event_restore(old_ei
)
7730 set_string_option_direct((char_u
*)"ei", -1, old_ei
,
7731 OPT_FREE
, SID_NONE
);
7735 # endif /* FEAT_SYN_HL */
7738 * do_autocmd() -- implements the :autocmd command. Can be used in the
7741 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7742 * will be automatically executed for <event>
7743 * when editing a file matching <pat>, in
7744 * the current group.
7745 * :autocmd <event> <pat> Show the auto-commands associated with
7746 * <event> and <pat>.
7747 * :autocmd <event> Show the auto-commands associated with
7749 * :autocmd Show all auto-commands.
7750 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7751 * <event> and <pat>, and add the command
7752 * <cmd>, for the current group.
7753 * :autocmd! <event> <pat> Remove all auto-commands associated with
7754 * <event> and <pat> for the current group.
7755 * :autocmd! <event> Remove all auto-commands associated with
7756 * <event> for the current group.
7757 * :autocmd! Remove ALL auto-commands for the current
7760 * Multiple events and patterns may be given separated by commas. Here are
7762 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
7763 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
7765 * :autocmd * *.c show all autocommands for *.c files.
7767 * Mostly a {group} argument can optionally appear before <event>.
7770 do_autocmd(arg
, forceit
)
7775 char_u
*envpat
= NULL
;
7778 int need_free
= FALSE
;
7783 * Check for a legal group name. If not, use AUGROUP_ALL.
7785 group
= au_get_grouparg(&arg
);
7786 if (arg
== NULL
) /* out of memory */
7790 * Scan over the events.
7791 * If we find an illegal name, return here, don't do anything.
7793 pat
= find_end_event(arg
, group
!= AUGROUP_ALL
);
7798 * Scan over the pattern. Put a NUL at the end.
7800 pat
= skipwhite(pat
);
7802 while (*cmd
&& (!vim_iswhite(*cmd
) || cmd
[-1] == '\\'))
7807 /* Expand environment variables in the pattern. Set 'shellslash', we want
7808 * forward slashes here. */
7809 if (vim_strchr(pat
, '$') != NULL
|| vim_strchr(pat
, '~') != NULL
)
7811 #ifdef BACKSLASH_IN_FILENAME
7812 int p_ssl_save
= p_ssl
;
7816 envpat
= expand_env_save(pat
);
7817 #ifdef BACKSLASH_IN_FILENAME
7825 * Check for "nested" flag.
7827 cmd
= skipwhite(cmd
);
7828 if (*cmd
!= NUL
&& STRNCMP(cmd
, "nested", 6) == 0 && vim_iswhite(cmd
[6]))
7831 cmd
= skipwhite(cmd
+ 6);
7835 * Find the start of the commands.
7836 * Expand <sfile> in it.
7840 cmd
= expand_sfile(cmd
);
7841 if (cmd
== NULL
) /* some error */
7847 * Print header when showing autocommands.
7849 if (!forceit
&& *cmd
== NUL
)
7851 /* Highlight title */
7852 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
7856 * Loop over the events.
7858 last_event
= (event_T
)-1; /* for listing the event name */
7859 last_group
= AUGROUP_ERROR
; /* for listing the group name */
7860 if (*arg
== '*' || *arg
== NUL
)
7862 for (event
= (event_T
)0; (int)event
< (int)NUM_EVENTS
;
7863 event
= (event_T
)((int)event
+ 1))
7864 if (do_autocmd_event(event
, pat
,
7865 nested
, cmd
, forceit
, group
) == FAIL
)
7870 while (*arg
&& !vim_iswhite(*arg
))
7871 if (do_autocmd_event(event_name2nr(arg
, &arg
), pat
,
7872 nested
, cmd
, forceit
, group
) == FAIL
)
7882 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
7883 * The "argp" argument is advanced to the following argument.
7885 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
7888 au_get_grouparg(argp
)
7893 char_u
*arg
= *argp
;
7894 int group
= AUGROUP_ALL
;
7896 p
= skiptowhite(arg
);
7899 group_name
= vim_strnsave(arg
, (int)(p
- arg
));
7900 if (group_name
== NULL
) /* out of memory */
7901 return AUGROUP_ERROR
;
7902 group
= au_find_group(group_name
);
7903 if (group
== AUGROUP_ERROR
)
7904 group
= AUGROUP_ALL
; /* no match, use all groups */
7906 *argp
= skipwhite(p
); /* match, skip over group name */
7907 vim_free(group_name
);
7913 * do_autocmd() for one event.
7914 * If *pat == NUL do for all patterns.
7915 * If *cmd == NUL show entries.
7916 * If forceit == TRUE delete entries.
7917 * If group is not AUGROUP_ALL, only use this group.
7920 do_autocmd_event(event
, pat
, nested
, cmd
, forceit
, group
)
7939 char_u buflocal_pat
[25]; /* for "<buffer=X>" */
7941 if (group
== AUGROUP_ALL
)
7942 findgroup
= current_augroup
;
7945 allgroups
= (group
== AUGROUP_ALL
&& !forceit
&& *cmd
== NUL
);
7948 * Show or delete all patterns for an event.
7952 for (ap
= first_autopat
[(int)event
]; ap
!= NULL
; ap
= ap
->next
)
7954 if (forceit
) /* delete the AutoPat, if it's in the current group */
7956 if (ap
->group
== findgroup
)
7959 else if (group
== AUGROUP_ALL
|| ap
->group
== group
)
7960 show_autocmd(ap
, event
);
7965 * Loop through all the specified patterns.
7967 for ( ; *pat
; pat
= (*endpat
== ',' ? endpat
+ 1 : endpat
))
7970 * Find end of the pattern.
7971 * Watch out for a comma in braces, like "*.\{obj,o\}".
7974 for (endpat
= pat
; *endpat
&& (*endpat
!= ',' || brace_level
7975 || endpat
[-1] == '\\'); ++endpat
)
7979 else if (*endpat
== '}')
7982 if (pat
== endpat
) /* ignore single comma */
7984 patlen
= (int)(endpat
- pat
);
7987 * detect special <buflocal[=X]> buffer-local patterns
7989 is_buflocal
= FALSE
;
7992 if (patlen
>= 7 && STRNCMP(pat
, "<buffer", 7) == 0
7993 && pat
[patlen
- 1] == '>')
7995 /* Error will be printed only for addition. printing and removing
7996 * will proceed silently. */
7999 buflocal_nr
= curbuf
->b_fnum
;
8000 else if (patlen
> 9 && pat
[7] == '=')
8003 if (patlen
== 13 && STRNICMP(pat
, "<buffer=abuf>", 13))
8004 buflocal_nr
= autocmd_bufnr
;
8006 else if (skipdigits(pat
+ 8) == pat
+ patlen
- 1)
8007 buflocal_nr
= atoi((char *)pat
+ 8);
8013 /* normalize pat into standard "<buffer>#N" form */
8014 sprintf((char *)buflocal_pat
, "<buffer=%d>", buflocal_nr
);
8015 pat
= buflocal_pat
; /* can modify pat and patlen */
8016 patlen
= (int)STRLEN(buflocal_pat
); /* but not endpat */
8020 * Find AutoPat entries with this pattern.
8022 prev_ap
= &first_autopat
[(int)event
];
8023 while ((ap
= *prev_ap
) != NULL
)
8025 if (ap
->pat
!= NULL
)
8027 /* Accept a pattern when:
8028 * - a group was specified and it's that group, or a group was
8029 * not specified and it's the current group, or a group was
8030 * not specified and we are listing
8031 * - the length of the pattern matches
8032 * - the pattern matches.
8033 * For <buffer[=X]>, this condition works because we normalize
8034 * all buffer-local patterns.
8036 if ((allgroups
|| ap
->group
== findgroup
)
8037 && ap
->patlen
== patlen
8038 && STRNCMP(pat
, ap
->pat
, patlen
) == 0)
8041 * Remove existing autocommands.
8042 * If adding any new autocmd's for this AutoPat, don't
8043 * delete the pattern from the autopat list, append to
8048 if (*cmd
!= NUL
&& ap
->next
== NULL
)
8057 * Show autocmd's for this autopat, or buflocals <buffer=X>
8059 else if (*cmd
== NUL
)
8060 show_autocmd(ap
, event
);
8063 * Add autocmd to this autopat, if it's the last one.
8065 else if (ap
->next
== NULL
)
8069 prev_ap
= &ap
->next
;
8073 * Add a new command.
8078 * If the pattern we want to add a command to does appear at the
8079 * end of the list (or not is not in the list at all), add the
8080 * pattern at the end of the list.
8084 /* refuse to add buffer-local ap if buffer number is invalid */
8085 if (is_buflocal
&& (buflocal_nr
== 0
8086 || buflist_findnr(buflocal_nr
) == NULL
))
8088 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
8093 ap
= (AutoPat
*)alloc((unsigned)sizeof(AutoPat
));
8096 ap
->pat
= vim_strnsave(pat
, patlen
);
8097 ap
->patlen
= patlen
;
8098 if (ap
->pat
== NULL
)
8106 ap
->buflocal_nr
= buflocal_nr
;
8107 ap
->reg_prog
= NULL
;
8113 ap
->buflocal_nr
= 0;
8114 reg_pat
= file_pat_to_reg_pat(pat
, endpat
,
8115 &ap
->allow_dirs
, TRUE
);
8116 if (reg_pat
!= NULL
)
8117 ap
->reg_prog
= vim_regcomp(reg_pat
, RE_MAGIC
);
8119 if (reg_pat
== NULL
|| ap
->reg_prog
== NULL
)
8129 if (group
== AUGROUP_ALL
)
8130 ap
->group
= current_augroup
;
8136 * Add the autocmd at the end of the AutoCmd list.
8138 prev_ac
= &(ap
->cmds
);
8139 while ((ac
= *prev_ac
) != NULL
)
8140 prev_ac
= &ac
->next
;
8141 ac
= (AutoCmd
*)alloc((unsigned)sizeof(AutoCmd
));
8144 ac
->cmd
= vim_strsave(cmd
);
8146 ac
->scriptID
= current_SID
;
8148 if (ac
->cmd
== NULL
)
8155 ac
->nested
= nested
;
8159 au_cleanup(); /* may really delete removed patterns/commands now */
8164 * Implementation of ":doautocmd [group] event [fname]".
8165 * Return OK for success, FAIL for failure;
8168 do_doautocmd(arg
, do_msg
)
8170 int do_msg
; /* give message for no matching autocmds? */
8173 int nothing_done
= TRUE
;
8177 * Check for a legal group name. If not, use AUGROUP_ALL.
8179 group
= au_get_grouparg(&arg
);
8180 if (arg
== NULL
) /* out of memory */
8185 EMSG(_("E217: Can't execute autocommands for ALL events"));
8190 * Scan over the events.
8191 * If we find an illegal name, return here, don't do anything.
8193 fname
= find_end_event(arg
, group
!= AUGROUP_ALL
);
8197 fname
= skipwhite(fname
);
8200 * Loop over the events.
8202 while (*arg
&& !vim_iswhite(*arg
))
8203 if (apply_autocmds_group(event_name2nr(arg
, &arg
),
8204 fname
, NULL
, TRUE
, group
, curbuf
, NULL
))
8205 nothing_done
= FALSE
;
8207 if (nothing_done
&& do_msg
)
8208 MSG(_("No matching autocommands"));
8211 return aborting() ? FAIL
: OK
;
8218 * ":doautoall": execute autocommands for each loaded buffer.
8229 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8230 * equal to curbuf, but for some buffers there may not be a window.
8231 * So we change the buffer for the current window for a moment. This
8232 * gives problems when the autocommands make changes to the list of
8233 * buffers or windows...
8235 for (buf
= firstbuf
; buf
!= NULL
; buf
= buf
->b_next
)
8237 if (buf
->b_ml
.ml_mfp
!= NULL
)
8239 /* find a window for this buffer and save some values */
8240 aucmd_prepbuf(&aco
, buf
);
8242 /* execute the autocommands for this buffer */
8243 retval
= do_doautocmd(eap
->arg
, FALSE
);
8245 /* Execute the modeline settings, but don't set window-local
8246 * options if we are using the current window for another buffer. */
8247 do_modelines(aco
.save_curwin
== NULL
? OPT_NOWIN
: 0);
8249 /* restore the current window */
8250 aucmd_restbuf(&aco
);
8252 /* stop if there is some error or buffer was deleted */
8253 if (retval
== FAIL
|| !buf_valid(buf
))
8258 check_cursor(); /* just in case lines got deleted */
8262 * Prepare for executing autocommands for (hidden) buffer "buf".
8263 * Search a window for the current buffer. Save the cursor position and
8265 * Set "curbuf" and "curwin" to match "buf".
8266 * When FEAT_AUTOCMD is not defined another version is used, see below.
8269 aucmd_prepbuf(aco
, buf
)
8270 aco_save_T
*aco
; /* structure to save values in */
8271 buf_T
*buf
; /* new curbuf */
8275 aco
->new_curbuf
= buf
;
8277 /* Find a window that is for the new buffer */
8278 if (buf
== curbuf
) /* be quick when buf is curbuf */
8282 for (win
= firstwin
; win
!= NULL
; win
= win
->w_next
)
8283 if (win
->w_buffer
== buf
)
8290 * Prefer to use an existing window for the buffer, it has the least side
8291 * effects (esp. if "buf" is curbuf).
8292 * Otherwise, use curwin for "buf". It might make some items in the
8293 * window invalid. At least save the cursor and topline.
8297 /* there is a window for "buf", make it the curwin */
8298 aco
->save_curwin
= curwin
;
8300 aco
->save_buf
= win
->w_buffer
;
8301 aco
->new_curwin
= win
;
8305 /* there is no window for "buf", use curwin */
8306 aco
->save_curwin
= NULL
;
8307 aco
->save_buf
= curbuf
;
8308 --curbuf
->b_nwindows
;
8309 curwin
->w_buffer
= buf
;
8312 /* save cursor and topline, set them to safe values */
8313 aco
->save_cursor
= curwin
->w_cursor
;
8314 curwin
->w_cursor
.lnum
= 1;
8315 curwin
->w_cursor
.col
= 0;
8316 aco
->save_topline
= curwin
->w_topline
;
8317 curwin
->w_topline
= 1;
8319 aco
->save_topfill
= curwin
->w_topfill
;
8320 curwin
->w_topfill
= 0;
8328 * Cleanup after executing autocommands for a (hidden) buffer.
8329 * Restore the window as it was (if possible).
8330 * When FEAT_AUTOCMD is not defined another version is used, see below.
8334 aco_save_T
*aco
; /* structure holding saved values */
8336 if (aco
->save_curwin
!= NULL
)
8338 /* restore curwin */
8340 if (win_valid(aco
->save_curwin
))
8343 /* restore the buffer which was previously edited by curwin, if
8344 * it's still the same window and it's valid */
8345 if (curwin
== aco
->new_curwin
8346 && buf_valid(aco
->save_buf
)
8347 && aco
->save_buf
->b_ml
.ml_mfp
!= NULL
)
8349 --curbuf
->b_nwindows
;
8350 curbuf
= aco
->save_buf
;
8351 curwin
->w_buffer
= curbuf
;
8352 ++curbuf
->b_nwindows
;
8355 curwin
= aco
->save_curwin
;
8356 curbuf
= curwin
->w_buffer
;
8361 /* restore buffer for curwin if it still exists and is loaded */
8362 if (buf_valid(aco
->save_buf
) && aco
->save_buf
->b_ml
.ml_mfp
!= NULL
)
8364 --curbuf
->b_nwindows
;
8365 curbuf
= aco
->save_buf
;
8366 curwin
->w_buffer
= curbuf
;
8367 ++curbuf
->b_nwindows
;
8368 curwin
->w_cursor
= aco
->save_cursor
;
8370 /* check topline < line_count, in case lines got deleted */
8371 if (aco
->save_topline
<= curbuf
->b_ml
.ml_line_count
)
8373 curwin
->w_topline
= aco
->save_topline
;
8375 curwin
->w_topfill
= aco
->save_topfill
;
8380 curwin
->w_topline
= curbuf
->b_ml
.ml_line_count
;
8382 curwin
->w_topfill
= 0;
8389 static int autocmd_nested
= FALSE
;
8392 * Execute autocommands for "event" and file name "fname".
8393 * Return TRUE if some commands were executed.
8396 apply_autocmds(event
, fname
, fname_io
, force
, buf
)
8398 char_u
*fname
; /* NULL or empty means use actual file name */
8399 char_u
*fname_io
; /* fname to use for <afile> on cmdline */
8400 int force
; /* when TRUE, ignore autocmd_busy */
8401 buf_T
*buf
; /* buffer for <abuf> */
8403 return apply_autocmds_group(event
, fname
, fname_io
, force
,
8404 AUGROUP_ALL
, buf
, NULL
);
8408 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8409 * setting v:filearg.
8412 apply_autocmds_exarg(event
, fname
, fname_io
, force
, buf
, eap
)
8420 return apply_autocmds_group(event
, fname
, fname_io
, force
,
8421 AUGROUP_ALL
, buf
, eap
);
8425 * Like apply_autocmds(), but handles the caller's retval. If the script
8426 * processing is being aborted or if retval is FAIL when inside a try
8427 * conditional, no autocommands are executed. If otherwise the autocommands
8428 * cause the script to be aborted, retval is set to FAIL.
8431 apply_autocmds_retval(event
, fname
, fname_io
, force
, buf
, retval
)
8433 char_u
*fname
; /* NULL or empty means use actual file name */
8434 char_u
*fname_io
; /* fname to use for <afile> on cmdline */
8435 int force
; /* when TRUE, ignore autocmd_busy */
8436 buf_T
*buf
; /* buffer for <abuf> */
8437 int *retval
; /* pointer to caller's retval */
8442 if (should_abort(*retval
))
8446 did_cmd
= apply_autocmds_group(event
, fname
, fname_io
, force
,
8447 AUGROUP_ALL
, buf
, NULL
);
8458 * Return TRUE when there is a CursorHold autocommand defined.
8463 return (first_autopat
[(int)(get_real_state() == NORMAL_BUSY
8464 ? EVENT_CURSORHOLD
: EVENT_CURSORHOLDI
)] != NULL
);
8468 * Return TRUE if the CursorHold event can be triggered.
8471 trigger_cursorhold()
8475 if (!did_cursorhold
&& has_cursorhold() && !Recording
8476 #ifdef FEAT_INS_EXPAND
8477 && !ins_compl_active()
8481 state
= get_real_state();
8482 if (state
== NORMAL_BUSY
|| (state
& INSERT
) != 0)
8489 * Return TRUE when there is a CursorMoved autocommand defined.
8494 return (first_autopat
[(int)EVENT_CURSORMOVED
] != NULL
);
8498 * Return TRUE when there is a CursorMovedI autocommand defined.
8503 return (first_autopat
[(int)EVENT_CURSORMOVEDI
] != NULL
);
8507 apply_autocmds_group(event
, fname
, fname_io
, force
, group
, buf
, eap
)
8509 char_u
*fname
; /* NULL or empty means use actual file name */
8510 char_u
*fname_io
; /* fname to use for <afile> on cmdline, NULL means
8512 int force
; /* when TRUE, ignore autocmd_busy */
8513 int group
; /* group ID, or AUGROUP_ALL */
8514 buf_T
*buf
; /* buffer for <abuf> */
8515 exarg_T
*eap
; /* command arguments */
8517 char_u
*sfname
= NULL
; /* short file name */
8522 char_u
*save_sourcing_name
;
8523 linenr_T save_sourcing_lnum
;
8524 char_u
*save_autocmd_fname
;
8525 int save_autocmd_fname_full
;
8526 int save_autocmd_bufnr
;
8527 char_u
*save_autocmd_match
;
8528 int save_autocmd_busy
;
8529 int save_autocmd_nested
;
8530 static int nesting
= 0;
8534 scid_T save_current_SID
;
8535 void *save_funccalp
;
8536 char_u
*save_cmdarg
;
8539 static int filechangeshell_busy
= FALSE
;
8541 proftime_T wait_time
;
8545 * Quickly return if there are no autocommands for this event or
8546 * autocommands are blocked.
8548 if (first_autopat
[(int)event
] == NULL
|| autocmd_blocked
> 0)
8552 * When autocommands are busy, new autocommands are only executed when
8553 * explicitly enabled with the "nested" flag.
8555 if (autocmd_busy
&& !(force
|| autocmd_nested
))
8560 * Quickly return when immediately aborting on error, or when an interrupt
8561 * occurred or an exception was thrown but not caught.
8568 * FileChangedShell never nests, because it can create an endless loop.
8570 if (filechangeshell_busy
&& (event
== EVENT_FILECHANGEDSHELL
8571 || event
== EVENT_FILECHANGEDSHELLPOST
))
8575 * Ignore events in 'eventignore'.
8577 if (event_ignored(event
))
8581 * Allow nesting of autocommands, but restrict the depth, because it's
8582 * possible to create an endless loop.
8586 EMSG(_("E218: autocommand nesting too deep"));
8591 * Check if these autocommands are disabled. Used when doing ":all" or
8594 if ( (autocmd_no_enter
8595 && (event
== EVENT_WINENTER
|| event
== EVENT_BUFENTER
))
8596 || (autocmd_no_leave
8597 && (event
== EVENT_WINLEAVE
|| event
== EVENT_BUFLEAVE
)))
8601 * Save the autocmd_* variables and info about the current buffer.
8603 save_autocmd_fname
= autocmd_fname
;
8604 save_autocmd_fname_full
= autocmd_fname_full
;
8605 save_autocmd_bufnr
= autocmd_bufnr
;
8606 save_autocmd_match
= autocmd_match
;
8607 save_autocmd_busy
= autocmd_busy
;
8608 save_autocmd_nested
= autocmd_nested
;
8609 save_changed
= curbuf
->b_changed
;
8610 old_curbuf
= curbuf
;
8613 * Set the file name to be used for <afile>.
8614 * Make a copy to avoid that changing a buffer name or directory makes it
8617 if (fname_io
== NULL
)
8619 if (fname
!= NULL
&& *fname
!= NUL
)
8620 autocmd_fname
= fname
;
8621 else if (buf
!= NULL
)
8622 autocmd_fname
= buf
->b_ffname
;
8624 autocmd_fname
= NULL
;
8627 autocmd_fname
= fname_io
;
8628 if (autocmd_fname
!= NULL
)
8629 autocmd_fname
= vim_strsave(autocmd_fname
);
8630 autocmd_fname_full
= FALSE
; /* call FullName_save() later */
8633 * Set the buffer number to be used for <abuf>.
8638 autocmd_bufnr
= buf
->b_fnum
;
8641 * When the file name is NULL or empty, use the file name of buffer "buf".
8642 * Always use the full path of the file name to match with, in case
8643 * "allow_dirs" is set.
8645 if (fname
== NULL
|| *fname
== NUL
)
8652 if (event
== EVENT_SYNTAX
)
8653 fname
= buf
->b_p_syn
;
8656 if (event
== EVENT_FILETYPE
)
8657 fname
= buf
->b_p_ft
;
8660 if (buf
->b_sfname
!= NULL
)
8661 sfname
= vim_strsave(buf
->b_sfname
);
8662 fname
= buf
->b_ffname
;
8666 fname
= (char_u
*)"";
8667 fname
= vim_strsave(fname
); /* make a copy, so we can change it */
8671 sfname
= vim_strsave(fname
);
8672 /* Don't try expanding FileType, Syntax, WindowID or QuickFixCmd* */
8673 if (event
== EVENT_FILETYPE
8674 || event
== EVENT_SYNTAX
8675 || event
== EVENT_REMOTEREPLY
8676 || event
== EVENT_SPELLFILEMISSING
8677 || event
== EVENT_QUICKFIXCMDPRE
8678 || event
== EVENT_QUICKFIXCMDPOST
)
8679 fname
= vim_strsave(fname
);
8681 fname
= FullName_save(fname
, FALSE
);
8683 if (fname
== NULL
) /* out of memory */
8690 #ifdef BACKSLASH_IN_FILENAME
8692 * Replace all backslashes with forward slashes. This makes the
8693 * autocommand patterns portable between Unix and MS-DOS.
8696 forward_slash(sfname
);
8697 forward_slash(fname
);
8701 /* remove version for correct match */
8703 vms_remove_version(sfname
);
8704 vms_remove_version(fname
);
8708 * Set the name to be used for <amatch>.
8710 autocmd_match
= fname
;
8713 /* Don't redraw while doing auto commands. */
8714 ++RedrawingDisabled
;
8715 save_sourcing_name
= sourcing_name
;
8716 sourcing_name
= NULL
; /* don't free this one */
8717 save_sourcing_lnum
= sourcing_lnum
;
8718 sourcing_lnum
= 0; /* no line number here */
8721 save_current_SID
= current_SID
;
8723 # ifdef FEAT_PROFILE
8724 if (do_profiling
== PROF_YES
)
8725 prof_child_enter(&wait_time
); /* doesn't count for the caller itself */
8728 /* Don't use local function variables, if called from a function */
8729 save_funccalp
= save_funccal();
8733 * When starting to execute autocommands, save the search patterns.
8737 save_search_patterns();
8739 did_filetype
= keep_filetype
;
8743 * Note that we are applying autocmds. Some commands need to know.
8745 autocmd_busy
= TRUE
;
8746 filechangeshell_busy
= (event
== EVENT_FILECHANGEDSHELL
);
8747 ++nesting
; /* see matching decrement below */
8749 /* Remember that FileType was triggered. Used for did_filetype(). */
8750 if (event
== EVENT_FILETYPE
)
8751 did_filetype
= TRUE
;
8753 tail
= gettail(fname
);
8755 /* Find first autocommand that matches */
8756 patcmd
.curpat
= first_autopat
[(int)event
];
8757 patcmd
.nextcmd
= NULL
;
8758 patcmd
.group
= group
;
8759 patcmd
.fname
= fname
;
8760 patcmd
.sfname
= sfname
;
8762 patcmd
.event
= event
;
8763 patcmd
.arg_bufnr
= autocmd_bufnr
;
8765 auto_next_pat(&patcmd
, FALSE
);
8767 /* found one, start executing the autocommands */
8768 if (patcmd
.curpat
!= NULL
)
8770 /* add to active_apc_list */
8771 patcmd
.next
= active_apc_list
;
8772 active_apc_list
= &patcmd
;
8775 /* set v:cmdarg (only when there is a matching pattern) */
8776 save_cmdbang
= get_vim_var_nr(VV_CMDBANG
);
8779 save_cmdarg
= set_cmdarg(eap
, NULL
);
8780 set_vim_var_nr(VV_CMDBANG
, (long)eap
->forceit
);
8783 save_cmdarg
= NULL
; /* avoid gcc warning */
8786 /* mark the last pattern, to avoid an endless loop when more patterns
8787 * are added when executing autocommands */
8788 for (ap
= patcmd
.curpat
; ap
->next
!= NULL
; ap
= ap
->next
)
8791 check_lnums(TRUE
); /* make sure cursor and topline are valid */
8792 do_cmdline(NULL
, getnextac
, (void *)&patcmd
,
8793 DOCMD_NOWAIT
|DOCMD_VERBOSE
|DOCMD_REPEAT
);
8797 (void)set_cmdarg(NULL
, save_cmdarg
);
8798 set_vim_var_nr(VV_CMDBANG
, save_cmdbang
);
8801 /* delete from active_apc_list */
8802 if (active_apc_list
== &patcmd
) /* just in case */
8803 active_apc_list
= patcmd
.next
;
8806 --RedrawingDisabled
;
8807 autocmd_busy
= save_autocmd_busy
;
8808 filechangeshell_busy
= FALSE
;
8809 autocmd_nested
= save_autocmd_nested
;
8810 vim_free(sourcing_name
);
8811 sourcing_name
= save_sourcing_name
;
8812 sourcing_lnum
= save_sourcing_lnum
;
8813 vim_free(autocmd_fname
);
8814 autocmd_fname
= save_autocmd_fname
;
8815 autocmd_fname_full
= save_autocmd_fname_full
;
8816 autocmd_bufnr
= save_autocmd_bufnr
;
8817 autocmd_match
= save_autocmd_match
;
8819 current_SID
= save_current_SID
;
8820 restore_funccal(save_funccalp
);
8821 # ifdef FEAT_PROFILE
8822 if (do_profiling
== PROF_YES
)
8823 prof_child_exit(&wait_time
);
8828 --nesting
; /* see matching increment above */
8831 * When stopping to execute autocommands, restore the search patterns and
8836 restore_search_patterns();
8838 did_filetype
= FALSE
;
8842 * Some events don't set or reset the Changed flag.
8843 * Check if still in the same buffer!
8845 if (curbuf
== old_curbuf
8846 && (event
== EVENT_BUFREADPOST
8847 || event
== EVENT_BUFWRITEPOST
8848 || event
== EVENT_FILEAPPENDPOST
8849 || event
== EVENT_VIMLEAVE
8850 || event
== EVENT_VIMLEAVEPRE
))
8853 if (curbuf
->b_changed
!= save_changed
)
8854 need_maketitle
= TRUE
;
8856 curbuf
->b_changed
= save_changed
;
8859 au_cleanup(); /* may really delete removed patterns/commands now */
8862 /* When wiping out a buffer make sure all its buffer-local autocommands
8864 if (event
== EVENT_BUFWIPEOUT
&& buf
!= NULL
)
8865 aubuflocal_remove(buf
);
8871 static char_u
*old_termresponse
= NULL
;
8875 * Block triggering autocommands until unblock_autocmd() is called.
8876 * Can be used recursively, so long as it's symmetric.
8882 /* Remember the value of v:termresponse. */
8883 if (autocmd_blocked
== 0)
8884 old_termresponse
= get_vim_var_str(VV_TERMRESPONSE
);
8895 /* When v:termresponse was set while autocommands were blocked, trigger
8896 * the autocommands now. Esp. useful when executing a shell command
8897 * during startup (vimdiff). */
8898 if (autocmd_blocked
== 0
8899 && get_vim_var_str(VV_TERMRESPONSE
) != old_termresponse
)
8900 apply_autocmds(EVENT_TERMRESPONSE
, NULL
, NULL
, FALSE
, curbuf
);
8905 * Find next autocommand pattern that matches.
8908 auto_next_pat(apc
, stop_at_last
)
8910 int stop_at_last
; /* stop when 'last' flag is set */
8917 vim_free(sourcing_name
);
8918 sourcing_name
= NULL
;
8920 for (ap
= apc
->curpat
; ap
!= NULL
&& !got_int
; ap
= ap
->next
)
8924 /* Only use a pattern when it has not been removed, has commands and
8925 * the group matches. For buffer-local autocommands only check the
8927 if (ap
->pat
!= NULL
&& ap
->cmds
!= NULL
8928 && (apc
->group
== AUGROUP_ALL
|| apc
->group
== ap
->group
))
8930 /* execution-condition */
8931 if (ap
->buflocal_nr
== 0
8932 ? (match_file_pat(NULL
, ap
->reg_prog
, apc
->fname
,
8933 apc
->sfname
, apc
->tail
, ap
->allow_dirs
))
8934 : ap
->buflocal_nr
== apc
->arg_bufnr
)
8936 name
= event_nr2name(apc
->event
);
8937 s
= _("%s Auto commands for \"%s\"");
8938 sourcing_name
= alloc((unsigned)(STRLEN(s
)
8939 + STRLEN(name
) + ap
->patlen
+ 1));
8940 if (sourcing_name
!= NULL
)
8942 sprintf((char *)sourcing_name
, s
,
8943 (char *)name
, (char *)ap
->pat
);
8947 smsg((char_u
*)_("Executing %s"), sourcing_name
);
8953 apc
->nextcmd
= ap
->cmds
;
8954 /* mark last command */
8955 for (cp
= ap
->cmds
; cp
->next
!= NULL
; cp
= cp
->next
)
8960 if (apc
->curpat
!= NULL
) /* found a match */
8963 if (stop_at_last
&& ap
->last
)
8969 * Get next autocommand command.
8970 * Called by do_cmdline() to get the next line for ":if".
8971 * Returns allocated string, or NULL for end of autocommands.
8975 getnextac(c
, cookie
, indent
)
8976 int c
; /* not used */
8978 int indent
; /* not used */
8980 AutoPatCmd
*acp
= (AutoPatCmd
*)cookie
;
8984 /* Can be called again after returning the last line. */
8985 if (acp
->curpat
== NULL
)
8988 /* repeat until we find an autocommand to execute */
8991 /* skip removed commands */
8992 while (acp
->nextcmd
!= NULL
&& acp
->nextcmd
->cmd
== NULL
)
8993 if (acp
->nextcmd
->last
)
8994 acp
->nextcmd
= NULL
;
8996 acp
->nextcmd
= acp
->nextcmd
->next
;
8998 if (acp
->nextcmd
!= NULL
)
9001 /* at end of commands, find next pattern that matches */
9002 if (acp
->curpat
->last
)
9005 acp
->curpat
= acp
->curpat
->next
;
9006 if (acp
->curpat
!= NULL
)
9007 auto_next_pat(acp
, TRUE
);
9008 if (acp
->curpat
== NULL
)
9016 verbose_enter_scroll();
9017 smsg((char_u
*)_("autocommand %s"), ac
->cmd
);
9018 msg_puts((char_u
*)"\n"); /* don't overwrite this either */
9019 verbose_leave_scroll();
9021 retval
= vim_strsave(ac
->cmd
);
9022 autocmd_nested
= ac
->nested
;
9024 current_SID
= ac
->scriptID
;
9027 acp
->nextcmd
= NULL
;
9029 acp
->nextcmd
= ac
->next
;
9034 * Return TRUE if there is a matching autocommand for "fname".
9035 * To account for buffer-local autocommands, function needs to know
9036 * in which buffer the file will be opened.
9039 has_autocmd(event
, sfname
, buf
)
9046 char_u
*tail
= gettail(sfname
);
9049 fname
= FullName_save(sfname
, FALSE
);
9053 #ifdef BACKSLASH_IN_FILENAME
9055 * Replace all backslashes with forward slashes. This makes the
9056 * autocommand patterns portable between Unix and MS-DOS.
9058 sfname
= vim_strsave(sfname
);
9060 forward_slash(sfname
);
9061 forward_slash(fname
);
9064 for (ap
= first_autopat
[(int)event
]; ap
!= NULL
; ap
= ap
->next
)
9065 if (ap
->pat
!= NULL
&& ap
->cmds
!= NULL
9066 && (ap
->buflocal_nr
== 0
9067 ? match_file_pat(NULL
, ap
->reg_prog
,
9068 fname
, sfname
, tail
, ap
->allow_dirs
)
9069 : buf
!= NULL
&& ap
->buflocal_nr
== buf
->b_fnum
9077 #ifdef BACKSLASH_IN_FILENAME
9084 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
9086 * Function given to ExpandGeneric() to obtain the list of autocommand group
9091 get_augroup_name(xp
, idx
)
9095 if (idx
== augroups
.ga_len
) /* add "END" add the end */
9096 return (char_u
*)"END";
9097 if (idx
>= augroups
.ga_len
) /* end of list */
9099 if (AUGROUP_NAME(idx
) == NULL
) /* skip deleted entries */
9100 return (char_u
*)"";
9101 return AUGROUP_NAME(idx
); /* return a name */
9104 static int include_groups
= FALSE
;
9107 set_context_in_autocmd(xp
, arg
, doautocmd
)
9110 int doautocmd
; /* TRUE for :doauto*, FALSE for :autocmd */
9115 /* check for a group name, skip it if present */
9116 include_groups
= FALSE
;
9118 group
= au_get_grouparg(&arg
);
9119 if (group
== AUGROUP_ERROR
)
9121 /* If there only is a group name that's what we expand. */
9122 if (*arg
== NUL
&& group
!= AUGROUP_ALL
&& !vim_iswhite(arg
[-1]))
9125 group
= AUGROUP_ALL
;
9128 /* skip over event name */
9129 for (p
= arg
; *p
!= NUL
&& !vim_iswhite(*p
); ++p
)
9134 if (group
== AUGROUP_ALL
)
9135 include_groups
= TRUE
;
9136 xp
->xp_context
= EXPAND_EVENTS
; /* expand event name */
9137 xp
->xp_pattern
= arg
;
9141 /* skip over pattern */
9143 while (*arg
&& (!vim_iswhite(*arg
) || arg
[-1] == '\\'))
9146 return arg
; /* expand (next) command */
9149 xp
->xp_context
= EXPAND_FILES
; /* expand file names */
9151 xp
->xp_context
= EXPAND_NOTHING
; /* pattern is not expanded */
9156 * Function given to ExpandGeneric() to obtain the list of event names.
9160 get_event_name(xp
, idx
)
9164 if (idx
< augroups
.ga_len
) /* First list group names, if wanted */
9166 if (!include_groups
|| AUGROUP_NAME(idx
) == NULL
)
9167 return (char_u
*)""; /* skip deleted entries */
9168 return AUGROUP_NAME(idx
); /* return a name */
9170 return (char_u
*)event_names
[idx
- augroups
.ga_len
].name
;
9173 #endif /* FEAT_CMDL_COMPL */
9176 * Return TRUE if autocmd is supported.
9179 autocmd_supported(name
)
9184 return (event_name2nr(name
, &p
) != NUM_EVENTS
);
9188 * Return TRUE if an autocommand is defined for a group, event and
9189 * pattern: The group can be omitted to accept any group. "event" and "pattern"
9190 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
9191 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
9193 * exists("#Group") or
9194 * exists("#Group#Event") or
9195 * exists("#Group#Event#pat") or
9196 * exists("#Event") or
9197 * exists("#Event#pat")
9204 char_u
*pattern
= NULL
;
9209 buf_T
*buflocal_buf
= NULL
;
9213 /* Make a copy so that we can change the '#' chars to a NUL. */
9214 arg_save
= vim_strsave(arg
);
9215 if (arg_save
== NULL
)
9217 p
= vim_strchr(arg_save
, '#');
9221 /* First, look for an autocmd group name */
9222 group
= au_find_group(arg_save
);
9223 if (group
== AUGROUP_ERROR
)
9225 /* Didn't match a group name, assume the first argument is an event. */
9226 group
= AUGROUP_ALL
;
9227 event_name
= arg_save
;
9233 /* "Group": group name is present and it's recognized */
9238 /* Must be "Group#Event" or "Group#Event#pat". */
9240 p
= vim_strchr(event_name
, '#');
9242 *p
++ = NUL
; /* "Group#Event#pat" */
9245 pattern
= p
; /* "pattern" is NULL when there is no pattern */
9247 /* find the index (enum) for the event name */
9248 event
= event_name2nr(event_name
, &p
);
9250 /* return FALSE if the event name is not recognized */
9251 if (event
== NUM_EVENTS
)
9254 /* Find the first autocommand for this event.
9255 * If there isn't any, return FALSE;
9256 * If there is one and no pattern given, return TRUE; */
9257 ap
= first_autopat
[(int)event
];
9260 if (pattern
== NULL
)
9266 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9267 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9268 if (STRICMP(pattern
, "<buffer>") == 0)
9269 buflocal_buf
= curbuf
;
9271 /* Check if there is an autocommand with the given pattern. */
9272 for ( ; ap
!= NULL
; ap
= ap
->next
)
9273 /* only use a pattern when it has not been removed and has commands. */
9274 /* For buffer-local autocommands, fnamecmp() works fine. */
9275 if (ap
->pat
!= NULL
&& ap
->cmds
!= NULL
9276 && (group
== AUGROUP_ALL
|| ap
->group
== group
)
9277 && (buflocal_buf
== NULL
9278 ? fnamecmp(ap
->pat
, pattern
) == 0
9279 : ap
->buflocal_nr
== buflocal_buf
->b_fnum
))
9290 #else /* FEAT_AUTOCMD */
9293 * Prepare for executing commands for (hidden) buffer "buf".
9294 * This is the non-autocommand version, it simply saves "curbuf" and sets
9295 * "curbuf" and "curwin" to match "buf".
9298 aucmd_prepbuf(aco
, buf
)
9299 aco_save_T
*aco
; /* structure to save values in */
9300 buf_T
*buf
; /* new curbuf */
9302 aco
->save_buf
= curbuf
;
9304 curwin
->w_buffer
= buf
;
9308 * Restore after executing commands for a (hidden) buffer.
9309 * This is the non-autocommand version.
9313 aco_save_T
*aco
; /* structure holding saved values */
9315 curbuf
= aco
->save_buf
;
9316 curwin
->w_buffer
= curbuf
;
9319 #endif /* FEAT_AUTOCMD */
9322 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9324 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9325 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9326 * vim_regcomp() often.
9327 * Used for autocommands and 'wildignore'.
9328 * Returns TRUE if there is a match, FALSE otherwise.
9331 match_file_pat(pattern
, prog
, fname
, sfname
, tail
, allow_dirs
)
9332 char_u
*pattern
; /* pattern to match with */
9333 regprog_T
*prog
; /* pre-compiled regprog or NULL */
9334 char_u
*fname
; /* full path of file name */
9335 char_u
*sfname
; /* short file name or NULL */
9336 char_u
*tail
; /* tail of path */
9337 int allow_dirs
; /* allow matching with dir */
9339 regmatch_T regmatch
;
9341 #ifdef FEAT_OSFILETYPE
9342 int no_pattern
= FALSE
; /* TRUE if check is filetype only */
9348 #ifdef CASE_INSENSITIVE_FILENAME
9349 regmatch
.rm_ic
= TRUE
; /* Always ignore case */
9351 regmatch
.rm_ic
= FALSE
; /* Don't ever ignore case */
9353 #ifdef FEAT_OSFILETYPE
9354 if (*pattern
== '<')
9356 /* There is a filetype condition specified with this pattern.
9357 * Check the filetype matches first. If not, don't bother with the
9358 * pattern (set regprog to NULL).
9359 * Always use magic for the regexp.
9362 for (type_start
= pattern
+ 1; (c
= *pattern
); pattern
++)
9364 if ((c
== ';' || c
== '>') && match
== FALSE
)
9366 *pattern
= NUL
; /* Terminate the string */
9367 match
= mch_check_filetype(fname
, type_start
);
9368 *pattern
= c
; /* Restore the terminator */
9369 type_start
= pattern
+ 1;
9375 /* (c should never be NUL, but check anyway) */
9376 if (match
== FALSE
|| c
== NUL
)
9377 regmatch
.regprog
= NULL
; /* Doesn't match - don't check pat. */
9378 else if (*pattern
== NUL
)
9380 regmatch
.regprog
= NULL
; /* Vim will try to free regprog later */
9381 no_pattern
= TRUE
; /* Always matches - don't check pat. */
9384 regmatch
.regprog
= vim_regcomp(pattern
+ 1, RE_MAGIC
);
9390 regmatch
.regprog
= prog
;
9392 regmatch
.regprog
= vim_regcomp(pattern
, RE_MAGIC
);
9396 * Try for a match with the pattern with:
9397 * 1. the full file name, when the pattern has a '/'.
9398 * 2. the short file name, when the pattern has a '/'.
9399 * 3. the tail of the file name, when the pattern has no '/'.
9402 #ifdef FEAT_OSFILETYPE
9403 /* If the check is for a filetype only and we don't care
9404 * about the path then skip all the regexp stuff.
9408 (regmatch
.regprog
!= NULL
9410 && (vim_regexec(®match
, fname
, (colnr_T
)0)
9412 && vim_regexec(®match
, sfname
, (colnr_T
)0))))
9413 || (!allow_dirs
&& vim_regexec(®match
, tail
, (colnr_T
)0)))))
9417 vim_free(regmatch
.regprog
);
9422 #if defined(FEAT_WILDIGN) || defined(PROTO)
9424 * Return TRUE if a file matches with a pattern in "list".
9425 * "list" is a comma-separated list of patterns, like 'wildignore'.
9426 * "sfname" is the short file name or NULL, "ffname" the long file name.
9429 match_file_list(list
, sfname
, ffname
)
9441 tail
= gettail(sfname
);
9443 /* try all patterns in 'wildignore' */
9447 copy_option_part(&p
, buf
, 100, ",");
9448 regpat
= file_pat_to_reg_pat(buf
, NULL
, &allow_dirs
, FALSE
);
9451 match
= match_file_pat(regpat
, NULL
, ffname
, sfname
,
9452 tail
, (int)allow_dirs
);
9462 * Convert the given pattern "pat" which has shell style wildcards in it, into
9463 * a regular expression, and return the result in allocated memory. If there
9464 * is a directory path separator to be matched, then TRUE is put in
9465 * allow_dirs, otherwise FALSE is put there -- webb.
9466 * Handle backslashes before special characters, like "\*" and "\ ".
9468 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9469 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9471 * Returns NULL when out of memory.
9475 file_pat_to_reg_pat(pat
, pat_end
, allow_dirs
, no_bslash
)
9477 char_u
*pat_end
; /* first char after pattern or NULL */
9478 char *allow_dirs
; /* Result passed back out in here */
9479 int no_bslash
; /* Don't use a backward slash as pathsep */
9487 int add_dollar
= TRUE
;
9488 #ifdef FEAT_OSFILETYPE
9489 int check_length
= 0;
9492 if (allow_dirs
!= NULL
)
9493 *allow_dirs
= FALSE
;
9494 if (pat_end
== NULL
)
9495 pat_end
= pat
+ STRLEN(pat
);
9497 #ifdef FEAT_OSFILETYPE
9498 /* Find out how much of the string is the filetype check */
9501 /* Count chars until the next '>' */
9502 for (p
= pat
+ 1; p
< pat_end
&& *p
!= '>'; p
++)
9506 /* Pattern is of the form <.*>.* */
9507 check_length
= p
- pat
+ 1;
9508 if (p
+ 1 >= pat_end
)
9510 /* The 'pattern' is a filetype check ONLY */
9511 reg_pat
= (char_u
*)alloc(check_length
+ 1);
9512 if (reg_pat
!= NULL
)
9514 mch_memmove(reg_pat
, pat
, (size_t)check_length
);
9515 reg_pat
[check_length
] = NUL
;
9520 /* else: there was no closing '>' - assume it was a normal pattern */
9523 pat
+= check_length
;
9524 size
= 2 + check_length
;
9526 size
= 2; /* '^' at start, '$' at end */
9529 for (p
= pat
; p
< pat_end
; p
++)
9539 size
+= 2; /* extra backslash */
9541 #ifdef BACKSLASH_IN_FILENAME
9544 size
+= 4; /* could become "[\/]" */
9550 if (enc_dbcs
!= 0 && (*mb_ptr2len
)(p
) > 1)
9559 reg_pat
= alloc(size
+ 1);
9560 if (reg_pat
== NULL
)
9563 #ifdef FEAT_OSFILETYPE
9564 /* Copy the type check in to the start. */
9566 mch_memmove(reg_pat
, pat
- check_length
, (size_t)check_length
);
9573 while (pat
[0] == '*' && pat
< pat_end
- 1)
9580 while (endp
- pat
> 0 && *endp
== '*')
9584 for (p
= pat
; *p
&& nested
>= 0 && p
<= endp
; p
++)
9591 while (p
[1] == '*') /* "**" matches like "*" */
9596 if (allow_dirs
!= NULL
)
9601 reg_pat
[i
++] = '\\';
9613 #ifdef BACKSLASH_IN_FILENAME
9617 * "\x" to "\\x" e.g., "dir\file"
9618 * "\*" to "\\.*" e.g., "dir\*.c"
9619 * "\?" to "\\." e.g., "dir\??.c"
9620 * "\+" to "\+" e.g., "fileX\+.c"
9622 if ((vim_isfilec(p
[1]) || p
[1] == '*' || p
[1] == '?')
9626 reg_pat
[i
++] = '\\';
9629 if (allow_dirs
!= NULL
)
9636 #ifdef BACKSLASH_IN_FILENAME
9646 if (allow_dirs
!= NULL
&& vim_ispathsep(*p
)
9647 #ifdef BACKSLASH_IN_FILENAME
9648 && (!no_bslash
|| *p
!= '\\')
9652 reg_pat
[i
++] = '\\';
9656 #ifdef BACKSLASH_IN_FILENAME
9659 reg_pat
[i
++] = '\\';
9662 if (allow_dirs
!= NULL
)
9667 reg_pat
[i
++] = '\\';
9672 reg_pat
[i
++] = '\\';
9679 reg_pat
[i
++] = '\\';
9687 if (enc_dbcs
!= 0 && (*mb_ptr2len
)(p
) > 1)
9688 reg_pat
[i
++] = *p
++;
9691 if (allow_dirs
!= NULL
&& vim_ispathsep(*p
))
9703 EMSG(_("E219: Missing {."));
9705 EMSG(_("E220: Missing }."));