1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
39 #ifdef HAVE_ACL_SET_FILE
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
52 #include "region-cache.h"
54 #include "dispextern.h"
61 #endif /* not WINDOWSNT */
65 #include <sys/param.h>
69 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
70 redirector allows the six letters between 'Z' and 'a' as well. */
72 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
75 #define IS_DRIVE(x) c_isalpha (x)
77 /* Need to lower-case the drive letter, or else expanded
78 filenames will sometimes compare unequal, because
79 `expand-file-name' doesn't always down-case the drive letter. */
80 #define DRIVE_LETTER(x) c_tolower (x)
85 #include <allocator.h>
86 #include <careadlinkat.h>
87 #include <stat-time.h>
95 /* True during writing of auto-save files. */
96 static bool auto_saving
;
98 /* Nonzero umask during creation of auto-save directories. */
99 static mode_t auto_saving_dir_umask
;
101 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
102 a new file with the same mode as the original. */
103 static mode_t auto_save_mode_bits
;
105 /* Set by auto_save_1 if an error occurred during the last auto-save. */
106 static bool auto_save_error_occurred
;
108 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
109 number of a file system where time stamps were observed to to work. */
110 static bool valid_timestamp_file_system
;
111 static dev_t timestamp_file_system
;
113 /* The symbol bound to coding-system-for-read when
114 insert-file-contents is called for recovering a file. This is not
115 an actual coding system name, but just an indicator to tell
116 insert-file-contents to use `emacs-mule' with a special flag for
117 auto saving and recovering a file. */
118 static Lisp_Object Qauto_save_coding
;
120 /* Property name of a file name handler,
121 which gives a list of operations it handles.. */
122 static Lisp_Object Qoperations
;
124 /* Lisp functions for translating file formats. */
125 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
127 /* Lisp function for setting buffer-file-coding-system and the
128 multibyteness of the current buffer after inserting a file. */
129 static Lisp_Object Qafter_insert_file_set_coding
;
131 static Lisp_Object Qwrite_region_annotate_functions
;
132 /* Each time an annotation function changes the buffer, the new buffer
134 static Lisp_Object Vwrite_region_annotation_buffers
;
136 static Lisp_Object Qdelete_by_moving_to_trash
;
138 /* Lisp function for moving files to trash. */
139 static Lisp_Object Qmove_file_to_trash
;
141 /* Lisp function for recursively copying directories. */
142 static Lisp_Object Qcopy_directory
;
144 /* Lisp function for recursively deleting directories. */
145 static Lisp_Object Qdelete_directory
;
147 static Lisp_Object Qsubstitute_env_in_file_name
;
152 Lisp_Object Qfile_error
, Qfile_notify_error
;
153 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
154 static Lisp_Object Qexcl
;
155 Lisp_Object Qfile_name_history
;
157 static Lisp_Object Qcar_less_than_car
;
159 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
160 Lisp_Object
*, struct coding_system
*);
161 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
162 struct coding_system
*);
165 /* Return true if FILENAME exists. */
168 check_existing (const char *filename
)
170 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
173 /* Return true if file FILENAME exists and can be executed. */
176 check_executable (char *filename
)
178 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
181 /* Return true if file FILENAME exists and can be accessed
182 according to AMODE, which should include W_OK.
183 On failure, return false and set errno. */
186 check_writable (const char *filename
, int amode
)
189 /* FIXME: an faccessat implementation should be added to the
190 DOS/Windows ports and this #ifdef branch should be removed. */
192 if (stat (filename
, &st
) < 0)
195 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
196 #else /* not MSDOS */
197 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
199 /* faccessat may have returned failure because Cygwin couldn't
200 determine the file's UID or GID; if so, we return success. */
203 int faccessat_errno
= errno
;
205 if (stat (filename
, &st
) < 0)
207 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
208 errno
= faccessat_errno
;
212 #endif /* not MSDOS */
215 /* Signal a file-access failure. STRING describes the failure,
216 NAME the file involved, and ERRORNO the errno value.
218 If NAME is neither null nor a pair, package it up as a singleton
219 list before reporting it; this saves report_file_errno's caller the
220 trouble of preserving errno before calling list1. */
223 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
225 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
226 Lisp_Object errstring
;
229 synchronize_system_messages_locale ();
230 str
= strerror (errorno
);
231 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
232 Vlocale_coding_system
, 0);
238 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
241 /* System error messages are capitalized. Downcase the initial
242 unless it is followed by a slash. (The slash case caters to
243 error messages that begin with "I/O" or, in German, "E/A".) */
244 if (STRING_MULTIBYTE (errstring
)
245 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
249 str
= SSDATA (errstring
);
250 c
= STRING_CHAR ((unsigned char *) str
);
251 Faset (errstring
, make_number (0), make_number (downcase (c
)));
254 xsignal (Qfile_error
,
255 Fcons (build_string (string
), Fcons (errstring
, data
)));
259 /* Signal a file-access failure that set errno. STRING describes the
260 failure, NAME the file involved. When invoking this function, take
261 care to not use arguments such as build_string ("foo") that involve
262 side effects that may set errno. */
265 report_file_error (char const *string
, Lisp_Object name
)
267 report_file_errno (string
, name
, errno
);
271 close_file_unwind (int fd
)
277 fclose_unwind (void *arg
)
283 /* Restore point, having saved it as a marker. */
286 restore_point_unwind (Lisp_Object location
)
288 Fgoto_char (location
);
289 unchain_marker (XMARKER (location
));
293 static Lisp_Object Qexpand_file_name
;
294 static Lisp_Object Qsubstitute_in_file_name
;
295 static Lisp_Object Qdirectory_file_name
;
296 static Lisp_Object Qfile_name_directory
;
297 static Lisp_Object Qfile_name_nondirectory
;
298 static Lisp_Object Qunhandled_file_name_directory
;
299 static Lisp_Object Qfile_name_as_directory
;
300 static Lisp_Object Qcopy_file
;
301 static Lisp_Object Qmake_directory_internal
;
302 static Lisp_Object Qmake_directory
;
303 static Lisp_Object Qdelete_directory_internal
;
304 Lisp_Object Qdelete_file
;
305 static Lisp_Object Qrename_file
;
306 static Lisp_Object Qadd_name_to_file
;
307 static Lisp_Object Qmake_symbolic_link
;
308 Lisp_Object Qfile_exists_p
;
309 static Lisp_Object Qfile_executable_p
;
310 static Lisp_Object Qfile_readable_p
;
311 static Lisp_Object Qfile_writable_p
;
312 static Lisp_Object Qfile_symlink_p
;
313 static Lisp_Object Qaccess_file
;
314 Lisp_Object Qfile_directory_p
;
315 static Lisp_Object Qfile_regular_p
;
316 static Lisp_Object Qfile_accessible_directory_p
;
317 static Lisp_Object Qfile_modes
;
318 static Lisp_Object Qset_file_modes
;
319 static Lisp_Object Qset_file_times
;
320 static Lisp_Object Qfile_selinux_context
;
321 static Lisp_Object Qset_file_selinux_context
;
322 static Lisp_Object Qfile_acl
;
323 static Lisp_Object Qset_file_acl
;
324 static Lisp_Object Qfile_newer_than_file_p
;
325 Lisp_Object Qinsert_file_contents
;
326 static Lisp_Object Qchoose_write_coding_system
;
327 Lisp_Object Qwrite_region
;
328 static Lisp_Object Qverify_visited_file_modtime
;
329 static Lisp_Object Qset_visited_file_modtime
;
331 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
332 Sfind_file_name_handler
, 2, 2, 0,
333 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
334 Otherwise, return nil.
335 A file name is handled if one of the regular expressions in
336 `file-name-handler-alist' matches it.
338 If OPERATION equals `inhibit-file-name-operation', then we ignore
339 any handlers that are members of `inhibit-file-name-handlers',
340 but we still do run any other handlers. This lets handlers
341 use the standard functions without calling themselves recursively. */)
342 (Lisp_Object filename
, Lisp_Object operation
)
344 /* This function must not munge the match data. */
345 Lisp_Object chain
, inhibited_handlers
, result
;
349 CHECK_STRING (filename
);
351 if (EQ (operation
, Vinhibit_file_name_operation
))
352 inhibited_handlers
= Vinhibit_file_name_handlers
;
354 inhibited_handlers
= Qnil
;
356 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
357 chain
= XCDR (chain
))
363 Lisp_Object string
= XCAR (elt
);
365 Lisp_Object handler
= XCDR (elt
);
366 Lisp_Object operations
= Qnil
;
368 if (SYMBOLP (handler
))
369 operations
= Fget (handler
, Qoperations
);
372 && (match_pos
= fast_string_match (string
, filename
)) > pos
373 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
377 handler
= XCDR (elt
);
378 tem
= Fmemq (handler
, inhibited_handlers
);
392 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
394 doc
: /* Return the directory component in file name FILENAME.
395 Return nil if FILENAME does not include a directory.
396 Otherwise return a directory name.
397 Given a Unix syntax file name, returns a string ending in slash. */)
398 (Lisp_Object filename
)
401 register const char *beg
;
406 register const char *p
;
409 CHECK_STRING (filename
);
411 /* If the file name has special constructs in it,
412 call the corresponding file handler. */
413 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
416 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
418 return STRINGP (handled_name
) ? handled_name
: Qnil
;
422 beg
= xlispstrdupa (filename
);
424 beg
= SSDATA (filename
);
426 p
= beg
+ SBYTES (filename
);
428 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
430 /* only recognize drive specifier at the beginning */
432 /* handle the "/:d:foo" and "/:foo" cases correctly */
433 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
434 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
441 /* Expansion of "c:" to drive and default directory. */
444 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
445 char *res
= alloca (MAXPATHLEN
+ 1);
448 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
450 memcpy (res
, beg
, 2);
455 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
457 size_t l
= strlen (res
);
459 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
462 p
= beg
+ strlen (beg
);
463 dostounix_filename (beg
);
464 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
465 STRING_MULTIBYTE (filename
));
468 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
469 STRING_MULTIBYTE (filename
));
471 else if (STRING_MULTIBYTE (filename
))
473 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
474 dostounix_filename (SSDATA (tem_fn
));
476 if (!NILP (Vw32_downcase_file_names
))
477 tem_fn
= Fdowncase (tem_fn
);
482 dostounix_filename (beg
);
483 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
487 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
491 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
492 Sfile_name_nondirectory
, 1, 1, 0,
493 doc
: /* Return file name FILENAME sans its directory.
494 For example, in a Unix-syntax file name,
495 this is everything after the last slash,
496 or the entire name if it contains no slash. */)
497 (Lisp_Object filename
)
499 register const char *beg
, *p
, *end
;
502 CHECK_STRING (filename
);
504 /* If the file name has special constructs in it,
505 call the corresponding file handler. */
506 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
509 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
511 if (STRINGP (handled_name
))
513 error ("Invalid handler in `file-name-handler-alist'");
516 beg
= SSDATA (filename
);
517 end
= p
= beg
+ SBYTES (filename
);
519 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
521 /* only recognize drive specifier at beginning */
523 /* handle the "/:d:foo" case correctly */
524 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
529 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
532 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
533 Sunhandled_file_name_directory
, 1, 1, 0,
534 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
535 A `directly usable' directory name is one that may be used without the
536 intervention of any file handler.
537 If FILENAME is a directly usable file itself, return
538 \(file-name-directory FILENAME).
539 If FILENAME refers to a file which is not accessible from a local process,
540 then this should return nil.
541 The `call-process' and `start-process' functions use this function to
542 get a current directory to run processes in. */)
543 (Lisp_Object filename
)
547 /* If the file name has special constructs in it,
548 call the corresponding file handler. */
549 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
552 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
554 return STRINGP (handled_name
) ? handled_name
: Qnil
;
557 return Ffile_name_directory (filename
);
560 /* Maximum number of bytes that DST will be longer than SRC
561 in file_name_as_directory. This occurs when SRCLEN == 0. */
562 enum { file_name_as_directory_slop
= 2 };
564 /* Convert from file name SRC of length SRCLEN to directory name in
565 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
566 string. On UNIX, just make sure there is a terminating /. Return
567 the length of DST in bytes. */
570 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
581 memcpy (dst
, src
, srclen
);
582 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
583 dst
[srclen
++] = DIRECTORY_SEP
;
586 dostounix_filename (dst
);
591 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
592 Sfile_name_as_directory
, 1, 1, 0,
593 doc
: /* Return a string representing the file name FILE interpreted as a directory.
594 This operation exists because a directory is also a file, but its name as
595 a directory is different from its name as a file.
596 The result can be used as the value of `default-directory'
597 or passed as second argument to `expand-file-name'.
598 For a Unix-syntax file name, just appends a slash. */)
603 Lisp_Object handler
, val
;
610 /* If the file name has special constructs in it,
611 call the corresponding file handler. */
612 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
615 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
617 if (STRINGP (handled_name
))
619 error ("Invalid handler in `file-name-handler-alist'");
623 if (!NILP (Vw32_downcase_file_names
))
624 file
= Fdowncase (file
);
626 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
627 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
628 STRING_MULTIBYTE (file
));
629 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
634 /* Convert from directory name SRC of length SRCLEN to file name in
635 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
636 string. On UNIX, just make sure there isn't a terminating /.
637 Return the length of DST in bytes. */
640 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
642 /* Process as Unix format: just remove any final slash.
643 But leave "/" and "//" unchanged. */
646 && !IS_ANY_SEP (src
[srclen
- 2])
648 && IS_DIRECTORY_SEP (src
[srclen
- 1])
649 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
652 memcpy (dst
, src
, srclen
);
655 dostounix_filename (dst
);
660 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
662 doc
: /* Returns the file name of the directory named DIRECTORY.
663 This is the name of the file that holds the data for the directory DIRECTORY.
664 This operation exists because a directory is also a file, but its name as
665 a directory is different from its name as a file.
666 In Unix-syntax, this function just removes the final slash. */)
667 (Lisp_Object directory
)
671 Lisp_Object handler
, val
;
674 CHECK_STRING (directory
);
676 if (NILP (directory
))
679 /* If the file name has special constructs in it,
680 call the corresponding file handler. */
681 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
684 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
686 if (STRINGP (handled_name
))
688 error ("Invalid handler in `file-name-handler-alist'");
692 if (!NILP (Vw32_downcase_file_names
))
693 directory
= Fdowncase (directory
);
695 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
696 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
697 STRING_MULTIBYTE (directory
));
698 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
703 static const char make_temp_name_tbl
[64] =
705 'A','B','C','D','E','F','G','H',
706 'I','J','K','L','M','N','O','P',
707 'Q','R','S','T','U','V','W','X',
708 'Y','Z','a','b','c','d','e','f',
709 'g','h','i','j','k','l','m','n',
710 'o','p','q','r','s','t','u','v',
711 'w','x','y','z','0','1','2','3',
712 '4','5','6','7','8','9','-','_'
715 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
717 /* Value is a temporary file name starting with PREFIX, a string.
719 The Emacs process number forms part of the result, so there is
720 no danger of generating a name being used by another process.
721 In addition, this function makes an attempt to choose a name
722 which has no existing file. To make this work, PREFIX should be
723 an absolute file name.
725 BASE64_P means add the pid as 3 characters in base64
726 encoding. In this case, 6 characters will be added to PREFIX to
727 form the file name. Otherwise, if Emacs is running on a system
728 with long file names, add the pid as a decimal number.
730 This function signals an error if no unique file name could be
734 make_temp_name (Lisp_Object prefix
, bool base64_p
)
736 Lisp_Object val
, encoded_prefix
;
740 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
743 CHECK_STRING (prefix
);
745 /* VAL is created by adding 6 characters to PREFIX. The first
746 three are the PID of this process, in base 64, and the second
747 three are incremented if the file already exists. This ensures
748 262144 unique file names per PID per PREFIX. */
754 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
755 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
756 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
761 #ifdef HAVE_LONG_FILE_NAMES
762 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
764 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
765 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
766 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
771 encoded_prefix
= ENCODE_FILE (prefix
);
772 len
= SBYTES (encoded_prefix
);
773 val
= make_uninit_string (len
+ 3 + pidlen
);
775 memcpy (data
, SSDATA (encoded_prefix
), len
);
778 memcpy (p
, pidbuf
, pidlen
);
781 /* Here we try to minimize useless stat'ing when this function is
782 invoked many times successively with the same PREFIX. We achieve
783 this by initializing count to a random value, and incrementing it
786 We don't want make-temp-name to be called while dumping,
787 because then make_temp_name_count_initialized_p would get set
788 and then make_temp_name_count would not be set when Emacs starts. */
790 if (!make_temp_name_count_initialized_p
)
792 make_temp_name_count
= time (NULL
);
793 make_temp_name_count_initialized_p
= 1;
798 unsigned num
= make_temp_name_count
;
800 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
801 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
802 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
804 /* Poor man's congruential RN generator. Replace with
805 ++make_temp_name_count for debugging. */
806 make_temp_name_count
+= 25229;
807 make_temp_name_count
%= 225307;
809 if (!check_existing (data
))
811 /* We want to return only if errno is ENOENT. */
813 return DECODE_FILE (val
);
815 /* The error here is dubious, but there is little else we
816 can do. The alternatives are to return nil, which is
817 as bad as (and in many cases worse than) throwing the
818 error, or to ignore the error, which will likely result
819 in looping through 225307 stat's, which is not only
820 dog-slow, but also useless since eventually nil would
821 have to be returned anyway. */
822 report_file_error ("Cannot create temporary name for prefix",
830 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
831 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
832 The Emacs process number forms part of the result,
833 so there is no danger of generating a name being used by another process.
835 In addition, this function makes an attempt to choose a name
836 which has no existing file. To make this work,
837 PREFIX should be an absolute file name.
839 There is a race condition between calling `make-temp-name' and creating the
840 file which opens all kinds of security holes. For that reason, you should
841 probably use `make-temp-file' instead, except in three circumstances:
843 * If you are creating the file in the user's home directory.
844 * If you are creating a directory rather than an ordinary file.
845 * If you are taking special precautions as `make-temp-file' does. */)
848 return make_temp_name (prefix
, 0);
853 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
854 doc
: /* Convert filename NAME to absolute, and canonicalize it.
855 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
856 \(does not start with slash or tilde); both the directory name and
857 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
858 missing, the current buffer's value of `default-directory' is used.
859 NAME should be a string that is a valid file name for the underlying
861 File name components that are `.' are removed, and
862 so are file name components followed by `..', along with the `..' itself;
863 note that these simplifications are done without checking the resulting
864 file names in the file system.
865 Multiple consecutive slashes are collapsed into a single slash,
866 except at the beginning of the file name when they are significant (e.g.,
867 UNC file names on MS-Windows.)
868 An initial `~/' expands to your home directory.
869 An initial `~USER/' expands to USER's home directory.
870 See also the function `substitute-in-file-name'.
872 For technical reasons, this function can return correct but
873 non-intuitive results for the root directory; for instance,
874 \(expand-file-name ".." "/") returns "/..". For this reason, use
875 \(directory-file-name (file-name-directory dirname)) to traverse a
876 filesystem tree, not (expand-file-name ".." dirname). */)
877 (Lisp_Object name
, Lisp_Object default_directory
)
879 /* These point to SDATA and need to be careful with string-relocation
880 during GC (via DECODE_FILE). */
883 /* This should only point to alloca'd data. */
890 bool collapse_newdir
= 1;
894 Lisp_Object handler
, result
, handled_name
;
901 /* If the file name has special constructs in it,
902 call the corresponding file handler. */
903 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
906 handled_name
= call3 (handler
, Qexpand_file_name
,
907 name
, default_directory
);
908 if (STRINGP (handled_name
))
910 error ("Invalid handler in `file-name-handler-alist'");
914 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
915 if (NILP (default_directory
))
916 default_directory
= BVAR (current_buffer
, directory
);
917 if (! STRINGP (default_directory
))
920 /* "/" is not considered a root directory on DOS_NT, so using "/"
921 here causes an infinite recursion in, e.g., the following:
923 (let (default-directory)
924 (expand-file-name "a"))
926 To avoid this, we set default_directory to the root of the
928 default_directory
= build_string (emacs_root_dir ());
930 default_directory
= build_string ("/");
934 if (!NILP (default_directory
))
936 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
939 handled_name
= call3 (handler
, Qexpand_file_name
,
940 name
, default_directory
);
941 if (STRINGP (handled_name
))
943 error ("Invalid handler in `file-name-handler-alist'");
948 char *o
= SSDATA (default_directory
);
950 /* Make sure DEFAULT_DIRECTORY is properly expanded.
951 It would be better to do this down below where we actually use
952 default_directory. Unfortunately, calling Fexpand_file_name recursively
953 could invoke GC, and the strings might be relocated. This would
954 be annoying because we have pointers into strings lying around
955 that would need adjusting, and people would add new pointers to
956 the code and forget to adjust them, resulting in intermittent bugs.
957 Putting this call here avoids all that crud.
959 The EQ test avoids infinite recursion. */
960 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
961 /* Save time in some common cases - as long as default_directory
962 is not relative, it can be canonicalized with name below (if it
963 is needed at all) without requiring it to be expanded now. */
965 /* Detect MSDOS file names with drive specifiers. */
966 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
967 && IS_DIRECTORY_SEP (o
[2]))
969 /* Detect Windows file names in UNC format. */
970 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
972 #else /* not DOS_NT */
973 /* Detect Unix absolute file names (/... alone is not absolute on
975 && ! (IS_DIRECTORY_SEP (o
[0]))
976 #endif /* not DOS_NT */
982 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
986 multibyte
= STRING_MULTIBYTE (name
);
987 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
991 unsigned char *p
= SDATA (name
);
993 while (*p
&& ASCII_BYTE_P (*p
))
997 /* NAME is a pure ASCII string, and DEFAULT_DIRECTORY is
998 unibyte. Do not convert DEFAULT_DIRECTORY to
999 multibyte; instead, convert NAME to a unibyte string,
1000 so that the result of this function is also a unibyte
1001 string. This is needed during bootstrapping and
1002 dumping, when Emacs cannot decode file names, because
1003 the locale environment is not set up. */
1004 name
= make_unibyte_string (SSDATA (name
), SBYTES (name
));
1008 default_directory
= string_to_multibyte (default_directory
);
1012 name
= string_to_multibyte (name
);
1018 if (!NILP (Vw32_downcase_file_names
))
1019 default_directory
= Fdowncase (default_directory
);
1022 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
1023 nm
= xlispstrdupa (name
);
1026 /* Note if special escape prefix is present, but remove for now. */
1027 if (nm
[0] == '/' && nm
[1] == ':')
1033 /* Find and remove drive specifier if present; this makes nm absolute
1034 even if the rest of the name appears to be relative. Only look for
1035 drive specifier at the beginning. */
1036 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1038 drive
= (unsigned char) nm
[0];
1043 /* If we see "c://somedir", we want to strip the first slash after the
1044 colon when stripping the drive letter. Otherwise, this expands to
1046 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1049 /* Discard any previous drive specifier if nm is now in UNC format. */
1050 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1054 #endif /* WINDOWSNT */
1057 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1058 none are found, we can probably return right away. We will avoid
1059 allocating a new string if name is already fully expanded. */
1061 IS_DIRECTORY_SEP (nm
[0])
1063 && drive
&& !is_escaped
1066 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1070 /* If it turns out that the filename we want to return is just a
1071 suffix of FILENAME, we don't need to go through and edit
1072 things; we just need to construct a new string using data
1073 starting at the middle of FILENAME. If we set LOSE, that
1074 means we've discovered that we can't do that cool trick. */
1080 /* Since we know the name is absolute, we can assume that each
1081 element starts with a "/". */
1083 /* "." and ".." are hairy. */
1084 if (IS_DIRECTORY_SEP (p
[0])
1086 && (IS_DIRECTORY_SEP (p
[2])
1088 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1091 /* Replace multiple slashes with a single one, except
1092 leave leading "//" alone. */
1093 else if (IS_DIRECTORY_SEP (p
[0])
1094 && IS_DIRECTORY_SEP (p
[1])
1095 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1102 /* Make sure directories are all separated with /, but
1103 avoid allocation of a new string when not required. */
1104 dostounix_filename (nm
);
1106 if (IS_DIRECTORY_SEP (nm
[1]))
1108 if (strcmp (nm
, SSDATA (name
)) != 0)
1109 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1113 /* Drive must be set, so this is okay. */
1114 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1118 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1119 temp
[0] = DRIVE_LETTER (drive
);
1120 name
= concat2 (build_string (temp
), name
);
1123 if (!NILP (Vw32_downcase_file_names
))
1124 name
= Fdowncase (name
);
1127 #else /* not DOS_NT */
1128 if (strcmp (nm
, SSDATA (name
)) == 0)
1130 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1131 #endif /* not DOS_NT */
1135 /* At this point, nm might or might not be an absolute file name. We
1136 need to expand ~ or ~user if present, otherwise prefix nm with
1137 default_directory if nm is not absolute, and finally collapse /./
1138 and /foo/../ sequences.
1140 We set newdir to be the appropriate prefix if one is needed:
1141 - the relevant user directory if nm starts with ~ or ~user
1142 - the specified drive's working dir (DOS/NT only) if nm does not
1144 - the value of default_directory.
1146 Note that these prefixes are not guaranteed to be absolute (except
1147 for the working dir of a drive). Therefore, to ensure we always
1148 return an absolute name, if the final prefix is not absolute we
1149 append it to the current working directory. */
1153 if (nm
[0] == '~') /* prefix ~ */
1155 if (IS_DIRECTORY_SEP (nm
[1])
1156 || nm
[1] == 0) /* ~ by itself */
1160 if (!(newdir
= egetenv ("HOME")))
1163 /* `egetenv' may return a unibyte string, which will bite us since
1164 we expect the directory to be multibyte. */
1168 char newdir_utf8
[MAX_UTF8_PATH
];
1170 filename_from_ansi (newdir
, newdir_utf8
);
1171 tem
= build_string (newdir_utf8
);
1175 tem
= build_string (newdir
);
1177 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1179 hdir
= DECODE_FILE (tem
);
1180 newdir
= SSDATA (hdir
);
1183 collapse_newdir
= 0;
1186 else /* ~user/filename */
1189 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1191 o
= SAFE_ALLOCA (p
- nm
+ 1);
1192 memcpy (o
, nm
, p
- nm
);
1196 pw
= getpwnam (o
+ 1);
1202 newdir
= pw
->pw_dir
;
1203 /* `getpwnam' may return a unibyte string, which will
1204 bite us since we expect the directory to be
1206 tem
= build_string (newdir
);
1207 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1209 hdir
= DECODE_FILE (tem
);
1210 newdir
= SSDATA (hdir
);
1214 collapse_newdir
= 0;
1218 /* If we don't find a user of that name, leave the name
1219 unchanged; don't move nm forward to p. */
1224 /* On DOS and Windows, nm is absolute if a drive name was specified;
1225 use the drive's current directory as the prefix if needed. */
1226 if (!newdir
&& drive
)
1228 /* Get default directory if needed to make nm absolute. */
1230 if (!IS_DIRECTORY_SEP (nm
[0]))
1232 adir
= alloca (MAXPATHLEN
+ 1);
1233 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1237 Lisp_Object tem
= build_string (adir
);
1239 tem
= DECODE_FILE (tem
);
1240 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1245 /* Either nm starts with /, or drive isn't mounted. */
1247 adir
[0] = DRIVE_LETTER (drive
);
1256 /* Finally, if no prefix has been specified and nm is not absolute,
1257 then it must be expanded relative to default_directory. */
1261 /* /... alone is not absolute on DOS and Windows. */
1262 && !IS_DIRECTORY_SEP (nm
[0])
1265 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1269 newdir
= SSDATA (default_directory
);
1271 /* Note if special escape prefix is present, but remove for now. */
1272 if (newdir
[0] == '/' && newdir
[1] == ':')
1283 /* First ensure newdir is an absolute name. */
1285 /* Detect MSDOS file names with drive specifiers. */
1286 ! (IS_DRIVE (newdir
[0])
1287 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1289 /* Detect Windows file names in UNC format. */
1290 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1294 /* Effectively, let newdir be (expand-file-name newdir cwd).
1295 Because of the admonition against calling expand-file-name
1296 when we have pointers into lisp strings, we accomplish this
1297 indirectly by prepending newdir to nm if necessary, and using
1298 cwd (or the wd of newdir's drive) as the new newdir. */
1301 const int adir_size
= MAX_UTF8_PATH
;
1303 const int adir_size
= MAXPATHLEN
+ 1;
1306 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1308 drive
= (unsigned char) newdir
[0];
1311 if (!IS_DIRECTORY_SEP (nm
[0]))
1313 ptrdiff_t newlen
= strlen (newdir
);
1314 char *tmp
= alloca (newlen
+ file_name_as_directory_slop
1316 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1320 adir
= alloca (adir_size
);
1323 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1327 getcwd (adir
, adir_size
);
1330 Lisp_Object tem
= build_string (adir
);
1332 tem
= DECODE_FILE (tem
);
1333 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1338 /* Strip off drive name from prefix, if present. */
1339 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1345 /* Keep only a prefix from newdir if nm starts with slash
1346 (//server/share for UNC, nothing otherwise). */
1347 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1350 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1352 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1354 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1356 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1369 /* Ignore any slash at the end of newdir, unless newdir is
1370 just "/" or "//". */
1371 length
= strlen (newdir
);
1372 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1373 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1379 /* Now concatenate the directory and name to new space in the stack frame. */
1380 tlen
= length
+ file_name_as_directory_slop
+ strlen (nm
) + 1;
1382 /* Reserve space for drive specifier and escape prefix, since either
1383 or both may need to be inserted. (The Microsoft x86 compiler
1384 produces incorrect code if the following two lines are combined.) */
1385 target
= alloca (tlen
+ 4);
1387 #else /* not DOS_NT */
1388 target
= SAFE_ALLOCA (tlen
);
1389 #endif /* not DOS_NT */
1394 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1397 /* If newdir is effectively "C:/", then the drive letter will have
1398 been stripped and newdir will be "/". Concatenating with an
1399 absolute directory in nm produces "//", which will then be
1400 incorrectly treated as a network share. Ignore newdir in
1401 this case (keeping the drive letter). */
1402 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1403 && newdir
[1] == '\0'))
1406 memcpy (target
, newdir
, length
);
1411 file_name_as_directory (target
, newdir
, length
, multibyte
);
1414 strcat (target
, nm
);
1416 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1424 if (!IS_DIRECTORY_SEP (*p
))
1428 else if (p
[1] == '.'
1429 && (IS_DIRECTORY_SEP (p
[2])
1432 /* If "/." is the entire filename, keep the "/". Otherwise,
1433 just delete the whole "/.". */
1434 if (o
== target
&& p
[2] == '\0')
1438 else if (p
[1] == '.' && p
[2] == '.'
1439 /* `/../' is the "superroot" on certain file systems.
1440 Turned off on DOS_NT systems because they have no
1441 "superroot" and because this causes us to produce
1442 file names like "d:/../foo" which fail file-related
1443 functions of the underlying OS. (To reproduce, try a
1444 long series of "../../" in default_directory, longer
1445 than the number of levels from the root.) */
1449 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1454 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1457 /* Don't go below server level in UNC filenames. */
1458 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1459 && IS_DIRECTORY_SEP (*target
))
1463 /* Keep initial / only if this is the whole name. */
1464 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1468 else if (IS_DIRECTORY_SEP (p
[1])
1469 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1470 /* Collapse multiple "/", except leave leading "//" alone. */
1479 /* At last, set drive name. */
1481 /* Except for network file name. */
1482 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1483 #endif /* WINDOWSNT */
1485 if (!drive
) emacs_abort ();
1487 target
[0] = DRIVE_LETTER (drive
);
1490 /* Reinsert the escape prefix if required. */
1497 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1498 dostounix_filename (SSDATA (result
));
1500 if (!NILP (Vw32_downcase_file_names
))
1501 result
= Fdowncase (result
);
1504 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1505 #endif /* !DOS_NT */
1508 /* Again look to see if the file name has special constructs in it
1509 and perhaps call the corresponding file handler. This is needed
1510 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1511 the ".." component gives us "/user@host:/bar/../baz" which needs
1512 to be expanded again. */
1513 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1514 if (!NILP (handler
))
1516 handled_name
= call3 (handler
, Qexpand_file_name
,
1517 result
, default_directory
);
1518 if (! STRINGP (handled_name
))
1519 error ("Invalid handler in `file-name-handler-alist'");
1520 result
= handled_name
;
1528 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1529 This is the old version of expand-file-name, before it was thoroughly
1530 rewritten for Emacs 10.31. We leave this version here commented-out,
1531 because the code is very complex and likely to have subtle bugs. If
1532 bugs _are_ found, it might be of interest to look at the old code and
1533 see what did it do in the relevant situation.
1535 Don't remove this code: it's true that it will be accessible
1536 from the repository, but a few years from deletion, people will
1537 forget it is there. */
1539 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1540 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1541 "Convert FILENAME to absolute, and canonicalize it.\n\
1542 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1543 \(does not start with slash); if DEFAULT is nil or missing,\n\
1544 the current buffer's value of default-directory is used.\n\
1545 Filenames containing `.' or `..' as components are simplified;\n\
1546 initial `~/' expands to your home directory.\n\
1547 See also the function `substitute-in-file-name'.")
1549 Lisp_Object name
, defalt
;
1553 register unsigned char *newdir
, *p
, *o
;
1555 unsigned char *target
;
1558 CHECK_STRING (name
);
1561 /* If nm is absolute, flush ...// and detect /./ and /../.
1562 If no /./ or /../ we can return right away. */
1569 if (p
[0] == '/' && p
[1] == '/')
1571 if (p
[0] == '/' && p
[1] == '~')
1572 nm
= p
+ 1, lose
= 1;
1573 if (p
[0] == '/' && p
[1] == '.'
1574 && (p
[2] == '/' || p
[2] == 0
1575 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1581 if (nm
== SDATA (name
))
1583 return build_string (nm
);
1587 /* Now determine directory to start with and put it in NEWDIR. */
1591 if (nm
[0] == '~') /* prefix ~ */
1592 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1594 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1595 newdir
= (unsigned char *) "";
1598 else /* ~user/filename */
1600 /* Get past ~ to user. */
1601 unsigned char *user
= nm
+ 1;
1602 /* Find end of name. */
1603 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1604 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1605 /* Copy the user name into temp storage. */
1606 o
= alloca (len
+ 1);
1607 memcpy (o
, user
, len
);
1610 /* Look up the user name. */
1612 pw
= (struct passwd
*) getpwnam (o
+ 1);
1615 error ("\"%s\" isn't a registered user", o
+ 1);
1617 newdir
= (unsigned char *) pw
->pw_dir
;
1619 /* Discard the user name from NM. */
1623 if (nm
[0] != '/' && !newdir
)
1626 defalt
= current_buffer
->directory
;
1627 CHECK_STRING (defalt
);
1628 newdir
= SDATA (defalt
);
1631 /* Now concatenate the directory and name to new space in the stack frame. */
1633 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1634 target
= alloca (tlen
);
1639 if (nm
[0] == 0 || nm
[0] == '/')
1640 strcpy (target
, newdir
);
1642 file_name_as_directory (target
, newdir
);
1645 strcat (target
, nm
);
1647 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1658 else if (!strncmp (p
, "//", 2)
1664 else if (p
[0] == '/' && p
[1] == '.'
1665 && (p
[2] == '/' || p
[2] == 0))
1667 else if (!strncmp (p
, "/..", 3)
1668 /* `/../' is the "superroot" on certain file systems. */
1670 && (p
[3] == '/' || p
[3] == 0))
1672 while (o
!= target
&& *--o
!= '/')
1674 if (o
== target
&& *o
== '/')
1684 return make_string (target
, o
- target
);
1688 /* If /~ or // appears, discard everything through first slash. */
1690 file_name_absolute_p (const char *filename
)
1693 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1695 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1696 && IS_DIRECTORY_SEP (filename
[2]))
1702 search_embedded_absfilename (char *nm
, char *endp
)
1706 for (p
= nm
+ 1; p
< endp
; p
++)
1708 if (IS_DIRECTORY_SEP (p
[-1])
1709 && file_name_absolute_p (p
)
1710 #if defined (WINDOWSNT) || defined (CYGWIN)
1711 /* // at start of file name is meaningful in Apollo,
1712 WindowsNT and Cygwin systems. */
1713 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1714 #endif /* not (WINDOWSNT || CYGWIN) */
1717 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1718 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1720 char *o
= alloca (s
- p
+ 1);
1722 memcpy (o
, p
, s
- p
);
1725 /* If we have ~user and `user' exists, discard
1726 everything up to ~. But if `user' does not exist, leave
1727 ~user alone, it might be a literal file name. */
1729 pw
= getpwnam (o
+ 1);
1741 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1742 Ssubstitute_in_file_name
, 1, 1, 0,
1743 doc
: /* Substitute environment variables referred to in FILENAME.
1744 `$FOO' where FOO is an environment variable name means to substitute
1745 the value of that variable. The variable name should be terminated
1746 with a character not a letter, digit or underscore; otherwise, enclose
1747 the entire variable name in braces.
1749 If `/~' appears, all of FILENAME through that `/' is discarded.
1750 If `//' appears, everything up to and including the first of
1751 those `/' is discarded. */)
1752 (Lisp_Object filename
)
1754 char *nm
, *p
, *x
, *endp
;
1755 bool substituted
= false;
1758 Lisp_Object handler
;
1760 CHECK_STRING (filename
);
1762 multibyte
= STRING_MULTIBYTE (filename
);
1764 /* If the file name has special constructs in it,
1765 call the corresponding file handler. */
1766 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1767 if (!NILP (handler
))
1769 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1771 if (STRINGP (handled_name
))
1772 return handled_name
;
1773 error ("Invalid handler in `file-name-handler-alist'");
1776 /* Always work on a copy of the string, in case GC happens during
1777 decode of environment variables, causing the original Lisp_String
1778 data to be relocated. */
1779 nm
= xlispstrdupa (filename
);
1782 dostounix_filename (nm
);
1783 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1785 endp
= nm
+ SBYTES (filename
);
1787 /* If /~ or // appears, discard everything through first slash. */
1788 p
= search_embedded_absfilename (nm
, endp
);
1790 /* Start over with the new string, so we check the file-name-handler
1791 again. Important with filenames like "/home/foo//:/hello///there"
1792 which would substitute to "/:/hello///there" rather than "/there". */
1793 return Fsubstitute_in_file_name
1794 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1796 /* See if any variables are substituted into the string. */
1798 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1801 = (!substituted
? filename
1802 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1803 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1805 if (!EQ (tmp
, name
))
1813 if (!NILP (Vw32_downcase_file_names
))
1814 filename
= Fdowncase (filename
);
1819 xnm
= SSDATA (filename
);
1820 x
= xnm
+ SBYTES (filename
);
1822 /* If /~ or // appears, discard everything through first slash. */
1823 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1824 /* This time we do not start over because we've already expanded envvars
1825 and replaced $$ with $. Maybe we should start over as well, but we'd
1826 need to quote some $ to $$ first. */
1830 if (!NILP (Vw32_downcase_file_names
))
1832 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1834 xname
= Fdowncase (xname
);
1839 return (xnm
== SSDATA (filename
)
1841 : make_specified_string (xnm
, -1, x
- xnm
, multibyte
));
1844 /* A slightly faster and more convenient way to get
1845 (directory-file-name (expand-file-name FOO)). */
1848 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1850 register Lisp_Object absname
;
1852 absname
= Fexpand_file_name (filename
, defdir
);
1854 /* Remove final slash, if any (unless this is the root dir).
1855 stat behaves differently depending! */
1856 if (SCHARS (absname
) > 1
1857 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1858 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1859 /* We cannot take shortcuts; they might be wrong for magic file names. */
1860 absname
= Fdirectory_file_name (absname
);
1864 /* Signal an error if the file ABSNAME already exists.
1865 If INTERACTIVE, ask the user whether to proceed,
1866 and bypass the error if the user says to go ahead.
1867 QUERYSTRING is a name for the action that is being considered
1870 *STATPTR is used to store the stat information if the file exists.
1871 If the file does not exist, STATPTR->st_mode is set to 0.
1872 If STATPTR is null, we don't store into it.
1874 If QUICK, ask for y or n, not yes or no. */
1877 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1878 bool interactive
, struct stat
*statptr
,
1881 Lisp_Object tem
, encoded_filename
;
1882 struct stat statbuf
;
1883 struct gcpro gcpro1
;
1885 encoded_filename
= ENCODE_FILE (absname
);
1887 /* `stat' is a good way to tell whether the file exists,
1888 regardless of what access permissions it has. */
1889 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1891 if (S_ISDIR (statbuf
.st_mode
))
1892 xsignal2 (Qfile_error
,
1893 build_string ("File is a directory"), absname
);
1896 xsignal2 (Qfile_already_exists
,
1897 build_string ("File already exists"), absname
);
1899 tem
= format2 ("File %s already exists; %s anyway? ",
1900 absname
, build_string (querystring
));
1902 tem
= call1 (intern ("y-or-n-p"), tem
);
1904 tem
= do_yes_or_no_p (tem
);
1907 xsignal2 (Qfile_already_exists
,
1908 build_string ("File already exists"), absname
);
1915 statptr
->st_mode
= 0;
1920 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1921 "fCopy file: \nGCopy %s to file: \np\nP",
1922 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1923 If NEWNAME names a directory, copy FILE there.
1925 This function always sets the file modes of the output file to match
1928 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1929 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1930 signal a `file-already-exists' error without overwriting. If
1931 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1932 about overwriting; this is what happens in interactive use with M-x.
1933 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1936 Fourth arg KEEP-TIME non-nil means give the output file the same
1937 last-modified time as the old one. (This works on only some systems.)
1939 A prefix arg makes KEEP-TIME non-nil.
1941 If PRESERVE-UID-GID is non-nil, we try to transfer the
1942 uid and gid of FILE to NEWNAME.
1944 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1945 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1946 entries (depending on how Emacs was built). */)
1947 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
, Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
, Lisp_Object preserve_extended_attributes
)
1951 char buf
[16 * 1024];
1952 struct stat st
, out_st
;
1953 Lisp_Object handler
;
1954 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1955 ptrdiff_t count
= SPECPDL_INDEX ();
1956 Lisp_Object encoded_file
, encoded_newname
;
1958 security_context_t con
;
1965 encoded_file
= encoded_newname
= Qnil
;
1966 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1967 CHECK_STRING (file
);
1968 CHECK_STRING (newname
);
1970 if (!NILP (Ffile_directory_p (newname
)))
1971 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1973 newname
= Fexpand_file_name (newname
, Qnil
);
1975 file
= Fexpand_file_name (file
, Qnil
);
1977 /* If the input file name has special constructs in it,
1978 call the corresponding file handler. */
1979 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1980 /* Likewise for output file name. */
1982 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1983 if (!NILP (handler
))
1984 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1985 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1986 preserve_extended_attributes
));
1988 encoded_file
= ENCODE_FILE (file
);
1989 encoded_newname
= ENCODE_FILE (newname
);
1991 if (NILP (ok_if_already_exists
)
1992 || INTEGERP (ok_if_already_exists
))
1993 barf_or_query_if_file_exists (newname
, "copy to it",
1994 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1995 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1999 if (!NILP (preserve_extended_attributes
))
2001 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2002 if (acl
== NULL
&& acl_errno_valid (errno
))
2003 report_file_error ("Getting ACL", file
);
2005 if (!CopyFile (SDATA (encoded_file
),
2006 SDATA (encoded_newname
),
2009 /* CopyFile doesn't set errno when it fails. By far the most
2010 "popular" reason is that the target is read-only. */
2011 report_file_errno ("Copying file", list2 (file
, newname
),
2012 GetLastError () == 5 ? EACCES
: EPERM
);
2014 /* CopyFile retains the timestamp by default. */
2015 else if (NILP (keep_time
))
2017 struct timespec now
;
2021 filename
= SDATA (encoded_newname
);
2023 /* Ensure file is writable while its modified time is set. */
2024 attributes
= GetFileAttributes (filename
);
2025 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2026 now
= current_timespec ();
2027 if (set_file_times (-1, filename
, now
, now
))
2029 /* Restore original attributes. */
2030 SetFileAttributes (filename
, attributes
);
2031 xsignal2 (Qfile_date_error
,
2032 build_string ("Cannot set file date"), newname
);
2034 /* Restore original attributes. */
2035 SetFileAttributes (filename
, attributes
);
2040 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2041 if (fail
&& acl_errno_valid (errno
))
2042 report_file_error ("Setting ACL", newname
);
2046 #else /* not WINDOWSNT */
2048 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2052 report_file_error ("Opening input file", file
);
2054 record_unwind_protect_int (close_file_unwind
, ifd
);
2056 if (fstat (ifd
, &st
) != 0)
2057 report_file_error ("Input file status", file
);
2059 if (!NILP (preserve_extended_attributes
))
2062 if (is_selinux_enabled ())
2064 conlength
= fgetfilecon (ifd
, &con
);
2065 if (conlength
== -1)
2066 report_file_error ("Doing fgetfilecon", file
);
2071 if (out_st
.st_mode
!= 0
2072 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2073 report_file_errno ("Input and output files are the same",
2074 list2 (file
, newname
), 0);
2076 /* We can copy only regular files. */
2077 if (!S_ISREG (st
.st_mode
))
2078 report_file_errno ("Non-regular file", file
,
2079 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
2083 int new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0600 : 0666);
2085 int new_mask
= S_IREAD
| S_IWRITE
;
2087 ofd
= emacs_open (SSDATA (encoded_newname
),
2088 (O_WRONLY
| O_TRUNC
| O_CREAT
2089 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2093 report_file_error ("Opening output file", newname
);
2095 record_unwind_protect_int (close_file_unwind
, ofd
);
2099 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2100 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2101 report_file_error ("Write error", newname
);
2105 /* Preserve the original file permissions, and if requested, also its
2108 mode_t mode_mask
= 07777;
2109 if (!NILP (preserve_uid_gid
))
2111 /* Attempt to change owner and group. If that doesn't work
2112 attempt to change just the group, as that is sometimes allowed.
2113 Adjust the mode mask to eliminate setuid or setgid bits
2114 that are inappropriate if the owner and group are wrong. */
2115 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2117 mode_mask
&= ~06000;
2118 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2123 switch (!NILP (preserve_extended_attributes
)
2124 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2125 SSDATA (encoded_newname
), ofd
,
2126 st
.st_mode
& mode_mask
)
2127 : fchmod (ofd
, st
.st_mode
& mode_mask
))
2129 case -2: report_file_error ("Copying permissions from", file
);
2130 case -1: report_file_error ("Copying permissions to", newname
);
2133 #endif /* not MSDOS */
2138 /* Set the modified context back to the file. */
2139 bool fail
= fsetfilecon (ofd
, con
) != 0;
2140 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2141 if (fail
&& errno
!= ENOTSUP
)
2142 report_file_error ("Doing fsetfilecon", newname
);
2148 if (!NILP (keep_time
))
2150 struct timespec atime
= get_stat_atime (&st
);
2151 struct timespec mtime
= get_stat_mtime (&st
);
2152 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2153 xsignal2 (Qfile_date_error
,
2154 build_string ("Cannot set file date"), newname
);
2157 if (emacs_close (ofd
) < 0)
2158 report_file_error ("Write error", newname
);
2163 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2164 and if it can't, it tells so. Otherwise, under MSDOS we usually
2165 get only the READ bit, which will make the copied file read-only,
2166 so it's better not to chmod at all. */
2167 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2168 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2170 #endif /* not WINDOWSNT */
2172 /* Discard the unwind protects. */
2173 specpdl_ptr
= specpdl
+ count
;
2179 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2180 Smake_directory_internal
, 1, 1, 0,
2181 doc
: /* Create a new directory named DIRECTORY. */)
2182 (Lisp_Object directory
)
2185 Lisp_Object handler
;
2186 Lisp_Object encoded_dir
;
2188 CHECK_STRING (directory
);
2189 directory
= Fexpand_file_name (directory
, Qnil
);
2191 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2192 if (!NILP (handler
))
2193 return call2 (handler
, Qmake_directory_internal
, directory
);
2195 encoded_dir
= ENCODE_FILE (directory
);
2197 dir
= SSDATA (encoded_dir
);
2200 if (mkdir (dir
) != 0)
2202 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2204 report_file_error ("Creating directory", directory
);
2209 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2210 Sdelete_directory_internal
, 1, 1, 0,
2211 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2212 (Lisp_Object directory
)
2215 Lisp_Object encoded_dir
;
2217 CHECK_STRING (directory
);
2218 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2219 encoded_dir
= ENCODE_FILE (directory
);
2220 dir
= SSDATA (encoded_dir
);
2222 if (rmdir (dir
) != 0)
2223 report_file_error ("Removing directory", directory
);
2228 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2229 "(list (read-file-name \
2230 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2231 \"Move file to trash: \" \"Delete file: \") \
2232 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2233 (null current-prefix-arg))",
2234 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2235 If file has multiple names, it continues to exist with the other names.
2236 TRASH non-nil means to trash the file instead of deleting, provided
2237 `delete-by-moving-to-trash' is non-nil.
2239 When called interactively, TRASH is t if no prefix argument is given.
2240 With a prefix argument, TRASH is nil. */)
2241 (Lisp_Object filename
, Lisp_Object trash
)
2243 Lisp_Object handler
;
2244 Lisp_Object encoded_file
;
2245 struct gcpro gcpro1
;
2248 if (!NILP (Ffile_directory_p (filename
))
2249 && NILP (Ffile_symlink_p (filename
)))
2250 xsignal2 (Qfile_error
,
2251 build_string ("Removing old name: is a directory"),
2254 filename
= Fexpand_file_name (filename
, Qnil
);
2256 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2257 if (!NILP (handler
))
2258 return call3 (handler
, Qdelete_file
, filename
, trash
);
2260 if (delete_by_moving_to_trash
&& !NILP (trash
))
2261 return call1 (Qmove_file_to_trash
, filename
);
2263 encoded_file
= ENCODE_FILE (filename
);
2265 if (unlink (SSDATA (encoded_file
)) < 0)
2266 report_file_error ("Removing old name", filename
);
2271 internal_delete_file_1 (Lisp_Object ignore
)
2276 /* Delete file FILENAME, returning true if successful.
2277 This ignores `delete-by-moving-to-trash'. */
2280 internal_delete_file (Lisp_Object filename
)
2284 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2285 Qt
, internal_delete_file_1
);
2289 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2290 "fRename file: \nGRename %s to file: \np",
2291 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2292 If file has names other than FILE, it continues to have those names.
2293 Signals a `file-already-exists' error if a file NEWNAME already exists
2294 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2295 A number as third arg means request confirmation if NEWNAME already exists.
2296 This is what happens in interactive use with M-x. */)
2297 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2299 Lisp_Object handler
;
2300 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2301 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2303 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2304 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2305 CHECK_STRING (file
);
2306 CHECK_STRING (newname
);
2307 file
= Fexpand_file_name (file
, Qnil
);
2309 if ((!NILP (Ffile_directory_p (newname
)))
2311 /* If the file names are identical but for the case,
2312 don't attempt to move directory to itself. */
2313 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2317 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2318 ? file
: Fdirectory_file_name (file
));
2319 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2322 newname
= Fexpand_file_name (newname
, Qnil
);
2324 /* If the file name has special constructs in it,
2325 call the corresponding file handler. */
2326 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2328 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2329 if (!NILP (handler
))
2330 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2331 file
, newname
, ok_if_already_exists
));
2333 encoded_file
= ENCODE_FILE (file
);
2334 encoded_newname
= ENCODE_FILE (newname
);
2337 /* If the file names are identical but for the case, don't ask for
2338 confirmation: they simply want to change the letter-case of the
2340 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2342 if (NILP (ok_if_already_exists
)
2343 || INTEGERP (ok_if_already_exists
))
2344 barf_or_query_if_file_exists (newname
, "rename to it",
2345 INTEGERP (ok_if_already_exists
), 0, 0);
2346 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2348 int rename_errno
= errno
;
2349 if (rename_errno
== EXDEV
)
2352 symlink_target
= Ffile_symlink_p (file
);
2353 if (! NILP (symlink_target
))
2354 Fmake_symbolic_link (symlink_target
, newname
,
2355 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2356 else if (!NILP (Ffile_directory_p (file
)))
2357 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2359 /* We have already prompted if it was an integer, so don't
2360 have copy-file prompt again. */
2361 Fcopy_file (file
, newname
,
2362 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2365 count
= SPECPDL_INDEX ();
2366 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2368 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2369 call2 (Qdelete_directory
, file
, Qt
);
2371 Fdelete_file (file
, Qnil
);
2372 unbind_to (count
, Qnil
);
2375 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2381 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2382 "fAdd name to file: \nGName to add to %s: \np",
2383 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2384 Signals a `file-already-exists' error if a file NEWNAME already exists
2385 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2386 A number as third arg means request confirmation if NEWNAME already exists.
2387 This is what happens in interactive use with M-x. */)
2388 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2390 Lisp_Object handler
;
2391 Lisp_Object encoded_file
, encoded_newname
;
2392 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2394 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2395 encoded_file
= encoded_newname
= Qnil
;
2396 CHECK_STRING (file
);
2397 CHECK_STRING (newname
);
2398 file
= Fexpand_file_name (file
, Qnil
);
2400 if (!NILP (Ffile_directory_p (newname
)))
2401 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2403 newname
= Fexpand_file_name (newname
, Qnil
);
2405 /* If the file name has special constructs in it,
2406 call the corresponding file handler. */
2407 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2408 if (!NILP (handler
))
2409 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2410 newname
, ok_if_already_exists
));
2412 /* If the new name has special constructs in it,
2413 call the corresponding file handler. */
2414 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2415 if (!NILP (handler
))
2416 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2417 newname
, ok_if_already_exists
));
2419 encoded_file
= ENCODE_FILE (file
);
2420 encoded_newname
= ENCODE_FILE (newname
);
2422 if (NILP (ok_if_already_exists
)
2423 || INTEGERP (ok_if_already_exists
))
2424 barf_or_query_if_file_exists (newname
, "make it a new name",
2425 INTEGERP (ok_if_already_exists
), 0, 0);
2427 unlink (SSDATA (newname
));
2428 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2430 int link_errno
= errno
;
2431 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2438 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2439 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2440 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2441 Both args must be strings.
2442 Signals a `file-already-exists' error if a file LINKNAME already exists
2443 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2444 A number as third arg means request confirmation if LINKNAME already exists.
2445 This happens for interactive use with M-x. */)
2446 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2448 Lisp_Object handler
;
2449 Lisp_Object encoded_filename
, encoded_linkname
;
2450 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2452 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2453 encoded_filename
= encoded_linkname
= Qnil
;
2454 CHECK_STRING (filename
);
2455 CHECK_STRING (linkname
);
2456 /* If the link target has a ~, we must expand it to get
2457 a truly valid file name. Otherwise, do not expand;
2458 we want to permit links to relative file names. */
2459 if (SREF (filename
, 0) == '~')
2460 filename
= Fexpand_file_name (filename
, Qnil
);
2462 if (!NILP (Ffile_directory_p (linkname
)))
2463 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2465 linkname
= Fexpand_file_name (linkname
, Qnil
);
2467 /* If the file name has special constructs in it,
2468 call the corresponding file handler. */
2469 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2470 if (!NILP (handler
))
2471 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2472 linkname
, ok_if_already_exists
));
2474 /* If the new link name has special constructs in it,
2475 call the corresponding file handler. */
2476 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2477 if (!NILP (handler
))
2478 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2479 linkname
, ok_if_already_exists
));
2481 encoded_filename
= ENCODE_FILE (filename
);
2482 encoded_linkname
= ENCODE_FILE (linkname
);
2484 if (NILP (ok_if_already_exists
)
2485 || INTEGERP (ok_if_already_exists
))
2486 barf_or_query_if_file_exists (linkname
, "make it a link",
2487 INTEGERP (ok_if_already_exists
), 0, 0);
2488 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2490 /* If we didn't complain already, silently delete existing file. */
2492 if (errno
== EEXIST
)
2494 unlink (SSDATA (encoded_linkname
));
2495 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2502 if (errno
== ENOSYS
)
2505 xsignal1 (Qfile_error
,
2506 build_string ("Symbolic links are not supported"));
2509 symlink_errno
= errno
;
2510 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2518 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2520 doc
: /* Return t if file FILENAME specifies an absolute file name.
2521 On Unix, this is a name starting with a `/' or a `~'. */)
2522 (Lisp_Object filename
)
2524 CHECK_STRING (filename
);
2525 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2528 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2529 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2530 See also `file-readable-p' and `file-attributes'.
2531 This returns nil for a symlink to a nonexistent file.
2532 Use `file-symlink-p' to test for such links. */)
2533 (Lisp_Object filename
)
2535 Lisp_Object absname
;
2536 Lisp_Object handler
;
2538 CHECK_STRING (filename
);
2539 absname
= Fexpand_file_name (filename
, Qnil
);
2541 /* If the file name has special constructs in it,
2542 call the corresponding file handler. */
2543 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2544 if (!NILP (handler
))
2546 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2551 absname
= ENCODE_FILE (absname
);
2553 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2556 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2557 doc
: /* Return t if FILENAME can be executed by you.
2558 For a directory, this means you can access files in that directory. */)
2559 (Lisp_Object filename
)
2561 Lisp_Object absname
;
2562 Lisp_Object handler
;
2564 CHECK_STRING (filename
);
2565 absname
= Fexpand_file_name (filename
, Qnil
);
2567 /* If the file name has special constructs in it,
2568 call the corresponding file handler. */
2569 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2570 if (!NILP (handler
))
2571 return call2 (handler
, Qfile_executable_p
, absname
);
2573 absname
= ENCODE_FILE (absname
);
2575 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2578 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2579 doc
: /* Return t if file FILENAME exists and you can read it.
2580 See also `file-exists-p' and `file-attributes'. */)
2581 (Lisp_Object filename
)
2583 Lisp_Object absname
;
2584 Lisp_Object handler
;
2586 CHECK_STRING (filename
);
2587 absname
= Fexpand_file_name (filename
, Qnil
);
2589 /* If the file name has special constructs in it,
2590 call the corresponding file handler. */
2591 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2592 if (!NILP (handler
))
2593 return call2 (handler
, Qfile_readable_p
, absname
);
2595 absname
= ENCODE_FILE (absname
);
2596 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2600 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2601 doc
: /* Return t if file FILENAME can be written or created by you. */)
2602 (Lisp_Object filename
)
2604 Lisp_Object absname
, dir
, encoded
;
2605 Lisp_Object handler
;
2607 CHECK_STRING (filename
);
2608 absname
= Fexpand_file_name (filename
, Qnil
);
2610 /* If the file name has special constructs in it,
2611 call the corresponding file handler. */
2612 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2613 if (!NILP (handler
))
2614 return call2 (handler
, Qfile_writable_p
, absname
);
2616 encoded
= ENCODE_FILE (absname
);
2617 if (check_writable (SSDATA (encoded
), W_OK
))
2619 if (errno
!= ENOENT
)
2622 dir
= Ffile_name_directory (absname
);
2623 eassert (!NILP (dir
));
2625 dir
= Fdirectory_file_name (dir
);
2628 dir
= ENCODE_FILE (dir
);
2630 /* The read-only attribute of the parent directory doesn't affect
2631 whether a file or directory can be created within it. Some day we
2632 should check ACLs though, which do affect this. */
2633 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2635 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2639 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2640 doc
: /* Access file FILENAME, and get an error if that does not work.
2641 The second argument STRING is used in the error message.
2642 If there is no error, returns nil. */)
2643 (Lisp_Object filename
, Lisp_Object string
)
2645 Lisp_Object handler
, encoded_filename
, absname
;
2647 CHECK_STRING (filename
);
2648 absname
= Fexpand_file_name (filename
, Qnil
);
2650 CHECK_STRING (string
);
2652 /* If the file name has special constructs in it,
2653 call the corresponding file handler. */
2654 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2655 if (!NILP (handler
))
2656 return call3 (handler
, Qaccess_file
, absname
, string
);
2658 encoded_filename
= ENCODE_FILE (absname
);
2660 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2661 report_file_error (SSDATA (string
), filename
);
2666 /* Relative to directory FD, return the symbolic link value of FILENAME.
2667 On failure, return nil. */
2669 emacs_readlinkat (int fd
, char const *filename
)
2671 static struct allocator
const emacs_norealloc_allocator
=
2672 { xmalloc
, NULL
, xfree
, memory_full
};
2674 char readlink_buf
[1024];
2675 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2676 &emacs_norealloc_allocator
, readlinkat
);
2680 val
= build_unibyte_string (buf
);
2681 if (buf
[0] == '/' && strchr (buf
, ':'))
2682 val
= concat2 (build_unibyte_string ("/:"), val
);
2683 if (buf
!= readlink_buf
)
2685 val
= DECODE_FILE (val
);
2689 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2690 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2691 The value is the link target, as a string.
2692 Otherwise it returns nil.
2694 This function returns t when given the name of a symlink that
2695 points to a nonexistent file. */)
2696 (Lisp_Object filename
)
2698 Lisp_Object handler
;
2700 CHECK_STRING (filename
);
2701 filename
= Fexpand_file_name (filename
, Qnil
);
2703 /* If the file name has special constructs in it,
2704 call the corresponding file handler. */
2705 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2706 if (!NILP (handler
))
2707 return call2 (handler
, Qfile_symlink_p
, filename
);
2709 filename
= ENCODE_FILE (filename
);
2711 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2714 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2715 doc
: /* Return t if FILENAME names an existing directory.
2716 Symbolic links to directories count as directories.
2717 See `file-symlink-p' to distinguish symlinks. */)
2718 (Lisp_Object filename
)
2720 Lisp_Object absname
;
2721 Lisp_Object handler
;
2723 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2725 /* If the file name has special constructs in it,
2726 call the corresponding file handler. */
2727 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2728 if (!NILP (handler
))
2729 return call2 (handler
, Qfile_directory_p
, absname
);
2731 absname
= ENCODE_FILE (absname
);
2733 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2736 /* Return true if FILE is a directory or a symlink to a directory. */
2738 file_directory_p (char const *file
)
2741 /* This is cheaper than 'stat'. */
2742 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2745 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2749 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2750 Sfile_accessible_directory_p
, 1, 1, 0,
2751 doc
: /* Return t if file FILENAME names a directory you can open.
2752 For the value to be t, FILENAME must specify the name of a directory as a file,
2753 and the directory must allow you to open files in it. In order to use a
2754 directory as a buffer's current directory, this predicate must return true.
2755 A directory name spec may be given instead; then the value is t
2756 if the directory so specified exists and really is a readable and
2757 searchable directory. */)
2758 (Lisp_Object filename
)
2760 Lisp_Object absname
;
2761 Lisp_Object handler
;
2763 CHECK_STRING (filename
);
2764 absname
= Fexpand_file_name (filename
, Qnil
);
2766 /* If the file name has special constructs in it,
2767 call the corresponding file handler. */
2768 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2769 if (!NILP (handler
))
2771 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2776 absname
= ENCODE_FILE (absname
);
2777 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2780 /* If FILE is a searchable directory or a symlink to a
2781 searchable directory, return true. Otherwise return
2782 false and set errno to an error number. */
2784 file_accessible_directory_p (char const *file
)
2787 /* There's no need to test whether FILE is searchable, as the
2788 searchable/executable bit is invented on DOS_NT platforms. */
2789 return file_directory_p (file
);
2791 /* On POSIXish platforms, use just one system call; this avoids a
2792 race and is typically faster. */
2793 ptrdiff_t len
= strlen (file
);
2799 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2800 There are three exceptions: "", "/", and "//". Leave "" alone,
2801 as it's invalid. Append only "." to the other two exceptions as
2802 "/" and "//" are distinct on some platforms, whereas "/", "///",
2803 "////", etc. are all equivalent. */
2808 /* Just check for trailing '/' when deciding whether to append '/'.
2809 That's simpler than testing the two special cases "/" and "//",
2810 and it's a safe optimization here. */
2811 char *buf
= SAFE_ALLOCA (len
+ 3);
2812 memcpy (buf
, file
, len
);
2813 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2817 ok
= check_existing (dir
);
2818 saved_errno
= errno
;
2820 errno
= saved_errno
;
2825 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2826 doc
: /* Return t if FILENAME names a regular file.
2827 This is the sort of file that holds an ordinary stream of data bytes.
2828 Symbolic links to regular files count as regular files.
2829 See `file-symlink-p' to distinguish symlinks. */)
2830 (Lisp_Object filename
)
2832 register Lisp_Object absname
;
2834 Lisp_Object handler
;
2836 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2838 /* If the file name has special constructs in it,
2839 call the corresponding file handler. */
2840 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2841 if (!NILP (handler
))
2842 return call2 (handler
, Qfile_regular_p
, absname
);
2844 absname
= ENCODE_FILE (absname
);
2849 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2851 /* Tell stat to use expensive method to get accurate info. */
2852 Vw32_get_true_file_attributes
= Qt
;
2853 result
= stat (SDATA (absname
), &st
);
2854 Vw32_get_true_file_attributes
= tem
;
2858 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2861 if (stat (SSDATA (absname
), &st
) < 0)
2863 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2867 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2868 Sfile_selinux_context
, 1, 1, 0,
2869 doc
: /* Return SELinux context of file named FILENAME.
2870 The return value is a list (USER ROLE TYPE RANGE), where the list
2871 elements are strings naming the user, role, type, and range of the
2872 file's SELinux security context.
2874 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2875 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2876 (Lisp_Object filename
)
2878 Lisp_Object absname
;
2879 Lisp_Object values
[4];
2880 Lisp_Object handler
;
2882 security_context_t con
;
2887 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2889 /* If the file name has special constructs in it,
2890 call the corresponding file handler. */
2891 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2892 if (!NILP (handler
))
2893 return call2 (handler
, Qfile_selinux_context
, absname
);
2895 absname
= ENCODE_FILE (absname
);
2902 if (is_selinux_enabled ())
2904 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2907 context
= context_new (con
);
2908 if (context_user_get (context
))
2909 values
[0] = build_string (context_user_get (context
));
2910 if (context_role_get (context
))
2911 values
[1] = build_string (context_role_get (context
));
2912 if (context_type_get (context
))
2913 values
[2] = build_string (context_type_get (context
));
2914 if (context_range_get (context
))
2915 values
[3] = build_string (context_range_get (context
));
2916 context_free (context
);
2922 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2925 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2926 Sset_file_selinux_context
, 2, 2, 0,
2927 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2928 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2929 elements are strings naming the components of a SELinux context.
2931 Value is t if setting of SELinux context was successful, nil otherwise.
2933 This function does nothing and returns nil if SELinux is disabled,
2934 or if Emacs was not compiled with SELinux support. */)
2935 (Lisp_Object filename
, Lisp_Object context
)
2937 Lisp_Object absname
;
2938 Lisp_Object handler
;
2940 Lisp_Object encoded_absname
;
2941 Lisp_Object user
= CAR_SAFE (context
);
2942 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2943 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2944 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2945 security_context_t con
;
2948 context_t parsed_con
;
2951 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2953 /* If the file name has special constructs in it,
2954 call the corresponding file handler. */
2955 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2956 if (!NILP (handler
))
2957 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2960 if (is_selinux_enabled ())
2962 /* Get current file context. */
2963 encoded_absname
= ENCODE_FILE (absname
);
2964 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2967 parsed_con
= context_new (con
);
2968 /* Change the parts defined in the parameter.*/
2971 if (context_user_set (parsed_con
, SSDATA (user
)))
2972 error ("Doing context_user_set");
2976 if (context_role_set (parsed_con
, SSDATA (role
)))
2977 error ("Doing context_role_set");
2981 if (context_type_set (parsed_con
, SSDATA (type
)))
2982 error ("Doing context_type_set");
2984 if (STRINGP (range
))
2986 if (context_range_set (parsed_con
, SSDATA (range
)))
2987 error ("Doing context_range_set");
2990 /* Set the modified context back to the file. */
2991 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2992 context_str (parsed_con
))
2994 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2995 if (fail
&& errno
!= ENOTSUP
)
2996 report_file_error ("Doing lsetfilecon", absname
);
2998 context_free (parsed_con
);
3000 return fail
? Qnil
: Qt
;
3003 report_file_error ("Doing lgetfilecon", absname
);
3010 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3011 doc
: /* Return ACL entries of file named FILENAME.
3012 The entries are returned in a format suitable for use in `set-file-acl'
3013 but is otherwise undocumented and subject to change.
3014 Return nil if file does not exist or is not accessible, or if Emacs
3015 was unable to determine the ACL entries. */)
3016 (Lisp_Object filename
)
3018 Lisp_Object absname
;
3019 Lisp_Object handler
;
3020 #ifdef HAVE_ACL_SET_FILE
3022 Lisp_Object acl_string
;
3026 absname
= expand_and_dir_to_file (filename
,
3027 BVAR (current_buffer
, directory
));
3029 /* If the file name has special constructs in it,
3030 call the corresponding file handler. */
3031 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3032 if (!NILP (handler
))
3033 return call2 (handler
, Qfile_acl
, absname
);
3035 #ifdef HAVE_ACL_SET_FILE
3036 absname
= ENCODE_FILE (absname
);
3038 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3042 str
= acl_to_text (acl
, NULL
);
3049 acl_string
= build_string (str
);
3059 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3061 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3062 ACL-STRING should contain the textual representation of the ACL
3063 entries in a format suitable for the platform.
3065 Value is t if setting of ACL was successful, nil otherwise.
3067 Setting ACL for local files requires Emacs to be built with ACL
3069 (Lisp_Object filename
, Lisp_Object acl_string
)
3071 Lisp_Object absname
;
3072 Lisp_Object handler
;
3073 #ifdef HAVE_ACL_SET_FILE
3074 Lisp_Object encoded_absname
;
3079 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3081 /* If the file name has special constructs in it,
3082 call the corresponding file handler. */
3083 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3084 if (!NILP (handler
))
3085 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3087 #ifdef HAVE_ACL_SET_FILE
3088 if (STRINGP (acl_string
))
3090 acl
= acl_from_text (SSDATA (acl_string
));
3093 report_file_error ("Converting ACL", absname
);
3097 encoded_absname
= ENCODE_FILE (absname
);
3099 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3102 if (fail
&& acl_errno_valid (errno
))
3103 report_file_error ("Setting ACL", absname
);
3106 return fail
? Qnil
: Qt
;
3113 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3114 doc
: /* Return mode bits of file named FILENAME, as an integer.
3115 Return nil, if file does not exist or is not accessible. */)
3116 (Lisp_Object filename
)
3118 Lisp_Object absname
;
3120 Lisp_Object handler
;
3122 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3124 /* If the file name has special constructs in it,
3125 call the corresponding file handler. */
3126 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3127 if (!NILP (handler
))
3128 return call2 (handler
, Qfile_modes
, absname
);
3130 absname
= ENCODE_FILE (absname
);
3132 if (stat (SSDATA (absname
), &st
) < 0)
3135 return make_number (st
.st_mode
& 07777);
3138 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3139 "(let ((file (read-file-name \"File: \"))) \
3140 (list file (read-file-modes nil file)))",
3141 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3142 Only the 12 low bits of MODE are used.
3144 Interactively, mode bits are read by `read-file-modes', which accepts
3145 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3146 (Lisp_Object filename
, Lisp_Object mode
)
3148 Lisp_Object absname
, encoded_absname
;
3149 Lisp_Object handler
;
3151 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3152 CHECK_NUMBER (mode
);
3154 /* If the file name has special constructs in it,
3155 call the corresponding file handler. */
3156 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3157 if (!NILP (handler
))
3158 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3160 encoded_absname
= ENCODE_FILE (absname
);
3162 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3163 report_file_error ("Doing chmod", absname
);
3168 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3169 doc
: /* Set the file permission bits for newly created files.
3170 The argument MODE should be an integer; only the low 9 bits are used.
3171 This setting is inherited by subprocesses. */)
3174 CHECK_NUMBER (mode
);
3176 umask ((~ XINT (mode
)) & 0777);
3181 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3182 doc
: /* Return the default file protection for created files.
3183 The value is an integer. */)
3190 realmask
= umask (0);
3194 XSETINT (value
, (~ realmask
) & 0777);
3199 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3200 doc
: /* Set times of file FILENAME to TIMESTAMP.
3201 Set both access and modification times.
3202 Return t on success, else nil.
3203 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3205 (Lisp_Object filename
, Lisp_Object timestamp
)
3207 Lisp_Object absname
, encoded_absname
;
3208 Lisp_Object handler
;
3209 struct timespec t
= lisp_time_argument (timestamp
);
3211 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3213 /* If the file name has special constructs in it,
3214 call the corresponding file handler. */
3215 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3216 if (!NILP (handler
))
3217 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3219 encoded_absname
= ENCODE_FILE (absname
);
3222 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3225 /* Setting times on a directory always fails. */
3226 if (file_directory_p (SSDATA (encoded_absname
)))
3229 report_file_error ("Setting file times", absname
);
3237 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3238 doc
: /* Tell Unix to finish all pending disk updates. */)
3245 #endif /* HAVE_SYNC */
3247 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3248 doc
: /* Return t if file FILE1 is newer than file FILE2.
3249 If FILE1 does not exist, the answer is nil;
3250 otherwise, if FILE2 does not exist, the answer is t. */)
3251 (Lisp_Object file1
, Lisp_Object file2
)
3253 Lisp_Object absname1
, absname2
;
3254 struct stat st1
, st2
;
3255 Lisp_Object handler
;
3256 struct gcpro gcpro1
, gcpro2
;
3258 CHECK_STRING (file1
);
3259 CHECK_STRING (file2
);
3262 GCPRO2 (absname1
, file2
);
3263 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3264 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3267 /* If the file name has special constructs in it,
3268 call the corresponding file handler. */
3269 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3271 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3272 if (!NILP (handler
))
3273 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3275 GCPRO2 (absname1
, absname2
);
3276 absname1
= ENCODE_FILE (absname1
);
3277 absname2
= ENCODE_FILE (absname2
);
3280 if (stat (SSDATA (absname1
), &st1
) < 0)
3283 if (stat (SSDATA (absname2
), &st2
) < 0)
3286 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3290 #ifndef READ_BUF_SIZE
3291 #define READ_BUF_SIZE (64 << 10)
3293 /* Some buffer offsets are stored in 'int' variables. */
3294 verify (READ_BUF_SIZE
<= INT_MAX
);
3296 /* This function is called after Lisp functions to decide a coding
3297 system are called, or when they cause an error. Before they are
3298 called, the current buffer is set unibyte and it contains only a
3299 newly inserted text (thus the buffer was empty before the
3302 The functions may set markers, overlays, text properties, or even
3303 alter the buffer contents, change the current buffer.
3305 Here, we reset all those changes by:
3306 o set back the current buffer.
3307 o move all markers and overlays to BEG.
3308 o remove all text properties.
3309 o set back the buffer multibyteness. */
3312 decide_coding_unwind (Lisp_Object unwind_data
)
3314 Lisp_Object multibyte
, undo_list
, buffer
;
3316 multibyte
= XCAR (unwind_data
);
3317 unwind_data
= XCDR (unwind_data
);
3318 undo_list
= XCAR (unwind_data
);
3319 buffer
= XCDR (unwind_data
);
3321 set_buffer_internal (XBUFFER (buffer
));
3322 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3323 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3324 set_buffer_intervals (current_buffer
, NULL
);
3325 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3327 /* Now we are safe to change the buffer's multibyteness directly. */
3328 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3329 bset_undo_list (current_buffer
, undo_list
);
3332 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3333 object where slot 0 is the file descriptor, slot 1 specifies
3334 an offset to put the read bytes, and slot 2 is the maximum
3335 amount of bytes to read. Value is the number of bytes read. */
3338 read_non_regular (Lisp_Object state
)
3344 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3345 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3346 + XSAVE_INTEGER (state
, 1)),
3347 XSAVE_INTEGER (state
, 2));
3349 /* Fast recycle this object for the likely next call. */
3351 return make_number (nbytes
);
3355 /* Condition-case handler used when reading from non-regular files
3356 in insert-file-contents. */
3359 read_non_regular_quit (Lisp_Object ignore
)
3364 /* Return the file offset that VAL represents, checking for type
3365 errors and overflow. */
3367 file_offset (Lisp_Object val
)
3369 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3374 double v
= XFLOAT_DATA (val
);
3376 && (sizeof (off_t
) < sizeof v
3377 ? v
<= TYPE_MAXIMUM (off_t
)
3378 : v
< TYPE_MAXIMUM (off_t
)))
3382 wrong_type_argument (intern ("file-offset"), val
);
3385 /* Return a special time value indicating the error number ERRNUM. */
3386 static struct timespec
3387 time_error_value (int errnum
)
3389 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3390 ? NONEXISTENT_MODTIME_NSECS
3391 : UNKNOWN_MODTIME_NSECS
);
3392 return make_timespec (0, ns
);
3395 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3397 doc
: /* Insert contents of file FILENAME after point.
3398 Returns list of absolute file name and number of characters inserted.
3399 If second argument VISIT is non-nil, the buffer's visited filename and
3400 last save file modtime are set, and it is marked unmodified. If
3401 visiting and the file does not exist, visiting is completed before the
3404 The optional third and fourth arguments BEG and END specify what portion
3405 of the file to insert. These arguments count bytes in the file, not
3406 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3408 If optional fifth argument REPLACE is non-nil, replace the current
3409 buffer contents (in the accessible portion) with the file contents.
3410 This is better than simply deleting and inserting the whole thing
3411 because (1) it preserves some marker positions and (2) it puts less data
3412 in the undo list. When REPLACE is non-nil, the second return value is
3413 the number of characters that replace previous buffer contents.
3415 This function does code conversion according to the value of
3416 `coding-system-for-read' or `file-coding-system-alist', and sets the
3417 variable `last-coding-system-used' to the coding system actually used.
3419 In addition, this function decodes the inserted text from known formats
3420 by calling `format-decode', which see. */)
3421 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3424 struct timespec mtime
;
3426 ptrdiff_t inserted
= 0;
3428 off_t beg_offset
, end_offset
;
3430 ptrdiff_t count
= SPECPDL_INDEX ();
3431 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3432 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3434 ptrdiff_t total
= 0;
3435 bool not_regular
= 0;
3437 char read_buf
[READ_BUF_SIZE
];
3438 struct coding_system coding
;
3439 bool replace_handled
= 0;
3440 bool set_coding_system
= 0;
3441 Lisp_Object coding_system
;
3443 /* If the undo log only contains the insertion, there's no point
3444 keeping it. It's typically when we first fill a file-buffer. */
3445 bool empty_undo_list_p
3446 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3448 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3449 bool we_locked_file
= 0;
3452 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3453 error ("Cannot do file visiting in an indirect buffer");
3455 if (!NILP (BVAR (current_buffer
, read_only
)))
3456 Fbarf_if_buffer_read_only ();
3460 orig_filename
= Qnil
;
3463 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3465 CHECK_STRING (filename
);
3466 filename
= Fexpand_file_name (filename
, Qnil
);
3468 /* The value Qnil means that the coding system is not yet
3470 coding_system
= Qnil
;
3472 /* If the file name has special constructs in it,
3473 call the corresponding file handler. */
3474 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3475 if (!NILP (handler
))
3477 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3478 visit
, beg
, end
, replace
);
3479 if (CONSP (val
) && CONSP (XCDR (val
))
3480 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3481 inserted
= XINT (XCAR (XCDR (val
)));
3485 orig_filename
= filename
;
3486 filename
= ENCODE_FILE (filename
);
3488 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3493 report_file_error ("Opening input file", orig_filename
);
3494 mtime
= time_error_value (save_errno
);
3496 if (!NILP (Vcoding_system_for_read
))
3497 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3501 fd_index
= SPECPDL_INDEX ();
3502 record_unwind_protect_int (close_file_unwind
, fd
);
3504 /* Replacement should preserve point as it preserves markers. */
3505 if (!NILP (replace
))
3506 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3508 if (fstat (fd
, &st
) != 0)
3509 report_file_error ("Input file status", orig_filename
);
3510 mtime
= get_stat_mtime (&st
);
3512 /* This code will need to be changed in order to work on named
3513 pipes, and it's probably just not worth it. So we should at
3514 least signal an error. */
3515 if (!S_ISREG (st
.st_mode
))
3522 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3523 xsignal2 (Qfile_error
,
3524 build_string ("not a regular file"), orig_filename
);
3529 if (!NILP (beg
) || !NILP (end
))
3530 error ("Attempt to visit less than an entire file");
3531 if (BEG
< Z
&& NILP (replace
))
3532 error ("Cannot do file visiting in a non-empty buffer");
3536 beg_offset
= file_offset (beg
);
3541 end_offset
= file_offset (end
);
3545 end_offset
= TYPE_MAXIMUM (off_t
);
3548 end_offset
= st
.st_size
;
3550 /* A negative size can happen on a platform that allows file
3551 sizes greater than the maximum off_t value. */
3555 /* The file size returned from stat may be zero, but data
3556 may be readable nonetheless, for example when this is a
3557 file in the /proc filesystem. */
3558 if (end_offset
== 0)
3559 end_offset
= READ_BUF_SIZE
;
3563 /* Check now whether the buffer will become too large,
3564 in the likely case where the file's length is not changing.
3565 This saves a lot of needless work before a buffer overflow. */
3568 /* The likely offset where we will stop reading. We could read
3569 more (or less), if the file grows (or shrinks) as we read it. */
3570 off_t likely_end
= min (end_offset
, st
.st_size
);
3572 if (beg_offset
< likely_end
)
3575 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3576 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3577 off_t likely_growth
= likely_end
- beg_offset
;
3578 if (buf_growth_max
< likely_growth
)
3583 /* Prevent redisplay optimizations. */
3584 current_buffer
->clip_changed
= 1;
3586 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3588 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3589 setup_coding_system (coding_system
, &coding
);
3590 /* Ensure we set Vlast_coding_system_used. */
3591 set_coding_system
= 1;
3595 /* Decide the coding system to use for reading the file now
3596 because we can't use an optimized method for handling
3597 `coding:' tag if the current buffer is not empty. */
3598 if (!NILP (Vcoding_system_for_read
))
3599 coding_system
= Vcoding_system_for_read
;
3602 /* Don't try looking inside a file for a coding system
3603 specification if it is not seekable. */
3604 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3606 /* Find a coding system specified in the heading two
3607 lines or in the tailing several lines of the file.
3608 We assume that the 1K-byte and 3K-byte for heading
3609 and tailing respectively are sufficient for this
3613 if (st
.st_size
<= (1024 * 4))
3614 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3617 nread
= emacs_read (fd
, read_buf
, 1024);
3621 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3622 report_file_error ("Setting file position",
3624 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3625 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3630 report_file_error ("Read error", orig_filename
);
3633 struct buffer
*prev
= current_buffer
;
3634 Lisp_Object workbuf
;
3637 record_unwind_current_buffer ();
3639 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3640 buf
= XBUFFER (workbuf
);
3642 delete_all_overlays (buf
);
3643 bset_directory (buf
, BVAR (current_buffer
, directory
));
3644 bset_read_only (buf
, Qnil
);
3645 bset_filename (buf
, Qnil
);
3646 bset_undo_list (buf
, Qt
);
3647 eassert (buf
->overlays_before
== NULL
);
3648 eassert (buf
->overlays_after
== NULL
);
3650 set_buffer_internal (buf
);
3652 bset_enable_multibyte_characters (buf
, Qnil
);
3654 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3655 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3656 coding_system
= call2 (Vset_auto_coding_function
,
3657 filename
, make_number (nread
));
3658 set_buffer_internal (prev
);
3660 /* Discard the unwind protect for recovering the
3664 /* Rewind the file for the actual read done later. */
3665 if (lseek (fd
, 0, SEEK_SET
) < 0)
3666 report_file_error ("Setting file position", orig_filename
);
3670 if (NILP (coding_system
))
3672 /* If we have not yet decided a coding system, check
3673 file-coding-system-alist. */
3674 Lisp_Object args
[6];
3676 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3677 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3678 coding_system
= Ffind_operation_coding_system (6, args
);
3679 if (CONSP (coding_system
))
3680 coding_system
= XCAR (coding_system
);
3684 if (NILP (coding_system
))
3685 coding_system
= Qundecided
;
3687 CHECK_CODING_SYSTEM (coding_system
);
3689 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3690 /* We must suppress all character code conversion except for
3691 end-of-line conversion. */
3692 coding_system
= raw_text_coding_system (coding_system
);
3694 setup_coding_system (coding_system
, &coding
);
3695 /* Ensure we set Vlast_coding_system_used. */
3696 set_coding_system
= 1;
3699 /* If requested, replace the accessible part of the buffer
3700 with the file contents. Avoid replacing text at the
3701 beginning or end of the buffer that matches the file contents;
3702 that preserves markers pointing to the unchanged parts.
3704 Here we implement this feature in an optimized way
3705 for the case where code conversion is NOT needed.
3706 The following if-statement handles the case of conversion
3707 in a less optimal way.
3709 If the code conversion is "automatic" then we try using this
3710 method and hope for the best.
3711 But if we discover the need for conversion, we give up on this method
3712 and let the following if-statement handle the replace job. */
3715 && (NILP (coding_system
)
3716 || ! CODING_REQUIRE_DECODING (&coding
)))
3718 /* same_at_start and same_at_end count bytes,
3719 because file access counts bytes
3720 and BEG and END count bytes. */
3721 ptrdiff_t same_at_start
= BEGV_BYTE
;
3722 ptrdiff_t same_at_end
= ZV_BYTE
;
3724 /* There is still a possibility we will find the need to do code
3725 conversion. If that happens, set this variable to
3726 give up on handling REPLACE in the optimized way. */
3727 bool giveup_match_end
= 0;
3729 if (beg_offset
!= 0)
3731 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3732 report_file_error ("Setting file position", orig_filename
);
3737 /* Count how many chars at the start of the file
3738 match the text at the beginning of the buffer. */
3743 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3745 report_file_error ("Read error", orig_filename
);
3746 else if (nread
== 0)
3749 if (CODING_REQUIRE_DETECTION (&coding
))
3751 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3754 setup_coding_system (coding_system
, &coding
);
3757 if (CODING_REQUIRE_DECODING (&coding
))
3758 /* We found that the file should be decoded somehow.
3759 Let's give up here. */
3761 giveup_match_end
= 1;
3766 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3767 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3768 same_at_start
++, bufpos
++;
3769 /* If we found a discrepancy, stop the scan.
3770 Otherwise loop around and scan the next bufferful. */
3771 if (bufpos
!= nread
)
3775 /* If the file matches the buffer completely,
3776 there's no need to replace anything. */
3777 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3780 clear_unwind_protect (fd_index
);
3782 /* Truncate the buffer to the size of the file. */
3783 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3788 /* Count how many chars at the end of the file
3789 match the text at the end of the buffer. But, if we have
3790 already found that decoding is necessary, don't waste time. */
3791 while (!giveup_match_end
)
3793 int total_read
, nread
, bufpos
, trial
;
3796 /* At what file position are we now scanning? */
3797 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3798 /* If the entire file matches the buffer tail, stop the scan. */
3801 /* How much can we scan in the next step? */
3802 trial
= min (curpos
, sizeof read_buf
);
3803 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3804 report_file_error ("Setting file position", orig_filename
);
3806 total_read
= nread
= 0;
3807 while (total_read
< trial
)
3809 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3811 report_file_error ("Read error", orig_filename
);
3812 else if (nread
== 0)
3814 total_read
+= nread
;
3817 /* Scan this bufferful from the end, comparing with
3818 the Emacs buffer. */
3819 bufpos
= total_read
;
3821 /* Compare with same_at_start to avoid counting some buffer text
3822 as matching both at the file's beginning and at the end. */
3823 while (bufpos
> 0 && same_at_end
> same_at_start
3824 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3825 same_at_end
--, bufpos
--;
3827 /* If we found a discrepancy, stop the scan.
3828 Otherwise loop around and scan the preceding bufferful. */
3831 /* If this discrepancy is because of code conversion,
3832 we cannot use this method; giveup and try the other. */
3833 if (same_at_end
> same_at_start
3834 && FETCH_BYTE (same_at_end
- 1) >= 0200
3835 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3836 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3837 giveup_match_end
= 1;
3846 if (! giveup_match_end
)
3850 /* We win! We can handle REPLACE the optimized way. */
3852 /* Extend the start of non-matching text area to multibyte
3853 character boundary. */
3854 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3855 while (same_at_start
> BEGV_BYTE
3856 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3859 /* Extend the end of non-matching text area to multibyte
3860 character boundary. */
3861 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3862 while (same_at_end
< ZV_BYTE
3863 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3866 /* Don't try to reuse the same piece of text twice. */
3867 overlap
= (same_at_start
- BEGV_BYTE
3869 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3871 same_at_end
+= overlap
;
3873 /* Arrange to read only the nonmatching middle part of the file. */
3874 beg_offset
+= same_at_start
- BEGV_BYTE
;
3875 end_offset
-= ZV_BYTE
- same_at_end
;
3877 invalidate_buffer_caches (current_buffer
,
3878 BYTE_TO_CHAR (same_at_start
),
3879 BYTE_TO_CHAR (same_at_end
));
3880 del_range_byte (same_at_start
, same_at_end
, 0);
3881 /* Insert from the file at the proper position. */
3882 temp
= BYTE_TO_CHAR (same_at_start
);
3883 SET_PT_BOTH (temp
, same_at_start
);
3885 /* If display currently starts at beginning of line,
3886 keep it that way. */
3887 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3888 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3890 replace_handled
= 1;
3894 /* If requested, replace the accessible part of the buffer
3895 with the file contents. Avoid replacing text at the
3896 beginning or end of the buffer that matches the file contents;
3897 that preserves markers pointing to the unchanged parts.
3899 Here we implement this feature for the case where code conversion
3900 is needed, in a simple way that needs a lot of memory.
3901 The preceding if-statement handles the case of no conversion
3902 in a more optimized way. */
3903 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3905 ptrdiff_t same_at_start
= BEGV_BYTE
;
3906 ptrdiff_t same_at_end
= ZV_BYTE
;
3907 ptrdiff_t same_at_start_charpos
;
3908 ptrdiff_t inserted_chars
;
3911 unsigned char *decoded
;
3914 ptrdiff_t this_count
= SPECPDL_INDEX ();
3916 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3917 Lisp_Object conversion_buffer
;
3918 struct gcpro gcpro1
;
3920 conversion_buffer
= code_conversion_save (1, multibyte
);
3922 /* First read the whole file, performing code conversion into
3923 CONVERSION_BUFFER. */
3925 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3926 report_file_error ("Setting file position", orig_filename
);
3928 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3929 unprocessed
= 0; /* Bytes not processed in previous loop. */
3931 GCPRO1 (conversion_buffer
);
3934 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3935 quitting while reading a huge file. */
3937 /* Allow quitting out of the actual I/O. */
3940 this = emacs_read (fd
, read_buf
+ unprocessed
,
3941 READ_BUF_SIZE
- unprocessed
);
3947 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3948 BUF_Z (XBUFFER (conversion_buffer
)));
3949 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3950 unprocessed
+ this, conversion_buffer
);
3951 unprocessed
= coding
.carryover_bytes
;
3952 if (coding
.carryover_bytes
> 0)
3953 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3957 report_file_error ("Read error", orig_filename
);
3959 clear_unwind_protect (fd_index
);
3961 if (unprocessed
> 0)
3963 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3964 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3965 unprocessed
, conversion_buffer
);
3966 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3969 coding_system
= CODING_ID_NAME (coding
.id
);
3970 set_coding_system
= 1;
3971 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3972 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3973 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3975 /* Compare the beginning of the converted string with the buffer
3979 while (bufpos
< inserted
&& same_at_start
< same_at_end
3980 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3981 same_at_start
++, bufpos
++;
3983 /* If the file matches the head of buffer completely,
3984 there's no need to replace anything. */
3986 if (bufpos
== inserted
)
3988 /* Truncate the buffer to the size of the file. */
3989 if (same_at_start
!= same_at_end
)
3991 invalidate_buffer_caches (current_buffer
,
3992 BYTE_TO_CHAR (same_at_start
),
3993 BYTE_TO_CHAR (same_at_end
));
3994 del_range_byte (same_at_start
, same_at_end
, 0);
3998 unbind_to (this_count
, Qnil
);
4002 /* Extend the start of non-matching text area to the previous
4003 multibyte character boundary. */
4004 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4005 while (same_at_start
> BEGV_BYTE
4006 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4009 /* Scan this bufferful from the end, comparing with
4010 the Emacs buffer. */
4013 /* Compare with same_at_start to avoid counting some buffer text
4014 as matching both at the file's beginning and at the end. */
4015 while (bufpos
> 0 && same_at_end
> same_at_start
4016 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4017 same_at_end
--, bufpos
--;
4019 /* Extend the end of non-matching text area to the next
4020 multibyte character boundary. */
4021 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4022 while (same_at_end
< ZV_BYTE
4023 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4026 /* Don't try to reuse the same piece of text twice. */
4027 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4029 same_at_end
+= overlap
;
4031 /* If display currently starts at beginning of line,
4032 keep it that way. */
4033 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4034 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4036 /* Replace the chars that we need to replace,
4037 and update INSERTED to equal the number of bytes
4038 we are taking from the decoded string. */
4039 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4041 if (same_at_end
!= same_at_start
)
4043 invalidate_buffer_caches (current_buffer
,
4044 BYTE_TO_CHAR (same_at_start
),
4045 BYTE_TO_CHAR (same_at_end
));
4046 del_range_byte (same_at_start
, same_at_end
, 0);
4048 eassert (same_at_start
== GPT_BYTE
);
4049 same_at_start
= GPT_BYTE
;
4053 temp
= BYTE_TO_CHAR (same_at_start
);
4055 /* Insert from the file at the proper position. */
4056 SET_PT_BOTH (temp
, same_at_start
);
4057 same_at_start_charpos
4058 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4059 same_at_start
- BEGV_BYTE
4060 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4061 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4063 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4064 same_at_start
+ inserted
- BEGV_BYTE
4065 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4066 - same_at_start_charpos
);
4067 /* This binding is to avoid ask-user-about-supersession-threat
4068 being called in insert_from_buffer (via in
4069 prepare_to_modify_buffer). */
4070 specbind (intern ("buffer-file-name"), Qnil
);
4071 insert_from_buffer (XBUFFER (conversion_buffer
),
4072 same_at_start_charpos
, inserted_chars
, 0);
4073 /* Set `inserted' to the number of inserted characters. */
4074 inserted
= PT
- temp
;
4075 /* Set point before the inserted characters. */
4076 SET_PT_BOTH (temp
, same_at_start
);
4078 unbind_to (this_count
, Qnil
);
4084 total
= end_offset
- beg_offset
;
4086 /* For a special file, all we can do is guess. */
4087 total
= READ_BUF_SIZE
;
4089 if (NILP (visit
) && total
> 0)
4091 #ifdef CLASH_DETECTION
4092 if (!NILP (BVAR (current_buffer
, file_truename
))
4093 /* Make binding buffer-file-name to nil effective. */
4094 && !NILP (BVAR (current_buffer
, filename
))
4095 && SAVE_MODIFF
>= MODIFF
)
4097 #endif /* CLASH_DETECTION */
4098 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4101 move_gap_both (PT
, PT_BYTE
);
4102 if (GAP_SIZE
< total
)
4103 make_gap (total
- GAP_SIZE
);
4105 if (beg_offset
!= 0 || !NILP (replace
))
4107 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4108 report_file_error ("Setting file position", orig_filename
);
4111 /* In the following loop, HOW_MUCH contains the total bytes read so
4112 far for a regular file, and not changed for a special file. But,
4113 before exiting the loop, it is set to a negative value if I/O
4117 /* Total bytes inserted. */
4120 /* Here, we don't do code conversion in the loop. It is done by
4121 decode_coding_gap after all data are read into the buffer. */
4123 ptrdiff_t gap_size
= GAP_SIZE
;
4125 while (how_much
< total
)
4127 /* try is reserved in some compilers (Microsoft C) */
4128 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4135 /* Maybe make more room. */
4136 if (gap_size
< trytry
)
4138 make_gap (trytry
- gap_size
);
4139 gap_size
= GAP_SIZE
- inserted
;
4142 /* Read from the file, capturing `quit'. When an
4143 error occurs, end the loop, and arrange for a quit
4144 to be signaled after decoding the text we read. */
4145 nbytes
= internal_condition_case_1
4147 make_save_int_int_int (fd
, inserted
, trytry
),
4148 Qerror
, read_non_regular_quit
);
4156 this = XINT (nbytes
);
4160 /* Allow quitting out of the actual I/O. We don't make text
4161 part of the buffer until all the reading is done, so a C-g
4162 here doesn't do any harm. */
4165 this = emacs_read (fd
,
4166 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4180 /* For a regular file, where TOTAL is the real size,
4181 count HOW_MUCH to compare with it.
4182 For a special file, where TOTAL is just a buffer size,
4183 so don't bother counting in HOW_MUCH.
4184 (INSERTED is where we count the number of characters inserted.) */
4191 /* Now we have either read all the file data into the gap,
4192 or stop reading on I/O error or quit. If nothing was
4193 read, undo marking the buffer modified. */
4197 #ifdef CLASH_DETECTION
4199 unlock_file (BVAR (current_buffer
, file_truename
));
4201 Vdeactivate_mark
= old_Vdeactivate_mark
;
4204 Vdeactivate_mark
= Qt
;
4207 clear_unwind_protect (fd_index
);
4210 report_file_error ("Read error", orig_filename
);
4212 /* Make the text read part of the buffer. */
4213 GAP_SIZE
-= inserted
;
4215 GPT_BYTE
+= inserted
;
4217 ZV_BYTE
+= inserted
;
4222 /* Put an anchor to ensure multi-byte form ends at gap. */
4227 if (NILP (coding_system
))
4229 /* The coding system is not yet decided. Decide it by an
4230 optimized method for handling `coding:' tag.
4232 Note that we can get here only if the buffer was empty
4233 before the insertion. */
4235 if (!NILP (Vcoding_system_for_read
))
4236 coding_system
= Vcoding_system_for_read
;
4239 /* Since we are sure that the current buffer was empty
4240 before the insertion, we can toggle
4241 enable-multibyte-characters directly here without taking
4242 care of marker adjustment. By this way, we can run Lisp
4243 program safely before decoding the inserted text. */
4244 Lisp_Object unwind_data
;
4245 ptrdiff_t count1
= SPECPDL_INDEX ();
4247 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4248 Fcons (BVAR (current_buffer
, undo_list
),
4249 Fcurrent_buffer ()));
4250 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4251 bset_undo_list (current_buffer
, Qt
);
4252 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4254 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4256 coding_system
= call2 (Vset_auto_coding_function
,
4257 filename
, make_number (inserted
));
4260 if (NILP (coding_system
))
4262 /* If the coding system is not yet decided, check
4263 file-coding-system-alist. */
4264 Lisp_Object args
[6];
4266 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4267 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4268 coding_system
= Ffind_operation_coding_system (6, args
);
4269 if (CONSP (coding_system
))
4270 coding_system
= XCAR (coding_system
);
4272 unbind_to (count1
, Qnil
);
4273 inserted
= Z_BYTE
- BEG_BYTE
;
4276 if (NILP (coding_system
))
4277 coding_system
= Qundecided
;
4279 CHECK_CODING_SYSTEM (coding_system
);
4281 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4282 /* We must suppress all character code conversion except for
4283 end-of-line conversion. */
4284 coding_system
= raw_text_coding_system (coding_system
);
4285 setup_coding_system (coding_system
, &coding
);
4286 /* Ensure we set Vlast_coding_system_used. */
4287 set_coding_system
= 1;
4292 /* When we visit a file by raw-text, we change the buffer to
4294 if (CODING_FOR_UNIBYTE (&coding
)
4295 /* Can't do this if part of the buffer might be preserved. */
4297 /* Visiting a file with these coding system makes the buffer
4299 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4302 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4303 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4304 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4306 move_gap_both (PT
, PT_BYTE
);
4307 GAP_SIZE
+= inserted
;
4308 ZV_BYTE
-= inserted
;
4312 decode_coding_gap (&coding
, inserted
, inserted
);
4313 inserted
= coding
.produced_char
;
4314 coding_system
= CODING_ID_NAME (coding
.id
);
4316 else if (inserted
> 0)
4317 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4320 /* Call after-change hooks for the inserted text, aside from the case
4321 of normal visiting (not with REPLACE), which is done in a new buffer
4322 "before" the buffer is changed. */
4323 if (inserted
> 0 && total
> 0
4324 && (NILP (visit
) || !NILP (replace
)))
4326 signal_after_change (PT
, 0, inserted
);
4327 update_compositions (PT
, PT
, CHECK_BORDER
);
4330 /* Now INSERTED is measured in characters. */
4336 if (empty_undo_list_p
)
4337 bset_undo_list (current_buffer
, Qnil
);
4341 current_buffer
->modtime
= mtime
;
4342 current_buffer
->modtime_size
= st
.st_size
;
4343 bset_filename (current_buffer
, orig_filename
);
4346 SAVE_MODIFF
= MODIFF
;
4347 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4348 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4349 #ifdef CLASH_DETECTION
4352 if (!NILP (BVAR (current_buffer
, file_truename
)))
4353 unlock_file (BVAR (current_buffer
, file_truename
));
4354 unlock_file (filename
);
4356 #endif /* CLASH_DETECTION */
4358 xsignal2 (Qfile_error
,
4359 build_string ("not a regular file"), orig_filename
);
4362 if (set_coding_system
)
4363 Vlast_coding_system_used
= coding_system
;
4365 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4367 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4369 if (! NILP (insval
))
4371 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4372 wrong_type_argument (intern ("inserted-chars"), insval
);
4373 inserted
= XFASTINT (insval
);
4377 /* Decode file format. */
4380 /* Don't run point motion or modification hooks when decoding. */
4381 ptrdiff_t count1
= SPECPDL_INDEX ();
4382 ptrdiff_t old_inserted
= inserted
;
4383 specbind (Qinhibit_point_motion_hooks
, Qt
);
4384 specbind (Qinhibit_modification_hooks
, Qt
);
4386 /* Save old undo list and don't record undo for decoding. */
4387 old_undo
= BVAR (current_buffer
, undo_list
);
4388 bset_undo_list (current_buffer
, Qt
);
4392 insval
= call3 (Qformat_decode
,
4393 Qnil
, make_number (inserted
), visit
);
4394 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4395 wrong_type_argument (intern ("inserted-chars"), insval
);
4396 inserted
= XFASTINT (insval
);
4400 /* If REPLACE is non-nil and we succeeded in not replacing the
4401 beginning or end of the buffer text with the file's contents,
4402 call format-decode with `point' positioned at the beginning
4403 of the buffer and `inserted' equaling the number of
4404 characters in the buffer. Otherwise, format-decode might
4405 fail to correctly analyze the beginning or end of the buffer.
4406 Hence we temporarily save `point' and `inserted' here and
4407 restore `point' iff format-decode did not insert or delete
4408 any text. Otherwise we leave `point' at point-min. */
4409 ptrdiff_t opoint
= PT
;
4410 ptrdiff_t opoint_byte
= PT_BYTE
;
4411 ptrdiff_t oinserted
= ZV
- BEGV
;
4412 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4414 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4415 insval
= call3 (Qformat_decode
,
4416 Qnil
, make_number (oinserted
), visit
);
4417 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4418 wrong_type_argument (intern ("inserted-chars"), insval
);
4419 if (ochars_modiff
== CHARS_MODIFF
)
4420 /* format_decode didn't modify buffer's characters => move
4421 point back to position before inserted text and leave
4422 value of inserted alone. */
4423 SET_PT_BOTH (opoint
, opoint_byte
);
4425 /* format_decode modified buffer's characters => consider
4426 entire buffer changed and leave point at point-min. */
4427 inserted
= XFASTINT (insval
);
4430 /* For consistency with format-decode call these now iff inserted > 0
4431 (martin 2007-06-28). */
4432 p
= Vafter_insert_file_functions
;
4437 insval
= call1 (XCAR (p
), make_number (inserted
));
4440 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4441 wrong_type_argument (intern ("inserted-chars"), insval
);
4442 inserted
= XFASTINT (insval
);
4447 /* For the rationale of this see the comment on
4448 format-decode above. */
4449 ptrdiff_t opoint
= PT
;
4450 ptrdiff_t opoint_byte
= PT_BYTE
;
4451 ptrdiff_t oinserted
= ZV
- BEGV
;
4452 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4454 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4455 insval
= call1 (XCAR (p
), make_number (oinserted
));
4458 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4459 wrong_type_argument (intern ("inserted-chars"), insval
);
4460 if (ochars_modiff
== CHARS_MODIFF
)
4461 /* after_insert_file_functions didn't modify
4462 buffer's characters => move point back to
4463 position before inserted text and leave value of
4465 SET_PT_BOTH (opoint
, opoint_byte
);
4467 /* after_insert_file_functions did modify buffer's
4468 characters => consider entire buffer changed and
4469 leave point at point-min. */
4470 inserted
= XFASTINT (insval
);
4478 if (!empty_undo_list_p
)
4480 bset_undo_list (current_buffer
, old_undo
);
4481 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4483 /* Adjust the last undo record for the size change during
4484 the format conversion. */
4485 Lisp_Object tem
= XCAR (old_undo
);
4486 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4487 && INTEGERP (XCDR (tem
))
4488 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4489 XSETCDR (tem
, make_number (PT
+ inserted
));
4493 /* If undo_list was Qt before, keep it that way.
4494 Otherwise start with an empty undo_list. */
4495 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4497 unbind_to (count1
, Qnil
);
4501 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4503 /* If visiting nonexistent file, return nil. */
4504 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4507 /* We made a lot of deletions and insertions above, so invalidate
4508 the newline cache for the entire region of the inserted
4510 if (current_buffer
->newline_cache
)
4511 invalidate_region_cache (current_buffer
,
4512 current_buffer
->newline_cache
,
4513 PT
- BEG
, Z
- PT
- inserted
);
4516 Fsignal (Qquit
, Qnil
);
4518 /* Retval needs to be dealt with in all cases consistently. */
4520 val
= list2 (orig_filename
, make_number (inserted
));
4522 RETURN_UNGCPRO (unbind_to (count
, val
));
4525 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4528 build_annotations_unwind (Lisp_Object arg
)
4530 Vwrite_region_annotation_buffers
= arg
;
4533 /* Decide the coding-system to encode the data with. */
4535 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4536 Schoose_write_coding_system
, 3, 6, 0,
4537 doc
: /* Choose the coding system for writing a file.
4538 Arguments are as for `write-region'.
4539 This function is for internal use only. It may prompt the user. */ )
4540 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4541 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4544 Lisp_Object eol_parent
= Qnil
;
4546 /* Mimic write-region behavior. */
4549 XSETFASTINT (start
, BEGV
);
4550 XSETFASTINT (end
, ZV
);
4554 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4555 BVAR (current_buffer
, auto_save_file_name
))))
4560 else if (!NILP (Vcoding_system_for_write
))
4562 val
= Vcoding_system_for_write
;
4563 if (coding_system_require_warning
4564 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4565 /* Confirm that VAL can surely encode the current region. */
4566 val
= call5 (Vselect_safe_coding_system_function
,
4567 start
, end
, list2 (Qt
, val
),
4572 /* If the variable `buffer-file-coding-system' is set locally,
4573 it means that the file was read with some kind of code
4574 conversion or the variable is explicitly set by users. We
4575 had better write it out with the same coding system even if
4576 `enable-multibyte-characters' is nil.
4578 If it is not set locally, we anyway have to convert EOL
4579 format if the default value of `buffer-file-coding-system'
4580 tells that it is not Unix-like (LF only) format. */
4581 bool using_default_coding
= 0;
4582 bool force_raw_text
= 0;
4584 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4586 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4589 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4595 /* Check file-coding-system-alist. */
4596 Lisp_Object args
[7], coding_systems
;
4598 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4599 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4601 coding_systems
= Ffind_operation_coding_system (7, args
);
4602 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4603 val
= XCDR (coding_systems
);
4608 /* If we still have not decided a coding system, use the
4609 default value of buffer-file-coding-system. */
4610 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4611 using_default_coding
= 1;
4614 if (! NILP (val
) && ! force_raw_text
)
4616 Lisp_Object spec
, attrs
;
4618 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4619 attrs
= AREF (spec
, 0);
4620 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4625 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4626 /* Confirm that VAL can surely encode the current region. */
4627 val
= call5 (Vselect_safe_coding_system_function
,
4628 start
, end
, val
, Qnil
, filename
);
4630 /* If the decided coding-system doesn't specify end-of-line
4631 format, we use that of
4632 `default-buffer-file-coding-system'. */
4633 if (! using_default_coding
4634 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4635 val
= (coding_inherit_eol_type
4636 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4638 /* If we decide not to encode text, use `raw-text' or one of its
4641 val
= raw_text_coding_system (val
);
4644 val
= coding_inherit_eol_type (val
, eol_parent
);
4648 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4649 "r\nFWrite region to file: \ni\ni\ni\np",
4650 doc
: /* Write current region into specified file.
4651 When called from a program, requires three arguments:
4652 START, END and FILENAME. START and END are normally buffer positions
4653 specifying the part of the buffer to write.
4654 If START is nil, that means to use the entire buffer contents.
4655 If START is a string, then output that string to the file
4656 instead of any buffer contents; END is ignored.
4658 Optional fourth argument APPEND if non-nil means
4659 append to existing file contents (if any). If it is a number,
4660 seek to that offset in the file before writing.
4661 Optional fifth argument VISIT, if t or a string, means
4662 set the last-save-file-modtime of buffer to this file's modtime
4663 and mark buffer not modified.
4664 If VISIT is a string, it is a second file name;
4665 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4666 VISIT is also the file name to lock and unlock for clash detection.
4667 If VISIT is neither t nor nil nor a string,
4668 that means do not display the \"Wrote file\" message.
4669 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4670 use for locking and unlocking, overriding FILENAME and VISIT.
4671 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4672 for an existing file with the same name. If MUSTBENEW is `excl',
4673 that means to get an error if the file already exists; never overwrite.
4674 If MUSTBENEW is neither nil nor `excl', that means ask for
4675 confirmation before overwriting, but do go ahead and overwrite the file
4676 if the user confirms.
4678 This does code conversion according to the value of
4679 `coding-system-for-write', `buffer-file-coding-system', or
4680 `file-coding-system-alist', and sets the variable
4681 `last-coding-system-used' to the coding system actually used.
4683 This calls `write-region-annotate-functions' at the start, and
4684 `write-region-post-annotation-function' at the end. */)
4685 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4686 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4688 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4692 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4693 descriptor for FILENAME, so do not open or close FILENAME. */
4696 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4697 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4698 Lisp_Object mustbenew
, int desc
)
4702 off_t offset
IF_LINT (= 0);
4703 bool open_and_close_file
= desc
< 0;
4708 struct timespec modtime
;
4709 ptrdiff_t count
= SPECPDL_INDEX ();
4710 ptrdiff_t count1
IF_LINT (= 0);
4711 Lisp_Object handler
;
4712 Lisp_Object visit_file
;
4713 Lisp_Object annotations
;
4714 Lisp_Object encoded_filename
;
4715 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4716 bool quietly
= !NILP (visit
);
4717 bool file_locked
= 0;
4718 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4719 struct buffer
*given_buffer
;
4720 struct coding_system coding
;
4722 if (current_buffer
->base_buffer
&& visiting
)
4723 error ("Cannot do file visiting in an indirect buffer");
4725 if (!NILP (start
) && !STRINGP (start
))
4726 validate_region (&start
, &end
);
4729 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4731 filename
= Fexpand_file_name (filename
, Qnil
);
4733 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4734 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4736 if (STRINGP (visit
))
4737 visit_file
= Fexpand_file_name (visit
, Qnil
);
4739 visit_file
= filename
;
4741 if (NILP (lockname
))
4742 lockname
= visit_file
;
4746 /* If the file name has special constructs in it,
4747 call the corresponding file handler. */
4748 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4749 /* If FILENAME has no handler, see if VISIT has one. */
4750 if (NILP (handler
) && STRINGP (visit
))
4751 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4753 if (!NILP (handler
))
4756 val
= call6 (handler
, Qwrite_region
, start
, end
,
4757 filename
, append
, visit
);
4761 SAVE_MODIFF
= MODIFF
;
4762 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4763 bset_filename (current_buffer
, visit_file
);
4769 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4771 /* Special kludge to simplify auto-saving. */
4774 /* Do it later, so write-region-annotate-function can work differently
4775 if we save "the buffer" vs "a region".
4776 This is useful in tar-mode. --Stef
4777 XSETFASTINT (start, BEG);
4778 XSETFASTINT (end, Z); */
4782 record_unwind_protect (build_annotations_unwind
,
4783 Vwrite_region_annotation_buffers
);
4784 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4786 given_buffer
= current_buffer
;
4788 if (!STRINGP (start
))
4790 annotations
= build_annotations (start
, end
);
4792 if (current_buffer
!= given_buffer
)
4794 XSETFASTINT (start
, BEGV
);
4795 XSETFASTINT (end
, ZV
);
4801 XSETFASTINT (start
, BEGV
);
4802 XSETFASTINT (end
, ZV
);
4807 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4809 /* Decide the coding-system to encode the data with.
4810 We used to make this choice before calling build_annotations, but that
4811 leads to problems when a write-annotate-function takes care of
4812 unsavable chars (as was the case with X-Symbol). */
4813 Vlast_coding_system_used
=
4814 Fchoose_write_coding_system (start
, end
, filename
,
4815 append
, visit
, lockname
);
4817 setup_coding_system (Vlast_coding_system_used
, &coding
);
4819 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4820 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4822 #ifdef CLASH_DETECTION
4823 if (open_and_close_file
&& !auto_saving
)
4825 lock_file (lockname
);
4828 #endif /* CLASH_DETECTION */
4830 encoded_filename
= ENCODE_FILE (filename
);
4831 fn
= SSDATA (encoded_filename
);
4832 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4833 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4834 if (NUMBERP (append
))
4835 offset
= file_offset (append
);
4836 else if (!NILP (append
))
4837 open_flags
|= O_APPEND
;
4839 mode
= S_IREAD
| S_IWRITE
;
4841 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4844 if (open_and_close_file
)
4846 desc
= emacs_open (fn
, open_flags
, mode
);
4849 int open_errno
= errno
;
4850 #ifdef CLASH_DETECTION
4852 unlock_file (lockname
);
4853 #endif /* CLASH_DETECTION */
4855 report_file_errno ("Opening output file", filename
, open_errno
);
4858 count1
= SPECPDL_INDEX ();
4859 record_unwind_protect_int (close_file_unwind
, desc
);
4862 if (NUMBERP (append
))
4864 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4867 int lseek_errno
= errno
;
4868 #ifdef CLASH_DETECTION
4870 unlock_file (lockname
);
4871 #endif /* CLASH_DETECTION */
4873 report_file_errno ("Lseek error", filename
, lseek_errno
);
4881 if (STRINGP (start
))
4882 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4883 else if (XINT (start
) != XINT (end
))
4884 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4885 &annotations
, &coding
);
4888 /* If file was empty, still need to write the annotations. */
4889 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4890 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4894 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4895 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4897 /* We have to flush out a data. */
4898 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4899 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4905 /* fsync is not crucial for temporary files. Nor for auto-save
4906 files, since they might lose some work anyway. */
4907 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4909 /* Transfer data and metadata to disk, retrying if interrupted.
4910 fsync can report a write failure here, e.g., due to disk full
4911 under NFS. But ignore EINVAL, which means fsync is not
4912 supported on this file. */
4913 while (fsync (desc
) != 0)
4916 if (errno
!= EINVAL
)
4917 ok
= 0, save_errno
= errno
;
4922 modtime
= invalid_timespec ();
4925 if (fstat (desc
, &st
) == 0)
4926 modtime
= get_stat_mtime (&st
);
4928 ok
= 0, save_errno
= errno
;
4931 if (open_and_close_file
)
4933 /* NFS can report a write failure now. */
4934 if (emacs_close (desc
) < 0)
4935 ok
= 0, save_errno
= errno
;
4937 /* Discard the unwind protect for close_file_unwind. */
4938 specpdl_ptr
= specpdl
+ count1
;
4941 /* Some file systems have a bug where st_mtime is not updated
4942 properly after a write. For example, CIFS might not see the
4943 st_mtime change until after the file is opened again.
4945 Attempt to detect this file system bug, and update MODTIME to the
4946 newer st_mtime if the bug appears to be present. This introduces
4947 a race condition, so to avoid most instances of the race condition
4948 on non-buggy file systems, skip this check if the most recently
4949 encountered non-buggy file system was the current file system.
4951 A race condition can occur if some other process modifies the
4952 file between the fstat above and the fstat below, but the race is
4953 unlikely and a similar race between the last write and the fstat
4954 above cannot possibly be closed anyway. */
4956 if (timespec_valid_p (modtime
)
4957 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4959 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4963 if (fstat (desc1
, &st1
) == 0
4964 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4966 /* Use the heuristic if it appears to be valid. With neither
4967 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4968 file, the time stamp won't change. Also, some non-POSIX
4969 systems don't update an empty file's time stamp when
4970 truncating it. Finally, file systems with 100 ns or worse
4971 resolution sometimes seem to have bugs: on a system with ns
4972 resolution, checking ns % 100 incorrectly avoids the heuristic
4973 1% of the time, but the problem should be temporary as we will
4974 try again on the next time stamp. */
4976 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4978 && modtime
.tv_nsec
% 100 != 0);
4980 struct timespec modtime1
= get_stat_mtime (&st1
);
4982 && timespec_cmp (modtime
, modtime1
) == 0
4983 && st
.st_size
== st1
.st_size
)
4985 timestamp_file_system
= st
.st_dev
;
4986 valid_timestamp_file_system
= 1;
4990 st
.st_size
= st1
.st_size
;
4994 emacs_close (desc1
);
4998 /* Call write-region-post-annotation-function. */
4999 while (CONSP (Vwrite_region_annotation_buffers
))
5001 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5002 if (!NILP (Fbuffer_live_p (buf
)))
5005 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5006 call0 (Vwrite_region_post_annotation_function
);
5008 Vwrite_region_annotation_buffers
5009 = XCDR (Vwrite_region_annotation_buffers
);
5012 unbind_to (count
, Qnil
);
5014 #ifdef CLASH_DETECTION
5016 unlock_file (lockname
);
5017 #endif /* CLASH_DETECTION */
5019 /* Do this before reporting IO error
5020 to avoid a "file has changed on disk" warning on
5021 next attempt to save. */
5022 if (timespec_valid_p (modtime
))
5024 current_buffer
->modtime
= modtime
;
5025 current_buffer
->modtime_size
= st
.st_size
;
5029 report_file_errno ("Write error", filename
, save_errno
);
5033 SAVE_MODIFF
= MODIFF
;
5034 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5035 bset_filename (current_buffer
, visit_file
);
5036 update_mode_lines
= 14;
5041 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5042 BVAR (current_buffer
, auto_save_file_name
))))
5043 SAVE_MODIFF
= MODIFF
;
5049 message_with_string ((NUMBERP (append
)
5059 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5060 doc
: /* Return t if (car A) is numerically less than (car B). */)
5061 (Lisp_Object a
, Lisp_Object b
)
5063 Lisp_Object args
[2] = { Fcar (a
), Fcar (b
), };
5064 return Flss (2, args
);
5067 /* Build the complete list of annotations appropriate for writing out
5068 the text between START and END, by calling all the functions in
5069 write-region-annotate-functions and merging the lists they return.
5070 If one of these functions switches to a different buffer, we assume
5071 that buffer contains altered text. Therefore, the caller must
5072 make sure to restore the current buffer in all cases,
5073 as save-excursion would do. */
5076 build_annotations (Lisp_Object start
, Lisp_Object end
)
5078 Lisp_Object annotations
;
5080 struct gcpro gcpro1
, gcpro2
;
5081 Lisp_Object original_buffer
;
5083 bool used_global
= 0;
5085 XSETBUFFER (original_buffer
, current_buffer
);
5088 p
= Vwrite_region_annotate_functions
;
5089 GCPRO2 (annotations
, p
);
5092 struct buffer
*given_buffer
= current_buffer
;
5093 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5094 { /* Use the global value of the hook. */
5097 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5099 p
= Fappend (2, arg
);
5102 Vwrite_region_annotations_so_far
= annotations
;
5103 res
= call2 (XCAR (p
), start
, end
);
5104 /* If the function makes a different buffer current,
5105 assume that means this buffer contains altered text to be output.
5106 Reset START and END from the buffer bounds
5107 and discard all previous annotations because they should have
5108 been dealt with by this function. */
5109 if (current_buffer
!= given_buffer
)
5111 Vwrite_region_annotation_buffers
5112 = Fcons (Fcurrent_buffer (),
5113 Vwrite_region_annotation_buffers
);
5114 XSETFASTINT (start
, BEGV
);
5115 XSETFASTINT (end
, ZV
);
5118 Flength (res
); /* Check basic validity of return value */
5119 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5123 /* Now do the same for annotation functions implied by the file-format */
5124 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5125 p
= BVAR (current_buffer
, auto_save_file_format
);
5127 p
= BVAR (current_buffer
, file_format
);
5128 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5130 struct buffer
*given_buffer
= current_buffer
;
5132 Vwrite_region_annotations_so_far
= annotations
;
5134 /* Value is either a list of annotations or nil if the function
5135 has written annotations to a temporary buffer, which is now
5137 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5138 original_buffer
, make_number (i
));
5139 if (current_buffer
!= given_buffer
)
5141 XSETFASTINT (start
, BEGV
);
5142 XSETFASTINT (end
, ZV
);
5147 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5155 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5156 If STRING is nil, POS is the character position in the current buffer.
5157 Intersperse with them the annotations from *ANNOT
5158 which fall within the range of POS to POS + NCHARS,
5159 each at its appropriate position.
5161 We modify *ANNOT by discarding elements as we use them up.
5163 Return true if successful. */
5166 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5167 ptrdiff_t nchars
, Lisp_Object
*annot
,
5168 struct coding_system
*coding
)
5172 ptrdiff_t lastpos
= pos
+ nchars
;
5174 while (NILP (*annot
) || CONSP (*annot
))
5176 tem
= Fcar_safe (Fcar (*annot
));
5179 nextpos
= XFASTINT (tem
);
5181 /* If there are no more annotations in this range,
5182 output the rest of the range all at once. */
5183 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5184 return e_write (desc
, string
, pos
, lastpos
, coding
);
5186 /* Output buffer text up to the next annotation's position. */
5189 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5193 /* Output the annotation. */
5194 tem
= Fcdr (Fcar (*annot
));
5197 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5200 *annot
= Fcdr (*annot
);
5205 /* Maximum number of characters that the next
5206 function encodes per one loop iteration. */
5208 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5210 /* Write text in the range START and END into descriptor DESC,
5211 encoding them with coding system CODING. If STRING is nil, START
5212 and END are character positions of the current buffer, else they
5213 are indexes to the string STRING. Return true if successful. */
5216 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5217 struct coding_system
*coding
)
5219 if (STRINGP (string
))
5222 end
= SCHARS (string
);
5225 /* We used to have a code for handling selective display here. But,
5226 now it is handled within encode_coding. */
5230 if (STRINGP (string
))
5232 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5233 if (CODING_REQUIRE_ENCODING (coding
))
5235 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5237 /* Avoid creating huge Lisp string in encode_coding_object. */
5238 if (nchars
== E_WRITE_MAX
)
5239 coding
->raw_destination
= 1;
5241 encode_coding_object
5242 (coding
, string
, start
, string_char_to_byte (string
, start
),
5243 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5248 coding
->dst_object
= string
;
5249 coding
->consumed_char
= SCHARS (string
);
5250 coding
->produced
= SBYTES (string
);
5255 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5256 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5258 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5259 if (CODING_REQUIRE_ENCODING (coding
))
5261 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5264 if (nchars
== E_WRITE_MAX
)
5265 coding
->raw_destination
= 1;
5267 encode_coding_object
5268 (coding
, Fcurrent_buffer (), start
, start_byte
,
5269 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5273 coding
->dst_object
= Qnil
;
5274 coding
->dst_pos_byte
= start_byte
;
5275 if (start
>= GPT
|| end
<= GPT
)
5277 coding
->consumed_char
= end
- start
;
5278 coding
->produced
= end_byte
- start_byte
;
5282 coding
->consumed_char
= GPT
- start
;
5283 coding
->produced
= GPT_BYTE
- start_byte
;
5288 if (coding
->produced
> 0)
5290 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5291 : (STRINGP (coding
->dst_object
)
5292 ? SSDATA (coding
->dst_object
)
5293 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5294 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5296 if (coding
->raw_destination
)
5298 /* We're responsible for freeing this, see
5299 encode_coding_object to check why. */
5300 xfree (coding
->destination
);
5301 coding
->raw_destination
= 0;
5303 if (coding
->produced
)
5306 start
+= coding
->consumed_char
;
5312 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5313 Sverify_visited_file_modtime
, 0, 1, 0,
5314 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5315 This means that the file has not been changed since it was visited or saved.
5316 If BUF is omitted or nil, it defaults to the current buffer.
5317 See Info node `(elisp)Modification Time' for more details. */)
5322 Lisp_Object handler
;
5323 Lisp_Object filename
;
5324 struct timespec mtime
;
5334 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5335 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5337 /* If the file name has special constructs in it,
5338 call the corresponding file handler. */
5339 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5340 Qverify_visited_file_modtime
);
5341 if (!NILP (handler
))
5342 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5344 filename
= ENCODE_FILE (BVAR (b
, filename
));
5346 mtime
= (stat (SSDATA (filename
), &st
) == 0
5347 ? get_stat_mtime (&st
)
5348 : time_error_value (errno
));
5349 if (timespec_cmp (mtime
, b
->modtime
) == 0
5350 && (b
->modtime_size
< 0
5351 || st
.st_size
== b
->modtime_size
))
5356 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5357 Svisited_file_modtime
, 0, 0, 0,
5358 doc
: /* Return the current buffer's recorded visited file modification time.
5359 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5360 `file-attributes' returns. If the current buffer has no recorded file
5361 modification time, this function returns 0. If the visited file
5362 doesn't exist, return -1.
5363 See Info node `(elisp)Modification Time' for more details. */)
5366 int ns
= current_buffer
->modtime
.tv_nsec
;
5368 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5369 return make_lisp_time (current_buffer
->modtime
);
5372 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5373 Sset_visited_file_modtime
, 0, 1, 0,
5374 doc
: /* Update buffer's recorded modification time from the visited file's time.
5375 Useful if the buffer was not read from the file normally
5376 or if the file itself has been changed for some known benign reason.
5377 An argument specifies the modification time value to use
5378 \(instead of that of the visited file), in the form of a list
5379 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5380 `visited-file-modtime'. */)
5381 (Lisp_Object time_flag
)
5383 if (!NILP (time_flag
))
5385 struct timespec mtime
;
5386 if (INTEGERP (time_flag
))
5388 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5389 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5392 mtime
= lisp_time_argument (time_flag
);
5394 current_buffer
->modtime
= mtime
;
5395 current_buffer
->modtime_size
= -1;
5399 register Lisp_Object filename
;
5401 Lisp_Object handler
;
5403 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5405 /* If the file name has special constructs in it,
5406 call the corresponding file handler. */
5407 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5408 if (!NILP (handler
))
5409 /* The handler can find the file name the same way we did. */
5410 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5412 filename
= ENCODE_FILE (filename
);
5414 if (stat (SSDATA (filename
), &st
) >= 0)
5416 current_buffer
->modtime
= get_stat_mtime (&st
);
5417 current_buffer
->modtime_size
= st
.st_size
;
5425 auto_save_error (Lisp_Object error_val
)
5427 Lisp_Object args
[3], msg
;
5429 struct gcpro gcpro1
;
5431 auto_save_error_occurred
= 1;
5433 ring_bell (XFRAME (selected_frame
));
5435 args
[0] = build_string ("Auto-saving %s: %s");
5436 args
[1] = BVAR (current_buffer
, name
);
5437 args
[2] = Ferror_message_string (error_val
);
5438 msg
= Fformat (3, args
);
5441 for (i
= 0; i
< 3; ++i
)
5446 message3_nolog (msg
);
5447 Fsleep_for (make_number (1), Qnil
);
5460 auto_save_mode_bits
= 0666;
5462 /* Get visited file's mode to become the auto save file's mode. */
5463 if (! NILP (BVAR (current_buffer
, filename
)))
5465 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5466 /* But make sure we can overwrite it later! */
5467 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5468 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5470 /* Remote files don't cooperate with stat. */
5471 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5475 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5476 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5480 struct auto_save_unwind
5487 do_auto_save_unwind (void *arg
)
5489 struct auto_save_unwind
*p
= arg
;
5490 FILE *stream
= p
->stream
;
5491 minibuffer_auto_raise
= p
->auto_raise
;
5502 do_auto_save_make_dir (Lisp_Object dir
)
5506 auto_saving_dir_umask
= 077;
5507 result
= call2 (Qmake_directory
, dir
, Qt
);
5508 auto_saving_dir_umask
= 0;
5513 do_auto_save_eh (Lisp_Object ignore
)
5515 auto_saving_dir_umask
= 0;
5519 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5520 doc
: /* Auto-save all buffers that need it.
5521 This is all buffers that have auto-saving enabled
5522 and are changed since last auto-saved.
5523 Auto-saving writes the buffer into a file
5524 so that your editing is not lost if the system crashes.
5525 This file is not the file you visited; that changes only when you save.
5526 Normally we run the normal hook `auto-save-hook' before saving.
5528 A non-nil NO-MESSAGE argument means do not print any message if successful.
5529 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5530 (Lisp_Object no_message
, Lisp_Object current_only
)
5532 struct buffer
*old
= current_buffer
, *b
;
5533 Lisp_Object tail
, buf
, hook
;
5534 bool auto_saved
= 0;
5535 int do_handled_files
;
5537 FILE *stream
= NULL
;
5538 ptrdiff_t count
= SPECPDL_INDEX ();
5539 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5540 bool old_message_p
= 0;
5541 struct auto_save_unwind auto_save_unwind
;
5542 struct gcpro gcpro1
, gcpro2
;
5544 if (max_specpdl_size
< specpdl_size
+ 40)
5545 max_specpdl_size
= specpdl_size
+ 40;
5550 if (NILP (no_message
))
5552 old_message_p
= push_message ();
5553 record_unwind_protect_void (pop_message_unwind
);
5556 /* Ordinarily don't quit within this function,
5557 but don't make it impossible to quit (in case we get hung in I/O). */
5561 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5562 point to non-strings reached from Vbuffer_alist. */
5564 hook
= intern ("auto-save-hook");
5565 safe_run_hooks (hook
);
5567 if (STRINGP (Vauto_save_list_file_name
))
5569 Lisp_Object listfile
;
5571 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5573 /* Don't try to create the directory when shutting down Emacs,
5574 because creating the directory might signal an error, and
5575 that would leave Emacs in a strange state. */
5576 if (!NILP (Vrun_hooks
))
5580 GCPRO2 (dir
, listfile
);
5581 dir
= Ffile_name_directory (listfile
);
5582 if (NILP (Ffile_directory_p (dir
)))
5583 internal_condition_case_1 (do_auto_save_make_dir
,
5589 stream
= emacs_fopen (SSDATA (listfile
), "w");
5592 auto_save_unwind
.stream
= stream
;
5593 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5594 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5595 minibuffer_auto_raise
= 0;
5597 auto_save_error_occurred
= 0;
5599 /* On first pass, save all files that don't have handlers.
5600 On second pass, save all files that do have handlers.
5602 If Emacs is crashing, the handlers may tweak what is causing
5603 Emacs to crash in the first place, and it would be a shame if
5604 Emacs failed to autosave perfectly ordinary files because it
5605 couldn't handle some ange-ftp'd file. */
5607 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5608 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5612 /* Record all the buffers that have auto save mode
5613 in the special file that lists them. For each of these buffers,
5614 Record visited name (if any) and auto save name. */
5615 if (STRINGP (BVAR (b
, auto_save_file_name
))
5616 && stream
!= NULL
&& do_handled_files
== 0)
5619 if (!NILP (BVAR (b
, filename
)))
5621 fwrite (SDATA (BVAR (b
, filename
)), 1,
5622 SBYTES (BVAR (b
, filename
)), stream
);
5624 putc ('\n', stream
);
5625 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5626 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5627 putc ('\n', stream
);
5631 if (!NILP (current_only
)
5632 && b
!= current_buffer
)
5635 /* Don't auto-save indirect buffers.
5636 The base buffer takes care of it. */
5640 /* Check for auto save enabled
5641 and file changed since last auto save
5642 and file changed since last real save. */
5643 if (STRINGP (BVAR (b
, auto_save_file_name
))
5644 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5645 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5646 /* -1 means we've turned off autosaving for a while--see below. */
5647 && XINT (BVAR (b
, save_length
)) >= 0
5648 && (do_handled_files
5649 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5652 struct timespec before_time
= current_timespec ();
5653 struct timespec after_time
;
5655 /* If we had a failure, don't try again for 20 minutes. */
5656 if (b
->auto_save_failure_time
> 0
5657 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5660 set_buffer_internal (b
);
5661 if (NILP (Vauto_save_include_big_deletions
)
5662 && (XFASTINT (BVAR (b
, save_length
)) * 10
5663 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5664 /* A short file is likely to change a large fraction;
5665 spare the user annoying messages. */
5666 && XFASTINT (BVAR (b
, save_length
)) > 5000
5667 /* These messages are frequent and annoying for `*mail*'. */
5668 && !EQ (BVAR (b
, filename
), Qnil
)
5669 && NILP (no_message
))
5671 /* It has shrunk too much; turn off auto-saving here. */
5672 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5673 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5675 minibuffer_auto_raise
= 0;
5676 /* Turn off auto-saving until there's a real save,
5677 and prevent any more warnings. */
5678 XSETINT (BVAR (b
, save_length
), -1);
5679 Fsleep_for (make_number (1), Qnil
);
5682 if (!auto_saved
&& NILP (no_message
))
5683 message1 ("Auto-saving...");
5684 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5686 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5687 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5688 set_buffer_internal (old
);
5690 after_time
= current_timespec ();
5692 /* If auto-save took more than 60 seconds,
5693 assume it was an NFS failure that got a timeout. */
5694 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5695 b
->auto_save_failure_time
= after_time
.tv_sec
;
5699 /* Prevent another auto save till enough input events come in. */
5700 record_auto_save ();
5702 if (auto_saved
&& NILP (no_message
))
5706 /* If we are going to restore an old message,
5707 give time to read ours. */
5708 sit_for (make_number (1), 0, 0);
5711 else if (!auto_save_error_occurred
)
5712 /* Don't overwrite the error message if an error occurred.
5713 If we displayed a message and then restored a state
5714 with no message, leave a "done" message on the screen. */
5715 message1 ("Auto-saving...done");
5720 /* This restores the message-stack status. */
5721 unbind_to (count
, Qnil
);
5725 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5726 Sset_buffer_auto_saved
, 0, 0, 0,
5727 doc
: /* Mark current buffer as auto-saved with its current text.
5728 No auto-save file will be written until the buffer changes again. */)
5731 /* FIXME: This should not be called in indirect buffers, since
5732 they're not autosaved. */
5733 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5734 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5735 current_buffer
->auto_save_failure_time
= 0;
5739 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5740 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5741 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5744 current_buffer
->auto_save_failure_time
= 0;
5748 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5750 doc
: /* Return t if current buffer has been auto-saved recently.
5751 More precisely, if it has been auto-saved since last read from or saved
5752 in the visited file. If the buffer has no visited file,
5753 then any auto-save counts as "recent". */)
5756 /* FIXME: maybe we should return nil for indirect buffers since
5757 they're never autosaved. */
5758 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5761 /* Reading and completing file names */
5763 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5764 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5765 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5766 The return value is only relevant for a call to `read-file-name' that happens
5767 before any other event (mouse or keypress) is handled. */)
5770 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5771 || defined (HAVE_NS)
5772 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5775 && window_system_available (SELECTED_FRAME ()))
5782 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5784 struct gcpro gcpro1
;
5785 Lisp_Object args
[7];
5787 GCPRO1 (default_filename
);
5788 args
[0] = intern ("read-file-name");
5791 args
[3] = default_filename
;
5792 args
[4] = mustmatch
;
5794 args
[6] = predicate
;
5795 RETURN_UNGCPRO (Ffuncall (7, args
));
5802 valid_timestamp_file_system
= 0;
5804 /* fsync can be a significant performance hit. Often it doesn't
5805 suffice to make the file-save operation survive a crash. For
5806 batch scripts, which are typically part of larger shell commands
5807 that don't fsync other files, its effect on performance can be
5808 significant so its utility is particularly questionable.
5809 Hence, for now by default fsync is used only when interactive.
5811 For more on why fsync often fails to work on today's hardware, see:
5812 Zheng M et al. Understanding the robustness of SSDs under power fault.
5813 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5814 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5816 For more on why fsync does not suffice even if it works properly, see:
5817 Roche X. Necessary step(s) to synchronize filename operations on disk.
5818 Austin Group Defect 672, 2013-03-19
5819 http://austingroupbugs.net/view.php?id=672 */
5820 write_region_inhibit_fsync
= noninteractive
;
5824 syms_of_fileio (void)
5826 DEFSYM (Qoperations
, "operations");
5827 DEFSYM (Qexpand_file_name
, "expand-file-name");
5828 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5829 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5830 DEFSYM (Qfile_name_directory
, "file-name-directory");
5831 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5832 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5833 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5834 DEFSYM (Qcopy_file
, "copy-file");
5835 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5836 DEFSYM (Qmake_directory
, "make-directory");
5837 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5838 DEFSYM (Qdelete_file
, "delete-file");
5839 DEFSYM (Qrename_file
, "rename-file");
5840 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5841 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5842 DEFSYM (Qfile_exists_p
, "file-exists-p");
5843 DEFSYM (Qfile_executable_p
, "file-executable-p");
5844 DEFSYM (Qfile_readable_p
, "file-readable-p");
5845 DEFSYM (Qfile_writable_p
, "file-writable-p");
5846 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5847 DEFSYM (Qaccess_file
, "access-file");
5848 DEFSYM (Qfile_directory_p
, "file-directory-p");
5849 DEFSYM (Qfile_regular_p
, "file-regular-p");
5850 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5851 DEFSYM (Qfile_modes
, "file-modes");
5852 DEFSYM (Qset_file_modes
, "set-file-modes");
5853 DEFSYM (Qset_file_times
, "set-file-times");
5854 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5855 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5856 DEFSYM (Qfile_acl
, "file-acl");
5857 DEFSYM (Qset_file_acl
, "set-file-acl");
5858 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5859 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5860 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5861 DEFSYM (Qwrite_region
, "write-region");
5862 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5863 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5864 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5866 DEFSYM (Qfile_name_history
, "file-name-history");
5867 Fset (Qfile_name_history
, Qnil
);
5869 DEFSYM (Qfile_error
, "file-error");
5870 DEFSYM (Qfile_already_exists
, "file-already-exists");
5871 DEFSYM (Qfile_date_error
, "file-date-error");
5872 DEFSYM (Qfile_notify_error
, "file-notify-error");
5873 DEFSYM (Qexcl
, "excl");
5875 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5876 doc
: /* Coding system for encoding file names.
5877 If it is nil, `default-file-name-coding-system' (which see) is used.
5879 On MS-Windows, the value of this variable is largely ignored if
5880 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5881 behaves as if file names were encoded in `utf-8'. */);
5882 Vfile_name_coding_system
= Qnil
;
5884 DEFVAR_LISP ("default-file-name-coding-system",
5885 Vdefault_file_name_coding_system
,
5886 doc
: /* Default coding system for encoding file names.
5887 This variable is used only when `file-name-coding-system' is nil.
5889 This variable is set/changed by the command `set-language-environment'.
5890 User should not set this variable manually,
5891 instead use `file-name-coding-system' to get a constant encoding
5892 of file names regardless of the current language environment.
5894 On MS-Windows, the value of this variable is largely ignored if
5895 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5896 behaves as if file names were encoded in `utf-8'. */);
5897 Vdefault_file_name_coding_system
= Qnil
;
5899 DEFSYM (Qformat_decode
, "format-decode");
5900 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5901 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5902 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5904 Fput (Qfile_error
, Qerror_conditions
,
5905 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5906 Fput (Qfile_error
, Qerror_message
,
5907 build_pure_c_string ("File error"));
5909 Fput (Qfile_already_exists
, Qerror_conditions
,
5910 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5911 Fput (Qfile_already_exists
, Qerror_message
,
5912 build_pure_c_string ("File already exists"));
5914 Fput (Qfile_date_error
, Qerror_conditions
,
5915 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5916 Fput (Qfile_date_error
, Qerror_message
,
5917 build_pure_c_string ("Cannot set file date"));
5919 Fput (Qfile_notify_error
, Qerror_conditions
,
5920 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5921 Fput (Qfile_notify_error
, Qerror_message
,
5922 build_pure_c_string ("File notification error"));
5924 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5925 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5926 If a file name matches REGEXP, all I/O on that file is done by calling
5927 HANDLER. If a file name matches more than one handler, the handler
5928 whose match starts last in the file name gets precedence. The
5929 function `find-file-name-handler' checks this list for a handler for
5932 HANDLER should be a function. The first argument given to it is the
5933 name of the I/O primitive to be handled; the remaining arguments are
5934 the arguments that were passed to that primitive. For example, if you
5935 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5936 HANDLER is called like this:
5938 (funcall HANDLER 'file-exists-p FILENAME)
5940 Note that HANDLER must be able to handle all I/O primitives; if it has
5941 nothing special to do for a primitive, it should reinvoke the
5942 primitive to handle the operation \"the usual way\".
5943 See Info node `(elisp)Magic File Names' for more details. */);
5944 Vfile_name_handler_alist
= Qnil
;
5946 DEFVAR_LISP ("set-auto-coding-function",
5947 Vset_auto_coding_function
,
5948 doc
: /* If non-nil, a function to call to decide a coding system of file.
5949 Two arguments are passed to this function: the file name
5950 and the length of a file contents following the point.
5951 This function should return a coding system to decode the file contents.
5952 It should check the file name against `auto-coding-alist'.
5953 If no coding system is decided, it should check a coding system
5954 specified in the heading lines with the format:
5955 -*- ... coding: CODING-SYSTEM; ... -*-
5956 or local variable spec of the tailing lines with `coding:' tag. */);
5957 Vset_auto_coding_function
= Qnil
;
5959 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5960 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5961 Each is passed one argument, the number of characters inserted,
5962 with point at the start of the inserted text. Each function
5963 should leave point the same, and return the new character count.
5964 If `insert-file-contents' is intercepted by a handler from
5965 `file-name-handler-alist', that handler is responsible for calling the
5966 functions in `after-insert-file-functions' if appropriate. */);
5967 Vafter_insert_file_functions
= Qnil
;
5969 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5970 doc
: /* A list of functions to be called at the start of `write-region'.
5971 Each is passed two arguments, START and END as for `write-region'.
5972 These are usually two numbers but not always; see the documentation
5973 for `write-region'. The function should return a list of pairs
5974 of the form (POSITION . STRING), consisting of strings to be effectively
5975 inserted at the specified positions of the file being written (1 means to
5976 insert before the first byte written). The POSITIONs must be sorted into
5979 If there are several annotation functions, the lists returned by these
5980 functions are merged destructively. As each annotation function runs,
5981 the variable `write-region-annotations-so-far' contains a list of all
5982 annotations returned by previous annotation functions.
5984 An annotation function can return with a different buffer current.
5985 Doing so removes the annotations returned by previous functions, and
5986 resets START and END to `point-min' and `point-max' of the new buffer.
5988 After `write-region' completes, Emacs calls the function stored in
5989 `write-region-post-annotation-function', once for each buffer that was
5990 current when building the annotations (i.e., at least once), with that
5991 buffer current. */);
5992 Vwrite_region_annotate_functions
= Qnil
;
5993 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5995 DEFVAR_LISP ("write-region-post-annotation-function",
5996 Vwrite_region_post_annotation_function
,
5997 doc
: /* Function to call after `write-region' completes.
5998 The function is called with no arguments. If one or more of the
5999 annotation functions in `write-region-annotate-functions' changed the
6000 current buffer, the function stored in this variable is called for
6001 each of those additional buffers as well, in addition to the original
6002 buffer. The relevant buffer is current during each function call. */);
6003 Vwrite_region_post_annotation_function
= Qnil
;
6004 staticpro (&Vwrite_region_annotation_buffers
);
6006 DEFVAR_LISP ("write-region-annotations-so-far",
6007 Vwrite_region_annotations_so_far
,
6008 doc
: /* When an annotation function is called, this holds the previous annotations.
6009 These are the annotations made by other annotation functions
6010 that were already called. See also `write-region-annotate-functions'. */);
6011 Vwrite_region_annotations_so_far
= Qnil
;
6013 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6014 doc
: /* A list of file name handlers that temporarily should not be used.
6015 This applies only to the operation `inhibit-file-name-operation'. */);
6016 Vinhibit_file_name_handlers
= Qnil
;
6018 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6019 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6020 Vinhibit_file_name_operation
= Qnil
;
6022 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6023 doc
: /* File name in which we write a list of all auto save file names.
6024 This variable is initialized automatically from `auto-save-list-file-prefix'
6025 shortly after Emacs reads your init file, if you have not yet given it
6026 a non-nil value. */);
6027 Vauto_save_list_file_name
= Qnil
;
6029 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6030 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6031 Normally auto-save files are written under other names. */);
6032 Vauto_save_visited_file_name
= Qnil
;
6034 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6035 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6036 If nil, deleting a substantial portion of the text disables auto-save
6037 in the buffer; this is the default behavior, because the auto-save
6038 file is usually more useful if it contains the deleted text. */);
6039 Vauto_save_include_big_deletions
= Qnil
;
6041 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6042 doc
: /* Non-nil means don't call fsync in `write-region'.
6043 This variable affects calls to `write-region' as well as save commands.
6044 Setting this to nil may avoid data loss if the system loses power or
6045 the operating system crashes. */);
6046 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6048 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6049 doc
: /* Specifies whether to use the system's trash can.
6050 When non-nil, certain file deletion commands use the function
6051 `move-file-to-trash' instead of deleting files outright.
6052 This includes interactive calls to `delete-file' and
6053 `delete-directory' and the Dired deletion commands. */);
6054 delete_by_moving_to_trash
= 0;
6055 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6057 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6058 DEFSYM (Qcopy_directory
, "copy-directory");
6059 DEFSYM (Qdelete_directory
, "delete-directory");
6060 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");
6062 defsubr (&Sfind_file_name_handler
);
6063 defsubr (&Sfile_name_directory
);
6064 defsubr (&Sfile_name_nondirectory
);
6065 defsubr (&Sunhandled_file_name_directory
);
6066 defsubr (&Sfile_name_as_directory
);
6067 defsubr (&Sdirectory_file_name
);
6068 defsubr (&Smake_temp_name
);
6069 defsubr (&Sexpand_file_name
);
6070 defsubr (&Ssubstitute_in_file_name
);
6071 defsubr (&Scopy_file
);
6072 defsubr (&Smake_directory_internal
);
6073 defsubr (&Sdelete_directory_internal
);
6074 defsubr (&Sdelete_file
);
6075 defsubr (&Srename_file
);
6076 defsubr (&Sadd_name_to_file
);
6077 defsubr (&Smake_symbolic_link
);
6078 defsubr (&Sfile_name_absolute_p
);
6079 defsubr (&Sfile_exists_p
);
6080 defsubr (&Sfile_executable_p
);
6081 defsubr (&Sfile_readable_p
);
6082 defsubr (&Sfile_writable_p
);
6083 defsubr (&Saccess_file
);
6084 defsubr (&Sfile_symlink_p
);
6085 defsubr (&Sfile_directory_p
);
6086 defsubr (&Sfile_accessible_directory_p
);
6087 defsubr (&Sfile_regular_p
);
6088 defsubr (&Sfile_modes
);
6089 defsubr (&Sset_file_modes
);
6090 defsubr (&Sset_file_times
);
6091 defsubr (&Sfile_selinux_context
);
6092 defsubr (&Sfile_acl
);
6093 defsubr (&Sset_file_acl
);
6094 defsubr (&Sset_file_selinux_context
);
6095 defsubr (&Sset_default_file_modes
);
6096 defsubr (&Sdefault_file_modes
);
6097 defsubr (&Sfile_newer_than_file_p
);
6098 defsubr (&Sinsert_file_contents
);
6099 defsubr (&Schoose_write_coding_system
);
6100 defsubr (&Swrite_region
);
6101 defsubr (&Scar_less_than_car
);
6102 defsubr (&Sverify_visited_file_modtime
);
6103 defsubr (&Svisited_file_modtime
);
6104 defsubr (&Sset_visited_file_modtime
);
6105 defsubr (&Sdo_auto_save
);
6106 defsubr (&Sset_buffer_auto_saved
);
6107 defsubr (&Sclear_buffer_auto_save_failure
);
6108 defsubr (&Srecent_auto_save_p
);
6110 defsubr (&Snext_read_file_uses_dialog_p
);
6113 defsubr (&Sunix_sync
);