1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
11 * fileio.c: read from and write to a file
14 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
15 # include "vimio.h" /* for lseek(), must be before vim.h */
19 # include "vimio.h" /* for mktemp(), CJW 1997-12-03 */
29 # include <limits.h> /* for SSIZE_MAX */
32 #if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
33 # include <utime.h> /* for struct utimbuf */
36 #define BUFSIZE 8192 /* size of normal write buffer */
37 #define SMBUFSIZE 256 /* size of emergency write buffer */
40 # define CRYPT_MAGIC "VimCrypt~01!" /* "01" is the version nr */
41 # define CRYPT_MAGIC_LEN 12 /* must be multiple of 4! */
44 /* Is there any system that doesn't have access()? */
45 #define USE_MCH_ACCESS
47 #if defined(sun) && defined(S_ISCHR)
48 # define OPEN_CHR_FILES
49 static int is_dev_fd_file(char_u
*fname
);
52 static char_u
*next_fenc
__ARGS((char_u
**pp
));
54 static char_u
*readfile_charconvert
__ARGS((char_u
*fname
, char_u
*fenc
, int *fdp
));
58 static void check_marks_read
__ARGS((void));
61 static char_u
*check_for_cryptkey
__ARGS((char_u
*cryptkey
, char_u
*ptr
, long *sizep
, long *filesizep
, int newfile
));
64 static void set_file_time
__ARGS((char_u
*fname
, time_t atime
, time_t mtime
));
66 static int set_rw_fname
__ARGS((char_u
*fname
, char_u
*sfname
));
67 static int msg_add_fileformat
__ARGS((int eol_type
));
68 static void msg_add_eol
__ARGS((void));
69 static int check_mtime
__ARGS((buf_T
*buf
, struct stat
*s
));
70 static int time_differs
__ARGS((long t1
, long t2
));
72 static int apply_autocmds_exarg
__ARGS((event_T event
, char_u
*fname
, char_u
*fname_io
, int force
, buf_T
*buf
, exarg_T
*eap
));
73 static int au_find_group
__ARGS((char_u
*name
));
75 # define AUGROUP_DEFAULT -1 /* default autocmd group */
76 # define AUGROUP_ERROR -2 /* errornouse autocmd group */
77 # define AUGROUP_ALL -3 /* all autocmd groups */
80 #if defined(FEAT_CRYPT) || defined(FEAT_MBYTE)
82 # define FIO_LATIN1 0x01 /* convert Latin1 */
83 # define FIO_UTF8 0x02 /* convert UTF-8 */
84 # define FIO_UCS2 0x04 /* convert UCS-2 */
85 # define FIO_UCS4 0x08 /* convert UCS-4 */
86 # define FIO_UTF16 0x10 /* convert UTF-16 */
88 # define FIO_CODEPAGE 0x20 /* convert MS-Windows codepage */
89 # define FIO_PUT_CP(x) (((x) & 0xffff) << 16) /* put codepage in top word */
90 # define FIO_GET_CP(x) (((x)>>16) & 0xffff) /* get codepage from top word */
93 # define FIO_MACROMAN 0x20 /* convert MacRoman */
95 # define FIO_ENDIAN_L 0x80 /* little endian */
96 # define FIO_ENCRYPTED 0x1000 /* encrypt written bytes */
97 # define FIO_NOCONVERT 0x2000 /* skip encoding conversion */
98 # define FIO_UCSBOM 0x4000 /* check for BOM at start of file */
99 # define FIO_ALL -1 /* allow all formats */
102 /* When converting, a read() or write() may leave some bytes to be converted
103 * for the next call. The value is guessed... */
104 #define CONV_RESTLEN 30
106 /* We have to guess how much a sequence of bytes may expand when converting
107 * with iconv() to be able to allocate a buffer. */
111 * Structure to pass arguments from buf_write() to buf_write_bytes().
115 int bw_fd
; /* file descriptor */
116 char_u
*bw_buf
; /* buffer with data to be written */
117 int bw_len
; /* length of data */
119 int bw_flags
; /* FIO_ flags */
122 char_u bw_rest
[CONV_RESTLEN
]; /* not converted bytes */
123 int bw_restlen
; /* nr of bytes in bw_rest[] */
124 int bw_first
; /* first write call */
125 char_u
*bw_conv_buf
; /* buffer for writing converted chars */
126 int bw_conv_buflen
; /* size of bw_conv_buf */
127 int bw_conv_error
; /* set for conversion error */
129 iconv_t bw_iconv_fd
; /* descriptor for iconv() or -1 */
134 static int buf_write_bytes
__ARGS((struct bw_info
*ip
));
137 static linenr_T readfile_linenr
__ARGS((linenr_T linecnt
, char_u
*p
, char_u
*endp
));
138 static int ucs2bytes
__ARGS((unsigned c
, char_u
**pp
, int flags
));
139 static int same_encoding
__ARGS((char_u
*a
, char_u
*b
));
140 static int get_fio_flags
__ARGS((char_u
*ptr
));
141 static char_u
*check_for_bom
__ARGS((char_u
*p
, long size
, int *lenp
, int flags
));
142 static int make_bom
__ARGS((char_u
*buf
, char_u
*name
));
144 static int get_win_fio_flags
__ARGS((char_u
*ptr
));
147 static int get_mac_fio_flags
__ARGS((char_u
*ptr
));
150 static int move_lines
__ARGS((buf_T
*frombuf
, buf_T
*tobuf
));
154 filemess(buf
, name
, s
, attr
)
164 msg_add_fname(buf
, name
); /* put file name in IObuff with quotes */
165 /* If it's extremely long, truncate it. */
166 if (STRLEN(IObuff
) > IOSIZE
- 80)
167 IObuff
[IOSIZE
- 80] = NUL
;
170 * For the first message may have to start a new line.
171 * For further ones overwrite the previous one, reset msg_scroll before
172 * calling filemess().
174 msg_scroll_save
= msg_scroll
;
175 if (shortmess(SHM_OVERALL
) && !exiting
&& p_verbose
== 0)
177 if (!msg_scroll
) /* wait a bit when overwriting an error msg */
178 check_for_delay(FALSE
);
180 msg_scroll
= msg_scroll_save
;
181 msg_scrolled_ign
= TRUE
;
182 /* may truncate the message to avoid a hit-return prompt */
183 msg_outtrans_attr(msg_may_trunc(FALSE
, IObuff
), attr
);
186 msg_scrolled_ign
= FALSE
;
190 * Read lines from file "fname" into the buffer after line "from".
192 * 1. We allocate blocks with lalloc, as big as possible.
193 * 2. Each block is filled with characters from the file with a single read().
194 * 3. The lines are inserted in the buffer with ml_append().
196 * (caller must check that fname != NULL, unless READ_STDIN is used)
198 * "lines_to_skip" is the number of lines that must be skipped
199 * "lines_to_read" is the number of lines that are appended
200 * When not recovering lines_to_skip is 0 and lines_to_read MAXLNUM.
203 * READ_NEW starting to edit a new buffer
204 * READ_FILTER reading filter output
205 * READ_STDIN read from stdin instead of a file
206 * READ_BUFFER read from curbuf instead of a file (converting after reading
208 * READ_DUMMY read into a dummy buffer (to check if file contents changed)
210 * return FAIL for failure, OK otherwise
213 readfile(fname
, sfname
, from
, lines_to_skip
, lines_to_read
, eap
, flags
)
217 linenr_T lines_to_skip
;
218 linenr_T lines_to_read
;
219 exarg_T
*eap
; /* can be NULL! */
223 int newfile
= (flags
& READ_NEW
);
225 int filtering
= (flags
& READ_FILTER
);
226 int read_stdin
= (flags
& READ_STDIN
);
227 int read_buffer
= (flags
& READ_BUFFER
);
228 int set_options
= newfile
|| read_buffer
229 || (eap
!= NULL
&& eap
->read_edit
);
230 linenr_T read_buf_lnum
= 1; /* next line to read from curbuf */
231 colnr_T read_buf_col
= 0; /* next char to read from this line */
233 linenr_T lnum
= from
;
234 char_u
*ptr
= NULL
; /* pointer into read buffer */
235 char_u
*buffer
= NULL
; /* read buffer */
236 char_u
*new_buffer
= NULL
; /* init to shut up gcc */
237 char_u
*line_start
= NULL
; /* init to shut up gcc */
238 int wasempty
; /* buffer was empty before reading */
243 int skip_read
= FALSE
;
245 char_u
*cryptkey
= NULL
;
247 int split
= 0; /* number of split lines */
248 #define UNKNOWN 0x0fffffff /* file size is unknown */
250 int error
= FALSE
; /* errors encountered */
251 int ff_error
= EOL_UNKNOWN
; /* file format with errors */
252 long linerest
= 0; /* remaining chars in line */
255 int swap_mode
= -1; /* protection bits for swap file */
259 int fileformat
= 0; /* end-of-line format */
260 int keep_fileformat
= FALSE
;
263 linenr_T skip_count
= 0;
264 linenr_T read_count
= 0;
265 int msg_save
= msg_scroll
;
266 linenr_T read_no_eol_lnum
= 0; /* non-zero lnum when last line of
267 * last read was missing the eol */
268 int try_mac
= (vim_strchr(p_ffs
, 'm') != NULL
);
269 int try_dos
= (vim_strchr(p_ffs
, 'd') != NULL
);
270 int try_unix
= (vim_strchr(p_ffs
, 'x') != NULL
);
271 int file_rewind
= FALSE
;
274 linenr_T conv_error
= 0; /* line nr with conversion error */
275 linenr_T illegal_byte
= 0; /* line nr with illegal byte */
276 int keep_dest_enc
= FALSE
; /* don't retry when char doesn't fit
277 in destination encoding */
278 int bad_char_behavior
= BAD_REPLACE
;
279 /* BAD_KEEP, BAD_DROP or character to
281 char_u
*tmpname
= NULL
; /* name of 'charconvert' output file */
283 char_u
*fenc
; /* fileencoding to use */
284 int fenc_alloced
; /* fenc_next is in allocated memory */
285 char_u
*fenc_next
= NULL
; /* next item in 'fencs' or NULL */
286 int advance_fenc
= FALSE
;
289 iconv_t iconv_fd
= (iconv_t
)-1; /* descriptor for iconv() or -1 */
291 int did_iconv
= FALSE
; /* TRUE when iconv() failed and trying
292 'charconvert' next */
295 int converted
= FALSE
; /* TRUE if conversion done */
296 int notconverted
= FALSE
; /* TRUE if conversion wanted but it
298 char_u conv_rest
[CONV_RESTLEN
];
299 int conv_restlen
= 0; /* nr of bytes in conv_rest[] */
302 write_no_eol_lnum
= 0; /* in case it was set by the previous read */
305 * If there is no file name yet, use the one for the read file.
306 * BF_NOTEDITED is set to reflect this.
307 * Don't do this for a read from a filter.
308 * Only do this when 'cpoptions' contains the 'f' flag.
310 if (curbuf
->b_ffname
== NULL
313 && vim_strchr(p_cpo
, CPO_FNAMER
) != NULL
314 && !(flags
& READ_DUMMY
))
316 if (set_rw_fname(fname
, sfname
) == FAIL
)
320 /* After reading a file the cursor line changes but we don't want to
321 * display the line. */
322 ex_no_reprint
= TRUE
;
324 /* don't display the file info for another buffer now */
325 need_fileinfo
= FALSE
;
328 * For Unix: Use the short file name whenever possible.
329 * Avoids problems with networks and when directory names are changed.
330 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
331 * another directory, which we don't detect.
335 #if defined(UNIX) || defined(__EMX__)
341 * The BufReadCmd and FileReadCmd events intercept the reading process by
342 * executing the associated commands instead.
344 if (!filtering
&& !read_stdin
&& !read_buffer
)
348 pos
= curbuf
->b_op_start
;
350 /* Set '[ mark to the line above where the lines go (line 1 if zero). */
351 curbuf
->b_op_start
.lnum
= ((from
== 0) ? 1 : from
);
352 curbuf
->b_op_start
.col
= 0;
356 if (apply_autocmds_exarg(EVENT_BUFREADCMD
, NULL
, sfname
,
359 return aborting() ? FAIL
: OK
;
364 else if (apply_autocmds_exarg(EVENT_FILEREADCMD
, sfname
, sfname
,
367 return aborting() ? FAIL
: OK
;
372 curbuf
->b_op_start
= pos
;
376 if ((shortmess(SHM_OVER
) || curbuf
->b_help
) && p_verbose
== 0)
377 msg_scroll
= FALSE
; /* overwrite previous file message */
379 msg_scroll
= TRUE
; /* don't overwrite previous file message */
382 * If the name ends in a path separator, we can't open it. Check here,
383 * because reading the file may actually work, but then creating the swap
384 * file may destroy it! Reported on MS-DOS and Win 95.
385 * If the name is too long we might crash further on, quit here.
387 if (fname
!= NULL
&& *fname
!= NUL
)
389 p
= fname
+ STRLEN(fname
);
390 if (after_pathsep(fname
, p
) || STRLEN(fname
) >= MAXPATHL
)
392 filemess(curbuf
, fname
, (char_u
*)_("Illegal file name"), 0);
394 msg_scroll
= msg_save
;
401 * On Unix it is possible to read a directory, so we have to
402 * check for it before the mch_open().
404 if (!read_stdin
&& !read_buffer
)
406 perm
= mch_getperm(fname
);
407 if (perm
>= 0 && !S_ISREG(perm
) /* not a regular file ... */
409 && !S_ISFIFO(perm
) /* ... or fifo */
412 && !S_ISSOCK(perm
) /* ... or socket */
414 # ifdef OPEN_CHR_FILES
415 && !(S_ISCHR(perm
) && is_dev_fd_file(fname
))
416 /* ... or a character special file named /dev/fd/<n> */
421 filemess(curbuf
, fname
, (char_u
*)_("is a directory"), 0);
423 filemess(curbuf
, fname
, (char_u
*)_("is not a file"), 0);
425 msg_scroll
= msg_save
;
429 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
431 * MS-Windows allows opening a device, but we will probably get stuck
434 if (!p_odev
&& mch_nodetype(fname
) == NODE_WRITABLE
)
436 filemess(curbuf
, fname
, (char_u
*)_("is a device (disabled with 'opendevice' option)"), 0);
438 msg_scroll
= msg_save
;
445 /* set default 'fileformat' */
448 if (eap
!= NULL
&& eap
->force_ff
!= 0)
449 set_fileformat(get_fileformat_force(curbuf
, eap
), OPT_LOCAL
);
450 else if (*p_ffs
!= NUL
)
451 set_fileformat(default_fileformat(), OPT_LOCAL
);
454 /* set or reset 'binary' */
455 if (eap
!= NULL
&& eap
->force_bin
!= 0)
457 int oldval
= curbuf
->b_p_bin
;
459 curbuf
->b_p_bin
= (eap
->force_bin
== FORCE_BIN
);
460 set_options_bin(oldval
, curbuf
->b_p_bin
, OPT_LOCAL
);
464 * When opening a new file we take the readonly flag from the file.
465 * Default is r/w, can be set to r/o below.
466 * Don't reset it when in readonly mode
467 * Only set/reset b_p_ro when BF_CHECK_RO is set.
469 check_readonly
= (newfile
&& (curbuf
->b_flags
& BF_CHECK_RO
));
470 if (check_readonly
&& !readonlymode
)
471 curbuf
->b_p_ro
= FALSE
;
473 if (newfile
&& !read_stdin
&& !read_buffer
)
475 /* Remember time of file.
476 * For RISCOS, also remember the filetype.
478 if (mch_stat((char *)fname
, &st
) >= 0)
480 buf_store_time(curbuf
, &st
, fname
);
481 curbuf
->b_mtime_read
= curbuf
->b_mtime
;
483 #if defined(RISCOS) && defined(FEAT_OSFILETYPE)
484 /* Read the filetype into the buffer local filetype option. */
485 mch_read_filetype(fname
);
489 * Use the protection bits of the original file for the swap file.
490 * This makes it possible for others to read the name of the
491 * edited file from the swapfile, but only if they can read the
493 * Remove the "write" and "execute" bits for group and others
494 * (they must not write the swapfile).
495 * Add the "read" and "write" bits for the user, otherwise we may
496 * not be able to write to the file ourselves.
497 * Setting the bits is done below, after creating the swap file.
499 swap_mode
= (st
.st_mode
& 0644) | 0600;
501 #ifdef FEAT_CW_EDITOR
502 /* Get the FSSpec on MacOS
503 * TODO: Update it properly when the buffer name changes
505 (void)GetFSSpecFromPath(curbuf
->b_ffname
, &curbuf
->b_FSSpec
);
508 curbuf
->b_fab_rfm
= st
.st_fab_rfm
;
509 curbuf
->b_fab_rat
= st
.st_fab_rat
;
510 curbuf
->b_fab_mrs
= st
.st_fab_mrs
;
516 curbuf
->b_mtime_read
= 0;
517 curbuf
->b_orig_size
= 0;
518 curbuf
->b_orig_mode
= 0;
521 /* Reset the "new file" flag. It will be set again below when the
522 * file doesn't exist. */
523 curbuf
->b_flags
&= ~(BF_NEW
| BF_NEW_W
);
527 * for UNIX: check readonly with perm and mch_access()
528 * for RISCOS: same as Unix, otherwise file gets re-datestamped!
529 * for MSDOS and Amiga: check readonly by trying to open the file for writing
531 file_readonly
= FALSE
;
534 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
535 /* Force binary I/O on stdin to avoid CR-LF -> LF conversion. */
536 setmode(0, O_BINARY
);
539 else if (!read_buffer
)
541 #ifdef USE_MCH_ACCESS
546 mch_access((char *)fname
, W_OK
))
547 file_readonly
= TRUE
;
548 fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0);
552 || (fd
= mch_open((char *)fname
, O_RDWR
| O_EXTRA
, 0)) < 0)
554 file_readonly
= TRUE
;
556 fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0);
561 if (fd
< 0) /* cannot open at all */
566 msg_scroll
= msg_save
;
569 * On MSDOS and Amiga we can't open a directory, check here.
571 isdir_f
= (mch_isdir(fname
));
572 perm
= mch_getperm(fname
); /* check if the file exists */
575 filemess(curbuf
, sfname
, (char_u
*)_("is a directory"), 0);
576 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
585 * Set the 'new-file' flag, so that when the file has
586 * been created by someone else, a ":w" will complain.
588 curbuf
->b_flags
|= BF_NEW
;
590 /* Create a swap file now, so that other Vims are warned
591 * that we are editing this file. Don't do this for a
592 * "nofile" or "nowrite" buffer type. */
594 if (!bt_dontwrite(curbuf
))
596 check_need_swap(newfile
);
597 if (dir_of_file_exists(fname
))
598 filemess(curbuf
, sfname
, (char_u
*)_("[New File]"), 0);
600 filemess(curbuf
, sfname
,
601 (char_u
*)_("[New DIRECTORY]"), 0);
603 /* Even though this is a new file, it might have been
604 * edited before and deleted. Get the old marks. */
608 if (eap
!= NULL
&& eap
->force_enc
!= 0)
610 /* set forced 'fileencoding' */
611 fenc
= enc_canonize(eap
->cmd
+ eap
->force_enc
);
613 set_string_option_direct((char_u
*)"fenc", -1,
614 fenc
, OPT_FREE
|OPT_LOCAL
, 0);
619 apply_autocmds_exarg(EVENT_BUFNEWFILE
, sfname
, sfname
,
622 /* remember the current fileformat */
623 save_file_ff(curbuf
);
625 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
626 if (aborting()) /* autocmds may abort script processing */
629 return OK
; /* a new file is not an error */
633 filemess(curbuf
, sfname
, (char_u
*)(
635 (errno
== EFBIG
) ? _("[File too big]") :
637 _("[Permission Denied]")), 0);
638 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
646 * Only set the 'ro' flag for readonly files the first time they are
647 * loaded. Help files always get readonly mode
649 if ((check_readonly
&& file_readonly
) || curbuf
->b_help
)
650 curbuf
->b_p_ro
= TRUE
;
654 /* Don't change 'eol' if reading from buffer as it will already be
655 * correctly set when reading stdin. */
658 curbuf
->b_p_eol
= TRUE
;
659 curbuf
->b_start_eol
= TRUE
;
662 curbuf
->b_p_bomb
= FALSE
;
663 curbuf
->b_start_bomb
= FALSE
;
667 /* Create a swap file now, so that other Vims are warned that we are
669 * Don't do this for a "nofile" or "nowrite" buffer type. */
671 if (!bt_dontwrite(curbuf
))
674 check_need_swap(newfile
);
676 /* Set swap file protection bits after creating it. */
677 if (swap_mode
> 0 && curbuf
->b_ml
.ml_mfp
->mf_fname
!= NULL
)
678 (void)mch_setperm(curbuf
->b_ml
.ml_mfp
->mf_fname
, (long)swap_mode
);
682 #if defined(HAS_SWAP_EXISTS_ACTION)
683 /* If "Quit" selected at ATTENTION dialog, don't load the file */
684 if (swap_exists_action
== SEA_QUIT
)
686 if (!read_buffer
&& !read_stdin
)
692 ++no_wait_return
; /* don't wait for return yet */
695 * Set '[ mark to the line above where the lines go (line 1 if zero).
697 curbuf
->b_op_start
.lnum
= ((from
== 0) ? 1 : from
);
698 curbuf
->b_op_start
.col
= 0;
704 int n
= msg_scrolled
;
705 buf_T
*old_curbuf
= curbuf
;
708 * The file must be closed again, the autocommands may want to change
709 * the file before reading it.
712 close(fd
); /* ignore errors */
715 * The output from the autocommands should not overwrite anything and
716 * should not be overwritten: Set msg_scroll, restore its value if no
721 apply_autocmds_exarg(EVENT_FILTERREADPRE
, NULL
, sfname
,
724 apply_autocmds_exarg(EVENT_STDINREADPRE
, NULL
, sfname
,
727 apply_autocmds_exarg(EVENT_BUFREADPRE
, NULL
, sfname
,
730 apply_autocmds_exarg(EVENT_FILEREADPRE
, sfname
, sfname
,
732 if (msg_scrolled
== n
)
736 if (aborting()) /* autocmds may abort script processing */
739 msg_scroll
= msg_save
;
740 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
745 * Don't allow the autocommands to change the current buffer.
746 * Try to re-open the file.
748 if (!read_stdin
&& (curbuf
!= old_curbuf
749 || (fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0)) < 0))
752 msg_scroll
= msg_save
;
754 EMSG(_("E200: *ReadPre autocommands made the file unreadable"));
756 EMSG(_("E201: *ReadPre autocommands must not change current buffer"));
757 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
761 #endif /* FEAT_AUTOCMD */
763 /* Autocommands may add lines to the file, need to check if it is empty */
764 wasempty
= (curbuf
->b_ml
.ml_flags
& ML_EMPTY
);
766 if (!recoverymode
&& !filtering
&& !(flags
& READ_DUMMY
))
769 * Show the user that we are busy reading the input. Sometimes this
770 * may take a while. When reading from stdin another program may
771 * still be running, don't move the cursor to the last line, unless
772 * always using the GUI.
776 #ifndef ALWAYS_USE_GUI
777 mch_msg(_("Vim: Reading from stdin...\n"));
780 /* Also write a message in the GUI window, if there is one. */
781 if (gui
.in_use
&& !gui
.dying
&& !gui
.starting
)
783 p
= (char_u
*)_("Reading from stdin...");
784 gui_write(p
, (int)STRLEN(p
));
788 else if (!read_buffer
)
789 filemess(curbuf
, sfname
, (char_u
*)"", 0);
792 msg_scroll
= FALSE
; /* overwrite the file message */
795 * Set linecnt now, before the "retry" caused by a wrong guess for
796 * fileformat, and after the autocommands, which may change them.
798 linecnt
= curbuf
->b_ml
.ml_line_count
;
801 /* "++bad=" argument. */
802 if (eap
!= NULL
&& eap
->bad_char
!= 0)
804 bad_char_behavior
= eap
->bad_char
;
806 curbuf
->b_bad_char
= eap
->bad_char
;
809 curbuf
->b_bad_char
= 0;
812 * Decide which 'encoding' to use or use first.
814 if (eap
!= NULL
&& eap
->force_enc
!= 0)
816 fenc
= enc_canonize(eap
->cmd
+ eap
->force_enc
);
818 keep_dest_enc
= TRUE
;
820 else if (curbuf
->b_p_bin
)
822 fenc
= (char_u
*)""; /* binary: don't convert */
823 fenc_alloced
= FALSE
;
825 else if (curbuf
->b_help
)
827 char_u firstline
[80];
830 /* Help files are either utf-8 or latin1. Try utf-8 first, if this
831 * fails it must be latin1.
832 * Always do this when 'encoding' is "utf-8". Otherwise only do
833 * this when needed to avoid [converted] remarks all the time.
834 * It is needed when the first line contains non-ASCII characters.
835 * That is only in *.??x files. */
836 fenc
= (char_u
*)"latin1";
838 if (!c
&& !read_stdin
)
840 fc
= fname
[STRLEN(fname
) - 1];
841 if (TOLOWER_ASC(fc
) == 'x')
843 /* Read the first line (and a bit more). Immediately rewind to
844 * the start of the file. If the read() fails "len" is -1. */
845 len
= vim_read(fd
, firstline
, 80);
846 lseek(fd
, (off_t
)0L, SEEK_SET
);
847 for (p
= firstline
; p
< firstline
+ len
; ++p
)
859 fenc
= (char_u
*)"utf-8";
861 /* When the file is utf-8 but a character doesn't fit in
862 * 'encoding' don't retry. In help text editing utf-8 bytes
863 * doesn't make sense. */
865 keep_dest_enc
= TRUE
;
867 fenc_alloced
= FALSE
;
869 else if (*p_fencs
== NUL
)
871 fenc
= curbuf
->b_p_fenc
; /* use format from buffer */
872 fenc_alloced
= FALSE
;
876 fenc_next
= p_fencs
; /* try items in 'fileencodings' */
877 fenc
= next_fenc(&fenc_next
);
883 * Jump back here to retry reading the file in different ways.
885 * - encoding conversion failed: try another one from "fenc_next"
886 * - BOM detected and fenc was set, need to setup conversion
887 * - "fileformat" check failed: try another
889 * Variables set for special retry actions:
890 * "file_rewind" Rewind the file to start reading it again.
891 * "advance_fenc" Advance "fenc" using "fenc_next".
892 * "skip_read" Re-use already read bytes (BOM detected).
893 * "did_iconv" iconv() conversion failed, try 'charconvert'.
894 * "keep_fileformat" Don't reset "fileformat".
896 * Other status indicators:
897 * "tmpname" When != NULL did conversion with 'charconvert'.
898 * Output file has to be deleted afterwards.
899 * "iconv_fd" When != -1 did conversion with iconv().
910 else if (read_stdin
|| lseek(fd
, (off_t
)0L, SEEK_SET
) != 0)
912 /* Can't rewind the file, give up. */
916 /* Delete the previously read lines. */
918 ml_delete(lnum
--, FALSE
);
923 curbuf
->b_p_bomb
= FALSE
;
924 curbuf
->b_start_bomb
= FALSE
;
931 * When retrying with another "fenc" and the first time "fileformat"
935 keep_fileformat
= FALSE
;
938 if (eap
!= NULL
&& eap
->force_ff
!= 0)
939 fileformat
= get_fileformat_force(curbuf
, eap
);
940 else if (curbuf
->b_p_bin
)
941 fileformat
= EOL_UNIX
; /* binary: use Unix format */
942 else if (*p_ffs
== NUL
)
943 fileformat
= get_fileformat(curbuf
);/* use format from buffer */
945 fileformat
= EOL_UNKNOWN
; /* detect from file */
950 if (iconv_fd
!= (iconv_t
)-1)
952 /* aborted conversion with iconv(), close the descriptor */
953 iconv_close(iconv_fd
);
954 iconv_fd
= (iconv_t
)-1;
961 * Try the next entry in 'fileencodings'.
963 advance_fenc
= FALSE
;
965 if (eap
!= NULL
&& eap
->force_enc
!= 0)
967 /* Conversion given with "++cc=" wasn't possible, read
968 * without conversion. */
974 fenc_alloced
= FALSE
;
980 if (fenc_next
!= NULL
)
982 fenc
= next_fenc(&fenc_next
);
983 fenc_alloced
= (fenc_next
!= NULL
);
988 fenc_alloced
= FALSE
;
993 mch_remove(tmpname
); /* delete converted file */
1000 * Conversion is required when the encoding of the file is different
1001 * from 'encoding' or 'encoding' is UTF-16, UCS-2 or UCS-4 (requires
1002 * conversion to UTF-8).
1005 converted
= (*fenc
!= NUL
&& !same_encoding(p_enc
, fenc
));
1006 if (converted
|| enc_unicode
!= 0)
1009 /* "ucs-bom" means we need to check the first bytes of the file
1011 if (STRCMP(fenc
, ENC_UCSBOM
) == 0)
1012 fio_flags
= FIO_UCSBOM
;
1015 * Check if UCS-2/4 or Latin1 to UTF-8 conversion needs to be
1016 * done. This is handled below after read(). Prepare the
1017 * fio_flags to avoid having to parse the string each time.
1018 * Also check for Unicode to Latin1 conversion, because iconv()
1019 * appears not to handle this correctly. This works just like
1020 * conversion to UTF-8 except how the resulting character is put in
1023 else if (enc_utf8
|| STRCMP(p_enc
, "latin1") == 0)
1024 fio_flags
= get_fio_flags(fenc
);
1028 * Conversion from an MS-Windows codepage to UTF-8 or another codepage
1029 * is handled with MultiByteToWideChar().
1032 fio_flags
= get_win_fio_flags(fenc
);
1036 /* Conversion from Apple MacRoman to latin1 or UTF-8 */
1038 fio_flags
= get_mac_fio_flags(fenc
);
1043 * Try using iconv() if we can't convert internally.
1050 iconv_fd
= (iconv_t
)my_iconv_open(
1051 enc_utf8
? (char_u
*)"utf-8" : p_enc
, fenc
);
1056 * Use the 'charconvert' expression when conversion is required
1057 * and we can't do it internally or with iconv().
1059 if (fio_flags
== 0 && !read_stdin
&& !read_buffer
&& *p_ccv
!= NUL
1061 && iconv_fd
== (iconv_t
)-1
1068 /* Skip conversion when it's already done (retry for wrong
1070 if (tmpname
== NULL
)
1072 tmpname
= readfile_charconvert(fname
, fenc
, &fd
);
1073 if (tmpname
== NULL
)
1075 /* Conversion failed. Try another one. */
1076 advance_fenc
= TRUE
;
1079 /* Re-opening the original file failed! */
1080 EMSG(_("E202: Conversion made file unreadable!"));
1093 && iconv_fd
== (iconv_t
)-1
1097 /* Conversion wanted but we can't.
1098 * Try the next conversion in 'fileencodings' */
1099 advance_fenc
= TRUE
;
1105 /* Set "can_retry" when it's possible to rewind the file and try with
1106 * another "fenc" value. It's FALSE when no other "fenc" to try, reading
1107 * stdin or fixed at a specific encoding. */
1108 can_retry
= (*fenc
!= NUL
&& !read_stdin
&& !keep_dest_enc
);
1115 skip_count
= lines_to_skip
;
1116 read_count
= lines_to_read
;
1122 while (!error
&& !got_int
)
1125 * We allocate as much space for the file as we can get, plus
1126 * space for the old line plus room for one terminating NUL.
1127 * The amount is limited by the fact that read() only can read
1128 * upto max_unsigned characters (and other things).
1131 if (linerest
>= 0x7ff0)
1134 *ptr
= NL
; /* split line by inserting a NL */
1143 # if defined(SSIZE_MAX) && (SSIZE_MAX < 0x10000L)
1144 size
= SSIZE_MAX
; /* use max I/O size, 52K */
1146 size
= 0x10000L
; /* use buffer >= 64K */
1149 size
= 0x7ff0L
- linerest
; /* limit buffer to 32K */
1152 for ( ; size
>= 10; size
= (long)((long_u
)size
>> 1))
1154 if ((new_buffer
= lalloc((long_u
)(size
+ linerest
+ 1),
1158 if (new_buffer
== NULL
)
1160 do_outofmem_msg((long_u
)(size
* 2 + linerest
+ 1));
1164 if (linerest
) /* copy characters from the previous buffer */
1165 mch_memmove(new_buffer
, ptr
- linerest
, (size_t)linerest
);
1167 buffer
= new_buffer
;
1168 ptr
= buffer
+ linerest
;
1169 line_start
= buffer
;
1172 /* May need room to translate into.
1173 * For iconv() we don't really know the required space, use a
1174 * factor ICONV_MULT.
1175 * latin1 to utf-8: 1 byte becomes up to 2 bytes
1176 * utf-16 to utf-8: 2 bytes become up to 3 bytes, 4 bytes
1177 * become up to 4 bytes, size must be multiple of 2
1178 * ucs-2 to utf-8: 2 bytes become up to 3 bytes, size must be
1180 * ucs-4 to utf-8: 4 bytes become up to 6 bytes, size must be
1182 real_size
= (int)size
;
1184 if (iconv_fd
!= (iconv_t
)-1)
1185 size
= size
/ ICONV_MULT
;
1188 if (fio_flags
& FIO_LATIN1
)
1190 else if (fio_flags
& (FIO_UCS2
| FIO_UTF16
))
1191 size
= (size
* 2 / 3) & ~1;
1192 else if (fio_flags
& FIO_UCS4
)
1193 size
= (size
* 2 / 3) & ~3;
1194 else if (fio_flags
== FIO_UCSBOM
)
1195 size
= size
/ ICONV_MULT
; /* worst case */
1197 else if (fio_flags
& FIO_CODEPAGE
)
1198 size
= size
/ ICONV_MULT
; /* also worst case */
1201 else if (fio_flags
& FIO_MACROMAN
)
1202 size
= size
/ ICONV_MULT
; /* also worst case */
1207 if (conv_restlen
> 0)
1209 /* Insert unconverted bytes from previous line. */
1210 mch_memmove(ptr
, conv_rest
, conv_restlen
);
1211 ptr
+= conv_restlen
;
1212 size
-= conv_restlen
;
1219 * Read bytes from curbuf. Used for converting text read
1222 if (read_buf_lnum
> from
)
1232 p
= ml_get(read_buf_lnum
) + read_buf_col
;
1234 if ((int)tlen
+ n
+ 1 > size
)
1236 /* Filled up to "size", append partial line.
1237 * Change NL to NUL to reverse the effect done
1239 n
= (int)(size
- tlen
);
1240 for (ni
= 0; ni
< n
; ++ni
)
1245 ptr
[tlen
++] = p
[ni
];
1252 /* Append whole line and new-line. Change NL
1253 * to NUL to reverse the effect done below. */
1254 for (ni
= 0; ni
< n
; ++ni
)
1259 ptr
[tlen
++] = p
[ni
];
1263 if (++read_buf_lnum
> from
)
1265 /* When the last line didn't have an
1266 * end-of-line don't add it now either. */
1267 if (!curbuf
->b_p_eol
)
1279 * Read bytes from the file.
1281 size
= vim_read(fd
, ptr
, size
);
1286 if (size
< 0) /* read error */
1289 else if (conv_restlen
> 0)
1291 /* Reached end-of-file but some trailing bytes could
1292 * not be converted. Truncated file? */
1293 if (conv_error
== 0)
1294 conv_error
= linecnt
;
1295 if (bad_char_behavior
!= BAD_DROP
)
1297 fio_flags
= 0; /* don't convert this */
1299 if (iconv_fd
!= (iconv_t
)-1)
1301 iconv_close(iconv_fd
);
1302 iconv_fd
= (iconv_t
)-1;
1305 if (bad_char_behavior
== BAD_KEEP
)
1307 /* Keep the trailing bytes as-is. */
1308 size
= conv_restlen
;
1309 ptr
-= conv_restlen
;
1313 /* Replace the trailing bytes with the
1314 * replacement character. */
1316 *--ptr
= bad_char_behavior
;
1326 * At start of file: Check for magic number of encryption.
1329 cryptkey
= check_for_cryptkey(cryptkey
, ptr
, &size
,
1330 &filesize
, newfile
);
1332 * Decrypt the read bytes.
1334 if (cryptkey
!= NULL
&& size
> 0)
1335 for (p
= ptr
; p
< ptr
+ size
; ++p
)
1343 * At start of file (or after crypt magic number): Check for BOM.
1344 * Also check for a BOM for other Unicode encodings, but not after
1345 * converting with 'charconvert' or when a BOM has already been
1350 || (filesize
== CRYPT_MAGIC_LEN
&& cryptkey
!= NULL
)
1353 && (fio_flags
== FIO_UCSBOM
1354 || (!curbuf
->b_p_bomb
1356 && (*fenc
== 'u' || (*fenc
== NUL
&& enc_utf8
)))))
1361 /* no BOM detection in a short file or in binary mode */
1362 if (size
< 2 || curbuf
->b_p_bin
)
1365 ccname
= check_for_bom(ptr
, size
, &blen
,
1366 fio_flags
== FIO_UCSBOM
? FIO_ALL
: get_fio_flags(fenc
));
1369 /* Remove BOM from the text */
1372 mch_memmove(ptr
, ptr
+ blen
, (size_t)size
);
1375 curbuf
->b_p_bomb
= TRUE
;
1376 curbuf
->b_start_bomb
= TRUE
;
1380 if (fio_flags
== FIO_UCSBOM
)
1384 /* No BOM detected: retry with next encoding. */
1385 advance_fenc
= TRUE
;
1389 /* BOM detected: set "fenc" and jump back */
1393 fenc_alloced
= FALSE
;
1395 /* retry reading without getting new bytes or rewinding */
1402 * Break here for a read error or end-of-file.
1409 /* Include not converted bytes. */
1410 ptr
-= conv_restlen
;
1411 size
+= conv_restlen
;
1415 if (iconv_fd
!= (iconv_t
)-1)
1418 * Attempt conversion of the read bytes to 'encoding' using
1426 fromp
= (char *)ptr
;
1430 to_size
= real_size
- size
;
1433 * If there is conversion error or not enough room try using
1434 * another conversion. Except for when there is no
1435 * alternative (help files).
1437 while ((iconv(iconv_fd
, (void *)&fromp
, &from_size
,
1439 == (size_t)-1 && ICONV_ERRNO
!= ICONV_EINVAL
)
1440 || from_size
> CONV_RESTLEN
)
1444 if (conv_error
== 0)
1445 conv_error
= readfile_linenr(linecnt
,
1446 ptr
, (char_u
*)top
);
1448 /* Deal with a bad byte and continue with the next. */
1451 if (bad_char_behavior
== BAD_KEEP
)
1453 *top
++ = *(fromp
- 1);
1456 else if (bad_char_behavior
!= BAD_DROP
)
1458 *top
++ = bad_char_behavior
;
1465 /* Some remaining characters, keep them for the next
1467 mch_memmove(conv_rest
, (char_u
*)fromp
, from_size
);
1468 conv_restlen
= (int)from_size
;
1471 /* move the linerest to before the converted characters */
1472 line_start
= ptr
- linerest
;
1473 mch_memmove(line_start
, buffer
, (size_t)linerest
);
1474 size
= (long)((char_u
*)top
- ptr
);
1479 if (fio_flags
& FIO_CODEPAGE
)
1484 int codepage
= FIO_GET_CP(fio_flags
);
1490 * Conversion from an MS-Windows codepage or UTF-8 to UTF-8 or
1491 * a codepage, using standard MS-Windows functions. This
1492 * requires two steps:
1493 * 1. convert from 'fileencoding' to ucs-2
1494 * 2. convert from ucs-2 to 'encoding'
1496 * Because there may be illegal bytes AND an incomplete byte
1497 * sequence at the end, we may have to do the conversion one
1498 * character at a time to get it right.
1501 /* Replacement string for WideCharToMultiByte(). */
1502 if (bad_char_behavior
> 0)
1503 replstr
[0] = bad_char_behavior
;
1509 * Move the bytes to the end of the buffer, so that we have
1510 * room to put the result at the start.
1512 src
= ptr
+ real_size
- size
;
1513 mch_memmove(src
, ptr
, size
);
1516 * Do the conversion.
1524 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
1525 if (codepage
== CP_UTF8
)
1527 /* Handle CP_UTF8 input ourselves to be able to handle
1528 * trailing bytes properly.
1529 * Get one UTF-8 character from src. */
1530 bytelen
= (int)utf_ptr2len_len(src
, size
);
1533 /* Only got some bytes of a character. Normally
1534 * it's put in "conv_rest", but if it's too long
1535 * deal with it as if they were illegal bytes. */
1536 if (bytelen
<= CONV_RESTLEN
)
1539 /* weird overlong byte sequence */
1545 int u8c
= utf_ptr2char(src
);
1547 if (u8c
> 0xffff || (*src
>= 0x80 && bytelen
== 1))
1556 /* We don't know how long the byte sequence is, try
1557 * from one to three bytes. */
1558 for (bytelen
= 1; bytelen
<= size
&& bytelen
<= 3;
1561 ucs2len
= MultiByteToWideChar(codepage
,
1562 MB_ERR_INVALID_CHARS
,
1563 (LPCSTR
)src
, bytelen
,
1570 /* If we have only one byte then it's probably an
1571 * incomplete byte sequence. Otherwise discard
1572 * one byte as a bad character. */
1584 /* Convert "ucs2buf[ucs2len]" to 'enc' in "dst". */
1587 /* From UCS-2 to UTF-8. Cannot fail. */
1588 for (i
= 0; i
< ucs2len
; ++i
)
1589 dst
+= utf_char2bytes(ucs2buf
[i
], dst
);
1596 /* From UCS-2 to "enc_codepage". If the
1597 * conversion uses the default character "?",
1598 * the data doesn't fit in this encoding. */
1599 dstlen
= WideCharToMultiByte(enc_codepage
, 0,
1600 (LPCWSTR
)ucs2buf
, ucs2len
,
1601 (LPSTR
)dst
, (int)(src
- dst
),
1612 /* Deal with bytes we can't convert. */
1615 if (conv_error
== 0)
1616 conv_error
= readfile_linenr(linecnt
, ptr
, dst
);
1617 if (bad_char_behavior
!= BAD_DROP
)
1619 if (bad_char_behavior
== BAD_KEEP
)
1621 mch_memmove(dst
, src
, bytelen
);
1625 *dst
++ = bad_char_behavior
;
1635 /* An incomplete byte sequence remaining. */
1636 mch_memmove(conv_rest
, src
, size
);
1637 conv_restlen
= size
;
1640 /* The new size is equal to how much "dst" was advanced. */
1641 size
= (long)(dst
- ptr
);
1645 # ifdef MACOS_CONVERT
1646 if (fio_flags
& FIO_MACROMAN
)
1649 * Conversion from Apple MacRoman char encoding to UTF-8 or
1650 * latin1. This is in os_mac_conv.c.
1652 if (macroman2enc(ptr
, &size
, real_size
) == FAIL
)
1661 char_u
*tail
= NULL
;
1664 * "enc_utf8" set: Convert Unicode or Latin1 to UTF-8.
1665 * "enc_utf8" not set: Convert Unicode to Latin1.
1666 * Go from end to start through the buffer, because the number
1667 * of bytes may increase.
1668 * "dest" points to after where the UTF-8 bytes go, "p" points
1669 * to after the next character to convert.
1671 dest
= ptr
+ real_size
;
1672 if (fio_flags
== FIO_LATIN1
|| fio_flags
== FIO_UTF8
)
1675 if (fio_flags
== FIO_UTF8
)
1677 /* Check for a trailing incomplete UTF-8 sequence */
1678 tail
= ptr
+ size
- 1;
1679 while (tail
> ptr
&& (*tail
& 0xc0) == 0x80)
1681 if (tail
+ utf_byte2len(*tail
) <= ptr
+ size
)
1687 else if (fio_flags
& (FIO_UCS2
| FIO_UTF16
))
1689 /* Check for a trailing byte */
1690 p
= ptr
+ (size
& ~1);
1693 if ((fio_flags
& FIO_UTF16
) && p
> ptr
)
1695 /* Check for a trailing leading word */
1696 if (fio_flags
& FIO_ENDIAN_L
)
1706 if (u8c
>= 0xd800 && u8c
<= 0xdbff)
1714 /* Check for trailing 1, 2 or 3 bytes */
1715 p
= ptr
+ (size
& ~3);
1720 /* If there is a trailing incomplete sequence move it to
1724 conv_restlen
= (int)((ptr
+ size
) - tail
);
1725 mch_memmove(conv_rest
, (char_u
*)tail
, conv_restlen
);
1726 size
-= conv_restlen
;
1732 if (fio_flags
& FIO_LATIN1
)
1734 else if (fio_flags
& (FIO_UCS2
| FIO_UTF16
))
1736 if (fio_flags
& FIO_ENDIAN_L
)
1746 if ((fio_flags
& FIO_UTF16
)
1747 && u8c
>= 0xdc00 && u8c
<= 0xdfff)
1753 /* Missing leading word. */
1756 if (conv_error
== 0)
1757 conv_error
= readfile_linenr(linecnt
,
1759 if (bad_char_behavior
== BAD_DROP
)
1761 if (bad_char_behavior
!= BAD_KEEP
)
1762 u8c
= bad_char_behavior
;
1765 /* found second word of double-word, get the first
1766 * word and compute the resulting character */
1767 if (fio_flags
& FIO_ENDIAN_L
)
1775 u16c
+= (*--p
<< 8);
1777 u8c
= 0x10000 + ((u16c
& 0x3ff) << 10)
1780 /* Check if the word is indeed a leading word. */
1781 if (u16c
< 0xd800 || u16c
> 0xdbff)
1785 if (conv_error
== 0)
1786 conv_error
= readfile_linenr(linecnt
,
1788 if (bad_char_behavior
== BAD_DROP
)
1790 if (bad_char_behavior
!= BAD_KEEP
)
1791 u8c
= bad_char_behavior
;
1795 else if (fio_flags
& FIO_UCS4
)
1797 if (fio_flags
& FIO_ENDIAN_L
)
1800 u8c
+= (*--p
<< 16);
1804 else /* big endian */
1808 u8c
+= (*--p
<< 16);
1809 u8c
+= (*--p
<< 24);
1818 len
= utf_head_off(ptr
, p
);
1820 u8c
= utf_ptr2char(p
);
1823 /* Not a valid UTF-8 character, retry with
1824 * another fenc when possible, otherwise just
1825 * report the error. */
1828 if (conv_error
== 0)
1829 conv_error
= readfile_linenr(linecnt
,
1831 if (bad_char_behavior
== BAD_DROP
)
1833 if (bad_char_behavior
!= BAD_KEEP
)
1834 u8c
= bad_char_behavior
;
1838 if (enc_utf8
) /* produce UTF-8 */
1840 dest
-= utf_char2len(u8c
);
1841 (void)utf_char2bytes(u8c
, dest
);
1843 else /* produce Latin1 */
1848 /* character doesn't fit in latin1, retry with
1849 * another fenc when possible, otherwise just
1850 * report the error. */
1853 if (conv_error
== 0)
1854 conv_error
= readfile_linenr(linecnt
, ptr
, p
);
1855 if (bad_char_behavior
== BAD_DROP
)
1857 else if (bad_char_behavior
== BAD_KEEP
)
1859 else if (eap
!= NULL
&& eap
->bad_char
!= 0)
1860 *dest
= bad_char_behavior
;
1869 /* move the linerest to before the converted characters */
1870 line_start
= dest
- linerest
;
1871 mch_memmove(line_start
, buffer
, (size_t)linerest
);
1872 size
= (long)((ptr
+ real_size
) - dest
);
1875 else if (enc_utf8
&& conv_error
== 0 && !curbuf
->b_p_bin
)
1877 /* Reading UTF-8: Check if the bytes are valid UTF-8.
1878 * Need to start before "ptr" when part of the character was
1879 * read in the previous read() call. */
1880 for (p
= ptr
- utf_head_off(buffer
, ptr
); ; ++p
)
1882 int todo
= (int)((ptr
+ size
) - p
);
1889 /* A length of 1 means it's an illegal byte. Accept
1890 * an incomplete character at the end though, the next
1891 * read() will get the next bytes, we'll check it
1893 l
= utf_ptr2len_len(p
, todo
);
1896 /* Incomplete byte sequence, the next read()
1897 * should get them and check the bytes. */
1903 /* Illegal byte. If we can try another encoding
1908 /* Remember the first linenr with an illegal byte */
1909 if (illegal_byte
== 0)
1910 illegal_byte
= readfile_linenr(linecnt
, ptr
, p
);
1912 /* When we did a conversion report an error. */
1913 if (iconv_fd
!= (iconv_t
)-1 && conv_error
== 0)
1914 conv_error
= readfile_linenr(linecnt
, ptr
, p
);
1917 /* Drop, keep or replace the bad byte. */
1918 if (bad_char_behavior
== BAD_DROP
)
1920 mch_memmove(p
, p
+1, todo
- 1);
1924 else if (bad_char_behavior
!= BAD_KEEP
)
1925 *p
= bad_char_behavior
;
1932 /* Detected a UTF-8 error. */
1934 /* Retry reading with another conversion. */
1935 # if defined(FEAT_EVAL) && defined(USE_ICONV)
1936 if (*p_ccv
!= NUL
&& iconv_fd
!= (iconv_t
)-1)
1937 /* iconv() failed, try 'charconvert' */
1941 /* use next item from 'fileencodings' */
1942 advance_fenc
= TRUE
;
1949 /* count the number of characters (after conversion!) */
1953 * when reading the first part of a file: guess EOL type
1955 if (fileformat
== EOL_UNKNOWN
)
1957 /* First try finding a NL, for Dos and Unix */
1958 if (try_dos
|| try_unix
)
1960 for (p
= ptr
; p
< ptr
+ size
; ++p
)
1965 || (try_dos
&& p
> ptr
&& p
[-1] == CAR
))
1966 fileformat
= EOL_DOS
;
1968 fileformat
= EOL_UNIX
;
1973 /* Don't give in to EOL_UNIX if EOL_MAC is more likely */
1974 if (fileformat
== EOL_UNIX
&& try_mac
)
1976 /* Need to reset the counters when retrying fenc. */
1979 for (; p
>= ptr
&& *p
!= CAR
; p
--)
1983 for (p
= ptr
; p
< ptr
+ size
; ++p
)
1990 if (try_mac
> try_unix
)
1991 fileformat
= EOL_MAC
;
1996 /* No NL found: may use Mac format */
1997 if (fileformat
== EOL_UNKNOWN
&& try_mac
)
1998 fileformat
= EOL_MAC
;
2000 /* Still nothing found? Use first format in 'ffs' */
2001 if (fileformat
== EOL_UNKNOWN
)
2002 fileformat
= default_fileformat();
2004 /* if editing a new file: may set p_tx and p_ff */
2006 set_fileformat(fileformat
, OPT_LOCAL
);
2011 * This loop is executed once for every character read.
2014 if (fileformat
== EOL_MAC
)
2017 while (++ptr
, --size
>= 0)
2019 /* catch most common case first */
2020 if ((c
= *ptr
) != NUL
&& c
!= CAR
&& c
!= NL
)
2023 *ptr
= NL
; /* NULs are replaced by newlines! */
2025 *ptr
= CAR
; /* NLs are replaced by CRs! */
2028 if (skip_count
== 0)
2030 *ptr
= NUL
; /* end of line */
2031 len
= (colnr_T
) (ptr
- line_start
+ 1);
2032 if (ml_append(lnum
, line_start
, len
, newfile
) == FAIL
)
2038 if (--read_count
== 0)
2040 error
= TRUE
; /* break loop */
2041 line_start
= ptr
; /* nothing left to write */
2047 line_start
= ptr
+ 1;
2054 while (++ptr
, --size
>= 0)
2056 if ((c
= *ptr
) != NUL
&& c
!= NL
) /* catch most common case */
2059 *ptr
= NL
; /* NULs are replaced by newlines! */
2062 if (skip_count
== 0)
2064 *ptr
= NUL
; /* end of line */
2065 len
= (colnr_T
)(ptr
- line_start
+ 1);
2066 if (fileformat
== EOL_DOS
)
2068 if (ptr
[-1] == CAR
) /* remove CR */
2074 * Reading in Dos format, but no CR-LF found!
2075 * When 'fileformats' includes "unix", delete all
2076 * the lines read so far and start all over again.
2077 * Otherwise give an error message later.
2079 else if (ff_error
!= EOL_DOS
)
2084 || lseek(fd
, (off_t
)0L, SEEK_SET
) == 0))
2086 fileformat
= EOL_UNIX
;
2088 set_fileformat(EOL_UNIX
, OPT_LOCAL
);
2090 keep_fileformat
= TRUE
;
2096 if (ml_append(lnum
, line_start
, len
, newfile
) == FAIL
)
2102 if (--read_count
== 0)
2104 error
= TRUE
; /* break loop */
2105 line_start
= ptr
; /* nothing left to write */
2111 line_start
= ptr
+ 1;
2115 linerest
= (long)(ptr
- line_start
);
2120 /* not an error, max. number of lines reached */
2121 if (error
&& read_count
== 0)
2125 * If we get EOF in the middle of a line, note the fact and
2126 * complete the line ourselves.
2127 * In Dos format ignore a trailing CTRL-Z, unless 'binary' set.
2132 && !(!curbuf
->b_p_bin
2133 && fileformat
== EOL_DOS
2134 && *line_start
== Ctrl_Z
2135 && ptr
== line_start
+ 1))
2137 /* remember for when writing */
2139 curbuf
->b_p_eol
= FALSE
;
2141 if (ml_append(lnum
, line_start
,
2142 (colnr_T
)(ptr
- line_start
+ 1), newfile
) == FAIL
)
2145 read_no_eol_lnum
= ++lnum
;
2149 save_file_ff(curbuf
); /* remember the current file format */
2152 if (cryptkey
!= curbuf
->b_p_key
)
2157 /* If editing a new file: set 'fenc' for the current buffer.
2158 * Also for ":read ++edit file". */
2160 set_string_option_direct((char_u
*)"fenc", -1, fenc
,
2161 OPT_FREE
|OPT_LOCAL
, 0);
2165 if (iconv_fd
!= (iconv_t
)-1)
2167 iconv_close(iconv_fd
);
2168 iconv_fd
= (iconv_t
)-1;
2173 if (!read_buffer
&& !read_stdin
)
2174 close(fd
); /* errors are ignored */
2180 /* Use stderr for stdin, makes shell commands work. */
2187 if (tmpname
!= NULL
)
2189 mch_remove(tmpname
); /* delete converted file */
2193 --no_wait_return
; /* may wait for return now */
2196 * In recovery mode everything but autocommands is skipped.
2200 /* need to delete the last line, which comes from the empty buffer */
2201 if (newfile
&& wasempty
&& !(curbuf
->b_ml
.ml_flags
& ML_EMPTY
))
2203 #ifdef FEAT_NETBEANS_INTG
2204 netbeansFireChanges
= 0;
2206 ml_delete(curbuf
->b_ml
.ml_line_count
, FALSE
);
2207 #ifdef FEAT_NETBEANS_INTG
2208 netbeansFireChanges
= 1;
2212 linecnt
= curbuf
->b_ml
.ml_line_count
- linecnt
;
2215 if (newfile
|| read_buffer
)
2217 redraw_curbuf_later(NOT_VALID
);
2219 /* After reading the text into the buffer the diff info needs to
2221 diff_invalidate(curbuf
);
2224 /* All folds in the window are invalid now. Mark them for update
2225 * before triggering autocommands. */
2226 foldUpdateAll(curwin
);
2229 else if (linecnt
) /* appended at least one line */
2230 appended_lines_mark(from
, linecnt
);
2232 #ifndef ALWAYS_USE_GUI
2234 * If we were reading from the same terminal as where messages go,
2235 * the screen will have been messed up.
2236 * Switch on raw mode now and clear the screen.
2240 settmode(TMODE_RAW
); /* set to raw mode */
2248 if (!(flags
& READ_DUMMY
))
2250 filemess(curbuf
, sfname
, (char_u
*)_(e_interr
), 0);
2252 curbuf
->b_p_ro
= TRUE
; /* must use "w!" now */
2254 msg_scroll
= msg_save
;
2258 return OK
; /* an interrupt isn't really an error */
2261 if (!filtering
&& !(flags
& READ_DUMMY
))
2263 msg_add_fname(curbuf
, sfname
); /* fname in IObuff with quotes */
2268 if (S_ISFIFO(perm
)) /* fifo or socket */
2270 STRCAT(IObuff
, _("[fifo/socket]"));
2275 if ((perm
& S_IFMT
) == S_IFIFO
) /* fifo */
2277 STRCAT(IObuff
, _("[fifo]"));
2282 if ((perm
& S_IFMT
) == S_IFSOCK
) /* or socket */
2284 STRCAT(IObuff
, _("[socket]"));
2289 # ifdef OPEN_CHR_FILES
2290 if (S_ISCHR(perm
)) /* or character special */
2292 STRCAT(IObuff
, _("[character special]"));
2299 STRCAT(IObuff
, shortmess(SHM_RO
) ? _("[RO]") : _("[readonly]"));
2302 if (read_no_eol_lnum
)
2307 if (ff_error
== EOL_DOS
)
2309 STRCAT(IObuff
, _("[CR missing]"));
2312 if (ff_error
== EOL_MAC
)
2314 STRCAT(IObuff
, _("[NL found]"));
2319 STRCAT(IObuff
, _("[long lines split]"));
2325 STRCAT(IObuff
, _("[NOT converted]"));
2330 STRCAT(IObuff
, _("[converted]"));
2335 if (cryptkey
!= NULL
)
2337 STRCAT(IObuff
, _("[crypted]"));
2342 if (conv_error
!= 0)
2344 sprintf((char *)IObuff
+ STRLEN(IObuff
),
2345 _("[CONVERSION ERROR in line %ld]"), (long)conv_error
);
2348 else if (illegal_byte
> 0)
2350 sprintf((char *)IObuff
+ STRLEN(IObuff
),
2351 _("[ILLEGAL BYTE in line %ld]"), (long)illegal_byte
);
2358 STRCAT(IObuff
, _("[READ ERRORS]"));
2361 if (msg_add_fileformat(fileformat
))
2364 if (cryptkey
!= NULL
)
2365 msg_add_lines(c
, (long)linecnt
, filesize
- CRYPT_MAGIC_LEN
);
2368 msg_add_lines(c
, (long)linecnt
, filesize
);
2372 msg_scrolled_ign
= TRUE
;
2373 #ifdef ALWAYS_USE_GUI
2374 /* Don't show the message when reading stdin, it would end up in a
2375 * message box (which might be shown when exiting!) */
2376 if (read_stdin
|| read_buffer
)
2377 p
= msg_may_trunc(FALSE
, IObuff
);
2380 p
= msg_trunc_attr(IObuff
, FALSE
, 0);
2381 if (read_stdin
|| read_buffer
|| restart_edit
!= 0
2382 || (msg_scrolled
!= 0 && !need_wait_return
))
2383 /* Need to repeat the message after redrawing when:
2384 * - When reading from stdin (the screen will be cleared next).
2385 * - When restart_edit is set (otherwise there will be a delay
2386 * before redrawing).
2387 * - When the screen was scrolled but there is no wait-return
2390 msg_scrolled_ign
= FALSE
;
2393 /* with errors writing the file requires ":w!" */
2394 if (newfile
&& (error
2397 || (illegal_byte
> 0 && bad_char_behavior
!= BAD_KEEP
)
2400 curbuf
->b_p_ro
= TRUE
;
2402 u_clearline(); /* cannot use "U" command after adding lines */
2405 * In Ex mode: cursor at last new line.
2406 * Otherwise: cursor at first new line.
2409 curwin
->w_cursor
.lnum
= from
+ linecnt
;
2411 curwin
->w_cursor
.lnum
= from
+ 1;
2412 check_cursor_lnum();
2413 beginline(BL_WHITE
| BL_FIX
); /* on first non-blank */
2416 * Set '[ and '] marks to the newly read lines.
2418 curbuf
->b_op_start
.lnum
= from
+ 1;
2419 curbuf
->b_op_start
.col
= 0;
2420 curbuf
->b_op_end
.lnum
= from
+ linecnt
;
2421 curbuf
->b_op_end
.col
= 0;
2425 * Work around a weird problem: When a file has two links (only
2426 * possible on NTFS) and we write through one link, then stat() it
2427 * throught the other link, the timestamp information may be wrong.
2428 * It's correct again after reading the file, thus reset the timestamp
2431 if (newfile
&& !read_stdin
&& !read_buffer
2432 && mch_stat((char *)fname
, &st
) >= 0)
2434 buf_store_time(curbuf
, &st
, fname
);
2435 curbuf
->b_mtime_read
= curbuf
->b_mtime
;
2439 msg_scroll
= msg_save
;
2443 * Get the marks before executing autocommands, so they can be used there.
2449 * Trick: We remember if the last line of the read didn't have
2450 * an eol for when writing it again. This is required for
2451 * ":autocmd FileReadPost *.gz set bin|'[,']!gunzip" to work.
2453 write_no_eol_lnum
= read_no_eol_lnum
;
2456 if (!read_stdin
&& !read_buffer
)
2459 int n
= msg_scrolled
;
2461 /* Save the fileformat now, otherwise the buffer will be considered
2462 * modified if the format/encoding was automatically detected. */
2464 save_file_ff(curbuf
);
2467 * The output from the autocommands should not overwrite anything and
2468 * should not be overwritten: Set msg_scroll, restore its value if no
2473 apply_autocmds_exarg(EVENT_FILTERREADPOST
, NULL
, sfname
,
2474 FALSE
, curbuf
, eap
);
2476 apply_autocmds_exarg(EVENT_BUFREADPOST
, NULL
, sfname
,
2477 FALSE
, curbuf
, eap
);
2479 apply_autocmds_exarg(EVENT_FILEREADPOST
, sfname
, sfname
,
2481 if (msg_scrolled
== n
)
2484 if (aborting()) /* autocmds may abort script processing */
2490 if (recoverymode
&& error
)
2495 #ifdef OPEN_CHR_FILES
2497 * Returns TRUE if the file name argument is of the form "/dev/fd/\d\+",
2498 * which is the name of files used for process substitution output by
2499 * some shells on some operating systems, e.g., bash on SunOS.
2500 * Do not accept "/dev/fd/[012]", opening these may hang Vim.
2503 is_dev_fd_file(fname
)
2506 return (STRNCMP(fname
, "/dev/fd/", 8) == 0
2507 && VIM_ISDIGIT(fname
[8])
2508 && *skipdigits(fname
+ 9) == NUL
2510 || (fname
[8] != '0' && fname
[8] != '1' && fname
[8] != '2')));
2517 * From the current line count and characters read after that, estimate the
2518 * line number where we are now.
2519 * Used for error messages that include a line number.
2522 readfile_linenr(linecnt
, p
, endp
)
2523 linenr_T linecnt
; /* line count before reading more bytes */
2524 char_u
*p
; /* start of more bytes read */
2525 char_u
*endp
; /* end of more bytes read */
2530 lnum
= curbuf
->b_ml
.ml_line_count
- linecnt
+ 1;
2531 for (s
= p
; s
< endp
; ++s
)
2539 * Fill "*eap" to force the 'fileencoding', 'fileformat' and 'binary to be
2540 * equal to the buffer "buf". Used for calling readfile().
2541 * Returns OK or FAIL.
2544 prep_exarg(eap
, buf
)
2548 eap
->cmd
= alloc((unsigned)(STRLEN(buf
->b_p_ff
)
2550 + STRLEN(buf
->b_p_fenc
)
2553 if (eap
->cmd
== NULL
)
2557 sprintf((char *)eap
->cmd
, "e ++ff=%s ++enc=%s", buf
->b_p_ff
, buf
->b_p_fenc
);
2558 eap
->force_enc
= 14 + (int)STRLEN(buf
->b_p_ff
);
2559 eap
->bad_char
= buf
->b_bad_char
;
2561 sprintf((char *)eap
->cmd
, "e ++ff=%s", buf
->b_p_ff
);
2565 eap
->force_bin
= buf
->b_p_bin
? FORCE_BIN
: FORCE_NOBIN
;
2566 eap
->read_edit
= FALSE
;
2567 eap
->forceit
= FALSE
;
2573 * Find next fileencoding to use from 'fileencodings'.
2574 * "pp" points to fenc_next. It's advanced to the next item.
2575 * When there are no more items, an empty string is returned and *pp is set to
2577 * When *pp is not set to NULL, the result is in allocated memory.
2589 return (char_u
*)"";
2591 p
= vim_strchr(*pp
, ',');
2594 r
= enc_canonize(*pp
);
2599 r
= vim_strnsave(*pp
, (int)(p
- *pp
));
2603 p
= enc_canonize(r
);
2608 if (r
== NULL
) /* out of memory */
2618 * Convert a file with the 'charconvert' expression.
2619 * This closes the file which is to be read, converts it and opens the
2620 * resulting file for reading.
2621 * Returns name of the resulting converted file (the caller should delete it
2622 * after reading it).
2623 * Returns NULL if the conversion failed ("*fdp" is not set) .
2626 readfile_charconvert(fname
, fenc
, fdp
)
2627 char_u
*fname
; /* name of input file */
2628 char_u
*fenc
; /* converted from */
2629 int *fdp
; /* in/out: file descriptor of file */
2632 char_u
*errmsg
= NULL
;
2634 tmpname
= vim_tempname('r');
2635 if (tmpname
== NULL
)
2636 errmsg
= (char_u
*)_("Can't find temp file for conversion");
2639 close(*fdp
); /* close the input file, ignore errors */
2641 if (eval_charconvert(fenc
, enc_utf8
? (char_u
*)"utf-8" : p_enc
,
2642 fname
, tmpname
) == FAIL
)
2643 errmsg
= (char_u
*)_("Conversion with 'charconvert' failed");
2644 if (errmsg
== NULL
&& (*fdp
= mch_open((char *)tmpname
,
2645 O_RDONLY
| O_EXTRA
, 0)) < 0)
2646 errmsg
= (char_u
*)_("can't read output of 'charconvert'");
2651 /* Don't use emsg(), it breaks mappings, the retry with
2652 * another type of conversion might still work. */
2654 if (tmpname
!= NULL
)
2656 mch_remove(tmpname
); /* delete converted file */
2662 /* If the input file is closed, open it (caller should check for error). */
2664 *fdp
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0);
2674 * Read marks for the current buffer from the viminfo file, when we support
2675 * buffer marks and the buffer has a name.
2680 if (!curbuf
->b_marks_read
&& get_viminfo_parameter('\'') > 0
2681 && curbuf
->b_ffname
!= NULL
)
2682 read_viminfo(NULL
, FALSE
, TRUE
, FALSE
);
2684 /* Always set b_marks_read; needed when 'viminfo' is changed to include
2685 * the ' parameter after opening a buffer. */
2686 curbuf
->b_marks_read
= TRUE
;
2692 * Check for magic number used for encryption.
2693 * If found, the magic number is removed from ptr[*sizep] and *sizep and
2694 * *filesizep are updated.
2695 * Return the (new) encryption key, NULL for no encryption.
2698 check_for_cryptkey(cryptkey
, ptr
, sizep
, filesizep
, newfile
)
2699 char_u
*cryptkey
; /* previous encryption key or NULL */
2700 char_u
*ptr
; /* pointer to read bytes */
2701 long *sizep
; /* length of read bytes */
2702 long *filesizep
; /* nr of bytes used from file */
2703 int newfile
; /* editing a new buffer */
2705 if (*sizep
>= CRYPT_MAGIC_LEN
2706 && STRNCMP(ptr
, CRYPT_MAGIC
, CRYPT_MAGIC_LEN
) == 0)
2708 if (cryptkey
== NULL
)
2710 if (*curbuf
->b_p_key
)
2711 cryptkey
= curbuf
->b_p_key
;
2714 /* When newfile is TRUE, store the typed key
2715 * in the 'key' option and don't free it. */
2716 cryptkey
= get_crypt_key(newfile
, FALSE
);
2717 /* check if empty key entered */
2718 if (cryptkey
!= NULL
&& *cryptkey
== NUL
)
2720 if (cryptkey
!= curbuf
->b_p_key
)
2727 if (cryptkey
!= NULL
)
2729 crypt_init_keys(cryptkey
);
2731 /* Remove magic number from the text */
2732 *filesizep
+= CRYPT_MAGIC_LEN
;
2733 *sizep
-= CRYPT_MAGIC_LEN
;
2734 mch_memmove(ptr
, ptr
+ CRYPT_MAGIC_LEN
, (size_t)*sizep
);
2737 /* When starting to edit a new file which does not have
2738 * encryption, clear the 'key' option, except when
2739 * starting up (called with -x argument) */
2740 else if (newfile
&& *curbuf
->b_p_key
&& !starting
)
2741 set_option_value((char_u
*)"key", 0L, (char_u
*)"", OPT_LOCAL
);
2749 set_file_time(fname
, atime
, mtime
)
2751 time_t atime
; /* access time */
2752 time_t mtime
; /* modification time */
2754 # if defined(HAVE_UTIME) && defined(HAVE_UTIME_H)
2758 buf
.modtime
= mtime
;
2759 (void)utime((char *)fname
, &buf
);
2761 # if defined(HAVE_UTIMES)
2762 struct timeval tvp
[2];
2764 tvp
[0].tv_sec
= atime
;
2766 tvp
[1].tv_sec
= mtime
;
2769 (void)utimes((char *)fname
, tvp
);
2771 (void)utimes((char *)fname
, (const struct timeval
*)&tvp
);
2778 #if defined(VMS) && !defined(MIN)
2779 /* Older DECC compiler for VAX doesn't define MIN() */
2780 # define MIN(a, b) ((a) < (b) ? (a) : (b))
2784 * Return TRUE if a file appears to be read-only from the file permissions.
2787 check_file_readonly(fname
, perm
)
2788 char_u
*fname
; /* full path to file */
2789 int perm
; /* known permissions on file */
2791 #ifndef USE_MCH_ACCESS
2796 #ifdef USE_MCH_ACCESS
2798 (perm
& 0222) == 0 ||
2800 mch_access((char *)fname
, W_OK
)
2802 (fd
= mch_open((char *)fname
, O_RDWR
| O_EXTRA
, 0)) < 0
2803 ? TRUE
: (close(fd
), FALSE
)
2810 * buf_write() - write to file "fname" lines "start" through "end"
2812 * We do our own buffering here because fwrite() is so slow.
2814 * If "forceit" is true, we don't care for errors when attempting backups.
2815 * In case of an error everything possible is done to restore the original
2816 * file. But when "forceit" is TRUE, we risk loosing it.
2818 * When "reset_changed" is TRUE and "append" == FALSE and "start" == 1 and
2819 * "end" == curbuf->b_ml.ml_line_count, reset curbuf->b_changed.
2821 * This function must NOT use NameBuff (because it's called by autowrite()).
2823 * return FAIL for failure, OK otherwise
2826 buf_write(buf
, fname
, sfname
, start
, end
, eap
, append
, forceit
,
2827 reset_changed
, filtering
)
2831 linenr_T start
, end
;
2832 exarg_T
*eap
; /* for forced 'ff' and 'fenc', can be
2834 int append
; /* append to the file */
2840 char_u
*backup
= NULL
;
2841 int backup_copy
= FALSE
; /* copy the original file? */
2844 char_u
*wfname
= NULL
; /* name of file to write to */
2851 char_u
*errmsg
= NULL
;
2852 char_u
*errnum
= NULL
;
2854 char_u smallbuf
[SMBUFSIZE
];
2857 long perm
; /* file permissions */
2859 int newfile
= FALSE
; /* TRUE if file doesn't exist yet */
2860 int msg_save
= msg_scroll
;
2861 int overwriting
; /* TRUE if writing over original */
2862 int no_eol
= FALSE
; /* no end-of-line written */
2863 int device
= FALSE
; /* writing to a device */
2865 int prev_got_int
= got_int
;
2866 int file_readonly
= FALSE
; /* overwritten file is read-only */
2867 static char *err_readonly
= "is read-only (cannot override: \"W\" in 'cpoptions')";
2868 #if defined(UNIX) || defined(__EMX__XX) /*XXX fix me sometime? */
2869 int made_writable
= FALSE
; /* 'w' bit has been set */
2871 /* writing everything */
2872 int whole
= (start
== 1 && end
== buf
->b_ml
.ml_line_count
);
2874 linenr_T old_line_count
= buf
->b_ml
.ml_line_count
;
2879 struct bw_info write_info
; /* info for buf_write_bytes() */
2881 int converted
= FALSE
;
2882 int notconverted
= FALSE
;
2883 char_u
*fenc
; /* effective 'fileencoding' */
2884 char_u
*fenc_tofree
= NULL
; /* allocated "fenc" */
2890 vim_acl_T acl
= NULL
; /* ACL copied from original file to
2891 backup or new file */
2894 if (fname
== NULL
|| *fname
== NUL
) /* safety check */
2898 * Disallow writing from .exrc and .vimrc in current directory for
2904 /* Avoid a crash for a long name. */
2905 if (STRLEN(fname
) >= MAXPATHL
)
2907 EMSG(_(e_longname
));
2912 /* must init bw_conv_buf and bw_iconv_fd before jumping to "fail" */
2913 write_info
.bw_conv_buf
= NULL
;
2914 write_info
.bw_conv_error
= FALSE
;
2915 write_info
.bw_restlen
= 0;
2917 write_info
.bw_iconv_fd
= (iconv_t
)-1;
2921 /* After writing a file changedtick changes but we don't want to display
2923 ex_no_reprint
= TRUE
;
2926 * If there is no file name yet, use the one for the written file.
2927 * BF_NOTEDITED is set to reflect this (in case the write fails).
2928 * Don't do this when the write is for a filter command.
2929 * Don't do this when appending.
2930 * Only do this when 'cpoptions' contains the 'F' flag.
2932 if (buf
->b_ffname
== NULL
2936 #ifdef FEAT_QUICKFIX
2940 && (!append
|| vim_strchr(p_cpo
, CPO_FNAMEAPP
) != NULL
)
2941 && vim_strchr(p_cpo
, CPO_FNAMEW
) != NULL
)
2943 if (set_rw_fname(fname
, sfname
) == FAIL
)
2945 buf
= curbuf
; /* just in case autocmds made "buf" invalid */
2951 * For Unix: Use the short file name whenever possible.
2952 * Avoids problems with networks and when directory names are changed.
2953 * Don't do this for MS-DOS, a "cd" in a sub-shell may have moved us to
2954 * another directory, which we don't detect
2956 ffname
= fname
; /* remember full fname */
2961 if (buf
->b_ffname
!= NULL
&& fnamecmp(ffname
, buf
->b_ffname
) == 0)
2964 overwriting
= FALSE
;
2967 settmode(TMODE_COOK
); /* when exiting allow typahead now */
2969 ++no_wait_return
; /* don't wait for return yet */
2972 * Set '[ and '] marks to the lines to be written.
2974 buf
->b_op_start
.lnum
= start
;
2975 buf
->b_op_start
.col
= 0;
2976 buf
->b_op_end
.lnum
= end
;
2977 buf
->b_op_end
.col
= 0;
2982 int buf_ffname
= FALSE
;
2983 int buf_sfname
= FALSE
;
2984 int buf_fname_f
= FALSE
;
2985 int buf_fname_s
= FALSE
;
2986 int did_cmd
= FALSE
;
2987 int nofile_err
= FALSE
;
2988 int empty_memline
= (buf
->b_ml
.ml_mfp
== NULL
);
2991 * Apply PRE aucocommands.
2992 * Set curbuf to the buffer to be written.
2993 * Careful: The autocommands may call buf_write() recursively!
2995 if (ffname
== buf
->b_ffname
)
2997 if (sfname
== buf
->b_sfname
)
2999 if (fname
== buf
->b_ffname
)
3001 if (fname
== buf
->b_sfname
)
3004 /* set curwin/curbuf to buf and save a few things */
3005 aucmd_prepbuf(&aco
, buf
);
3009 if (!(did_cmd
= apply_autocmds_exarg(EVENT_FILEAPPENDCMD
,
3010 sfname
, sfname
, FALSE
, curbuf
, eap
)))
3012 #ifdef FEAT_QUICKFIX
3013 if (overwriting
&& bt_nofile(curbuf
))
3017 apply_autocmds_exarg(EVENT_FILEAPPENDPRE
,
3018 sfname
, sfname
, FALSE
, curbuf
, eap
);
3023 apply_autocmds_exarg(EVENT_FILTERWRITEPRE
,
3024 NULL
, sfname
, FALSE
, curbuf
, eap
);
3026 else if (reset_changed
&& whole
)
3028 if (!(did_cmd
= apply_autocmds_exarg(EVENT_BUFWRITECMD
,
3029 sfname
, sfname
, FALSE
, curbuf
, eap
)))
3031 #ifdef FEAT_QUICKFIX
3032 if (overwriting
&& bt_nofile(curbuf
))
3036 apply_autocmds_exarg(EVENT_BUFWRITEPRE
,
3037 sfname
, sfname
, FALSE
, curbuf
, eap
);
3042 if (!(did_cmd
= apply_autocmds_exarg(EVENT_FILEWRITECMD
,
3043 sfname
, sfname
, FALSE
, curbuf
, eap
)))
3045 #ifdef FEAT_QUICKFIX
3046 if (overwriting
&& bt_nofile(curbuf
))
3050 apply_autocmds_exarg(EVENT_FILEWRITEPRE
,
3051 sfname
, sfname
, FALSE
, curbuf
, eap
);
3055 /* restore curwin/curbuf and a few other things */
3056 aucmd_restbuf(&aco
);
3059 * In three situations we return here and don't write the file:
3060 * 1. the autocommands deleted or unloaded the buffer.
3061 * 2. The autocommands abort script processing.
3062 * 3. If one of the "Cmd" autocommands was executed.
3064 if (!buf_valid(buf
))
3066 if (buf
== NULL
|| (buf
->b_ml
.ml_mfp
== NULL
&& !empty_memline
)
3067 || did_cmd
|| nofile_err
3074 msg_scroll
= msg_save
;
3076 EMSG(_("E676: No matching autocommands for acwrite buffer"));
3083 /* An aborting error, interrupt or exception in the
3089 /* The buffer was deleted. We assume it was written
3090 * (can't retry anyway). */
3094 /* Assume the buffer was written, update the timestamp. */
3097 buf
->b_flags
&= ~BF_NEW
;
3099 buf
->b_flags
&= ~BF_WRITE_MASK
;
3101 if (reset_changed
&& buf
->b_changed
&& !append
3102 && (overwriting
|| vim_strchr(p_cpo
, CPO_PLUS
) != NULL
))
3103 /* Buffer still changed, the autocommands didn't work
3111 EMSG(_("E203: Autocommands deleted or unloaded buffer to be written"));
3116 * The autocommands may have changed the number of lines in the file.
3117 * When writing the whole file, adjust the end.
3118 * When writing part of the file, assume that the autocommands only
3119 * changed the number of lines that are to be written (tricky!).
3121 if (buf
->b_ml
.ml_line_count
!= old_line_count
)
3123 if (whole
) /* write all */
3124 end
= buf
->b_ml
.ml_line_count
;
3125 else if (buf
->b_ml
.ml_line_count
> old_line_count
) /* more lines */
3126 end
+= buf
->b_ml
.ml_line_count
- old_line_count
;
3127 else /* less lines */
3129 end
-= old_line_count
- buf
->b_ml
.ml_line_count
;
3133 msg_scroll
= msg_save
;
3134 EMSG(_("E204: Autocommand changed number of lines in unexpected way"));
3141 * The autocommands may have changed the name of the buffer, which may
3142 * be kept in fname, ffname and sfname.
3145 ffname
= buf
->b_ffname
;
3147 sfname
= buf
->b_sfname
;
3149 fname
= buf
->b_ffname
;
3151 fname
= buf
->b_sfname
;
3155 #ifdef FEAT_NETBEANS_INTG
3156 if (usingNetbeans
&& isNetbeansBuffer(buf
))
3161 * b_changed can be 0 after an undo, but we still need to write
3162 * the buffer to NetBeans.
3164 if (buf
->b_changed
|| isNetbeansModified(buf
))
3166 --no_wait_return
; /* may wait for return now */
3167 msg_scroll
= msg_save
;
3168 netbeans_save_buffer(buf
); /* no error checking... */
3173 errnum
= (char_u
*)"E656: ";
3174 errmsg
= (char_u
*)_("NetBeans dissallows writes of unmodified buffers");
3181 errnum
= (char_u
*)"E657: ";
3182 errmsg
= (char_u
*)_("Partial writes disallowed for NetBeans buffers");
3189 if (shortmess(SHM_OVER
) && !exiting
)
3190 msg_scroll
= FALSE
; /* overwrite previous file message */
3192 msg_scroll
= TRUE
; /* don't overwrite previous file message */
3200 (char_u
*)"", 0); /* show that we are busy */
3201 msg_scroll
= FALSE
; /* always overwrite the file message now */
3203 buffer
= alloc(BUFSIZE
);
3204 if (buffer
== NULL
) /* can't allocate big buffer, use small
3205 * one (to be able to write when out of
3209 bufsize
= SMBUFSIZE
;
3215 * Get information about original file (if there is one).
3217 #if defined(UNIX) && !defined(ARCHIE)
3221 if (mch_stat((char *)fname
, &st_old
) < 0)
3225 perm
= st_old
.st_mode
;
3226 if (!S_ISREG(st_old
.st_mode
)) /* not a file */
3228 if (S_ISDIR(st_old
.st_mode
))
3230 errnum
= (char_u
*)"E502: ";
3231 errmsg
= (char_u
*)_("is a directory");
3234 if (mch_nodetype(fname
) != NODE_WRITABLE
)
3236 errnum
= (char_u
*)"E503: ";
3237 errmsg
= (char_u
*)_("is not a file or writable device");
3240 /* It's a device of some kind (or a fifo) which we can write to
3241 * but for which we can't make a backup. */
3249 * Check for a writable device name.
3251 c
= mch_nodetype(fname
);
3252 if (c
== NODE_OTHER
)
3254 errnum
= (char_u
*)"E503: ";
3255 errmsg
= (char_u
*)_("is not a file or writable device");
3258 if (c
== NODE_WRITABLE
)
3260 # if defined(MSDOS) || defined(MSWIN) || defined(OS2)
3261 /* MS-Windows allows opening a device, but we will probably get stuck
3262 * trying to write to it. */
3265 errnum
= (char_u
*)"E796: ";
3266 errmsg
= (char_u
*)_("writing to device disabled with 'opendevice' option");
3276 perm
= mch_getperm(fname
);
3279 else if (mch_isdir(fname
))
3281 errnum
= (char_u
*)"E502: ";
3282 errmsg
= (char_u
*)_("is a directory");
3286 (void)mch_stat((char *)fname
, &st_old
);
3290 if (!device
&& !newfile
)
3293 * Check if the file is really writable (when renaming the file to
3294 * make a backup we won't discover it later).
3296 file_readonly
= check_file_readonly(fname
, (int)perm
);
3298 if (!forceit
&& file_readonly
)
3300 if (vim_strchr(p_cpo
, CPO_FWRITE
) != NULL
)
3302 errnum
= (char_u
*)"E504: ";
3303 errmsg
= (char_u
*)_(err_readonly
);
3307 errnum
= (char_u
*)"E505: ";
3308 errmsg
= (char_u
*)_("is read-only (add ! to override)");
3314 * Check if the timestamp hasn't changed since reading the file.
3318 retval
= check_mtime(buf
, &st_old
);
3326 * For systems that support ACL: get the ACL from the original file.
3329 acl
= mch_get_acl(fname
);
3333 * If 'backupskip' is not empty, don't make a backup for some files.
3335 dobackup
= (p_wb
|| p_bk
|| *p_pm
!= NUL
);
3337 if (dobackup
&& *p_bsk
!= NUL
&& match_file_list(p_bsk
, sfname
, ffname
))
3342 * Save the value of got_int and reset it. We don't want a previous
3343 * interruption cancel writing, only hitting CTRL-C while writing should
3346 prev_got_int
= got_int
;
3349 /* Mark the buffer as 'being saved' to prevent changed buffer warnings */
3350 buf
->b_saving
= TRUE
;
3353 * If we are not appending or filtering, the file exists, and the
3354 * 'writebackup', 'backup' or 'patchmode' option is set, need a backup.
3355 * When 'patchmode' is set also make a backup when appending.
3357 * Do not make any backup, if 'writebackup' and 'backup' are both switched
3358 * off. This helps when editing large files on almost-full disks.
3360 if (!(append
&& *p_pm
== NUL
) && !filtering
&& perm
>= 0 && dobackup
)
3362 #if defined(UNIX) || defined(WIN32)
3366 if ((bkc_flags
& BKC_YES
) || append
) /* "yes" */
3368 #if defined(UNIX) || defined(WIN32)
3369 else if ((bkc_flags
& BKC_AUTO
)) /* "auto" */
3375 * Don't rename the file when:
3376 * - it's a hard link
3377 * - it's a symbolic link
3378 * - we don't have write permission in the directory
3379 * - we can't set the owner/group of the new file
3381 if (st_old
.st_nlink
> 1
3382 || mch_lstat((char *)fname
, &st
) < 0
3383 || st
.st_dev
!= st_old
.st_dev
3384 || st
.st_ino
!= st_old
.st_ino
3385 # ifndef HAVE_FCHOWN
3386 || st
.st_uid
!= st_old
.st_uid
3387 || st
.st_gid
!= st_old
.st_gid
3394 /* On NTFS file systems hard links are possible. */
3395 if (mch_is_linked(fname
))
3402 * Check if we can create a file and set the owner/group to
3403 * the ones from the original file.
3404 * First find a file name that doesn't exist yet (use some
3405 * arbitrary numbers).
3407 STRCPY(IObuff
, fname
);
3408 for (i
= 4913; ; i
+= 123)
3410 sprintf((char *)gettail(IObuff
), "%d", i
);
3411 if (mch_lstat((char *)IObuff
, &st
) < 0)
3414 fd
= mch_open((char *)IObuff
,
3415 O_CREAT
|O_WRONLY
|O_EXCL
|O_NOFOLLOW
, perm
);
3416 if (fd
< 0) /* can't write in directory */
3422 fchown(fd
, st_old
.st_uid
, st_old
.st_gid
);
3424 if (mch_stat((char *)IObuff
, &st
) < 0
3425 || st
.st_uid
!= st_old
.st_uid
3426 || st
.st_gid
!= st_old
.st_gid
3427 || st
.st_mode
!= perm
)
3430 /* Close the file before removing it, on MS-Windows we
3431 * can't delete an open file. */
3440 * Break symlinks and/or hardlinks if we've been asked to.
3442 if ((bkc_flags
& BKC_BREAKSYMLINK
) || (bkc_flags
& BKC_BREAKHARDLINK
))
3446 lstat_res
= mch_lstat((char *)fname
, &st
);
3449 if ((bkc_flags
& BKC_BREAKSYMLINK
)
3451 && st
.st_ino
!= st_old
.st_ino
)
3452 backup_copy
= FALSE
;
3455 if ((bkc_flags
& BKC_BREAKHARDLINK
)
3456 && st_old
.st_nlink
> 1
3457 && (lstat_res
!= 0 || st
.st_ino
== st_old
.st_ino
))
3458 backup_copy
= FALSE
;
3464 /* make sure we have a valid backup extension to use */
3468 backup_ext
= (char_u
*)"/bak";
3470 backup_ext
= (char_u
*)".bak";
3477 && (fd
= mch_open((char *)fname
, O_RDONLY
| O_EXTRA
, 0)) >= 0)
3480 char_u
*copybuf
, *wp
;
3481 int some_error
= FALSE
;
3485 #if defined(UNIX) && !defined(SHORT_FNAME)
3486 int did_set_shortname
;
3489 copybuf
= alloc(BUFSIZE
+ 1);
3490 if (copybuf
== NULL
)
3492 some_error
= TRUE
; /* out of memory */
3497 * Try to make the backup in each directory in the 'bdir' option.
3499 * Unix semantics has it, that we may have a writable file,
3500 * that cannot be recreated with a simple open(..., O_CREAT, ) e.g:
3501 * - the directory is not writable,
3502 * - the file may be a symbolic link,
3503 * - the file may belong to another user/group, etc.
3505 * For these reasons, the existing writable file must be truncated
3506 * and reused. Creation of a backup COPY will be attempted.
3518 * Isolate one directory name, using an entry in 'bdir'.
3520 (void)copy_option_part(&dirp
, copybuf
, BUFSIZE
, ",");
3521 rootname
= get_file_in_dir(fname
, copybuf
);
3522 if (rootname
== NULL
)
3524 some_error
= TRUE
; /* out of memory */
3528 #if defined(UNIX) && !defined(SHORT_FNAME)
3529 did_set_shortname
= FALSE
;
3533 * May try twice if 'shortname' not set.
3538 * Make backup file name.
3540 backup
= buf_modname(
3544 (buf
->b_p_sn
|| buf
->b_shortname
),
3546 rootname
, backup_ext
, FALSE
);
3550 some_error
= TRUE
; /* out of memory */
3555 * Check if backup file already exists.
3557 if (mch_stat((char *)backup
, &st_new
) >= 0)
3561 * Check if backup file is same as original file.
3562 * May happen when modname() gave the same file back.
3563 * E.g. silly link, or file name-length reached.
3564 * If we don't check here, we either ruin the file
3565 * when copying or erase it after writing. jw.
3567 if (st_new
.st_dev
== st_old
.st_dev
3568 && st_new
.st_ino
== st_old
.st_ino
)
3571 backup
= NULL
; /* no backup file to delete */
3572 # ifndef SHORT_FNAME
3574 * may try again with 'shortname' set
3576 if (!(buf
->b_shortname
|| buf
->b_p_sn
))
3578 buf
->b_shortname
= TRUE
;
3579 did_set_shortname
= TRUE
;
3582 /* setting shortname didn't help */
3583 if (did_set_shortname
)
3584 buf
->b_shortname
= FALSE
;
3591 * If we are not going to keep the backup file, don't
3592 * delete an existing one, try to use another name.
3593 * Change one character, just before the extension.
3597 wp
= backup
+ STRLEN(backup
) - 1
3598 - STRLEN(backup_ext
);
3599 if (wp
< backup
) /* empty file name ??? */
3603 && mch_stat((char *)backup
, &st_new
) >= 0)
3605 /* They all exist??? Must be something wrong. */
3618 * Try to create the backup file
3622 /* remove old backup, if present */
3624 /* Open with O_EXCL to avoid the file being created while
3625 * we were sleeping (symlink hacker attack?) */
3626 bfd
= mch_open((char *)backup
,
3627 O_WRONLY
|O_CREAT
|O_EXTRA
|O_EXCL
|O_NOFOLLOW
,
3636 /* set file protection same as original file, but
3638 (void)mch_setperm(backup
, perm
& 0777);
3642 * Try to set the group of the backup same as the
3643 * original file. If this fails, set the protection
3644 * bits for the group same as the protection bits for
3647 if (st_new
.st_gid
!= st_old
.st_gid
3648 # ifdef HAVE_FCHOWN /* sequent-ptx lacks fchown() */
3649 && fchown(bfd
, (uid_t
)-1, st_old
.st_gid
) != 0
3653 (perm
& 0707) | ((perm
& 07) << 3));
3659 write_info
.bw_fd
= bfd
;
3660 write_info
.bw_buf
= copybuf
;
3662 write_info
.bw_flags
= FIO_NOCONVERT
;
3664 while ((write_info
.bw_len
= vim_read(fd
, copybuf
,
3667 if (buf_write_bytes(&write_info
) == FAIL
)
3669 errmsg
= (char_u
*)_("E506: Can't write to backup file (add ! to override)");
3675 errmsg
= (char_u
*)_(e_interr
);
3680 if (close(bfd
) < 0 && errmsg
== NULL
)
3681 errmsg
= (char_u
*)_("E507: Close error for backup file (add ! to override)");
3682 if (write_info
.bw_len
< 0)
3683 errmsg
= (char_u
*)_("E508: Can't read file for backup (add ! to override)");
3685 set_file_time(backup
, st_old
.st_atime
, st_old
.st_mtime
);
3688 mch_set_acl(backup
, acl
);
3695 close(fd
); /* ignore errors for closing read file */
3698 if (backup
== NULL
&& errmsg
== NULL
)
3699 errmsg
= (char_u
*)_("E509: Cannot create backup file (add ! to override)");
3700 /* ignore errors when forceit is TRUE */
3701 if ((some_error
|| errmsg
!= NULL
) && !forceit
)
3715 * Make a backup by renaming the original file.
3718 * If 'cpoptions' includes the "W" flag, we don't want to
3719 * overwrite a read-only file. But rename may be possible
3720 * anyway, thus we need an extra check here.
3722 if (file_readonly
&& vim_strchr(p_cpo
, CPO_FWRITE
) != NULL
)
3724 errnum
= (char_u
*)"E504: ";
3725 errmsg
= (char_u
*)_(err_readonly
);
3731 * Form the backup file name - change path/fo.o.h to
3732 * path/fo.o.h.bak Try all directories in 'backupdir', first one
3733 * that works is used.
3739 * Isolate one directory name and make the backup file name.
3741 (void)copy_option_part(&dirp
, IObuff
, IOSIZE
, ",");
3742 rootname
= get_file_in_dir(fname
, IObuff
);
3743 if (rootname
== NULL
)
3747 backup
= buf_modname(
3751 (buf
->b_p_sn
|| buf
->b_shortname
),
3753 rootname
, backup_ext
, FALSE
);
3760 * If we are not going to keep the backup file, don't
3761 * delete an existing one, try to use another name.
3762 * Change one character, just before the extension.
3764 if (!p_bk
&& mch_getperm(backup
) >= 0)
3766 p
= backup
+ STRLEN(backup
) - 1 - STRLEN(backup_ext
);
3767 if (p
< backup
) /* empty file name ??? */
3770 while (*p
> 'a' && mch_getperm(backup
) >= 0)
3772 /* They all exist??? Must be something wrong! */
3783 * Delete any existing backup and move the current version
3784 * to the backup. For safety, we don't remove the backup
3785 * until the write has finished successfully. And if the
3786 * 'backup' option is set, leave it around.
3789 * If the renaming of the original file to the backup file
3792 if (vim_rename(fname
, backup
) == 0)
3795 vim_free(backup
); /* don't do the rename below */
3799 if (backup
== NULL
&& !forceit
)
3801 errmsg
= (char_u
*)_("E510: Can't make backup file (add ! to override)");
3807 #if defined(UNIX) && !defined(ARCHIE)
3808 /* When using ":w!" and the file was read-only: make it writable */
3809 if (forceit
&& perm
>= 0 && !(perm
& 0200) && st_old
.st_uid
== getuid()
3810 && vim_strchr(p_cpo
, CPO_FWRITE
) == NULL
)
3813 (void)mch_setperm(fname
, perm
);
3814 made_writable
= TRUE
;
3818 /* When using ":w!" and writing to the current file, 'readonly' makes no
3819 * sense, reset it, unless 'Z' appears in 'cpoptions'. */
3820 if (forceit
&& overwriting
&& vim_strchr(p_cpo
, CPO_KEEPRO
) == NULL
)
3822 buf
->b_p_ro
= FALSE
;
3824 need_maketitle
= TRUE
; /* set window title later */
3827 status_redraw_all(); /* redraw status lines later */
3831 if (end
> buf
->b_ml
.ml_line_count
)
3832 end
= buf
->b_ml
.ml_line_count
;
3833 if (buf
->b_ml
.ml_flags
& ML_EMPTY
)
3837 * If the original file is being overwritten, there is a small chance that
3838 * we crash in the middle of writing. Therefore the file is preserved now.
3839 * This makes all block numbers positive so that recovery does not need
3840 * the original file.
3841 * Don't do this if there is a backup file and we are exiting.
3843 if (reset_changed
&& !newfile
&& overwriting
3844 && !(exiting
&& backup
!= NULL
))
3846 ml_preserve(buf
, FALSE
);
3849 errmsg
= (char_u
*)_(e_interr
);
3850 goto restore_backup
;
3854 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
3856 * Before risking to lose the original file verify if there's
3857 * a resource fork to preserve, and if cannot be done warn
3858 * the users. This happens when overwriting without backups.
3860 if (backup
== NULL
&& overwriting
&& !append
)
3861 if (mch_has_resource_fork(fname
))
3863 errmsg
= (char_u
*)_("E460: The resource fork would be lost (add ! to override)");
3864 goto restore_backup
;
3869 vms_remove_version(fname
); /* remove version */
3871 /* Default: write the the file directly. May write to a temp file for
3872 * multi-byte conversion. */
3876 /* Check for forced 'fileencoding' from "++opt=val" argument. */
3877 if (eap
!= NULL
&& eap
->force_enc
!= 0)
3879 fenc
= eap
->cmd
+ eap
->force_enc
;
3880 fenc
= enc_canonize(fenc
);
3884 fenc
= buf
->b_p_fenc
;
3887 * The file needs to be converted when 'fileencoding' is set and
3888 * 'fileencoding' differs from 'encoding'.
3890 converted
= (*fenc
!= NUL
&& !same_encoding(p_enc
, fenc
));
3893 * Check if UTF-8 to UCS-2/4 or Latin1 conversion needs to be done. Or
3894 * Latin1 to Unicode conversion. This is handled in buf_write_bytes().
3895 * Prepare the flags for it and allocate bw_conv_buf when needed.
3897 if (converted
&& (enc_utf8
|| STRCMP(p_enc
, "latin1") == 0))
3899 wb_flags
= get_fio_flags(fenc
);
3900 if (wb_flags
& (FIO_UCS2
| FIO_UCS4
| FIO_UTF16
| FIO_UTF8
))
3902 /* Need to allocate a buffer to translate into. */
3903 if (wb_flags
& (FIO_UCS2
| FIO_UTF16
| FIO_UTF8
))
3904 write_info
.bw_conv_buflen
= bufsize
* 2;
3906 write_info
.bw_conv_buflen
= bufsize
* 4;
3907 write_info
.bw_conv_buf
3908 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3909 if (write_info
.bw_conv_buf
== NULL
)
3915 if (converted
&& wb_flags
== 0 && (wb_flags
= get_win_fio_flags(fenc
)) != 0)
3917 /* Convert UTF-8 -> UCS-2 and UCS-2 -> DBCS. Worst-case * 4: */
3918 write_info
.bw_conv_buflen
= bufsize
* 4;
3919 write_info
.bw_conv_buf
3920 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3921 if (write_info
.bw_conv_buf
== NULL
)
3927 if (converted
&& wb_flags
== 0 && (wb_flags
= get_mac_fio_flags(fenc
)) != 0)
3929 write_info
.bw_conv_buflen
= bufsize
* 3;
3930 write_info
.bw_conv_buf
3931 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3932 if (write_info
.bw_conv_buf
== NULL
)
3937 # if defined(FEAT_EVAL) || defined(USE_ICONV)
3938 if (converted
&& wb_flags
== 0)
3942 * Use iconv() conversion when conversion is needed and it's not done
3945 write_info
.bw_iconv_fd
= (iconv_t
)my_iconv_open(fenc
,
3946 enc_utf8
? (char_u
*)"utf-8" : p_enc
);
3947 if (write_info
.bw_iconv_fd
!= (iconv_t
)-1)
3949 /* We're going to use iconv(), allocate a buffer to convert in. */
3950 write_info
.bw_conv_buflen
= bufsize
* ICONV_MULT
;
3951 write_info
.bw_conv_buf
3952 = lalloc((long_u
)write_info
.bw_conv_buflen
, TRUE
);
3953 if (write_info
.bw_conv_buf
== NULL
)
3955 write_info
.bw_first
= TRUE
;
3964 * When the file needs to be converted with 'charconvert' after
3965 * writing, write to a temp file instead and let the conversion
3966 * overwrite the original file.
3970 wfname
= vim_tempname('w');
3971 if (wfname
== NULL
) /* Can't write without a tempfile! */
3973 errmsg
= (char_u
*)_("E214: Can't find temp file for writing");
3974 goto restore_backup
;
3980 if (converted
&& wb_flags
== 0
3982 && write_info
.bw_iconv_fd
== (iconv_t
)-1
3991 errmsg
= (char_u
*)_("E213: Cannot convert (add ! to write without conversion)");
3992 goto restore_backup
;
3994 notconverted
= TRUE
;
3999 * Open the file "wfname" for writing.
4000 * We may try to open the file twice: If we can't write to the
4001 * file and forceit is TRUE we delete the existing file and try to create
4002 * a new one. If this still fails we may have lost the original file!
4003 * (this may happen when the user reached his quotum for number of files).
4004 * Appending will fail if the file does not exist and forceit is FALSE.
4006 while ((fd
= mch_open((char *)wfname
, O_WRONLY
| O_EXTRA
| (append
4007 ? (forceit
? (O_APPEND
| O_CREAT
) : O_APPEND
)
4008 : (O_CREAT
| O_TRUNC
))
4009 , perm
< 0 ? 0666 : (perm
& 0777))) < 0)
4012 * A forced write will try to create a new file if the old one is
4013 * still readonly. This may also happen when the directory is
4014 * read-only. In that case the mch_remove() will fail.
4021 /* Don't delete the file when it's a hard or symbolic link. */
4022 if ((!newfile
&& st_old
.st_nlink
> 1)
4023 || (mch_lstat((char *)fname
, &st
) == 0
4024 && (st
.st_dev
!= st_old
.st_dev
4025 || st
.st_ino
!= st_old
.st_ino
)))
4026 errmsg
= (char_u
*)_("E166: Can't open linked file for writing");
4030 errmsg
= (char_u
*)_("E212: Can't open file for writing");
4031 if (forceit
&& vim_strchr(p_cpo
, CPO_FWRITE
) == NULL
4035 /* we write to the file, thus it should be marked
4036 writable after all */
4038 made_writable
= TRUE
;
4040 if (st_old
.st_uid
!= getuid() || st_old
.st_gid
!= getgid())
4043 if (!append
) /* don't remove when appending */
4055 * If we failed to open the file, we don't need a backup. Throw it
4056 * away. If we moved or removed the original file try to put the
4057 * backup in its place.
4059 if (backup
!= NULL
&& wfname
== fname
)
4064 * There is a small chance that we removed the original,
4065 * try to move the copy in its place.
4066 * This may not work if the vim_rename() fails.
4067 * In that case we leave the copy around.
4069 /* If file does not exist, put the copy in its place */
4070 if (mch_stat((char *)fname
, &st
) < 0)
4071 vim_rename(backup
, fname
);
4072 /* if original file does exist throw away the copy */
4073 if (mch_stat((char *)fname
, &st
) >= 0)
4078 /* try to put the original file back */
4079 vim_rename(backup
, fname
);
4083 /* if original file no longer exists give an extra warning */
4084 if (!newfile
&& mch_stat((char *)fname
, &st
) < 0)
4089 if (wfname
!= fname
)
4096 #if defined(MACOS_CLASSIC) || defined(WIN3264)
4097 /* TODO: Is it need for MACOS_X? (Dany) */
4099 * On macintosh copy the original files attributes (i.e. the backup)
4100 * This is done in order to preserve the resource fork and the
4101 * Finder attribute (label, comments, custom icons, file creator)
4103 if (backup
!= NULL
&& overwriting
&& !append
)
4106 (void)mch_copy_file_attribute(wfname
, backup
);
4108 (void)mch_copy_file_attribute(backup
, wfname
);
4111 if (!overwriting
&& !append
)
4113 if (buf
->b_ffname
!= NULL
)
4114 (void)mch_copy_file_attribute(buf
->b_ffname
, wfname
);
4115 /* Should copy resource fork */
4119 write_info
.bw_fd
= fd
;
4122 if (*buf
->b_p_key
&& !filtering
)
4124 crypt_init_keys(buf
->b_p_key
);
4125 /* Write magic number, so that Vim knows that this file is encrypted
4126 * when reading it again. This also undergoes utf-8 to ucs-2/4
4127 * conversion when needed. */
4128 write_info
.bw_buf
= (char_u
*)CRYPT_MAGIC
;
4129 write_info
.bw_len
= CRYPT_MAGIC_LEN
;
4130 write_info
.bw_flags
= FIO_NOCONVERT
;
4131 if (buf_write_bytes(&write_info
) == FAIL
)
4133 wb_flags
|= FIO_ENCRYPTED
;
4137 write_info
.bw_buf
= buffer
;
4140 /* use "++bin", "++nobin" or 'binary' */
4141 if (eap
!= NULL
&& eap
->force_bin
!= 0)
4142 write_bin
= (eap
->force_bin
== FORCE_BIN
);
4144 write_bin
= buf
->b_p_bin
;
4148 * The BOM is written just after the encryption magic number.
4149 * Skip it when appending and the file already existed, the BOM only makes
4150 * sense at the start of the file.
4152 if (buf
->b_p_bomb
&& !write_bin
&& (!append
|| perm
< 0))
4154 write_info
.bw_len
= make_bom(buffer
, fenc
);
4155 if (write_info
.bw_len
> 0)
4157 /* don't convert, do encryption */
4158 write_info
.bw_flags
= FIO_NOCONVERT
| wb_flags
;
4159 if (buf_write_bytes(&write_info
) == FAIL
)
4162 nchars
+= write_info
.bw_len
;
4167 write_info
.bw_len
= bufsize
;
4169 write_info
.bw_flags
= wb_flags
;
4171 fileformat
= get_fileformat_force(buf
, eap
);
4174 for (lnum
= start
; lnum
<= end
; ++lnum
)
4177 * The next while loop is done once for each character written.
4180 ptr
= ml_get_buf(buf
, lnum
, FALSE
) - 1;
4181 while ((c
= *++ptr
) != NUL
)
4184 *s
= NUL
; /* replace newlines with NULs */
4185 else if (c
== CAR
&& fileformat
== EOL_MAC
)
4186 *s
= NL
; /* Mac: replace CRs with NLs */
4190 if (++len
!= bufsize
)
4192 if (buf_write_bytes(&write_info
) == FAIL
)
4194 end
= 0; /* write error: break loop */
4201 /* write failed or last line has no EOL: stop here */
4205 && (lnum
== write_no_eol_lnum
4206 || (lnum
== buf
->b_ml
.ml_line_count
&& !buf
->b_p_eol
))))
4208 ++lnum
; /* written the line, count it */
4212 if (fileformat
== EOL_UNIX
)
4216 *s
++ = CAR
; /* EOL_MAC or EOL_DOS: write CR */
4217 if (fileformat
== EOL_DOS
) /* write CR-NL */
4219 if (++len
== bufsize
)
4221 if (buf_write_bytes(&write_info
) == FAIL
)
4223 end
= 0; /* write error: break loop */
4233 if (++len
== bufsize
&& end
)
4235 if (buf_write_bytes(&write_info
) == FAIL
)
4237 end
= 0; /* write error: break loop */
4247 end
= 0; /* Interrupted, break loop */
4253 * On VMS there is a problem: newlines get added when writing blocks
4254 * at a time. Fix it by writing a line at a time.
4255 * This is much slower!
4256 * Explanation: VAX/DECC RTL insists that records in some RMS
4257 * structures end with a newline (carriage return) character, and if
4258 * they don't it adds one.
4259 * With other RMS structures it works perfect without this fix.
4261 if (buf
->b_fab_rfm
== FAB$C_VFC
4262 || ((buf
->b_fab_rat
& (FAB$M_FTN
| FAB$M_CR
)) != 0))
4266 buf
->b_fab_mrs
= (buf
->b_fab_mrs
== 0
4267 ? MIN(4096, bufsize
)
4268 : MIN(buf
->b_fab_mrs
, bufsize
));
4273 write_info
.bw_len
= MIN(b2write
, buf
->b_fab_mrs
);
4274 if (buf_write_bytes(&write_info
) == FAIL
)
4279 b2write
-= MIN(b2write
, buf
->b_fab_mrs
);
4281 write_info
.bw_len
= bufsize
;
4288 if (len
> 0 && end
> 0)
4290 write_info
.bw_len
= len
;
4291 if (buf_write_bytes(&write_info
) == FAIL
)
4292 end
= 0; /* write error */
4296 #if defined(UNIX) && defined(HAVE_FSYNC)
4297 /* On many journalling file systems there is a bug that causes both the
4298 * original and the backup file to be lost when halting the system right
4299 * after writing the file. That's because only the meta-data is
4300 * journalled. Syncing the file slows down the system, but assures it has
4301 * been written to disk and we don't lose it.
4302 * For a device do try the fsync() but don't complain if it does not work
4303 * (could be a pipe).
4304 * If the 'fsync' option is FALSE, don't fsync(). Useful for laptops. */
4305 if (p_fs
&& fsync(fd
) != 0 && !device
)
4307 errmsg
= (char_u
*)_("E667: Fsync failed");
4313 /* When creating a new file, set its owner/group to that of the original
4314 * file. Get the new device and inode number. */
4315 if (backup
!= NULL
&& !backup_copy
)
4320 /* don't change the owner when it's already OK, some systems remove
4321 * permission or ACL stuff */
4322 if (mch_stat((char *)wfname
, &st
) < 0
4323 || st
.st_uid
!= st_old
.st_uid
4324 || st
.st_gid
!= st_old
.st_gid
)
4326 fchown(fd
, st_old
.st_uid
, st_old
.st_gid
);
4327 if (perm
>= 0) /* set permission again, may have changed */
4328 (void)mch_setperm(wfname
, perm
);
4333 else if (buf
->b_dev
< 0)
4334 /* Set the inode when creating a new file. */
4340 errmsg
= (char_u
*)_("E512: Close failed");
4346 perm
&= ~0200; /* reset 'w' bit for security reasons */
4348 if (perm
>= 0) /* set perm. of new file same as old file */
4349 (void)mch_setperm(wfname
, perm
);
4351 if (!append
&& !filtering
)
4352 /* Set the filetype after writing the file. */
4353 mch_set_filetype(wfname
, buf
->b_p_oft
);
4356 /* Probably need to set the ACL before changing the user (can't set the
4357 * ACL on a file the user doesn't own). */
4359 mch_set_acl(wfname
, acl
);
4363 #if defined(FEAT_MBYTE) && defined(FEAT_EVAL)
4364 if (wfname
!= fname
)
4367 * The file was written to a temp file, now it needs to be converted
4368 * with 'charconvert' to (overwrite) the output file.
4372 if (eval_charconvert(enc_utf8
? (char_u
*)"utf-8" : p_enc
, fenc
,
4373 wfname
, fname
) == FAIL
)
4375 write_info
.bw_conv_error
= TRUE
;
4389 if (write_info
.bw_conv_error
)
4390 errmsg
= (char_u
*)_("E513: write error, conversion failed (make 'fenc' empty to override)");
4394 errmsg
= (char_u
*)_(e_interr
);
4396 errmsg
= (char_u
*)_("E514: write error (file system full?)");
4400 * If we have a backup file, try to put it in place of the new file,
4401 * because the new file is probably corrupt. This avoids loosing the
4402 * original file when trying to make a backup when writing the file a
4404 * When "backup_copy" is set we need to copy the backup over the new
4405 * file. Otherwise rename the backup file.
4406 * If this is OK, don't give the extra warning message.
4412 /* This may take a while, if we were interrupted let the user
4413 * know we got the message. */
4419 if ((fd
= mch_open((char *)backup
, O_RDONLY
| O_EXTRA
, 0)) >= 0)
4421 if ((write_info
.bw_fd
= mch_open((char *)fname
,
4422 O_WRONLY
| O_CREAT
| O_TRUNC
| O_EXTRA
,
4425 /* copy the file. */
4426 write_info
.bw_buf
= smallbuf
;
4428 write_info
.bw_flags
= FIO_NOCONVERT
;
4430 while ((write_info
.bw_len
= vim_read(fd
, smallbuf
,
4432 if (buf_write_bytes(&write_info
) == FAIL
)
4435 if (close(write_info
.bw_fd
) >= 0
4436 && write_info
.bw_len
== 0)
4437 end
= 1; /* success */
4439 close(fd
); /* ignore errors for closing read file */
4444 if (vim_rename(backup
, fname
) == 0)
4451 lnum
-= start
; /* compute number of written lines */
4452 --no_wait_return
; /* may wait for return now */
4454 #if !(defined(UNIX) || defined(VMS))
4455 fname
= sfname
; /* use shortname now, for the messages */
4459 msg_add_fname(buf
, fname
); /* put fname in IObuff with quotes */
4462 if (write_info
.bw_conv_error
)
4464 STRCAT(IObuff
, _(" CONVERSION ERROR"));
4467 else if (notconverted
)
4469 STRCAT(IObuff
, _("[NOT converted]"));
4474 STRCAT(IObuff
, _("[converted]"));
4480 STRCAT(IObuff
, _("[Device]"));
4485 STRCAT(IObuff
, shortmess(SHM_NEW
) ? _("[New]") : _("[New File]"));
4493 /* may add [unix/dos/mac] */
4494 if (msg_add_fileformat(fileformat
))
4497 if (wb_flags
& FIO_ENCRYPTED
)
4499 STRCAT(IObuff
, _("[crypted]"));
4503 msg_add_lines(c
, (long)lnum
, nchars
); /* add line/char count */
4504 if (!shortmess(SHM_WRITE
))
4507 STRCAT(IObuff
, shortmess(SHM_WRI
) ? _(" [a]") : _(" appended"));
4509 STRCAT(IObuff
, shortmess(SHM_WRI
) ? _(" [w]") : _(" written"));
4512 set_keep_msg(msg_trunc_attr(IObuff
, FALSE
, 0), 0);
4515 /* When written everything correctly: reset 'modified'. Unless not
4516 * writing to the original file and '+' is not in 'cpoptions'. */
4517 if (reset_changed
&& whole
&& !append
4519 && !write_info
.bw_conv_error
4521 && (overwriting
|| vim_strchr(p_cpo
, CPO_PLUS
) != NULL
)
4524 unchanged(buf
, TRUE
);
4529 * If written to the current file, update the timestamp of the swap file
4530 * and reset the BF_WRITE_MASK flags. Also sets buf->b_mtime.
4536 buf
->b_flags
&= ~BF_NEW
;
4538 buf
->b_flags
&= ~BF_WRITE_MASK
;
4542 * If we kept a backup until now, and we are in patch mode, then we make
4543 * the backup file our 'original' file.
4545 if (*p_pm
&& dobackup
)
4547 char *org
= (char *)buf_modname(
4551 (buf
->b_p_sn
|| buf
->b_shortname
),
4553 fname
, p_pm
, FALSE
);
4560 * If the original file does not exist yet
4561 * the current backup file becomes the original file
4564 EMSG(_("E205: Patchmode: can't save original file"));
4565 else if (mch_stat(org
, &st
) < 0)
4567 vim_rename(backup
, (char_u
*)org
);
4568 vim_free(backup
); /* don't delete the file */
4571 set_file_time((char_u
*)org
, st_old
.st_atime
, st_old
.st_mtime
);
4576 * If there is no backup file, remember that a (new) file was
4584 || (empty_fd
= mch_open(org
,
4585 O_CREAT
| O_EXTRA
| O_EXCL
| O_NOFOLLOW
,
4586 perm
< 0 ? 0666 : (perm
& 0777))) < 0)
4587 EMSG(_("E206: patchmode: can't touch empty original file"));
4593 mch_setperm((char_u
*)org
, mch_getperm(fname
) & 0777);
4599 * Remove the backup unless 'backup' option is set
4601 if (!p_bk
&& backup
!= NULL
&& mch_remove(backup
) != 0)
4602 EMSG(_("E207: Can't delete backup file"));
4604 #ifdef FEAT_SUN_WORKSHOP
4605 if (usingSunWorkShop
)
4606 workshop_file_saved((char *) ffname
);
4612 * Finish up. We get here either after failure or success.
4615 --no_wait_return
; /* may wait for return now */
4618 /* Done saving, we accept changed buffer warnings again */
4619 buf
->b_saving
= FALSE
;
4622 if (buffer
!= smallbuf
)
4625 vim_free(fenc_tofree
);
4626 vim_free(write_info
.bw_conv_buf
);
4628 if (write_info
.bw_iconv_fd
!= (iconv_t
)-1)
4630 iconv_close(write_info
.bw_iconv_fd
);
4631 write_info
.bw_iconv_fd
= (iconv_t
)-1;
4641 int numlen
= errnum
!= NULL
? (int)STRLEN(errnum
) : 0;
4643 attr
= hl_attr(HLF_E
); /* set highlight for error messages */
4650 ); /* put file name in IObuff with quotes */
4651 if (STRLEN(IObuff
) + STRLEN(errmsg
) + numlen
>= IOSIZE
)
4652 IObuff
[IOSIZE
- STRLEN(errmsg
) - numlen
- 1] = NUL
;
4653 /* If the error message has the form "is ...", put the error number in
4654 * front of the file name. */
4657 mch_memmove(IObuff
+ numlen
, IObuff
, STRLEN(IObuff
) + 1);
4658 mch_memmove(IObuff
, errnum
, (size_t)numlen
);
4660 STRCAT(IObuff
, errmsg
);
4666 MSG_PUTS_ATTR(_("\nWARNING: Original file may be lost or damaged\n"),
4668 MSG_PUTS_ATTR(_("don't quit the editor until the file is successfully written!"),
4671 /* Update the timestamp to avoid an "overwrite changed file"
4672 * prompt when writing again. */
4673 if (mch_stat((char *)fname
, &st_old
) >= 0)
4675 buf_store_time(buf
, &st_old
, fname
);
4676 buf
->b_mtime_read
= buf
->b_mtime
;
4680 msg_scroll
= msg_save
;
4684 if (!should_abort(retval
))
4691 write_no_eol_lnum
= 0; /* in case it was set by the previous read */
4694 * Apply POST autocommands.
4695 * Careful: The autocommands may call buf_write() recursively!
4697 aucmd_prepbuf(&aco
, buf
);
4700 apply_autocmds_exarg(EVENT_FILEAPPENDPOST
, fname
, fname
,
4701 FALSE
, curbuf
, eap
);
4703 apply_autocmds_exarg(EVENT_FILTERWRITEPOST
, NULL
, fname
,
4704 FALSE
, curbuf
, eap
);
4705 else if (reset_changed
&& whole
)
4706 apply_autocmds_exarg(EVENT_BUFWRITEPOST
, fname
, fname
,
4707 FALSE
, curbuf
, eap
);
4709 apply_autocmds_exarg(EVENT_FILEWRITEPOST
, fname
, fname
,
4710 FALSE
, curbuf
, eap
);
4712 /* restore curwin/curbuf and a few other things */
4713 aucmd_restbuf(&aco
);
4716 if (aborting()) /* autocmds may abort script processing */
4722 got_int
|= prev_got_int
;
4724 #ifdef MACOS_CLASSIC /* TODO: Is it need for MACOS_X? (Dany) */
4725 /* Update machine specific information. */
4726 mch_post_buffer_write(buf
);
4728 #ifdef FEAT_ODB_EDITOR
4729 odb_post_buffer_write(buf
);
4736 * Set the name of the current buffer. Use when the buffer doesn't have a
4737 * name and a ":r" or ":w" command with a file name is used.
4740 set_rw_fname(fname
, sfname
)
4745 /* It's like the unnamed buffer is deleted.... */
4747 apply_autocmds(EVENT_BUFDELETE
, NULL
, NULL
, FALSE
, curbuf
);
4748 apply_autocmds(EVENT_BUFWIPEOUT
, NULL
, NULL
, FALSE
, curbuf
);
4750 if (aborting()) /* autocmds may abort script processing */
4755 if (setfname(curbuf
, fname
, sfname
, FALSE
) == OK
)
4756 curbuf
->b_flags
|= BF_NOTEDITED
;
4759 /* ....and a new named one is created */
4760 apply_autocmds(EVENT_BUFNEW
, NULL
, NULL
, FALSE
, curbuf
);
4762 apply_autocmds(EVENT_BUFADD
, NULL
, NULL
, FALSE
, curbuf
);
4764 if (aborting()) /* autocmds may abort script processing */
4768 /* Do filetype detection now if 'filetype' is empty. */
4769 if (*curbuf
->b_p_ft
== NUL
)
4771 if (au_has_group((char_u
*)"filetypedetect"))
4772 (void)do_doautocmd((char_u
*)"filetypedetect BufRead", FALSE
);
4781 * Put file name into IObuff with quotes.
4784 msg_add_fname(buf
, fname
)
4789 fname
= (char_u
*)"-stdin-";
4790 home_replace(buf
, fname
, IObuff
+ 1, IOSIZE
- 4, TRUE
);
4792 STRCAT(IObuff
, "\" ");
4796 * Append message for text mode to IObuff.
4797 * Return TRUE if something appended.
4800 msg_add_fileformat(eol_type
)
4804 if (eol_type
== EOL_DOS
)
4806 STRCAT(IObuff
, shortmess(SHM_TEXT
) ? _("[dos]") : _("[dos format]"));
4811 if (eol_type
== EOL_MAC
)
4813 STRCAT(IObuff
, shortmess(SHM_TEXT
) ? _("[mac]") : _("[mac format]"));
4817 #if defined(USE_CRNL) || defined(USE_CR)
4818 if (eol_type
== EOL_UNIX
)
4820 STRCAT(IObuff
, shortmess(SHM_TEXT
) ? _("[unix]") : _("[unix format]"));
4828 * Append line and character count to IObuff.
4831 msg_add_lines(insert_space
, lnum
, nchars
)
4838 p
= IObuff
+ STRLEN(IObuff
);
4842 if (shortmess(SHM_LINES
))
4843 sprintf((char *)p
, "%ldL, %ldC", lnum
, nchars
);
4847 STRCPY(p
, _("1 line, "));
4849 sprintf((char *)p
, _("%ld lines, "), lnum
);
4852 STRCPY(p
, _("1 character"));
4854 sprintf((char *)p
, _("%ld characters"), nchars
);
4859 * Append message for missing line separator to IObuff.
4864 STRCAT(IObuff
, shortmess(SHM_LAST
) ? _("[noeol]") : _("[Incomplete last line]"));
4868 * Check modification time of file, before writing to it.
4869 * The size isn't checked, because using a tool like "gzip" takes care of
4870 * using the same timestamp but can't set the size.
4873 check_mtime(buf
, st
)
4877 if (buf
->b_mtime_read
!= 0
4878 && time_differs((long)st
->st_mtime
, buf
->b_mtime_read
))
4880 msg_scroll
= TRUE
; /* don't overwrite messages here */
4881 msg_silent
= 0; /* must give this prompt */
4882 /* don't use emsg() here, don't want to flush the buffers */
4883 MSG_ATTR(_("WARNING: The file has been changed since reading it!!!"),
4885 if (ask_yesno((char_u
*)_("Do you really want to write to it"),
4888 msg_scroll
= FALSE
; /* always overwrite the file message now */
4894 time_differs(t1
, t2
)
4897 #if defined(__linux__) || defined(MSDOS) || defined(MSWIN)
4898 /* On a FAT filesystem, esp. under Linux, there are only 5 bits to store
4899 * the seconds. Since the roundoff is done when flushing the inode, the
4900 * time may change unexpectedly by one second!!! */
4901 return (t1
- t2
> 1 || t2
- t1
> 1);
4908 * Call write() to write a number of bytes to the file.
4909 * Also handles encryption and 'encoding' conversion.
4911 * Return FAIL for failure, OK otherwise.
4918 char_u
*buf
= ip
->bw_buf
; /* data to write */
4919 int len
= ip
->bw_len
; /* length of data */
4921 int flags
= ip
->bw_flags
; /* extra flags */
4926 * Skip conversion when writing the crypt magic number or the BOM.
4928 if (!(flags
& FIO_NOCONVERT
))
4934 if (flags
& FIO_UTF8
)
4937 * Convert latin1 in the buffer to UTF-8 in the file.
4939 p
= ip
->bw_conv_buf
; /* translate to buffer */
4940 for (wlen
= 0; wlen
< len
; ++wlen
)
4941 p
+= utf_char2bytes(buf
[wlen
], p
);
4942 buf
= ip
->bw_conv_buf
;
4943 len
= (int)(p
- ip
->bw_conv_buf
);
4945 else if (flags
& (FIO_UCS4
| FIO_UTF16
| FIO_UCS2
| FIO_LATIN1
))
4948 * Convert UTF-8 bytes in the buffer to UCS-2, UCS-4, UTF-16 or
4949 * Latin1 chars in the file.
4951 if (flags
& FIO_LATIN1
)
4952 p
= buf
; /* translate in-place (can only get shorter) */
4954 p
= ip
->bw_conv_buf
; /* translate to buffer */
4955 for (wlen
= 0; wlen
< len
; wlen
+= n
)
4957 if (wlen
== 0 && ip
->bw_restlen
!= 0)
4961 /* Use remainder of previous call. Append the start of
4962 * buf[] to get a full sequence. Might still be too
4964 l
= CONV_RESTLEN
- ip
->bw_restlen
;
4967 mch_memmove(ip
->bw_rest
+ ip
->bw_restlen
, buf
, (size_t)l
);
4968 n
= utf_ptr2len_len(ip
->bw_rest
, ip
->bw_restlen
+ l
);
4969 if (n
> ip
->bw_restlen
+ len
)
4971 /* We have an incomplete byte sequence at the end to
4972 * be written. We can't convert it without the
4973 * remaining bytes. Keep them for the next call. */
4974 if (ip
->bw_restlen
+ len
> CONV_RESTLEN
)
4976 ip
->bw_restlen
+= len
;
4980 c
= utf_ptr2char(ip
->bw_rest
);
4983 if (n
>= ip
->bw_restlen
)
4985 n
-= ip
->bw_restlen
;
4990 ip
->bw_restlen
-= n
;
4991 mch_memmove(ip
->bw_rest
, ip
->bw_rest
+ n
,
4992 (size_t)ip
->bw_restlen
);
4998 n
= utf_ptr2len_len(buf
+ wlen
, len
- wlen
);
5001 /* We have an incomplete byte sequence at the end to
5002 * be written. We can't convert it without the
5003 * remaining bytes. Keep them for the next call. */
5004 if (len
- wlen
> CONV_RESTLEN
)
5006 ip
->bw_restlen
= len
- wlen
;
5007 mch_memmove(ip
->bw_rest
, buf
+ wlen
,
5008 (size_t)ip
->bw_restlen
);
5012 c
= utf_ptr2char(buf
+ wlen
);
5017 ip
->bw_conv_error
|= ucs2bytes(c
, &p
, flags
);
5019 if (flags
& FIO_LATIN1
)
5020 len
= (int)(p
- buf
);
5023 buf
= ip
->bw_conv_buf
;
5024 len
= (int)(p
- ip
->bw_conv_buf
);
5029 else if (flags
& FIO_CODEPAGE
)
5032 * Convert UTF-8 or codepage to UCS-2 and then to MS-Windows
5042 if (ip
->bw_restlen
> 0)
5044 /* Need to concatenate the remainder of the previous call and
5045 * the bytes of the current call. Use the end of the
5046 * conversion buffer for this. */
5047 fromlen
= len
+ ip
->bw_restlen
;
5048 from
= ip
->bw_conv_buf
+ ip
->bw_conv_buflen
- fromlen
;
5049 mch_memmove(from
, ip
->bw_rest
, (size_t)ip
->bw_restlen
);
5050 mch_memmove(from
+ ip
->bw_restlen
, buf
, (size_t)len
);
5058 to
= ip
->bw_conv_buf
;
5061 /* Convert from UTF-8 to UCS-2, to the start of the buffer.
5062 * The buffer has been allocated to be big enough. */
5065 n
= (int)utf_ptr2len_len(from
, (int)fromlen
);
5066 if (n
> (int)fromlen
) /* incomplete byte sequence */
5068 u8c
= utf_ptr2char(from
);
5069 *to
++ = (u8c
& 0xff);
5075 /* Copy remainder to ip->bw_rest[] to be used for the next
5077 if (fromlen
> CONV_RESTLEN
)
5079 /* weird overlong sequence */
5080 ip
->bw_conv_error
= TRUE
;
5083 mch_memmove(ip
->bw_rest
, from
, fromlen
);
5084 ip
->bw_restlen
= (int)fromlen
;
5088 /* Convert from enc_codepage to UCS-2, to the start of the
5089 * buffer. The buffer has been allocated to be big enough. */
5091 needed
= MultiByteToWideChar(enc_codepage
,
5092 MB_ERR_INVALID_CHARS
, (LPCSTR
)from
, (int)fromlen
,
5096 /* When conversion fails there may be a trailing byte. */
5097 needed
= MultiByteToWideChar(enc_codepage
,
5098 MB_ERR_INVALID_CHARS
, (LPCSTR
)from
, (int)fromlen
- 1,
5102 /* Conversion doesn't work. */
5103 ip
->bw_conv_error
= TRUE
;
5106 /* Save the trailing byte for the next call. */
5107 ip
->bw_rest
[0] = from
[fromlen
- 1];
5110 needed
= MultiByteToWideChar(enc_codepage
, MB_ERR_INVALID_CHARS
,
5111 (LPCSTR
)from
, (int)(fromlen
- ip
->bw_restlen
),
5112 (LPWSTR
)to
, needed
);
5115 /* Safety check: Conversion doesn't work. */
5116 ip
->bw_conv_error
= TRUE
;
5122 fromlen
= to
- ip
->bw_conv_buf
;
5124 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5125 if (FIO_GET_CP(flags
) == CP_UTF8
)
5127 /* Convert from UCS-2 to UTF-8, using the remainder of the
5128 * conversion buffer. Fails when out of space. */
5129 for (from
= ip
->bw_conv_buf
; fromlen
> 1; fromlen
-= 2)
5132 u8c
+= (*from
++ << 8);
5133 to
+= utf_char2bytes(u8c
, to
);
5134 if (to
+ 6 >= ip
->bw_conv_buf
+ ip
->bw_conv_buflen
)
5136 ip
->bw_conv_error
= TRUE
;
5140 len
= (int)(to
- buf
);
5145 /* Convert from UCS-2 to the codepage, using the remainder of
5146 * the conversion buffer. If the conversion uses the default
5147 * character "0", the data doesn't fit in this encoding, so
5149 len
= WideCharToMultiByte(FIO_GET_CP(flags
), 0,
5150 (LPCWSTR
)ip
->bw_conv_buf
, (int)fromlen
/ sizeof(WCHAR
),
5151 (LPSTR
)to
, (int)(ip
->bw_conv_buflen
- fromlen
), 0,
5155 ip
->bw_conv_error
= TRUE
;
5162 # ifdef MACOS_CONVERT
5163 else if (flags
& FIO_MACROMAN
)
5166 * Convert UTF-8 or latin1 to Apple MacRoman.
5171 if (ip
->bw_restlen
> 0)
5173 /* Need to concatenate the remainder of the previous call and
5174 * the bytes of the current call. Use the end of the
5175 * conversion buffer for this. */
5176 fromlen
= len
+ ip
->bw_restlen
;
5177 from
= ip
->bw_conv_buf
+ ip
->bw_conv_buflen
- fromlen
;
5178 mch_memmove(from
, ip
->bw_rest
, (size_t)ip
->bw_restlen
);
5179 mch_memmove(from
+ ip
->bw_restlen
, buf
, (size_t)len
);
5187 if (enc2macroman(from
, fromlen
,
5188 ip
->bw_conv_buf
, &len
, ip
->bw_conv_buflen
,
5189 ip
->bw_rest
, &ip
->bw_restlen
) == FAIL
)
5191 ip
->bw_conv_error
= TRUE
;
5194 buf
= ip
->bw_conv_buf
;
5199 if (ip
->bw_iconv_fd
!= (iconv_t
)-1)
5206 /* Convert with iconv(). */
5207 if (ip
->bw_restlen
> 0)
5209 /* Need to concatenate the remainder of the previous call and
5210 * the bytes of the current call. Use the end of the
5211 * conversion buffer for this. */
5212 fromlen
= len
+ ip
->bw_restlen
;
5213 from
= (char *)ip
->bw_conv_buf
+ ip
->bw_conv_buflen
- fromlen
;
5214 mch_memmove((void *)from
, ip
->bw_rest
, (size_t)ip
->bw_restlen
);
5215 mch_memmove((void *)(from
+ ip
->bw_restlen
), buf
, (size_t)len
);
5216 tolen
= ip
->bw_conv_buflen
- fromlen
;
5220 from
= (const char *)buf
;
5222 tolen
= ip
->bw_conv_buflen
;
5224 to
= (char *)ip
->bw_conv_buf
;
5228 size_t save_len
= tolen
;
5230 /* output the initial shift state sequence */
5231 (void)iconv(ip
->bw_iconv_fd
, NULL
, NULL
, &to
, &tolen
);
5233 /* There is a bug in iconv() on Linux (which appears to be
5234 * wide-spread) which sets "to" to NULL and messes up "tolen".
5238 to
= (char *)ip
->bw_conv_buf
;
5241 ip
->bw_first
= FALSE
;
5245 * If iconv() has an error or there is not enough room, fail.
5247 if ((iconv(ip
->bw_iconv_fd
, (void *)&from
, &fromlen
, &to
, &tolen
)
5248 == (size_t)-1 && ICONV_ERRNO
!= ICONV_EINVAL
)
5249 || fromlen
> CONV_RESTLEN
)
5251 ip
->bw_conv_error
= TRUE
;
5255 /* copy remainder to ip->bw_rest[] to be used for the next call. */
5257 mch_memmove(ip
->bw_rest
, (void *)from
, fromlen
);
5258 ip
->bw_restlen
= (int)fromlen
;
5260 buf
= ip
->bw_conv_buf
;
5261 len
= (int)((char_u
*)to
- ip
->bw_conv_buf
);
5265 #endif /* FEAT_MBYTE */
5268 if (flags
& FIO_ENCRYPTED
) /* encrypt the data */
5272 for (i
= 0; i
< len
; i
++)
5275 buf
[i
] = ZENCODE(ztemp
, t
);
5280 /* Repeat the write(), it may be interrupted by a signal. */
5283 wlen
= vim_write(ip
->bw_fd
, buf
, len
);
5284 if (wlen
<= 0) /* error! */
5294 * Convert a Unicode character to bytes.
5297 ucs2bytes(c
, pp
, flags
)
5298 unsigned c
; /* in: character */
5299 char_u
**pp
; /* in/out: pointer to result */
5300 int flags
; /* FIO_ flags */
5307 if (flags
& FIO_UCS4
)
5309 if (flags
& FIO_ENDIAN_L
)
5324 else if (flags
& (FIO_UCS2
| FIO_UTF16
))
5328 if (flags
& FIO_UTF16
)
5330 /* Make two words, ten bits of the character in each. First
5331 * word is 0xd800 - 0xdbff, second one 0xdc00 - 0xdfff */
5335 cc
= ((c
>> 10) & 0x3ff) + 0xd800;
5336 if (flags
& FIO_ENDIAN_L
)
5339 *p
++ = ((unsigned)cc
>> 8);
5343 *p
++ = ((unsigned)cc
>> 8);
5346 c
= (c
& 0x3ff) + 0xdc00;
5351 if (flags
& FIO_ENDIAN_L
)
5378 * Return TRUE if "a" and "b" are the same 'encoding'.
5379 * Ignores difference between "ansi" and "latin1", "ucs-4" and "ucs-4be", etc.
5388 if (STRCMP(a
, b
) == 0)
5390 f
= get_fio_flags(a
);
5391 return (f
!= 0 && get_fio_flags(b
) == f
);
5395 * Check "ptr" for a unicode encoding and return the FIO_ flags needed for the
5396 * internal conversion.
5397 * if "ptr" is an empty string, use 'encoding'.
5408 prop
= enc_canon_props(ptr
);
5409 if (prop
& ENC_UNICODE
)
5411 if (prop
& ENC_2BYTE
)
5413 if (prop
& ENC_ENDIAN_L
)
5414 return FIO_UCS2
| FIO_ENDIAN_L
;
5417 if (prop
& ENC_4BYTE
)
5419 if (prop
& ENC_ENDIAN_L
)
5420 return FIO_UCS4
| FIO_ENDIAN_L
;
5423 if (prop
& ENC_2WORD
)
5425 if (prop
& ENC_ENDIAN_L
)
5426 return FIO_UTF16
| FIO_ENDIAN_L
;
5431 if (prop
& ENC_LATIN1
)
5433 /* must be ENC_DBCS, requires iconv() */
5439 * Check "ptr" for a MS-Windows codepage name and return the FIO_ flags needed
5440 * for the conversion MS-Windows can do for us. Also accept "utf-8".
5441 * Used for conversion between 'encoding' and 'fileencoding'.
5444 get_win_fio_flags(ptr
)
5449 /* Cannot do this when 'encoding' is not utf-8 and not a codepage. */
5450 if (!enc_utf8
&& enc_codepage
<= 0)
5453 cp
= encname2codepage(ptr
);
5456 # ifdef CP_UTF8 /* VC 4.1 doesn't define CP_UTF8 */
5457 if (STRCMP(ptr
, "utf-8") == 0)
5463 return FIO_PUT_CP(cp
) | FIO_CODEPAGE
;
5469 * Check "ptr" for a Carbon supported encoding and return the FIO_ flags
5470 * needed for the internal conversion to/from utf-8 or latin1.
5473 get_mac_fio_flags(ptr
)
5476 if ((enc_utf8
|| STRCMP(p_enc
, "latin1") == 0)
5477 && (enc_canon_props(ptr
) & ENC_MACROMAN
))
5478 return FIO_MACROMAN
;
5484 * Check for a Unicode BOM (Byte Order Mark) at the start of p[size].
5485 * "size" must be at least 2.
5486 * Return the name of the encoding and set "*lenp" to the length.
5487 * Returns NULL when no BOM found.
5490 check_for_bom(p
, size
, lenp
, flags
)
5499 if (p
[0] == 0xef && p
[1] == 0xbb && size
>= 3 && p
[2] == 0xbf
5500 && (flags
== FIO_ALL
|| flags
== 0))
5502 name
= "utf-8"; /* EF BB BF */
5505 else if (p
[0] == 0xff && p
[1] == 0xfe)
5507 if (size
>= 4 && p
[2] == 0 && p
[3] == 0
5508 && (flags
== FIO_ALL
|| flags
== (FIO_UCS4
| FIO_ENDIAN_L
)))
5510 name
= "ucs-4le"; /* FF FE 00 00 */
5513 else if (flags
== FIO_ALL
|| flags
== (FIO_UCS2
| FIO_ENDIAN_L
))
5514 name
= "ucs-2le"; /* FF FE */
5515 else if (flags
== (FIO_UTF16
| FIO_ENDIAN_L
))
5516 name
= "utf-16le"; /* FF FE */
5518 else if (p
[0] == 0xfe && p
[1] == 0xff
5519 && (flags
== FIO_ALL
|| flags
== FIO_UCS2
|| flags
== FIO_UTF16
))
5521 if (flags
== FIO_UTF16
)
5522 name
= "utf-16"; /* FE FF */
5524 name
= "ucs-2"; /* FE FF */
5526 else if (size
>= 4 && p
[0] == 0 && p
[1] == 0 && p
[2] == 0xfe
5527 && p
[3] == 0xff && (flags
== FIO_ALL
|| flags
== FIO_UCS4
))
5529 name
= "ucs-4"; /* 00 00 FE FF */
5534 return (char_u
*)name
;
5538 * Generate a BOM in "buf[4]" for encoding "name".
5539 * Return the length of the BOM (zero when no BOM).
5549 flags
= get_fio_flags(name
);
5551 /* Can't put a BOM in a non-Unicode file. */
5552 if (flags
== FIO_LATIN1
|| flags
== 0)
5555 if (flags
== FIO_UTF8
) /* UTF-8 */
5563 (void)ucs2bytes(0xfeff, &p
, flags
);
5564 return (int)(p
- buf
);
5568 #if defined(FEAT_VIMINFO) || defined(FEAT_BROWSE) || \
5569 defined(FEAT_QUICKFIX) || defined(FEAT_AUTOCMD) || defined(PROTO)
5571 * Try to find a shortname by comparing the fullname with the current
5573 * Returns "full_path" or pointer into "full_path" if shortened.
5576 shorten_fname1(full_path
)
5579 char_u dirname
[MAXPATHL
];
5580 char_u
*p
= full_path
;
5582 if (mch_dirname(dirname
, MAXPATHL
) == OK
)
5584 p
= shorten_fname(full_path
, dirname
);
5585 if (p
== NULL
|| *p
== NUL
)
5593 * Try to find a shortname by comparing the fullname with the current
5595 * Returns NULL if not shorter name possible, pointer into "full_path"
5599 shorten_fname(full_path
, dir_name
)
5606 if (full_path
== NULL
)
5608 len
= (int)STRLEN(dir_name
);
5609 if (fnamencmp(dir_name
, full_path
, len
) == 0)
5611 p
= full_path
+ len
;
5612 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5614 * MSDOS: when a file is in the root directory, dir_name will end in a
5615 * slash, since C: by itself does not define a specific dir. In this
5616 * case p may already be correct. <negri>
5618 if (!((len
> 2) && (*(p
- 2) == ':')))
5621 if (vim_ispathsep(*p
))
5623 #ifndef VMS /* the path separator is always part of the path */
5629 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
5631 * When using a file in the current drive, remove the drive name:
5632 * "A:\dir\file" -> "\dir\file". This helps when moving a session file on
5633 * a floppy from "A:\dir" to "B:\dir".
5636 && TOUPPER_LOC(full_path
[0]) == TOUPPER_LOC(dir_name
[0])
5637 && full_path
[1] == ':'
5638 && vim_ispathsep(full_path
[2]))
5647 * Shorten filenames for all buffers.
5648 * When "force" is TRUE: Use full path from now on for files currently being
5649 * edited, both for file name and swap file name. Try to shorten the file
5650 * names a bit, if safe to do so.
5651 * When "force" is FALSE: Only try to shorten absolute file names.
5652 * For buffers that have buftype "nofile" or "scratch": never change the file
5656 shorten_fnames(force
)
5659 char_u dirname
[MAXPATHL
];
5663 mch_dirname(dirname
, MAXPATHL
);
5664 for (buf
= firstbuf
; buf
!= NULL
; buf
= buf
->b_next
)
5666 if (buf
->b_fname
!= NULL
5667 #ifdef FEAT_QUICKFIX
5670 && !path_with_url(buf
->b_fname
)
5672 || buf
->b_sfname
== NULL
5673 || mch_isFullName(buf
->b_sfname
)))
5675 vim_free(buf
->b_sfname
);
5676 buf
->b_sfname
= NULL
;
5677 p
= shorten_fname(buf
->b_ffname
, dirname
);
5680 buf
->b_sfname
= vim_strsave(p
);
5681 buf
->b_fname
= buf
->b_sfname
;
5683 if (p
== NULL
|| buf
->b_fname
== NULL
)
5684 buf
->b_fname
= buf
->b_ffname
;
5687 /* Always make the swap file name a full path, a "nofile" buffer may
5688 * also have a swap file. */
5689 mf_fullname(buf
->b_ml
.ml_mfp
);
5692 status_redraw_all();
5693 redraw_tabline
= TRUE
;
5697 #if (defined(FEAT_DND) && defined(FEAT_GUI_GTK)) \
5698 || defined(FEAT_GUI_MSWIN) \
5699 || defined(FEAT_GUI_MAC) \
5701 || defined(FEAT_GUI_MACVIM)
5703 * Shorten all filenames in "fnames[count]" by current directory.
5706 shorten_filenames(fnames
, count
)
5711 char_u dirname
[MAXPATHL
];
5714 if (fnames
== NULL
|| count
< 1)
5716 mch_dirname(dirname
, sizeof(dirname
));
5717 for (i
= 0; i
< count
; ++i
)
5719 if ((p
= shorten_fname(fnames
[i
], dirname
)) != NULL
)
5721 /* shorten_fname() returns pointer in given "fnames[i]". If free
5722 * "fnames[i]" first, "p" becomes invalid. So we need to copy
5723 * "p" first then free fnames[i]. */
5725 vim_free(fnames
[i
]);
5733 * add extention to file name - change path/fo.o.h to path/fo.o.h.ext or
5734 * fo_o_h.ext for MSDOS or when shortname option set.
5736 * Assumed that fname is a valid name found in the filesystem we assure that
5737 * the return value is a different name and ends in 'ext'.
5738 * "ext" MUST be at most 4 characters long if it starts with a dot, 3
5739 * characters otherwise.
5740 * Space for the returned name is allocated, must be freed later.
5741 * Returns NULL when out of memory.
5744 modname(fname
, ext
, prepend_dot
)
5745 char_u
*fname
, *ext
;
5746 int prepend_dot
; /* may prepend a '.' to file name */
5752 (curbuf
->b_p_sn
|| curbuf
->b_shortname
),
5754 fname
, ext
, prepend_dot
);
5758 buf_modname(shortname
, fname
, ext
, prepend_dot
)
5759 int shortname
; /* use 8.3 file name */
5760 char_u
*fname
, *ext
;
5761 int prepend_dot
; /* may prepend a '.' to file name */
5767 int fnamelen
, extlen
;
5769 extlen
= (int)STRLEN(ext
);
5772 * If there is no file name we must get the name of the current directory
5773 * (we need the full path in case :cd is used).
5775 if (fname
== NULL
|| *fname
== NUL
)
5777 retval
= alloc((unsigned)(MAXPATHL
+ extlen
+ 3));
5780 if (mch_dirname(retval
, MAXPATHL
) == FAIL
||
5781 (fnamelen
= (int)STRLEN(retval
)) == 0)
5786 if (!after_pathsep(retval
, retval
+ fnamelen
))
5788 retval
[fnamelen
++] = PATHSEP
;
5789 retval
[fnamelen
] = NUL
;
5792 prepend_dot
= FALSE
; /* nothing to prepend a dot to */
5797 fnamelen
= (int)STRLEN(fname
);
5798 retval
= alloc((unsigned)(fnamelen
+ extlen
+ 3));
5801 STRCPY(retval
, fname
);
5803 vms_remove_version(retval
); /* we do not need versions here */
5808 * search backwards until we hit a '/', '\' or ':' replacing all '.'
5809 * by '_' for MSDOS or when shortname option set and ext starts with a dot.
5810 * Then truncate what is after the '/', '\' or ':' to 8 characters for
5811 * MSDOS and 26 characters for AMIGA, a lot more for UNIX.
5813 for (ptr
= retval
+ fnamelen
; ptr
> retval
; mb_ptr_back(retval
, ptr
))
5817 # ifdef USE_LONG_FNAME
5818 && (!USE_LONG_FNAME
|| shortname
)
5820 # ifndef SHORT_FNAME
5825 if (*ptr
== '.') /* replace '.' by '_' */
5828 if (vim_ispathsep(*ptr
))
5835 /* the file name has at most BASENAMELEN characters. */
5837 if (STRLEN(ptr
) > (unsigned)BASENAMELEN
)
5838 ptr
[BASENAMELEN
] = '\0';
5841 s
= ptr
+ STRLEN(ptr
);
5844 * For 8.3 file names we may have to reduce the length.
5846 #ifdef USE_LONG_FNAME
5847 if (!USE_LONG_FNAME
|| shortname
)
5849 # ifndef SHORT_FNAME
5855 * If there is no file name, or the file name ends in '/', and the
5856 * extension starts with '.', put a '_' before the dot, because just
5857 * ".ext" is invalid.
5859 if (fname
== NULL
|| *fname
== NUL
5860 || vim_ispathsep(fname
[STRLEN(fname
) - 1]))
5870 * If the extension starts with '.', truncate the base name at 8
5874 /* We normally use '/', but swap files are '_' */
5875 else if (*ext
== '/' || *ext
== '_')
5877 else if (*ext
== '.')
5880 if (s
- ptr
> (size_t)8)
5887 * If the extension doesn't start with '.', and the file name
5888 * doesn't have an extension yet, append a '.'
5891 else if ((e
= vim_strchr(ptr
, '/')) == NULL
)
5894 else if ((e
= vim_strchr(ptr
, '.')) == NULL
)
5898 * If the extension doesn't start with '.', and there already is an
5899 * extension, it may need to be truncated
5901 else if ((int)STRLEN(e
) + extlen
> 4)
5904 #if defined(OS2) || defined(USE_LONG_FNAME) || defined(WIN3264)
5906 * If there is no file name, and the extension starts with '.', put a
5907 * '_' before the dot, because just ".ext" may be invalid if it's on a
5908 * FAT partition, and on HPFS it doesn't matter.
5910 else if ((fname
== NULL
|| *fname
== NUL
) && *ext
== '.')
5915 * Append the extention.
5916 * ext can start with '.' and cannot exceed 3 more characters.
5924 if (prepend_dot
&& !shortname
&& *(e
= gettail(retval
)) !=
5930 #ifdef USE_LONG_FNAME
5935 mch_memmove(e
+ 1, e
, STRLEN(e
) + 1);
5945 * Check that, after appending the extension, the file name is really
5948 if (fname
!= NULL
&& STRCMP(fname
, retval
) == 0)
5950 /* we search for a character that can be replaced by '_' */
5959 if (s
< ptr
) /* fname was "________.<ext>", how tricky! */
5966 * Like fgets(), but if the file line is too long, it is truncated and the
5967 * rest of the line is thrown away. Returns TRUE for end-of-file.
5970 vim_fgets(buf
, size
, fp
)
5976 #define FGETS_SIZE 200
5977 char tbuf
[FGETS_SIZE
];
5979 buf
[size
- 2] = NUL
;
5981 eof
= fgets_cr((char *)buf
, size
, fp
);
5983 eof
= fgets((char *)buf
, size
, fp
);
5985 if (buf
[size
- 2] != NUL
&& buf
[size
- 2] != '\n')
5987 buf
[size
- 1] = NUL
; /* Truncate the line */
5989 /* Now throw away the rest of the line: */
5992 tbuf
[FGETS_SIZE
- 2] = NUL
;
5994 fgets_cr((char *)tbuf
, FGETS_SIZE
, fp
);
5996 fgets((char *)tbuf
, FGETS_SIZE
, fp
);
5998 } while (tbuf
[FGETS_SIZE
- 2] != NUL
&& tbuf
[FGETS_SIZE
- 2] != '\n');
6000 return (eof
== NULL
);
6003 #if defined(USE_CR) || defined(PROTO)
6005 * Like vim_fgets(), but accept any line terminator: CR, CR-LF or LF.
6006 * Returns TRUE for end-of-file.
6007 * Only used for the Mac, because it's much slower than vim_fgets().
6010 tag_fgets(buf
, size
, fp
)
6029 /* Always store a NL for end-of-line. */
6033 if (c
!= '\n') /* Macintosh format: single CR. */
6048 * rename() only works if both files are on the same file system, this
6049 * function will (attempts to?) copy the file across if rename fails -- webb
6050 * Return -1 for failure, 0 for success.
6053 vim_rename(from
, to
)
6060 char *errmsg
= NULL
;
6068 vim_acl_T acl
; /* ACL from original file */
6072 * When the names are identical, there is nothing to do.
6074 if (fnamecmp(from
, to
) == 0)
6078 * Fail if the "from" file doesn't exist. Avoids that "to" is deleted.
6080 if (mch_stat((char *)from
, &st
) < 0)
6084 * Delete the "to" file, this is required on some systems to make the
6085 * mch_rename() work, on other systems it makes sure that we don't have
6086 * two files when the mch_rename() fails.
6091 * With MSDOS-compatible filesystems (crossdos, messydos) it is possible
6092 * that the name of the "to" file is the same as the "from" file, even
6093 * though the names are different. To avoid the chance of accidentally
6094 * deleting the "from" file (horror!) we lock it during the remove.
6096 * When used for making a backup before writing the file: This should not
6097 * happen with ":w", because startscript() should detect this problem and
6098 * set buf->b_shortname, causing modname() to return a correct ".bak" file
6099 * name. This problem does exist with ":w filename", but then the
6100 * original file will be somewhere else so the backup isn't really
6101 * important. If autoscripting is off the rename may fail.
6103 flock
= Lock((UBYTE
*)from
, (long)ACCESS_READ
);
6112 * First try a normal rename, return if it works.
6114 if (mch_rename((char *)from
, (char *)to
) == 0)
6118 * Rename() failed, try copying the file.
6120 perm
= mch_getperm(from
);
6122 /* For systems that support ACL: get the ACL from the original file. */
6123 acl
= mch_get_acl(from
);
6125 fd_in
= mch_open((char *)from
, O_RDONLY
|O_EXTRA
, 0);
6129 /* Create the new file with same permissions as the original. */
6130 fd_out
= mch_open((char *)to
,
6131 O_CREAT
|O_EXCL
|O_WRONLY
|O_EXTRA
|O_NOFOLLOW
, (int)perm
);
6138 buffer
= (char *)alloc(BUFSIZE
);
6146 while ((n
= vim_read(fd_in
, buffer
, BUFSIZE
)) > 0)
6147 if (vim_write(fd_out
, buffer
, n
) != n
)
6149 errmsg
= _("E208: Error writing to \"%s\"");
6155 if (close(fd_out
) < 0)
6156 errmsg
= _("E209: Error closing \"%s\"");
6159 errmsg
= _("E210: Error reading \"%s\"");
6162 #ifndef UNIX /* for Unix mch_open() already set the permission */
6163 mch_setperm(to
, perm
);
6166 mch_set_acl(to
, acl
);
6177 static int already_warned
= FALSE
;
6180 * Check if any not hidden buffer has been changed.
6181 * Postpone the check if there are characters in the stuff buffer, a global
6182 * command is being executed, a mapping is being executed or an autocommand is
6184 * Returns TRUE if some message was written (screen should be redrawn and
6185 * cursor positioned).
6188 check_timestamps(focus
)
6189 int focus
; /* called for GUI focus event */
6195 /* Don't check timestamps while system() or another low-level function may
6196 * cause us to lose and gain focus. */
6197 if (no_check_timestamps
> 0)
6200 /* Avoid doing a check twice. The OK/Reload dialog can cause a focus
6201 * event and we would keep on checking if the file is steadily growing.
6202 * Do check again after typing something. */
6203 if (focus
&& did_check_timestamps
)
6205 need_check_timestamps
= TRUE
;
6209 if (!stuff_empty() || global_busy
|| !typebuf_typed()
6211 || autocmd_busy
|| curbuf_lock
> 0
6214 need_check_timestamps
= TRUE
; /* check later */
6218 did_check_timestamps
= TRUE
;
6219 already_warned
= FALSE
;
6220 for (buf
= firstbuf
; buf
!= NULL
; )
6222 /* Only check buffers in a window. */
6223 if (buf
->b_nwindows
> 0)
6225 n
= buf_check_timestamp(buf
, focus
);
6228 if (n
> 0 && !buf_valid(buf
))
6230 /* Autocommands have removed the buffer, start at the
6231 * first one again. */
6239 need_check_timestamps
= FALSE
;
6240 if (need_wait_return
&& didit
== 2)
6242 /* make sure msg isn't overwritten */
6243 msg_puts((char_u
*)"\n");
6251 * Move all the lines from buffer "frombuf" to buffer "tobuf".
6252 * Return OK or FAIL. When FAIL "tobuf" is incomplete and/or "frombuf" is not
6256 move_lines(frombuf
, tobuf
)
6260 buf_T
*tbuf
= curbuf
;
6265 /* Copy the lines in "frombuf" to "tobuf". */
6267 for (lnum
= 1; lnum
<= frombuf
->b_ml
.ml_line_count
; ++lnum
)
6269 p
= vim_strsave(ml_get_buf(frombuf
, lnum
, FALSE
));
6270 if (p
== NULL
|| ml_append(lnum
- 1, p
, 0, FALSE
) == FAIL
)
6279 /* Delete all the lines in "frombuf". */
6283 for (lnum
= curbuf
->b_ml
.ml_line_count
; lnum
> 0; --lnum
)
6284 if (ml_delete(lnum
, FALSE
) == FAIL
)
6286 /* Oops! We could try putting back the saved lines, but that
6287 * might fail again... */
6298 * Check if buffer "buf" has been changed.
6299 * Also check if the file for a new buffer unexpectedly appeared.
6300 * return 1 if a changed buffer was found.
6301 * return 2 if a message has been displayed.
6302 * return 0 otherwise.
6306 buf_check_timestamp(buf
, focus
)
6308 int focus
; /* called for GUI focus event */
6317 int helpmesg
= FALSE
;
6319 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6320 int can_reload
= FALSE
;
6322 size_t orig_size
= buf
->b_orig_size
;
6323 int orig_mode
= buf
->b_orig_mode
;
6325 int save_mouse_correct
= need_mouse_correct
;
6328 static int busy
= FALSE
;
6334 /* If there is no file name, the buffer is not loaded, 'buftype' is
6335 * set, we are in the middle of a save or being called recursively: ignore
6337 if (buf
->b_ffname
== NULL
6338 || buf
->b_ml
.ml_mfp
== NULL
6339 #if defined(FEAT_QUICKFIX)
6340 || *buf
->b_p_bt
!= NUL
6346 #ifdef FEAT_NETBEANS_INTG
6347 || isNetbeansBuffer(buf
)
6352 if ( !(buf
->b_flags
& BF_NOTEDITED
)
6353 && buf
->b_mtime
!= 0
6354 && ((stat_res
= mch_stat((char *)buf
->b_ffname
, &st
)) < 0
6355 || time_differs((long)st
.st_mtime
, buf
->b_mtime
)
6357 || (int)st
.st_mode
!= buf
->b_orig_mode
6359 || mch_getperm(buf
->b_ffname
) != buf
->b_orig_mode
6365 /* set b_mtime to stop further warnings (e.g., when executing
6366 * FileChangedShell autocmd) */
6370 buf
->b_orig_size
= 0;
6371 buf
->b_orig_mode
= 0;
6374 buf_store_time(buf
, &st
, buf
->b_ffname
);
6376 /* Don't do anything for a directory. Might contain the file
6378 if (mch_isdir(buf
->b_fname
))
6382 * If 'autoread' is set, the buffer has no changes and the file still
6383 * exists, reload the buffer. Use the buffer-local option value if it
6384 * was set, the global option value otherwise.
6386 else if ((buf
->b_p_ar
>= 0 ? buf
->b_p_ar
: p_ar
)
6387 && !bufIsChanged(buf
) && stat_res
>= 0)
6393 else if (bufIsChanged(buf
))
6394 reason
= "conflict";
6395 else if (orig_size
!= buf
->b_orig_size
|| buf_contents_changed(buf
))
6397 else if (orig_mode
!= buf
->b_orig_mode
)
6404 * Only give the warning if there are no FileChangedShell
6406 * Avoid being called recursively by setting "busy".
6410 set_vim_var_string(VV_FCS_REASON
, (char_u
*)reason
, -1);
6411 set_vim_var_string(VV_FCS_CHOICE
, (char_u
*)"", -1);
6413 n
= apply_autocmds(EVENT_FILECHANGEDSHELL
,
6414 buf
->b_fname
, buf
->b_fname
, FALSE
, buf
);
6418 if (!buf_valid(buf
))
6419 EMSG(_("E246: FileChangedShell autocommand deleted buffer"));
6421 s
= get_vim_var_str(VV_FCS_CHOICE
);
6422 if (STRCMP(s
, "reload") == 0 && *reason
!= 'd')
6424 else if (STRCMP(s
, "ask") == 0)
6434 mesg
= _("E211: File \"%s\" no longer available");
6438 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6442 * Check if the file contents really changed to avoid
6443 * giving a warning when only the timestamp was set (e.g.,
6444 * checked out of CVS). Always warn when the buffer was
6447 if (reason
[2] == 'n')
6449 mesg
= _("W12: Warning: File \"%s\" has changed and the buffer was changed in Vim as well");
6450 mesg2
= _("See \":help W12\" for more info.");
6452 else if (reason
[1] == 'h')
6454 mesg
= _("W11: Warning: File \"%s\" has changed since editing started");
6455 mesg2
= _("See \":help W11\" for more info.");
6457 else if (*reason
== 'm')
6459 mesg
= _("W16: Warning: Mode of file \"%s\" has changed since editing started");
6460 mesg2
= _("See \":help W16\" for more info.");
6462 /* Else: only timestamp changed, ignored */
6468 else if ((buf
->b_flags
& BF_NEW
) && !(buf
->b_flags
& BF_NEW_W
)
6469 && vim_fexists(buf
->b_ffname
))
6472 mesg
= _("W13: Warning: File \"%s\" has been created after editing started");
6473 buf
->b_flags
|= BF_NEW_W
;
6474 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6481 path
= home_replace_save(buf
, buf
->b_fname
);
6486 tbuf
= alloc((unsigned)(STRLEN(path
) + STRLEN(mesg
)
6487 + STRLEN(mesg2
) + 2));
6488 sprintf((char *)tbuf
, mesg
, path
);
6489 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG)
6495 STRCAT(tbuf
, mesg2
);
6497 if (do_dialog(VIM_WARNING
, (char_u
*)_("Warning"), tbuf
,
6498 (char_u
*)_("&OK\n&Load File"), 1, NULL
) == 2)
6503 if (State
> NORMAL_BUSY
|| (State
& CMDLINE
) || already_warned
)
6508 STRCAT(tbuf
, mesg2
);
6515 # ifdef FEAT_AUTOCMD
6520 msg_puts_attr(tbuf
, hl_attr(HLF_E
) + MSG_HIST
);
6522 msg_puts_attr((char_u
*)mesg2
,
6523 hl_attr(HLF_W
) + MSG_HIST
);
6526 if (emsg_silent
== 0)
6532 /* give the user some time to think about it */
6533 ui_delay(1000L, TRUE
);
6535 /* don't redraw and erase the message */
6536 redraw_cmdline
= FALSE
;
6539 already_warned
= TRUE
;
6548 /* Reload the buffer. */
6549 buf_reload(buf
, orig_mode
);
6553 (void)apply_autocmds(EVENT_FILECHANGEDSHELLPOST
,
6554 buf
->b_fname
, buf
->b_fname
, FALSE
, buf
);
6557 /* restore this in case an autocommand has set it; it would break
6559 need_mouse_correct
= save_mouse_correct
;
6566 * Reload a buffer that is already loaded.
6567 * Used when the file was changed outside of Vim.
6568 * "orig_mode" is buf->b_orig_mode before the need for reloading was detected.
6569 * buf->b_orig_mode may have been reset already.
6572 buf_reload(buf
, orig_mode
)
6578 linenr_T old_topline
;
6579 int old_ro
= buf
->b_p_ro
;
6584 /* set curwin/curbuf for "buf" and save some things */
6585 aucmd_prepbuf(&aco
, buf
);
6587 /* We only want to read the text from the file, not reset the syntax
6588 * highlighting, clear marks, diff status, etc. Force the fileformat
6589 * and encoding to be the same. */
6590 if (prep_exarg(&ea
, buf
) == OK
)
6592 old_cursor
= curwin
->w_cursor
;
6593 old_topline
= curwin
->w_topline
;
6596 * To behave like when a new file is edited (matters for
6597 * BufReadPost autocommands) we first need to delete the current
6598 * buffer contents. But if reading the file fails we should keep
6599 * the old contents. Can't use memory only, the file might be
6600 * too big. Use a hidden buffer to move the buffer contents to.
6606 /* Allocate a buffer without putting it in the buffer list. */
6607 savebuf
= buflist_new(NULL
, NULL
, (linenr_T
)1, BLN_DUMMY
);
6608 if (savebuf
!= NULL
&& buf
== curbuf
)
6610 /* Open the memline. */
6612 curwin
->w_buffer
= savebuf
;
6613 saved
= ml_open(curbuf
);
6615 curwin
->w_buffer
= buf
;
6617 if (savebuf
== NULL
|| saved
== FAIL
|| buf
!= curbuf
6618 || move_lines(buf
, savebuf
) == FAIL
)
6620 EMSG2(_("E462: Could not prepare for reloading \"%s\""),
6628 curbuf
->b_flags
|= BF_CHECK_RO
; /* check for RO again */
6630 keep_filetype
= TRUE
; /* don't detect 'filetype' */
6632 if (readfile(buf
->b_ffname
, buf
->b_fname
, (linenr_T
)0,
6634 (linenr_T
)MAXLNUM
, &ea
, READ_NEW
) == FAIL
)
6636 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6639 EMSG2(_("E321: Could not reload \"%s\""), buf
->b_fname
);
6640 if (savebuf
!= NULL
&& buf_valid(savebuf
) && buf
== curbuf
)
6642 /* Put the text back from the save buffer. First
6643 * delete any lines that readfile() added. */
6645 if (ml_delete(buf
->b_ml
.ml_line_count
, FALSE
) == FAIL
)
6647 (void)move_lines(savebuf
, buf
);
6650 else if (buf
== curbuf
)
6652 /* Mark the buffer as unmodified and free undo info. */
6653 unchanged(buf
, TRUE
);
6660 if (savebuf
!= NULL
&& buf_valid(savebuf
))
6661 wipe_buffer(savebuf
, FALSE
);
6664 /* Invalidate diff info if necessary. */
6665 diff_invalidate(curbuf
);
6668 /* Restore the topline and cursor position and check it (lines may
6669 * have been removed). */
6670 if (old_topline
> curbuf
->b_ml
.ml_line_count
)
6671 curwin
->w_topline
= curbuf
->b_ml
.ml_line_count
;
6673 curwin
->w_topline
= old_topline
;
6674 curwin
->w_cursor
= old_cursor
;
6678 keep_filetype
= FALSE
;
6684 /* Update folds unless they are defined manually. */
6686 if (wp
->w_buffer
== curwin
->w_buffer
6687 && !foldmethodIsManual(wp
))
6691 /* If the mode didn't change and 'readonly' was set, keep the old
6692 * value; the user probably used the ":view" command. But don't
6693 * reset it, might have had a read error. */
6694 if (orig_mode
== curbuf
->b_orig_mode
)
6695 curbuf
->b_p_ro
|= old_ro
;
6698 /* restore curwin/curbuf and a few other things */
6699 aucmd_restbuf(&aco
);
6700 /* Careful: autocommands may have made "buf" invalid! */
6705 buf_store_time(buf
, st
, fname
)
6710 buf
->b_mtime
= (long)st
->st_mtime
;
6711 buf
->b_orig_size
= (size_t)st
->st_size
;
6713 buf
->b_orig_mode
= (int)st
->st_mode
;
6715 buf
->b_orig_mode
= mch_getperm(fname
);
6720 * Adjust the line with missing eol, used for the next write.
6721 * Used for do_filter(), when the input lines for the filter are deleted.
6724 write_lnum_adjust(offset
)
6727 if (write_no_eol_lnum
!= 0) /* only if there is a missing eol */
6728 write_no_eol_lnum
+= offset
;
6731 #if defined(TEMPDIRNAMES) || defined(PROTO)
6732 static long temp_count
= 0; /* Temp filename counter. */
6735 * Delete the temp directory and all files it contains.
6744 if (vim_tempdir
!= NULL
)
6746 sprintf((char *)NameBuff
, "%s*", vim_tempdir
);
6747 if (gen_expand_wildcards(1, &NameBuff
, &file_count
, &files
,
6748 EW_DIR
|EW_FILE
|EW_SILENT
) == OK
)
6750 for (i
= 0; i
< file_count
; ++i
)
6751 mch_remove(files
[i
]);
6752 FreeWild(file_count
, files
);
6754 gettail(NameBuff
)[-1] = NUL
;
6755 (void)mch_rmdir(NameBuff
);
6757 vim_free(vim_tempdir
);
6764 * vim_tempname(): Return a unique name that can be used for a temp file.
6766 * The temp file is NOT created.
6768 * The returned pointer is to allocated memory.
6769 * The returned pointer is NULL if no valid name was found.
6773 vim_tempname(extra_char
)
6774 int extra_char
; /* character to use in the name instead of '?' */
6777 char_u itmp
[L_tmpnam
]; /* use tmpnam() */
6779 char_u itmp
[TEMPNAMELEN
];
6783 static char *(tempdirs
[]) = {TEMPDIRNAMES
};
6792 * This will create a directory for private use by this instance of Vim.
6793 * This is done once, and the same directory is used for all temp files.
6794 * This method avoids security problems because of symlink attacks et al.
6795 * It's also a bit faster, because we only need to check for an existing
6796 * file when creating the directory and not for each temp file.
6798 if (vim_tempdir
== NULL
)
6801 * Try the entries in TEMPDIRNAMES to create the temp directory.
6803 for (i
= 0; i
< sizeof(tempdirs
) / sizeof(char *); ++i
)
6805 /* expand $TMP, leave room for "/v1100000/999999999" */
6806 expand_env((char_u
*)tempdirs
[i
], itmp
, TEMPNAMELEN
- 20);
6807 if (mch_isdir(itmp
)) /* directory exists */
6810 /* If $TMP contains a forward slash (perhaps using bash or
6811 * tcsh), don't add a backslash, use a forward slash!
6812 * Adding 2 backslashes didn't work. */
6813 if (vim_strchr(itmp
, '/') != NULL
)
6819 /* Get an arbitrary number of up to 6 digits. When it's
6820 * unlikely that it already exists it will be faster,
6821 * otherwise it doesn't matter. The use of mkdir() avoids any
6822 * security problems because of the predictable number. */
6823 nr
= (mch_get_pid() + (long)time(NULL
)) % 1000000L;
6825 /* Try up to 10000 different values until we find a name that
6827 for (off
= 0; off
< 10000L; ++off
)
6830 #if defined(UNIX) || defined(VMS)
6834 sprintf((char *)itmp
+ STRLEN(itmp
), "v%ld", nr
+ off
);
6836 /* If mkdir() does not set errno to EEXIST, check for
6837 * existing file here. There is a race condition then,
6838 * although it's fail-safe. */
6839 if (mch_stat((char *)itmp
, &st
) >= 0)
6842 #if defined(UNIX) || defined(VMS)
6843 /* Make sure the umask doesn't remove the executable bit.
6844 * "repl" has been reported to use "177". */
6845 umask_save
= umask(077);
6847 r
= vim_mkdir(itmp
, 0700);
6848 #if defined(UNIX) || defined(VMS)
6849 (void)umask(umask_save
);
6855 /* Directory was created, use this name.
6856 * Expand to full path; When using the current
6857 * directory a ":cd" would confuse us. */
6858 buf
= alloc((unsigned)MAXPATHL
+ 1);
6861 if (vim_FullName(itmp
, buf
, MAXPATHL
, FALSE
)
6865 if (vim_strchr(buf
, '/') != NULL
)
6870 vim_tempdir
= vim_strsave(buf
);
6876 /* If the mkdir() didn't fail because the file/dir exists,
6877 * we probably can't create any dir here, try another
6879 if (errno
!= EEXIST
)
6883 if (vim_tempdir
!= NULL
)
6889 if (vim_tempdir
!= NULL
)
6891 /* There is no need to check if the file exists, because we own the
6892 * directory and nobody else creates a file in it. */
6893 sprintf((char *)itmp
, "%s%ld", vim_tempdir
, temp_count
++);
6894 return vim_strsave(itmp
);
6899 #else /* TEMPDIRNAMES */
6902 char szTempFile
[_MAX_PATH
+ 1];
6908 if (GetTempPath(_MAX_PATH
, szTempFile
) == 0)
6909 szTempFile
[0] = NUL
; /* GetTempPath() failed, use current dir */
6910 strcpy(buf4
, "VIM");
6911 buf4
[2] = extra_char
; /* make it "VIa", "VIb", etc. */
6912 if (GetTempFileName(szTempFile
, buf4
, 0, itmp
) == 0)
6914 /* GetTempFileName() will create the file, we don't want that */
6915 (void)DeleteFile(itmp
);
6917 /* Backslashes in a temp file name cause problems when filtering with
6918 * "sh". NOTE: This also checks 'shellcmdflag' to help those people who
6919 * didn't set 'shellslash'. */
6920 retval
= vim_strsave(itmp
);
6921 if (*p_shcf
== '-' || p_ssl
)
6922 for (p
= retval
; *p
; ++p
)
6927 # else /* WIN3264 */
6930 /* tmpnam() will make its own name */
6931 if (*tmpnam((char *)itmp
) == NUL
)
6937 /* mktemp() is not working on VMS. It seems to be
6938 * a do-nothing function. Therefore we use tempnam().
6940 sprintf((char *)itmp
, "VIM%c", extra_char
);
6941 p
= (char_u
*)tempnam("tmp:", (char *)itmp
);
6944 /* VMS will use '.LOG' if we don't explicitly specify an extension,
6945 * and VIM will then be unable to find the file later */
6947 STRCAT(itmp
, ".txt");
6953 STRCPY(itmp
, TEMPNAME
);
6954 if ((p
= vim_strchr(itmp
, '?')) != NULL
)
6956 if (mktemp((char *)itmp
) == NULL
)
6961 return vim_strsave(itmp
);
6962 # endif /* WIN3264 */
6963 #endif /* TEMPDIRNAMES */
6966 #if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
6968 * Convert all backslashes in fname to forward slashes in-place.
6971 forward_slash(fname
)
6976 for (p
= fname
; *p
!= NUL
; ++p
)
6978 /* The Big5 encoding can have '\' in the trail byte. */
6979 if (enc_dbcs
!= 0 && (*mb_ptr2len
)(p
) > 1)
6990 * Code for automatic commands.
6992 * Only included when "FEAT_AUTOCMD" has been defined.
6995 #if defined(FEAT_AUTOCMD) || defined(PROTO)
6998 * The autocommands are stored in a list for each event.
6999 * Autocommands for the same pattern, that are consecutive, are joined
7000 * together, to avoid having to match the pattern too often.
7001 * The result is an array of Autopat lists, which point to AutoCmd lists:
7003 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
7004 * Autopat.cmds Autopat.cmds
7007 * AutoCmd.next AutoCmd.next
7015 * first_autopat[1] --> Autopat.next --> NULL
7025 * The order of AutoCmds is important, this is the order in which they were
7026 * defined and will have to be executed.
7028 typedef struct AutoCmd
7030 char_u
*cmd
; /* The command to be executed (NULL
7031 when command has been removed) */
7032 char nested
; /* If autocommands nest here */
7033 char last
; /* last command in list */
7035 scid_T scriptID
; /* script ID where defined */
7037 struct AutoCmd
*next
; /* Next AutoCmd in list */
7040 typedef struct AutoPat
7042 int group
; /* group ID */
7043 char_u
*pat
; /* pattern as typed (NULL when pattern
7044 has been removed) */
7045 int patlen
; /* strlen() of pat */
7046 regprog_T
*reg_prog
; /* compiled regprog for pattern */
7047 char allow_dirs
; /* Pattern may match whole path */
7048 char last
; /* last pattern for apply_autocmds() */
7049 AutoCmd
*cmds
; /* list of commands to do */
7050 struct AutoPat
*next
; /* next AutoPat in AutoPat list */
7051 int buflocal_nr
; /* !=0 for buffer-local AutoPat */
7054 static struct event_name
7056 char *name
; /* event name */
7057 event_T event
; /* event number */
7060 {"BufAdd", EVENT_BUFADD
},
7061 {"BufCreate", EVENT_BUFADD
},
7062 {"BufDelete", EVENT_BUFDELETE
},
7063 {"BufEnter", EVENT_BUFENTER
},
7064 {"BufFilePost", EVENT_BUFFILEPOST
},
7065 {"BufFilePre", EVENT_BUFFILEPRE
},
7066 {"BufHidden", EVENT_BUFHIDDEN
},
7067 {"BufLeave", EVENT_BUFLEAVE
},
7068 {"BufNew", EVENT_BUFNEW
},
7069 {"BufNewFile", EVENT_BUFNEWFILE
},
7070 {"BufRead", EVENT_BUFREADPOST
},
7071 {"BufReadCmd", EVENT_BUFREADCMD
},
7072 {"BufReadPost", EVENT_BUFREADPOST
},
7073 {"BufReadPre", EVENT_BUFREADPRE
},
7074 {"BufUnload", EVENT_BUFUNLOAD
},
7075 {"BufWinEnter", EVENT_BUFWINENTER
},
7076 {"BufWinLeave", EVENT_BUFWINLEAVE
},
7077 {"BufWipeout", EVENT_BUFWIPEOUT
},
7078 {"BufWrite", EVENT_BUFWRITEPRE
},
7079 {"BufWritePost", EVENT_BUFWRITEPOST
},
7080 {"BufWritePre", EVENT_BUFWRITEPRE
},
7081 {"BufWriteCmd", EVENT_BUFWRITECMD
},
7082 {"CmdwinEnter", EVENT_CMDWINENTER
},
7083 {"CmdwinLeave", EVENT_CMDWINLEAVE
},
7084 {"ColorScheme", EVENT_COLORSCHEME
},
7085 {"CursorHold", EVENT_CURSORHOLD
},
7086 {"CursorHoldI", EVENT_CURSORHOLDI
},
7087 {"CursorMoved", EVENT_CURSORMOVED
},
7088 {"CursorMovedI", EVENT_CURSORMOVEDI
},
7089 {"EncodingChanged", EVENT_ENCODINGCHANGED
},
7090 {"FileEncoding", EVENT_ENCODINGCHANGED
},
7091 {"FileAppendPost", EVENT_FILEAPPENDPOST
},
7092 {"FileAppendPre", EVENT_FILEAPPENDPRE
},
7093 {"FileAppendCmd", EVENT_FILEAPPENDCMD
},
7094 {"FileChangedShell",EVENT_FILECHANGEDSHELL
},
7095 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST
},
7096 {"FileChangedRO", EVENT_FILECHANGEDRO
},
7097 {"FileReadPost", EVENT_FILEREADPOST
},
7098 {"FileReadPre", EVENT_FILEREADPRE
},
7099 {"FileReadCmd", EVENT_FILEREADCMD
},
7100 {"FileType", EVENT_FILETYPE
},
7101 {"FileWritePost", EVENT_FILEWRITEPOST
},
7102 {"FileWritePre", EVENT_FILEWRITEPRE
},
7103 {"FileWriteCmd", EVENT_FILEWRITECMD
},
7104 {"FilterReadPost", EVENT_FILTERREADPOST
},
7105 {"FilterReadPre", EVENT_FILTERREADPRE
},
7106 {"FilterWritePost", EVENT_FILTERWRITEPOST
},
7107 {"FilterWritePre", EVENT_FILTERWRITEPRE
},
7108 {"FocusGained", EVENT_FOCUSGAINED
},
7109 {"FocusLost", EVENT_FOCUSLOST
},
7110 {"FuncUndefined", EVENT_FUNCUNDEFINED
},
7111 {"GUIEnter", EVENT_GUIENTER
},
7112 {"GUIFailed", EVENT_GUIFAILED
},
7113 {"InsertChange", EVENT_INSERTCHANGE
},
7114 {"InsertEnter", EVENT_INSERTENTER
},
7115 {"InsertLeave", EVENT_INSERTLEAVE
},
7116 {"MenuPopup", EVENT_MENUPOPUP
},
7117 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST
},
7118 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE
},
7119 {"RemoteReply", EVENT_REMOTEREPLY
},
7120 {"SessionLoadPost", EVENT_SESSIONLOADPOST
},
7121 {"ShellCmdPost", EVENT_SHELLCMDPOST
},
7122 {"ShellFilterPost", EVENT_SHELLFILTERPOST
},
7123 {"SourcePre", EVENT_SOURCEPRE
},
7124 {"SourceCmd", EVENT_SOURCECMD
},
7125 {"SpellFileMissing",EVENT_SPELLFILEMISSING
},
7126 {"StdinReadPost", EVENT_STDINREADPOST
},
7127 {"StdinReadPre", EVENT_STDINREADPRE
},
7128 {"SwapExists", EVENT_SWAPEXISTS
},
7129 {"Syntax", EVENT_SYNTAX
},
7130 {"TabEnter", EVENT_TABENTER
},
7131 {"TabLeave", EVENT_TABLEAVE
},
7132 {"TermChanged", EVENT_TERMCHANGED
},
7133 {"TermResponse", EVENT_TERMRESPONSE
},
7134 {"User", EVENT_USER
},
7135 {"VimEnter", EVENT_VIMENTER
},
7136 {"VimLeave", EVENT_VIMLEAVE
},
7137 {"VimLeavePre", EVENT_VIMLEAVEPRE
},
7138 {"WinEnter", EVENT_WINENTER
},
7139 {"WinLeave", EVENT_WINLEAVE
},
7140 {"VimResized", EVENT_VIMRESIZED
},
7144 static AutoPat
*first_autopat
[NUM_EVENTS
] =
7146 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7147 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7148 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7149 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7150 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
7151 NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
7155 * struct used to keep status while executing autocommands for an event.
7157 typedef struct AutoPatCmd
7159 AutoPat
*curpat
; /* next AutoPat to examine */
7160 AutoCmd
*nextcmd
; /* next AutoCmd to execute */
7161 int group
; /* group being used */
7162 char_u
*fname
; /* fname to match with */
7163 char_u
*sfname
; /* sfname to match with */
7164 char_u
*tail
; /* tail of fname */
7165 event_T event
; /* current event */
7166 int arg_bufnr
; /* initially equal to <abuf>, set to zero when
7168 struct AutoPatCmd
*next
; /* chain of active apc-s for auto-invalidation*/
7171 static AutoPatCmd
*active_apc_list
= NULL
; /* stack of active autocommands */
7174 * augroups stores a list of autocmd group names.
7176 static garray_T augroups
= {0, 0, sizeof(char_u
*), 10, NULL
};
7177 #define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
7180 * The ID of the current group. Group 0 is the default one.
7182 static int current_augroup
= AUGROUP_DEFAULT
;
7184 static int au_need_clean
= FALSE
; /* need to delete marked patterns */
7186 static void show_autocmd
__ARGS((AutoPat
*ap
, event_T event
));
7187 static void au_remove_pat
__ARGS((AutoPat
*ap
));
7188 static void au_remove_cmds
__ARGS((AutoPat
*ap
));
7189 static void au_cleanup
__ARGS((void));
7190 static int au_new_group
__ARGS((char_u
*name
));
7191 static void au_del_group
__ARGS((char_u
*name
));
7192 static event_T event_name2nr
__ARGS((char_u
*start
, char_u
**end
));
7193 static char_u
*event_nr2name
__ARGS((event_T event
));
7194 static char_u
*find_end_event
__ARGS((char_u
*arg
, int have_group
));
7195 static int event_ignored
__ARGS((event_T event
));
7196 static int au_get_grouparg
__ARGS((char_u
**argp
));
7197 static int do_autocmd_event
__ARGS((event_T event
, char_u
*pat
, int nested
, char_u
*cmd
, int forceit
, int group
));
7198 static char_u
*getnextac
__ARGS((int c
, void *cookie
, int indent
));
7199 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
));
7200 static void auto_next_pat
__ARGS((AutoPatCmd
*apc
, int stop_at_last
));
7203 static event_T last_event
;
7204 static int last_group
;
7205 static int autocmd_blocked
= 0; /* block all autocmds */
7208 * Show the autocommands for one AutoPat.
7211 show_autocmd(ap
, event
)
7217 /* Check for "got_int" (here and at various places below), which is set
7218 * when "q" has been hit for the "--more--" prompt */
7221 if (ap
->pat
== NULL
) /* pattern has been removed */
7227 if (event
!= last_event
|| ap
->group
!= last_group
)
7229 if (ap
->group
!= AUGROUP_DEFAULT
)
7231 if (AUGROUP_NAME(ap
->group
) == NULL
)
7232 msg_puts_attr((char_u
*)_("--Deleted--"), hl_attr(HLF_E
));
7234 msg_puts_attr(AUGROUP_NAME(ap
->group
), hl_attr(HLF_T
));
7235 msg_puts((char_u
*)" ");
7237 msg_puts_attr(event_nr2name(event
), hl_attr(HLF_T
));
7239 last_group
= ap
->group
;
7245 msg_outtrans(ap
->pat
);
7247 for (ac
= ap
->cmds
; ac
!= NULL
; ac
= ac
->next
)
7249 if (ac
->cmd
!= NULL
) /* skip removed commands */
7256 msg_outtrans(ac
->cmd
);
7259 last_set_msg(ac
->scriptID
);
7263 if (ac
->next
!= NULL
)
7274 * Mark an autocommand pattern for deletion.
7282 ap
->buflocal_nr
= -1;
7283 au_need_clean
= TRUE
;
7287 * Mark all commands for a pattern for deletion.
7295 for (ac
= ap
->cmds
; ac
!= NULL
; ac
= ac
->next
)
7300 au_need_clean
= TRUE
;
7304 * Cleanup autocommands and patterns that have been deleted.
7305 * This is only done when not executing autocommands.
7310 AutoPat
*ap
, **prev_ap
;
7311 AutoCmd
*ac
, **prev_ac
;
7314 if (autocmd_busy
|| !au_need_clean
)
7317 /* loop over all events */
7318 for (event
= (event_T
)0; (int)event
< (int)NUM_EVENTS
;
7319 event
= (event_T
)((int)event
+ 1))
7321 /* loop over all autocommand patterns */
7322 prev_ap
= &(first_autopat
[(int)event
]);
7323 for (ap
= *prev_ap
; ap
!= NULL
; ap
= *prev_ap
)
7325 /* loop over all commands for this pattern */
7326 prev_ac
= &(ap
->cmds
);
7327 for (ac
= *prev_ac
; ac
!= NULL
; ac
= *prev_ac
)
7329 /* remove the command if the pattern is to be deleted or when
7330 * the command has been marked for deletion */
7331 if (ap
->pat
== NULL
|| ac
->cmd
== NULL
)
7333 *prev_ac
= ac
->next
;
7338 prev_ac
= &(ac
->next
);
7341 /* remove the pattern if it has been marked for deletion */
7342 if (ap
->pat
== NULL
)
7344 *prev_ap
= ap
->next
;
7345 vim_free(ap
->reg_prog
);
7349 prev_ap
= &(ap
->next
);
7353 au_need_clean
= FALSE
;
7357 * Called when buffer is freed, to remove/invalidate related buffer-local
7361 aubuflocal_remove(buf
)
7368 /* invalidate currently executing autocommands */
7369 for (apc
= active_apc_list
; apc
; apc
= apc
->next
)
7370 if (buf
->b_fnum
== apc
->arg_bufnr
)
7373 /* invalidate buflocals looping through events */
7374 for (event
= (event_T
)0; (int)event
< (int)NUM_EVENTS
;
7375 event
= (event_T
)((int)event
+ 1))
7376 /* loop over all autocommand patterns */
7377 for (ap
= first_autopat
[(int)event
]; ap
!= NULL
; ap
= ap
->next
)
7378 if (ap
->buflocal_nr
== buf
->b_fnum
)
7385 _("auto-removing autocommand: %s <buffer=%d>"),
7386 event_nr2name(event
), buf
->b_fnum
);
7394 * Add an autocmd group name.
7395 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7403 i
= au_find_group(name
);
7404 if (i
== AUGROUP_ERROR
) /* the group doesn't exist yet, add it */
7406 /* First try using a free entry. */
7407 for (i
= 0; i
< augroups
.ga_len
; ++i
)
7408 if (AUGROUP_NAME(i
) == NULL
)
7410 if (i
== augroups
.ga_len
&& ga_grow(&augroups
, 1) == FAIL
)
7411 return AUGROUP_ERROR
;
7413 AUGROUP_NAME(i
) = vim_strsave(name
);
7414 if (AUGROUP_NAME(i
) == NULL
)
7415 return AUGROUP_ERROR
;
7416 if (i
== augroups
.ga_len
)
7429 i
= au_find_group(name
);
7430 if (i
== AUGROUP_ERROR
) /* the group doesn't exist */
7431 EMSG2(_("E367: No such group: \"%s\""), name
);
7434 vim_free(AUGROUP_NAME(i
));
7435 AUGROUP_NAME(i
) = NULL
;
7440 * Find the ID of an autocmd group name.
7441 * Return it's ID. Returns AUGROUP_ERROR (< 0) for error.
7449 for (i
= 0; i
< augroups
.ga_len
; ++i
)
7450 if (AUGROUP_NAME(i
) != NULL
&& STRCMP(AUGROUP_NAME(i
), name
) == 0)
7452 return AUGROUP_ERROR
;
7456 * Return TRUE if augroup "name" exists.
7462 return au_find_group(name
) != AUGROUP_ERROR
;
7466 * ":augroup {name}".
7469 do_augroup(arg
, del_group
)
7482 else if (STRICMP(arg
, "end") == 0) /* ":aug end": back to group 0 */
7483 current_augroup
= AUGROUP_DEFAULT
;
7484 else if (*arg
) /* ":aug xxx": switch to group xxx */
7486 i
= au_new_group(arg
);
7487 if (i
!= AUGROUP_ERROR
)
7488 current_augroup
= i
;
7490 else /* ":aug": list the group names */
7493 for (i
= 0; i
< augroups
.ga_len
; ++i
)
7495 if (AUGROUP_NAME(i
) != NULL
)
7497 msg_puts(AUGROUP_NAME(i
));
7498 msg_puts((char_u
*)" ");
7506 #if defined(EXITFREE) || defined(PROTO)
7510 for (current_augroup
= -1; current_augroup
< augroups
.ga_len
;
7512 do_autocmd((char_u
*)"", TRUE
);
7513 ga_clear_strings(&augroups
);
7518 * Return the event number for event name "start".
7519 * Return NUM_EVENTS if the event name was not found.
7520 * Return a pointer to the next event name in "end".
7523 event_name2nr(start
, end
)
7531 /* the event name ends with end of line, a blank or a comma */
7532 for (p
= start
; *p
&& !vim_iswhite(*p
) && *p
!= ','; ++p
)
7534 for (i
= 0; event_names
[i
].name
!= NULL
; ++i
)
7536 len
= (int)STRLEN(event_names
[i
].name
);
7537 if (len
== p
- start
&& STRNICMP(event_names
[i
].name
, start
, len
) == 0)
7543 if (event_names
[i
].name
== NULL
)
7545 return event_names
[i
].event
;
7549 * Return the name for event "event".
7552 event_nr2name(event
)
7557 for (i
= 0; event_names
[i
].name
!= NULL
; ++i
)
7558 if (event_names
[i
].event
== event
)
7559 return (char_u
*)event_names
[i
].name
;
7560 return (char_u
*)"Unknown";
7564 * Scan over the events. "*" stands for all events.
7567 find_end_event(arg
, have_group
)
7569 int have_group
; /* TRUE when group name was found */
7576 if (arg
[1] && !vim_iswhite(arg
[1]))
7578 EMSG2(_("E215: Illegal character after *: %s"), arg
);
7585 for (pat
= arg
; *pat
&& !vim_iswhite(*pat
); pat
= p
)
7587 if ((int)event_name2nr(pat
, &p
) >= (int)NUM_EVENTS
)
7590 EMSG2(_("E216: No such event: %s"), pat
);
7592 EMSG2(_("E216: No such group or event: %s"), pat
);
7601 * Return TRUE if "event" is included in 'eventignore'.
7604 event_ignored(event
)
7611 if (STRNICMP(p
, "all", 3) == 0 && (p
[3] == NUL
|| p
[3] == ','))
7613 if (event_name2nr(p
, &p
) == event
)
7621 * Return OK when the contents of p_ei is valid, FAIL otherwise.
7630 if (STRNICMP(p
, "all", 3) == 0 && (p
[3] == NUL
|| p
[3] == ','))
7636 else if (event_name2nr(p
, &p
) == NUM_EVENTS
)
7643 # if defined(FEAT_SYN_HL) || defined(PROTO)
7646 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
7647 * buffer loaded into the window. "what" must start with a comma.
7648 * Returns the old value of 'eventignore' in allocated memory.
7651 au_event_disable(what
)
7657 save_ei
= vim_strsave(p_ei
);
7658 if (save_ei
!= NULL
)
7660 new_ei
= vim_strnsave(p_ei
, (int)(STRLEN(p_ei
) + STRLEN(what
)));
7663 STRCAT(new_ei
, what
);
7664 set_string_option_direct((char_u
*)"ei", -1, new_ei
,
7665 OPT_FREE
, SID_NONE
);
7673 au_event_restore(old_ei
)
7678 set_string_option_direct((char_u
*)"ei", -1, old_ei
,
7679 OPT_FREE
, SID_NONE
);
7683 # endif /* FEAT_SYN_HL */
7686 * do_autocmd() -- implements the :autocmd command. Can be used in the
7689 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
7690 * will be automatically executed for <event>
7691 * when editing a file matching <pat>, in
7692 * the current group.
7693 * :autocmd <event> <pat> Show the auto-commands associated with
7694 * <event> and <pat>.
7695 * :autocmd <event> Show the auto-commands associated with
7697 * :autocmd Show all auto-commands.
7698 * :autocmd! <event> <pat> <cmd> Remove all auto-commands associated with
7699 * <event> and <pat>, and add the command
7700 * <cmd>, for the current group.
7701 * :autocmd! <event> <pat> Remove all auto-commands associated with
7702 * <event> and <pat> for the current group.
7703 * :autocmd! <event> Remove all auto-commands associated with
7704 * <event> for the current group.
7705 * :autocmd! Remove ALL auto-commands for the current
7708 * Multiple events and patterns may be given separated by commas. Here are
7710 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
7711 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
7713 * :autocmd * *.c show all autocommands for *.c files.
7715 * Mostly a {group} argument can optionally appear before <event>.
7718 do_autocmd(arg
, forceit
)
7723 char_u
*envpat
= NULL
;
7726 int need_free
= FALSE
;
7731 * Check for a legal group name. If not, use AUGROUP_ALL.
7733 group
= au_get_grouparg(&arg
);
7734 if (arg
== NULL
) /* out of memory */
7738 * Scan over the events.
7739 * If we find an illegal name, return here, don't do anything.
7741 pat
= find_end_event(arg
, group
!= AUGROUP_ALL
);
7746 * Scan over the pattern. Put a NUL at the end.
7748 pat
= skipwhite(pat
);
7750 while (*cmd
&& (!vim_iswhite(*cmd
) || cmd
[-1] == '\\'))
7755 /* Expand environment variables in the pattern. Set 'shellslash', we want
7756 * forward slashes here. */
7757 if (vim_strchr(pat
, '$') != NULL
|| vim_strchr(pat
, '~') != NULL
)
7759 #ifdef BACKSLASH_IN_FILENAME
7760 int p_ssl_save
= p_ssl
;
7764 envpat
= expand_env_save(pat
);
7765 #ifdef BACKSLASH_IN_FILENAME
7773 * Check for "nested" flag.
7775 cmd
= skipwhite(cmd
);
7776 if (*cmd
!= NUL
&& STRNCMP(cmd
, "nested", 6) == 0 && vim_iswhite(cmd
[6]))
7779 cmd
= skipwhite(cmd
+ 6);
7783 * Find the start of the commands.
7784 * Expand <sfile> in it.
7788 cmd
= expand_sfile(cmd
);
7789 if (cmd
== NULL
) /* some error */
7795 * Print header when showing autocommands.
7797 if (!forceit
&& *cmd
== NUL
)
7799 /* Highlight title */
7800 MSG_PUTS_TITLE(_("\n--- Auto-Commands ---"));
7804 * Loop over the events.
7806 last_event
= (event_T
)-1; /* for listing the event name */
7807 last_group
= AUGROUP_ERROR
; /* for listing the group name */
7808 if (*arg
== '*' || *arg
== NUL
)
7810 for (event
= (event_T
)0; (int)event
< (int)NUM_EVENTS
;
7811 event
= (event_T
)((int)event
+ 1))
7812 if (do_autocmd_event(event
, pat
,
7813 nested
, cmd
, forceit
, group
) == FAIL
)
7818 while (*arg
&& !vim_iswhite(*arg
))
7819 if (do_autocmd_event(event_name2nr(arg
, &arg
), pat
,
7820 nested
, cmd
, forceit
, group
) == FAIL
)
7830 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
7831 * The "argp" argument is advanced to the following argument.
7833 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
7836 au_get_grouparg(argp
)
7841 char_u
*arg
= *argp
;
7842 int group
= AUGROUP_ALL
;
7844 p
= skiptowhite(arg
);
7847 group_name
= vim_strnsave(arg
, (int)(p
- arg
));
7848 if (group_name
== NULL
) /* out of memory */
7849 return AUGROUP_ERROR
;
7850 group
= au_find_group(group_name
);
7851 if (group
== AUGROUP_ERROR
)
7852 group
= AUGROUP_ALL
; /* no match, use all groups */
7854 *argp
= skipwhite(p
); /* match, skip over group name */
7855 vim_free(group_name
);
7861 * do_autocmd() for one event.
7862 * If *pat == NUL do for all patterns.
7863 * If *cmd == NUL show entries.
7864 * If forceit == TRUE delete entries.
7865 * If group is not AUGROUP_ALL, only use this group.
7868 do_autocmd_event(event
, pat
, nested
, cmd
, forceit
, group
)
7887 char_u buflocal_pat
[25]; /* for "<buffer=X>" */
7889 if (group
== AUGROUP_ALL
)
7890 findgroup
= current_augroup
;
7893 allgroups
= (group
== AUGROUP_ALL
&& !forceit
&& *cmd
== NUL
);
7896 * Show or delete all patterns for an event.
7900 for (ap
= first_autopat
[(int)event
]; ap
!= NULL
; ap
= ap
->next
)
7902 if (forceit
) /* delete the AutoPat, if it's in the current group */
7904 if (ap
->group
== findgroup
)
7907 else if (group
== AUGROUP_ALL
|| ap
->group
== group
)
7908 show_autocmd(ap
, event
);
7913 * Loop through all the specified patterns.
7915 for ( ; *pat
; pat
= (*endpat
== ',' ? endpat
+ 1 : endpat
))
7918 * Find end of the pattern.
7919 * Watch out for a comma in braces, like "*.\{obj,o\}".
7922 for (endpat
= pat
; *endpat
&& (*endpat
!= ',' || brace_level
7923 || endpat
[-1] == '\\'); ++endpat
)
7927 else if (*endpat
== '}')
7930 if (pat
== endpat
) /* ignore single comma */
7932 patlen
= (int)(endpat
- pat
);
7935 * detect special <buflocal[=X]> buffer-local patterns
7937 is_buflocal
= FALSE
;
7940 if (patlen
>= 7 && STRNCMP(pat
, "<buffer", 7) == 0
7941 && pat
[patlen
- 1] == '>')
7943 /* Error will be printed only for addition. printing and removing
7944 * will proceed silently. */
7947 buflocal_nr
= curbuf
->b_fnum
;
7948 else if (patlen
> 9 && pat
[7] == '=')
7951 if (patlen
== 13 && STRNICMP(pat
, "<buffer=abuf>", 13))
7952 buflocal_nr
= autocmd_bufnr
;
7954 else if (skipdigits(pat
+ 8) == pat
+ patlen
- 1)
7955 buflocal_nr
= atoi((char *)pat
+ 8);
7961 /* normalize pat into standard "<buffer>#N" form */
7962 sprintf((char *)buflocal_pat
, "<buffer=%d>", buflocal_nr
);
7963 pat
= buflocal_pat
; /* can modify pat and patlen */
7964 patlen
= (int)STRLEN(buflocal_pat
); /* but not endpat */
7968 * Find AutoPat entries with this pattern.
7970 prev_ap
= &first_autopat
[(int)event
];
7971 while ((ap
= *prev_ap
) != NULL
)
7973 if (ap
->pat
!= NULL
)
7975 /* Accept a pattern when:
7976 * - a group was specified and it's that group, or a group was
7977 * not specified and it's the current group, or a group was
7978 * not specified and we are listing
7979 * - the length of the pattern matches
7980 * - the pattern matches.
7981 * For <buffer[=X]>, this condition works because we normalize
7982 * all buffer-local patterns.
7984 if ((allgroups
|| ap
->group
== findgroup
)
7985 && ap
->patlen
== patlen
7986 && STRNCMP(pat
, ap
->pat
, patlen
) == 0)
7989 * Remove existing autocommands.
7990 * If adding any new autocmd's for this AutoPat, don't
7991 * delete the pattern from the autopat list, append to
7996 if (*cmd
!= NUL
&& ap
->next
== NULL
)
8005 * Show autocmd's for this autopat, or buflocals <buffer=X>
8007 else if (*cmd
== NUL
)
8008 show_autocmd(ap
, event
);
8011 * Add autocmd to this autopat, if it's the last one.
8013 else if (ap
->next
== NULL
)
8017 prev_ap
= &ap
->next
;
8021 * Add a new command.
8026 * If the pattern we want to add a command to does appear at the
8027 * end of the list (or not is not in the list at all), add the
8028 * pattern at the end of the list.
8032 /* refuse to add buffer-local ap if buffer number is invalid */
8033 if (is_buflocal
&& (buflocal_nr
== 0
8034 || buflist_findnr(buflocal_nr
) == NULL
))
8036 EMSGN(_("E680: <buffer=%d>: invalid buffer number "),
8041 ap
= (AutoPat
*)alloc((unsigned)sizeof(AutoPat
));
8044 ap
->pat
= vim_strnsave(pat
, patlen
);
8045 ap
->patlen
= patlen
;
8046 if (ap
->pat
== NULL
)
8054 ap
->buflocal_nr
= buflocal_nr
;
8055 ap
->reg_prog
= NULL
;
8061 ap
->buflocal_nr
= 0;
8062 reg_pat
= file_pat_to_reg_pat(pat
, endpat
,
8063 &ap
->allow_dirs
, TRUE
);
8064 if (reg_pat
!= NULL
)
8065 ap
->reg_prog
= vim_regcomp(reg_pat
, RE_MAGIC
);
8067 if (reg_pat
== NULL
|| ap
->reg_prog
== NULL
)
8077 if (group
== AUGROUP_ALL
)
8078 ap
->group
= current_augroup
;
8084 * Add the autocmd at the end of the AutoCmd list.
8086 prev_ac
= &(ap
->cmds
);
8087 while ((ac
= *prev_ac
) != NULL
)
8088 prev_ac
= &ac
->next
;
8089 ac
= (AutoCmd
*)alloc((unsigned)sizeof(AutoCmd
));
8092 ac
->cmd
= vim_strsave(cmd
);
8094 ac
->scriptID
= current_SID
;
8096 if (ac
->cmd
== NULL
)
8103 ac
->nested
= nested
;
8107 au_cleanup(); /* may really delete removed patterns/commands now */
8112 * Implementation of ":doautocmd [group] event [fname]".
8113 * Return OK for success, FAIL for failure;
8116 do_doautocmd(arg
, do_msg
)
8118 int do_msg
; /* give message for no matching autocmds? */
8121 int nothing_done
= TRUE
;
8125 * Check for a legal group name. If not, use AUGROUP_ALL.
8127 group
= au_get_grouparg(&arg
);
8128 if (arg
== NULL
) /* out of memory */
8133 EMSG(_("E217: Can't execute autocommands for ALL events"));
8138 * Scan over the events.
8139 * If we find an illegal name, return here, don't do anything.
8141 fname
= find_end_event(arg
, group
!= AUGROUP_ALL
);
8145 fname
= skipwhite(fname
);
8148 * Loop over the events.
8150 while (*arg
&& !vim_iswhite(*arg
))
8151 if (apply_autocmds_group(event_name2nr(arg
, &arg
),
8152 fname
, NULL
, TRUE
, group
, curbuf
, NULL
))
8153 nothing_done
= FALSE
;
8155 if (nothing_done
&& do_msg
)
8156 MSG(_("No matching autocommands"));
8159 return aborting() ? FAIL
: OK
;
8166 * ":doautoall": execute autocommands for each loaded buffer.
8177 * This is a bit tricky: For some commands curwin->w_buffer needs to be
8178 * equal to curbuf, but for some buffers there may not be a window.
8179 * So we change the buffer for the current window for a moment. This
8180 * gives problems when the autocommands make changes to the list of
8181 * buffers or windows...
8183 for (buf
= firstbuf
; buf
!= NULL
; buf
= buf
->b_next
)
8185 if (curbuf
->b_ml
.ml_mfp
!= NULL
)
8187 /* find a window for this buffer and save some values */
8188 aucmd_prepbuf(&aco
, buf
);
8190 /* execute the autocommands for this buffer */
8191 retval
= do_doautocmd(eap
->arg
, FALSE
);
8193 /* Execute the modeline settings, but don't set window-local
8194 * options if we are using the current window for another buffer. */
8195 do_modelines(aco
.save_curwin
== NULL
? OPT_NOWIN
: 0);
8197 /* restore the current window */
8198 aucmd_restbuf(&aco
);
8200 /* stop if there is some error or buffer was deleted */
8201 if (retval
== FAIL
|| !buf_valid(buf
))
8206 check_cursor(); /* just in case lines got deleted */
8210 * Prepare for executing autocommands for (hidden) buffer "buf".
8211 * Search a window for the current buffer. Save the cursor position and
8213 * Set "curbuf" and "curwin" to match "buf".
8214 * When FEAT_AUTOCMD is not defined another version is used, see below.
8217 aucmd_prepbuf(aco
, buf
)
8218 aco_save_T
*aco
; /* structure to save values in */
8219 buf_T
*buf
; /* new curbuf */
8223 aco
->new_curbuf
= buf
;
8225 /* Find a window that is for the new buffer */
8226 if (buf
== curbuf
) /* be quick when buf is curbuf */
8230 for (win
= firstwin
; win
!= NULL
; win
= win
->w_next
)
8231 if (win
->w_buffer
== buf
)
8238 * Prefer to use an existing window for the buffer, it has the least side
8239 * effects (esp. if "buf" is curbuf).
8240 * Otherwise, use curwin for "buf". It might make some items in the
8241 * window invalid. At least save the cursor and topline.
8245 /* there is a window for "buf", make it the curwin */
8246 aco
->save_curwin
= curwin
;
8248 aco
->save_buf
= win
->w_buffer
;
8249 aco
->new_curwin
= win
;
8253 /* there is no window for "buf", use curwin */
8254 aco
->save_curwin
= NULL
;
8255 aco
->save_buf
= curbuf
;
8256 --curbuf
->b_nwindows
;
8257 curwin
->w_buffer
= buf
;
8260 /* save cursor and topline, set them to safe values */
8261 aco
->save_cursor
= curwin
->w_cursor
;
8262 curwin
->w_cursor
.lnum
= 1;
8263 curwin
->w_cursor
.col
= 0;
8264 aco
->save_topline
= curwin
->w_topline
;
8265 curwin
->w_topline
= 1;
8267 aco
->save_topfill
= curwin
->w_topfill
;
8268 curwin
->w_topfill
= 0;
8276 * Cleanup after executing autocommands for a (hidden) buffer.
8277 * Restore the window as it was (if possible).
8278 * When FEAT_AUTOCMD is not defined another version is used, see below.
8282 aco_save_T
*aco
; /* structure holding saved values */
8284 if (aco
->save_curwin
!= NULL
)
8286 /* restore curwin */
8288 if (win_valid(aco
->save_curwin
))
8291 /* restore the buffer which was previously edited by curwin, if
8292 * it's still the same window and it's valid */
8293 if (curwin
== aco
->new_curwin
8294 && buf_valid(aco
->save_buf
)
8295 && aco
->save_buf
->b_ml
.ml_mfp
!= NULL
)
8297 --curbuf
->b_nwindows
;
8298 curbuf
= aco
->save_buf
;
8299 curwin
->w_buffer
= curbuf
;
8300 ++curbuf
->b_nwindows
;
8303 curwin
= aco
->save_curwin
;
8304 curbuf
= curwin
->w_buffer
;
8309 /* restore buffer for curwin if it still exists and is loaded */
8310 if (buf_valid(aco
->save_buf
) && aco
->save_buf
->b_ml
.ml_mfp
!= NULL
)
8312 --curbuf
->b_nwindows
;
8313 curbuf
= aco
->save_buf
;
8314 curwin
->w_buffer
= curbuf
;
8315 ++curbuf
->b_nwindows
;
8316 curwin
->w_cursor
= aco
->save_cursor
;
8318 /* check topline < line_count, in case lines got deleted */
8319 if (aco
->save_topline
<= curbuf
->b_ml
.ml_line_count
)
8321 curwin
->w_topline
= aco
->save_topline
;
8323 curwin
->w_topfill
= aco
->save_topfill
;
8328 curwin
->w_topline
= curbuf
->b_ml
.ml_line_count
;
8330 curwin
->w_topfill
= 0;
8337 static int autocmd_nested
= FALSE
;
8340 * Execute autocommands for "event" and file name "fname".
8341 * Return TRUE if some commands were executed.
8344 apply_autocmds(event
, fname
, fname_io
, force
, buf
)
8346 char_u
*fname
; /* NULL or empty means use actual file name */
8347 char_u
*fname_io
; /* fname to use for <afile> on cmdline */
8348 int force
; /* when TRUE, ignore autocmd_busy */
8349 buf_T
*buf
; /* buffer for <abuf> */
8351 return apply_autocmds_group(event
, fname
, fname_io
, force
,
8352 AUGROUP_ALL
, buf
, NULL
);
8356 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
8357 * setting v:filearg.
8360 apply_autocmds_exarg(event
, fname
, fname_io
, force
, buf
, eap
)
8368 return apply_autocmds_group(event
, fname
, fname_io
, force
,
8369 AUGROUP_ALL
, buf
, eap
);
8373 * Like apply_autocmds(), but handles the caller's retval. If the script
8374 * processing is being aborted or if retval is FAIL when inside a try
8375 * conditional, no autocommands are executed. If otherwise the autocommands
8376 * cause the script to be aborted, retval is set to FAIL.
8379 apply_autocmds_retval(event
, fname
, fname_io
, force
, buf
, retval
)
8381 char_u
*fname
; /* NULL or empty means use actual file name */
8382 char_u
*fname_io
; /* fname to use for <afile> on cmdline */
8383 int force
; /* when TRUE, ignore autocmd_busy */
8384 buf_T
*buf
; /* buffer for <abuf> */
8385 int *retval
; /* pointer to caller's retval */
8390 if (should_abort(*retval
))
8394 did_cmd
= apply_autocmds_group(event
, fname
, fname_io
, force
,
8395 AUGROUP_ALL
, buf
, NULL
);
8406 * Return TRUE when there is a CursorHold autocommand defined.
8411 return (first_autopat
[(int)(get_real_state() == NORMAL_BUSY
8412 ? EVENT_CURSORHOLD
: EVENT_CURSORHOLDI
)] != NULL
);
8416 * Return TRUE if the CursorHold event can be triggered.
8419 trigger_cursorhold()
8423 if (!did_cursorhold
&& has_cursorhold() && !Recording
8424 #ifdef FEAT_INS_EXPAND
8425 && !ins_compl_active()
8429 state
= get_real_state();
8430 if (state
== NORMAL_BUSY
|| (state
& INSERT
) != 0)
8437 * Return TRUE when there is a CursorMoved autocommand defined.
8442 return (first_autopat
[(int)EVENT_CURSORMOVED
] != NULL
);
8446 * Return TRUE when there is a CursorMovedI autocommand defined.
8451 return (first_autopat
[(int)EVENT_CURSORMOVEDI
] != NULL
);
8455 apply_autocmds_group(event
, fname
, fname_io
, force
, group
, buf
, eap
)
8457 char_u
*fname
; /* NULL or empty means use actual file name */
8458 char_u
*fname_io
; /* fname to use for <afile> on cmdline, NULL means
8460 int force
; /* when TRUE, ignore autocmd_busy */
8461 int group
; /* group ID, or AUGROUP_ALL */
8462 buf_T
*buf
; /* buffer for <abuf> */
8463 exarg_T
*eap
; /* command arguments */
8465 char_u
*sfname
= NULL
; /* short file name */
8470 char_u
*save_sourcing_name
;
8471 linenr_T save_sourcing_lnum
;
8472 char_u
*save_autocmd_fname
;
8473 int save_autocmd_bufnr
;
8474 char_u
*save_autocmd_match
;
8475 int save_autocmd_busy
;
8476 int save_autocmd_nested
;
8477 static int nesting
= 0;
8481 scid_T save_current_SID
;
8482 void *save_funccalp
;
8483 char_u
*save_cmdarg
;
8486 static int filechangeshell_busy
= FALSE
;
8488 proftime_T wait_time
;
8492 * Quickly return if there are no autocommands for this event or
8493 * autocommands are blocked.
8495 if (first_autopat
[(int)event
] == NULL
|| autocmd_blocked
> 0)
8499 * When autocommands are busy, new autocommands are only executed when
8500 * explicitly enabled with the "nested" flag.
8502 if (autocmd_busy
&& !(force
|| autocmd_nested
))
8507 * Quickly return when immediately aborting on error, or when an interrupt
8508 * occurred or an exception was thrown but not caught.
8515 * FileChangedShell never nests, because it can create an endless loop.
8517 if (filechangeshell_busy
&& (event
== EVENT_FILECHANGEDSHELL
8518 || event
== EVENT_FILECHANGEDSHELLPOST
))
8522 * Ignore events in 'eventignore'.
8524 if (event_ignored(event
))
8528 * Allow nesting of autocommands, but restrict the depth, because it's
8529 * possible to create an endless loop.
8533 EMSG(_("E218: autocommand nesting too deep"));
8538 * Check if these autocommands are disabled. Used when doing ":all" or
8541 if ( (autocmd_no_enter
8542 && (event
== EVENT_WINENTER
|| event
== EVENT_BUFENTER
))
8543 || (autocmd_no_leave
8544 && (event
== EVENT_WINLEAVE
|| event
== EVENT_BUFLEAVE
)))
8548 * Save the autocmd_* variables and info about the current buffer.
8550 save_autocmd_fname
= autocmd_fname
;
8551 save_autocmd_bufnr
= autocmd_bufnr
;
8552 save_autocmd_match
= autocmd_match
;
8553 save_autocmd_busy
= autocmd_busy
;
8554 save_autocmd_nested
= autocmd_nested
;
8555 save_changed
= curbuf
->b_changed
;
8556 old_curbuf
= curbuf
;
8559 * Set the file name to be used for <afile>.
8560 * Make a copy to avoid that changing a buffer name or directory makes it
8563 if (fname_io
== NULL
)
8565 if (fname
!= NULL
&& *fname
!= NUL
)
8566 autocmd_fname
= fname
;
8567 else if (buf
!= NULL
)
8568 autocmd_fname
= buf
->b_fname
;
8570 autocmd_fname
= NULL
;
8573 autocmd_fname
= fname_io
;
8574 if (autocmd_fname
!= NULL
)
8575 autocmd_fname
= FullName_save(autocmd_fname
, FALSE
);
8578 * Set the buffer number to be used for <abuf>.
8583 autocmd_bufnr
= buf
->b_fnum
;
8586 * When the file name is NULL or empty, use the file name of buffer "buf".
8587 * Always use the full path of the file name to match with, in case
8588 * "allow_dirs" is set.
8590 if (fname
== NULL
|| *fname
== NUL
)
8597 if (event
== EVENT_SYNTAX
)
8598 fname
= buf
->b_p_syn
;
8601 if (event
== EVENT_FILETYPE
)
8602 fname
= buf
->b_p_ft
;
8605 if (buf
->b_sfname
!= NULL
)
8606 sfname
= vim_strsave(buf
->b_sfname
);
8607 fname
= buf
->b_ffname
;
8611 fname
= (char_u
*)"";
8612 fname
= vim_strsave(fname
); /* make a copy, so we can change it */
8616 sfname
= vim_strsave(fname
);
8617 /* Don't try expanding FileType, Syntax, WindowID or QuickFixCmd* */
8618 if (event
== EVENT_FILETYPE
8619 || event
== EVENT_SYNTAX
8620 || event
== EVENT_REMOTEREPLY
8621 || event
== EVENT_SPELLFILEMISSING
8622 || event
== EVENT_QUICKFIXCMDPRE
8623 || event
== EVENT_QUICKFIXCMDPOST
)
8624 fname
= vim_strsave(fname
);
8626 fname
= FullName_save(fname
, FALSE
);
8628 if (fname
== NULL
) /* out of memory */
8635 #ifdef BACKSLASH_IN_FILENAME
8637 * Replace all backslashes with forward slashes. This makes the
8638 * autocommand patterns portable between Unix and MS-DOS.
8641 forward_slash(sfname
);
8642 forward_slash(fname
);
8646 /* remove version for correct match */
8648 vms_remove_version(sfname
);
8649 vms_remove_version(fname
);
8653 * Set the name to be used for <amatch>.
8655 autocmd_match
= fname
;
8658 /* Don't redraw while doing auto commands. */
8659 ++RedrawingDisabled
;
8660 save_sourcing_name
= sourcing_name
;
8661 sourcing_name
= NULL
; /* don't free this one */
8662 save_sourcing_lnum
= sourcing_lnum
;
8663 sourcing_lnum
= 0; /* no line number here */
8666 save_current_SID
= current_SID
;
8668 # ifdef FEAT_PROFILE
8669 if (do_profiling
== PROF_YES
)
8670 prof_child_enter(&wait_time
); /* doesn't count for the caller itself */
8673 /* Don't use local function variables, if called from a function */
8674 save_funccalp
= save_funccal();
8678 * When starting to execute autocommands, save the search patterns.
8682 save_search_patterns();
8684 did_filetype
= keep_filetype
;
8688 * Note that we are applying autocmds. Some commands need to know.
8690 autocmd_busy
= TRUE
;
8691 filechangeshell_busy
= (event
== EVENT_FILECHANGEDSHELL
);
8692 ++nesting
; /* see matching decrement below */
8694 /* Remember that FileType was triggered. Used for did_filetype(). */
8695 if (event
== EVENT_FILETYPE
)
8696 did_filetype
= TRUE
;
8698 tail
= gettail(fname
);
8700 /* Find first autocommand that matches */
8701 patcmd
.curpat
= first_autopat
[(int)event
];
8702 patcmd
.nextcmd
= NULL
;
8703 patcmd
.group
= group
;
8704 patcmd
.fname
= fname
;
8705 patcmd
.sfname
= sfname
;
8707 patcmd
.event
= event
;
8708 patcmd
.arg_bufnr
= autocmd_bufnr
;
8710 auto_next_pat(&patcmd
, FALSE
);
8712 /* found one, start executing the autocommands */
8713 if (patcmd
.curpat
!= NULL
)
8715 /* add to active_apc_list */
8716 patcmd
.next
= active_apc_list
;
8717 active_apc_list
= &patcmd
;
8720 /* set v:cmdarg (only when there is a matching pattern) */
8721 save_cmdbang
= get_vim_var_nr(VV_CMDBANG
);
8724 save_cmdarg
= set_cmdarg(eap
, NULL
);
8725 set_vim_var_nr(VV_CMDBANG
, (long)eap
->forceit
);
8728 save_cmdarg
= NULL
; /* avoid gcc warning */
8731 /* mark the last pattern, to avoid an endless loop when more patterns
8732 * are added when executing autocommands */
8733 for (ap
= patcmd
.curpat
; ap
->next
!= NULL
; ap
= ap
->next
)
8736 check_lnums(TRUE
); /* make sure cursor and topline are valid */
8737 do_cmdline(NULL
, getnextac
, (void *)&patcmd
,
8738 DOCMD_NOWAIT
|DOCMD_VERBOSE
|DOCMD_REPEAT
);
8742 (void)set_cmdarg(NULL
, save_cmdarg
);
8743 set_vim_var_nr(VV_CMDBANG
, save_cmdbang
);
8746 /* delete from active_apc_list */
8747 if (active_apc_list
== &patcmd
) /* just in case */
8748 active_apc_list
= patcmd
.next
;
8751 --RedrawingDisabled
;
8752 autocmd_busy
= save_autocmd_busy
;
8753 filechangeshell_busy
= FALSE
;
8754 autocmd_nested
= save_autocmd_nested
;
8755 vim_free(sourcing_name
);
8756 sourcing_name
= save_sourcing_name
;
8757 sourcing_lnum
= save_sourcing_lnum
;
8758 vim_free(autocmd_fname
);
8759 autocmd_fname
= save_autocmd_fname
;
8760 autocmd_bufnr
= save_autocmd_bufnr
;
8761 autocmd_match
= save_autocmd_match
;
8763 current_SID
= save_current_SID
;
8764 restore_funccal(save_funccalp
);
8765 # ifdef FEAT_PROFILE
8766 if (do_profiling
== PROF_YES
)
8767 prof_child_exit(&wait_time
);
8772 --nesting
; /* see matching increment above */
8775 * When stopping to execute autocommands, restore the search patterns and
8780 restore_search_patterns();
8782 did_filetype
= FALSE
;
8786 * Some events don't set or reset the Changed flag.
8787 * Check if still in the same buffer!
8789 if (curbuf
== old_curbuf
8790 && (event
== EVENT_BUFREADPOST
8791 || event
== EVENT_BUFWRITEPOST
8792 || event
== EVENT_FILEAPPENDPOST
8793 || event
== EVENT_VIMLEAVE
8794 || event
== EVENT_VIMLEAVEPRE
))
8797 if (curbuf
->b_changed
!= save_changed
)
8798 need_maketitle
= TRUE
;
8800 curbuf
->b_changed
= save_changed
;
8803 au_cleanup(); /* may really delete removed patterns/commands now */
8806 /* When wiping out a buffer make sure all its buffer-local autocommands
8808 if (event
== EVENT_BUFWIPEOUT
&& buf
!= NULL
)
8809 aubuflocal_remove(buf
);
8815 static char_u
*old_termresponse
= NULL
;
8819 * Block triggering autocommands until unblock_autocmd() is called.
8820 * Can be used recursively, so long as it's symmetric.
8826 /* Remember the value of v:termresponse. */
8827 if (autocmd_blocked
== 0)
8828 old_termresponse
= get_vim_var_str(VV_TERMRESPONSE
);
8839 /* When v:termresponse was set while autocommands were blocked, trigger
8840 * the autocommands now. Esp. useful when executing a shell command
8841 * during startup (vimdiff). */
8842 if (autocmd_blocked
== 0
8843 && get_vim_var_str(VV_TERMRESPONSE
) != old_termresponse
)
8844 apply_autocmds(EVENT_TERMRESPONSE
, NULL
, NULL
, FALSE
, curbuf
);
8849 * Find next autocommand pattern that matches.
8852 auto_next_pat(apc
, stop_at_last
)
8854 int stop_at_last
; /* stop when 'last' flag is set */
8861 vim_free(sourcing_name
);
8862 sourcing_name
= NULL
;
8864 for (ap
= apc
->curpat
; ap
!= NULL
&& !got_int
; ap
= ap
->next
)
8868 /* only use a pattern when it has not been removed, has commands and
8869 * the group matches. For buffer-local autocommands only check the
8871 if (ap
->pat
!= NULL
&& ap
->cmds
!= NULL
8872 && (apc
->group
== AUGROUP_ALL
|| apc
->group
== ap
->group
))
8874 /* execution-condition */
8875 if (ap
->buflocal_nr
== 0
8876 ? (match_file_pat(NULL
, ap
->reg_prog
, apc
->fname
,
8877 apc
->sfname
, apc
->tail
, ap
->allow_dirs
))
8878 : ap
->buflocal_nr
== apc
->arg_bufnr
)
8880 name
= event_nr2name(apc
->event
);
8881 s
= _("%s Auto commands for \"%s\"");
8882 sourcing_name
= alloc((unsigned)(STRLEN(s
)
8883 + STRLEN(name
) + ap
->patlen
+ 1));
8884 if (sourcing_name
!= NULL
)
8886 sprintf((char *)sourcing_name
, s
,
8887 (char *)name
, (char *)ap
->pat
);
8891 smsg((char_u
*)_("Executing %s"), sourcing_name
);
8897 apc
->nextcmd
= ap
->cmds
;
8898 /* mark last command */
8899 for (cp
= ap
->cmds
; cp
->next
!= NULL
; cp
= cp
->next
)
8904 if (apc
->curpat
!= NULL
) /* found a match */
8907 if (stop_at_last
&& ap
->last
)
8913 * Get next autocommand command.
8914 * Called by do_cmdline() to get the next line for ":if".
8915 * Returns allocated string, or NULL for end of autocommands.
8919 getnextac(c
, cookie
, indent
)
8920 int c
; /* not used */
8922 int indent
; /* not used */
8924 AutoPatCmd
*acp
= (AutoPatCmd
*)cookie
;
8928 /* Can be called again after returning the last line. */
8929 if (acp
->curpat
== NULL
)
8932 /* repeat until we find an autocommand to execute */
8935 /* skip removed commands */
8936 while (acp
->nextcmd
!= NULL
&& acp
->nextcmd
->cmd
== NULL
)
8937 if (acp
->nextcmd
->last
)
8938 acp
->nextcmd
= NULL
;
8940 acp
->nextcmd
= acp
->nextcmd
->next
;
8942 if (acp
->nextcmd
!= NULL
)
8945 /* at end of commands, find next pattern that matches */
8946 if (acp
->curpat
->last
)
8949 acp
->curpat
= acp
->curpat
->next
;
8950 if (acp
->curpat
!= NULL
)
8951 auto_next_pat(acp
, TRUE
);
8952 if (acp
->curpat
== NULL
)
8960 verbose_enter_scroll();
8961 smsg((char_u
*)_("autocommand %s"), ac
->cmd
);
8962 msg_puts((char_u
*)"\n"); /* don't overwrite this either */
8963 verbose_leave_scroll();
8965 retval
= vim_strsave(ac
->cmd
);
8966 autocmd_nested
= ac
->nested
;
8968 current_SID
= ac
->scriptID
;
8971 acp
->nextcmd
= NULL
;
8973 acp
->nextcmd
= ac
->next
;
8978 * Return TRUE if there is a matching autocommand for "fname".
8979 * To account for buffer-local autocommands, function needs to know
8980 * in which buffer the file will be opened.
8983 has_autocmd(event
, sfname
, buf
)
8990 char_u
*tail
= gettail(sfname
);
8993 fname
= FullName_save(sfname
, FALSE
);
8997 #ifdef BACKSLASH_IN_FILENAME
8999 * Replace all backslashes with forward slashes. This makes the
9000 * autocommand patterns portable between Unix and MS-DOS.
9002 sfname
= vim_strsave(sfname
);
9004 forward_slash(sfname
);
9005 forward_slash(fname
);
9008 for (ap
= first_autopat
[(int)event
]; ap
!= NULL
; ap
= ap
->next
)
9009 if (ap
->pat
!= NULL
&& ap
->cmds
!= NULL
9010 && (ap
->buflocal_nr
== 0
9011 ? match_file_pat(NULL
, ap
->reg_prog
,
9012 fname
, sfname
, tail
, ap
->allow_dirs
)
9013 : buf
!= NULL
&& ap
->buflocal_nr
== buf
->b_fnum
9021 #ifdef BACKSLASH_IN_FILENAME
9028 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
9030 * Function given to ExpandGeneric() to obtain the list of autocommand group
9035 get_augroup_name(xp
, idx
)
9039 if (idx
== augroups
.ga_len
) /* add "END" add the end */
9040 return (char_u
*)"END";
9041 if (idx
>= augroups
.ga_len
) /* end of list */
9043 if (AUGROUP_NAME(idx
) == NULL
) /* skip deleted entries */
9044 return (char_u
*)"";
9045 return AUGROUP_NAME(idx
); /* return a name */
9048 static int include_groups
= FALSE
;
9051 set_context_in_autocmd(xp
, arg
, doautocmd
)
9054 int doautocmd
; /* TRUE for :doautocmd, FALSE for :autocmd */
9059 /* check for a group name, skip it if present */
9060 include_groups
= FALSE
;
9062 group
= au_get_grouparg(&arg
);
9063 if (group
== AUGROUP_ERROR
)
9065 /* If there only is a group name that's what we expand. */
9066 if (*arg
== NUL
&& group
!= AUGROUP_ALL
&& !vim_iswhite(arg
[-1]))
9069 group
= AUGROUP_ALL
;
9072 /* skip over event name */
9073 for (p
= arg
; *p
!= NUL
&& !vim_iswhite(*p
); ++p
)
9078 if (group
== AUGROUP_ALL
)
9079 include_groups
= TRUE
;
9080 xp
->xp_context
= EXPAND_EVENTS
; /* expand event name */
9081 xp
->xp_pattern
= arg
;
9085 /* skip over pattern */
9087 while (*arg
&& (!vim_iswhite(*arg
) || arg
[-1] == '\\'))
9090 return arg
; /* expand (next) command */
9093 xp
->xp_context
= EXPAND_FILES
; /* expand file names */
9095 xp
->xp_context
= EXPAND_NOTHING
; /* pattern is not expanded */
9100 * Function given to ExpandGeneric() to obtain the list of event names.
9104 get_event_name(xp
, idx
)
9108 if (idx
< augroups
.ga_len
) /* First list group names, if wanted */
9110 if (!include_groups
|| AUGROUP_NAME(idx
) == NULL
)
9111 return (char_u
*)""; /* skip deleted entries */
9112 return AUGROUP_NAME(idx
); /* return a name */
9114 return (char_u
*)event_names
[idx
- augroups
.ga_len
].name
;
9117 #endif /* FEAT_CMDL_COMPL */
9120 * Return TRUE if autocmd is supported.
9123 autocmd_supported(name
)
9128 return (event_name2nr(name
, &p
) != NUM_EVENTS
);
9132 * Return TRUE if an autocommand is defined for a group, event and
9133 * pattern: The group can be omitted to accept any group. "event" and "pattern"
9134 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
9135 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
9137 * exists("#Group") or
9138 * exists("#Group#Event") or
9139 * exists("#Group#Event#pat") or
9140 * exists("#Event") or
9141 * exists("#Event#pat")
9148 char_u
*pattern
= NULL
;
9153 buf_T
*buflocal_buf
= NULL
;
9157 /* Make a copy so that we can change the '#' chars to a NUL. */
9158 arg_save
= vim_strsave(arg
);
9159 if (arg_save
== NULL
)
9161 p
= vim_strchr(arg_save
, '#');
9165 /* First, look for an autocmd group name */
9166 group
= au_find_group(arg_save
);
9167 if (group
== AUGROUP_ERROR
)
9169 /* Didn't match a group name, assume the first argument is an event. */
9170 group
= AUGROUP_ALL
;
9171 event_name
= arg_save
;
9177 /* "Group": group name is present and it's recognized */
9182 /* Must be "Group#Event" or "Group#Event#pat". */
9184 p
= vim_strchr(event_name
, '#');
9186 *p
++ = NUL
; /* "Group#Event#pat" */
9189 pattern
= p
; /* "pattern" is NULL when there is no pattern */
9191 /* find the index (enum) for the event name */
9192 event
= event_name2nr(event_name
, &p
);
9194 /* return FALSE if the event name is not recognized */
9195 if (event
== NUM_EVENTS
)
9198 /* Find the first autocommand for this event.
9199 * If there isn't any, return FALSE;
9200 * If there is one and no pattern given, return TRUE; */
9201 ap
= first_autopat
[(int)event
];
9204 if (pattern
== NULL
)
9210 /* if pattern is "<buffer>", special handling is needed which uses curbuf */
9211 /* for pattern "<buffer=N>, fnamecmp() will work fine */
9212 if (STRICMP(pattern
, "<buffer>") == 0)
9213 buflocal_buf
= curbuf
;
9215 /* Check if there is an autocommand with the given pattern. */
9216 for ( ; ap
!= NULL
; ap
= ap
->next
)
9217 /* only use a pattern when it has not been removed and has commands. */
9218 /* For buffer-local autocommands, fnamecmp() works fine. */
9219 if (ap
->pat
!= NULL
&& ap
->cmds
!= NULL
9220 && (group
== AUGROUP_ALL
|| ap
->group
== group
)
9221 && (buflocal_buf
== NULL
9222 ? fnamecmp(ap
->pat
, pattern
) == 0
9223 : ap
->buflocal_nr
== buflocal_buf
->b_fnum
))
9234 #else /* FEAT_AUTOCMD */
9237 * Prepare for executing commands for (hidden) buffer "buf".
9238 * This is the non-autocommand version, it simply saves "curbuf" and sets
9239 * "curbuf" and "curwin" to match "buf".
9242 aucmd_prepbuf(aco
, buf
)
9243 aco_save_T
*aco
; /* structure to save values in */
9244 buf_T
*buf
; /* new curbuf */
9246 aco
->save_buf
= buf
;
9248 curwin
->w_buffer
= buf
;
9252 * Restore after executing commands for a (hidden) buffer.
9253 * This is the non-autocommand version.
9257 aco_save_T
*aco
; /* structure holding saved values */
9259 curbuf
= aco
->save_buf
;
9260 curwin
->w_buffer
= curbuf
;
9263 #endif /* FEAT_AUTOCMD */
9266 #if defined(FEAT_AUTOCMD) || defined(FEAT_WILDIGN) || defined(PROTO)
9268 * Try matching a filename with a "pattern" ("prog" is NULL), or use the
9269 * precompiled regprog "prog" ("pattern" is NULL). That avoids calling
9270 * vim_regcomp() often.
9271 * Used for autocommands and 'wildignore'.
9272 * Returns TRUE if there is a match, FALSE otherwise.
9275 match_file_pat(pattern
, prog
, fname
, sfname
, tail
, allow_dirs
)
9276 char_u
*pattern
; /* pattern to match with */
9277 regprog_T
*prog
; /* pre-compiled regprog or NULL */
9278 char_u
*fname
; /* full path of file name */
9279 char_u
*sfname
; /* short file name or NULL */
9280 char_u
*tail
; /* tail of path */
9281 int allow_dirs
; /* allow matching with dir */
9283 regmatch_T regmatch
;
9285 #ifdef FEAT_OSFILETYPE
9286 int no_pattern
= FALSE
; /* TRUE if check is filetype only */
9292 #ifdef CASE_INSENSITIVE_FILENAME
9293 regmatch
.rm_ic
= TRUE
; /* Always ignore case */
9295 regmatch
.rm_ic
= FALSE
; /* Don't ever ignore case */
9297 #ifdef FEAT_OSFILETYPE
9298 if (*pattern
== '<')
9300 /* There is a filetype condition specified with this pattern.
9301 * Check the filetype matches first. If not, don't bother with the
9302 * pattern (set regprog to NULL).
9303 * Always use magic for the regexp.
9306 for (type_start
= pattern
+ 1; (c
= *pattern
); pattern
++)
9308 if ((c
== ';' || c
== '>') && match
== FALSE
)
9310 *pattern
= NUL
; /* Terminate the string */
9311 match
= mch_check_filetype(fname
, type_start
);
9312 *pattern
= c
; /* Restore the terminator */
9313 type_start
= pattern
+ 1;
9319 /* (c should never be NUL, but check anyway) */
9320 if (match
== FALSE
|| c
== NUL
)
9321 regmatch
.regprog
= NULL
; /* Doesn't match - don't check pat. */
9322 else if (*pattern
== NUL
)
9324 regmatch
.regprog
= NULL
; /* Vim will try to free regprog later */
9325 no_pattern
= TRUE
; /* Always matches - don't check pat. */
9328 regmatch
.regprog
= vim_regcomp(pattern
+ 1, RE_MAGIC
);
9334 regmatch
.regprog
= prog
;
9336 regmatch
.regprog
= vim_regcomp(pattern
, RE_MAGIC
);
9340 * Try for a match with the pattern with:
9341 * 1. the full file name, when the pattern has a '/'.
9342 * 2. the short file name, when the pattern has a '/'.
9343 * 3. the tail of the file name, when the pattern has no '/'.
9346 #ifdef FEAT_OSFILETYPE
9347 /* If the check is for a filetype only and we don't care
9348 * about the path then skip all the regexp stuff.
9352 (regmatch
.regprog
!= NULL
9354 && (vim_regexec(®match
, fname
, (colnr_T
)0)
9356 && vim_regexec(®match
, sfname
, (colnr_T
)0))))
9357 || (!allow_dirs
&& vim_regexec(®match
, tail
, (colnr_T
)0)))))
9361 vim_free(regmatch
.regprog
);
9366 #if defined(FEAT_WILDIGN) || defined(PROTO)
9368 * Return TRUE if a file matches with a pattern in "list".
9369 * "list" is a comma-separated list of patterns, like 'wildignore'.
9370 * "sfname" is the short file name or NULL, "ffname" the long file name.
9373 match_file_list(list
, sfname
, ffname
)
9385 tail
= gettail(sfname
);
9387 /* try all patterns in 'wildignore' */
9391 copy_option_part(&p
, buf
, 100, ",");
9392 regpat
= file_pat_to_reg_pat(buf
, NULL
, &allow_dirs
, FALSE
);
9395 match
= match_file_pat(regpat
, NULL
, ffname
, sfname
,
9396 tail
, (int)allow_dirs
);
9406 * Convert the given pattern "pat" which has shell style wildcards in it, into
9407 * a regular expression, and return the result in allocated memory. If there
9408 * is a directory path separator to be matched, then TRUE is put in
9409 * allow_dirs, otherwise FALSE is put there -- webb.
9410 * Handle backslashes before special characters, like "\*" and "\ ".
9412 * If FEAT_OSFILETYPE defined then pass initial <type> through unchanged. Eg:
9413 * '<html>myfile' becomes '<html>^myfile$' -- leonard.
9415 * Returns NULL when out of memory.
9419 file_pat_to_reg_pat(pat
, pat_end
, allow_dirs
, no_bslash
)
9421 char_u
*pat_end
; /* first char after pattern or NULL */
9422 char *allow_dirs
; /* Result passed back out in here */
9423 int no_bslash
; /* Don't use a backward slash as pathsep */
9431 int add_dollar
= TRUE
;
9432 #ifdef FEAT_OSFILETYPE
9433 int check_length
= 0;
9436 if (allow_dirs
!= NULL
)
9437 *allow_dirs
= FALSE
;
9438 if (pat_end
== NULL
)
9439 pat_end
= pat
+ STRLEN(pat
);
9441 #ifdef FEAT_OSFILETYPE
9442 /* Find out how much of the string is the filetype check */
9445 /* Count chars until the next '>' */
9446 for (p
= pat
+ 1; p
< pat_end
&& *p
!= '>'; p
++)
9450 /* Pattern is of the form <.*>.* */
9451 check_length
= p
- pat
+ 1;
9452 if (p
+ 1 >= pat_end
)
9454 /* The 'pattern' is a filetype check ONLY */
9455 reg_pat
= (char_u
*)alloc(check_length
+ 1);
9456 if (reg_pat
!= NULL
)
9458 mch_memmove(reg_pat
, pat
, (size_t)check_length
);
9459 reg_pat
[check_length
] = NUL
;
9464 /* else: there was no closing '>' - assume it was a normal pattern */
9467 pat
+= check_length
;
9468 size
= 2 + check_length
;
9470 size
= 2; /* '^' at start, '$' at end */
9473 for (p
= pat
; p
< pat_end
; p
++)
9483 size
+= 2; /* extra backslash */
9485 #ifdef BACKSLASH_IN_FILENAME
9488 size
+= 4; /* could become "[\/]" */
9494 if (enc_dbcs
!= 0 && (*mb_ptr2len
)(p
) > 1)
9503 reg_pat
= alloc(size
+ 1);
9504 if (reg_pat
== NULL
)
9507 #ifdef FEAT_OSFILETYPE
9508 /* Copy the type check in to the start. */
9510 mch_memmove(reg_pat
, pat
- check_length
, (size_t)check_length
);
9517 while (pat
[0] == '*' && pat
< pat_end
- 1)
9524 while (endp
- pat
> 0 && *endp
== '*')
9528 for (p
= pat
; *p
&& nested
>= 0 && p
<= endp
; p
++)
9535 while (p
[1] == '*') /* "**" matches like "*" */
9540 if (allow_dirs
!= NULL
)
9545 reg_pat
[i
++] = '\\';
9557 #ifdef BACKSLASH_IN_FILENAME
9561 * "\x" to "\\x" e.g., "dir\file"
9562 * "\*" to "\\.*" e.g., "dir\*.c"
9563 * "\?" to "\\." e.g., "dir\??.c"
9564 * "\+" to "\+" e.g., "fileX\+.c"
9566 if ((vim_isfilec(p
[1]) || p
[1] == '*' || p
[1] == '?')
9570 reg_pat
[i
++] = '\\';
9573 if (allow_dirs
!= NULL
)
9580 #ifdef BACKSLASH_IN_FILENAME
9590 if (allow_dirs
!= NULL
&& vim_ispathsep(*p
)
9591 #ifdef BACKSLASH_IN_FILENAME
9592 && (!no_bslash
|| *p
!= '\\')
9596 reg_pat
[i
++] = '\\';
9600 #ifdef BACKSLASH_IN_FILENAME
9603 reg_pat
[i
++] = '\\';
9606 if (allow_dirs
!= NULL
)
9611 reg_pat
[i
++] = '\\';
9616 reg_pat
[i
++] = '\\';
9623 reg_pat
[i
++] = '\\';
9631 if (enc_dbcs
!= 0 && (*mb_ptr2len
)(p
) > 1)
9632 reg_pat
[i
++] = *p
++;
9635 if (allow_dirs
!= NULL
&& vim_ispathsep(*p
))
9647 EMSG(_("E219: Missing {."));
9649 EMSG(_("E220: Missing }."));