1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2014 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 /* Emacs's real umask. */
99 static mode_t realmask
;
101 /* Nonzero umask during creation of auto-save directories. */
102 static mode_t auto_saving_dir_umask
;
104 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
105 a new file with the same mode as the original. */
106 static mode_t auto_save_mode_bits
;
108 /* Set by auto_save_1 if an error occurred during the last auto-save. */
109 static bool auto_save_error_occurred
;
111 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
112 number of a file system where time stamps were observed to to work. */
113 static bool valid_timestamp_file_system
;
114 static dev_t timestamp_file_system
;
116 /* The symbol bound to coding-system-for-read when
117 insert-file-contents is called for recovering a file. This is not
118 an actual coding system name, but just an indicator to tell
119 insert-file-contents to use `emacs-mule' with a special flag for
120 auto saving and recovering a file. */
121 static Lisp_Object Qauto_save_coding
;
123 /* Property name of a file name handler,
124 which gives a list of operations it handles.. */
125 static Lisp_Object Qoperations
;
127 /* Lisp functions for translating file formats. */
128 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
130 /* Lisp function for setting buffer-file-coding-system and the
131 multibyteness of the current buffer after inserting a file. */
132 static Lisp_Object Qafter_insert_file_set_coding
;
134 static Lisp_Object Qwrite_region_annotate_functions
;
135 /* Each time an annotation function changes the buffer, the new buffer
137 static Lisp_Object Vwrite_region_annotation_buffers
;
139 static Lisp_Object Qdelete_by_moving_to_trash
;
141 /* Lisp function for moving files to trash. */
142 static Lisp_Object Qmove_file_to_trash
;
144 /* Lisp function for recursively copying directories. */
145 static Lisp_Object Qcopy_directory
;
147 /* Lisp function for recursively deleting directories. */
148 static Lisp_Object Qdelete_directory
;
150 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 close_file_ptr_unwind (void *fdp
)
279 int fd
= *((int *) fdp
);
285 fclose_unwind (void *arg
)
292 fclose_ptr_unwind (void *arg
)
294 FILE *stream
= *((void **) arg
);
299 /* Restore point, having saved it as a marker. */
302 restore_point_unwind (Lisp_Object location
)
304 Fgoto_char (location
);
305 unchain_marker (XMARKER (location
));
309 static Lisp_Object Qexpand_file_name
;
310 static Lisp_Object Qsubstitute_in_file_name
;
311 static Lisp_Object Qdirectory_file_name
;
312 static Lisp_Object Qfile_name_directory
;
313 static Lisp_Object Qfile_name_nondirectory
;
314 static Lisp_Object Qunhandled_file_name_directory
;
315 static Lisp_Object Qfile_name_as_directory
;
316 static Lisp_Object Qcopy_file
;
317 static Lisp_Object Qmake_directory_internal
;
318 static Lisp_Object Qmake_directory
;
319 static Lisp_Object Qdelete_directory_internal
;
320 Lisp_Object Qdelete_file
;
321 static Lisp_Object Qrename_file
;
322 static Lisp_Object Qadd_name_to_file
;
323 static Lisp_Object Qmake_symbolic_link
;
324 Lisp_Object Qfile_exists_p
;
325 static Lisp_Object Qfile_executable_p
;
326 static Lisp_Object Qfile_readable_p
;
327 static Lisp_Object Qfile_writable_p
;
328 static Lisp_Object Qfile_symlink_p
;
329 static Lisp_Object Qaccess_file
;
330 Lisp_Object Qfile_directory_p
;
331 static Lisp_Object Qfile_regular_p
;
332 static Lisp_Object Qfile_accessible_directory_p
;
333 static Lisp_Object Qfile_modes
;
334 static Lisp_Object Qset_file_modes
;
335 static Lisp_Object Qset_file_times
;
336 static Lisp_Object Qfile_selinux_context
;
337 static Lisp_Object Qset_file_selinux_context
;
338 static Lisp_Object Qfile_acl
;
339 static Lisp_Object Qset_file_acl
;
340 static Lisp_Object Qfile_newer_than_file_p
;
341 Lisp_Object Qinsert_file_contents
;
342 static Lisp_Object Qchoose_write_coding_system
;
343 Lisp_Object Qwrite_region
;
344 static Lisp_Object Qverify_visited_file_modtime
;
345 static Lisp_Object Qset_visited_file_modtime
;
347 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
348 Sfind_file_name_handler
, 2, 2, 0,
349 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
350 Otherwise, return nil.
351 A file name is handled if one of the regular expressions in
352 `file-name-handler-alist' matches it.
354 If OPERATION equals `inhibit-file-name-operation', then we ignore
355 any handlers that are members of `inhibit-file-name-handlers',
356 but we still do run any other handlers. This lets handlers
357 use the standard functions without calling themselves recursively. */)
358 (Lisp_Object filename
, Lisp_Object operation
)
360 /* This function must not munge the match data. */
361 Lisp_Object chain
, inhibited_handlers
, result
;
365 CHECK_STRING (filename
);
367 if (EQ (operation
, Vinhibit_file_name_operation
))
368 inhibited_handlers
= Vinhibit_file_name_handlers
;
370 inhibited_handlers
= Qnil
;
372 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
373 chain
= XCDR (chain
))
379 Lisp_Object string
= XCAR (elt
);
381 Lisp_Object handler
= XCDR (elt
);
382 Lisp_Object operations
= Qnil
;
384 if (SYMBOLP (handler
))
385 operations
= Fget (handler
, Qoperations
);
388 && (match_pos
= fast_string_match (string
, filename
)) > pos
389 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
393 handler
= XCDR (elt
);
394 tem
= Fmemq (handler
, inhibited_handlers
);
408 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
410 doc
: /* Return the directory component in file name FILENAME.
411 Return nil if FILENAME does not include a directory.
412 Otherwise return a directory name.
413 Given a Unix syntax file name, returns a string ending in slash. */)
414 (Lisp_Object filename
)
417 register const char *beg
;
422 register const char *p
;
425 CHECK_STRING (filename
);
427 /* If the file name has special constructs in it,
428 call the corresponding file handler. */
429 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
432 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
434 return STRINGP (handled_name
) ? handled_name
: Qnil
;
438 beg
= xlispstrdupa (filename
);
440 beg
= SSDATA (filename
);
442 p
= beg
+ SBYTES (filename
);
444 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
446 /* only recognize drive specifier at the beginning */
448 /* handle the "/:d:foo" and "/:foo" cases correctly */
449 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
450 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
457 /* Expansion of "c:" to drive and default directory. */
460 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
461 char *res
= alloca (MAXPATHLEN
+ 1);
464 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
466 memcpy (res
, beg
, 2);
471 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
473 size_t l
= strlen (res
);
475 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
478 p
= beg
+ strlen (beg
);
479 dostounix_filename (beg
);
480 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
481 STRING_MULTIBYTE (filename
));
484 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
485 STRING_MULTIBYTE (filename
));
487 else if (STRING_MULTIBYTE (filename
))
489 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
490 dostounix_filename (SSDATA (tem_fn
));
492 if (!NILP (Vw32_downcase_file_names
))
493 tem_fn
= Fdowncase (tem_fn
);
498 dostounix_filename (beg
);
499 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
503 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
507 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
508 Sfile_name_nondirectory
, 1, 1, 0,
509 doc
: /* Return file name FILENAME sans its directory.
510 For example, in a Unix-syntax file name,
511 this is everything after the last slash,
512 or the entire name if it contains no slash. */)
513 (Lisp_Object filename
)
515 register const char *beg
, *p
, *end
;
518 CHECK_STRING (filename
);
520 /* If the file name has special constructs in it,
521 call the corresponding file handler. */
522 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
525 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
527 if (STRINGP (handled_name
))
529 error ("Invalid handler in `file-name-handler-alist'");
532 beg
= SSDATA (filename
);
533 end
= p
= beg
+ SBYTES (filename
);
535 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
537 /* only recognize drive specifier at beginning */
539 /* handle the "/:d:foo" case correctly */
540 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
545 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
548 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
549 Sunhandled_file_name_directory
, 1, 1, 0,
550 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
551 A `directly usable' directory name is one that may be used without the
552 intervention of any file handler.
553 If FILENAME is a directly usable file itself, return
554 \(file-name-directory FILENAME).
555 If FILENAME refers to a file which is not accessible from a local process,
556 then this should return nil.
557 The `call-process' and `start-process' functions use this function to
558 get a current directory to run processes in. */)
559 (Lisp_Object filename
)
563 /* If the file name has special constructs in it,
564 call the corresponding file handler. */
565 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
568 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
570 return STRINGP (handled_name
) ? handled_name
: Qnil
;
573 return Ffile_name_directory (filename
);
576 /* Maximum number of bytes that DST will be longer than SRC
577 in file_name_as_directory. This occurs when SRCLEN == 0. */
578 enum { file_name_as_directory_slop
= 2 };
580 /* Convert from file name SRC of length SRCLEN to directory name in
581 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
582 string. On UNIX, just make sure there is a terminating /. Return
583 the length of DST in bytes. */
586 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
597 memcpy (dst
, src
, srclen
);
598 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
599 dst
[srclen
++] = DIRECTORY_SEP
;
602 dostounix_filename (dst
);
607 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
608 Sfile_name_as_directory
, 1, 1, 0,
609 doc
: /* Return a string representing the file name FILE interpreted as a directory.
610 This operation exists because a directory is also a file, but its name as
611 a directory is different from its name as a file.
612 The result can be used as the value of `default-directory'
613 or passed as second argument to `expand-file-name'.
614 For a Unix-syntax file name, just appends a slash. */)
619 Lisp_Object handler
, val
;
626 /* If the file name has special constructs in it,
627 call the corresponding file handler. */
628 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
631 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
633 if (STRINGP (handled_name
))
635 error ("Invalid handler in `file-name-handler-alist'");
639 if (!NILP (Vw32_downcase_file_names
))
640 file
= Fdowncase (file
);
642 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
643 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
644 STRING_MULTIBYTE (file
));
645 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
650 /* Convert from directory name SRC of length SRCLEN to file name in
651 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
652 string. On UNIX, just make sure there isn't a terminating /.
653 Return the length of DST in bytes. */
656 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
658 /* Process as Unix format: just remove any final slash.
659 But leave "/" and "//" unchanged. */
662 && !IS_ANY_SEP (src
[srclen
- 2])
664 && IS_DIRECTORY_SEP (src
[srclen
- 1])
665 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
668 memcpy (dst
, src
, srclen
);
671 dostounix_filename (dst
);
676 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
678 doc
: /* Returns the file name of the directory named DIRECTORY.
679 This is the name of the file that holds the data for the directory DIRECTORY.
680 This operation exists because a directory is also a file, but its name as
681 a directory is different from its name as a file.
682 In Unix-syntax, this function just removes the final slash. */)
683 (Lisp_Object directory
)
687 Lisp_Object handler
, val
;
690 CHECK_STRING (directory
);
692 if (NILP (directory
))
695 /* If the file name has special constructs in it,
696 call the corresponding file handler. */
697 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
700 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
702 if (STRINGP (handled_name
))
704 error ("Invalid handler in `file-name-handler-alist'");
708 if (!NILP (Vw32_downcase_file_names
))
709 directory
= Fdowncase (directory
);
711 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
712 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
713 STRING_MULTIBYTE (directory
));
714 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
719 static const char make_temp_name_tbl
[64] =
721 'A','B','C','D','E','F','G','H',
722 'I','J','K','L','M','N','O','P',
723 'Q','R','S','T','U','V','W','X',
724 'Y','Z','a','b','c','d','e','f',
725 'g','h','i','j','k','l','m','n',
726 'o','p','q','r','s','t','u','v',
727 'w','x','y','z','0','1','2','3',
728 '4','5','6','7','8','9','-','_'
731 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
733 /* Value is a temporary file name starting with PREFIX, a string.
735 The Emacs process number forms part of the result, so there is
736 no danger of generating a name being used by another process.
737 In addition, this function makes an attempt to choose a name
738 which has no existing file. To make this work, PREFIX should be
739 an absolute file name.
741 BASE64_P means add the pid as 3 characters in base64
742 encoding. In this case, 6 characters will be added to PREFIX to
743 form the file name. Otherwise, if Emacs is running on a system
744 with long file names, add the pid as a decimal number.
746 This function signals an error if no unique file name could be
750 make_temp_name (Lisp_Object prefix
, bool base64_p
)
752 Lisp_Object val
, encoded_prefix
;
756 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
759 CHECK_STRING (prefix
);
761 /* VAL is created by adding 6 characters to PREFIX. The first
762 three are the PID of this process, in base 64, and the second
763 three are incremented if the file already exists. This ensures
764 262144 unique file names per PID per PREFIX. */
770 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
771 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
772 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
777 #ifdef HAVE_LONG_FILE_NAMES
778 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
780 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
781 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
782 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
787 encoded_prefix
= ENCODE_FILE (prefix
);
788 len
= SBYTES (encoded_prefix
);
789 val
= make_uninit_string (len
+ 3 + pidlen
);
791 memcpy (data
, SSDATA (encoded_prefix
), len
);
794 memcpy (p
, pidbuf
, pidlen
);
797 /* Here we try to minimize useless stat'ing when this function is
798 invoked many times successively with the same PREFIX. We achieve
799 this by initializing count to a random value, and incrementing it
802 We don't want make-temp-name to be called while dumping,
803 because then make_temp_name_count_initialized_p would get set
804 and then make_temp_name_count would not be set when Emacs starts. */
806 if (!make_temp_name_count_initialized_p
)
808 make_temp_name_count
= time (NULL
);
809 make_temp_name_count_initialized_p
= 1;
814 unsigned num
= make_temp_name_count
;
816 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
817 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
818 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
820 /* Poor man's congruential RN generator. Replace with
821 ++make_temp_name_count for debugging. */
822 make_temp_name_count
+= 25229;
823 make_temp_name_count
%= 225307;
825 if (!check_existing (data
))
827 /* We want to return only if errno is ENOENT. */
829 return DECODE_FILE (val
);
831 /* The error here is dubious, but there is little else we
832 can do. The alternatives are to return nil, which is
833 as bad as (and in many cases worse than) throwing the
834 error, or to ignore the error, which will likely result
835 in looping through 225307 stat's, which is not only
836 dog-slow, but also useless since eventually nil would
837 have to be returned anyway. */
838 report_file_error ("Cannot create temporary name for prefix",
846 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
847 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
848 The Emacs process number forms part of the result,
849 so there is no danger of generating a name being used by another process.
851 In addition, this function makes an attempt to choose a name
852 which has no existing file. To make this work,
853 PREFIX should be an absolute file name.
855 There is a race condition between calling `make-temp-name' and creating the
856 file which opens all kinds of security holes. For that reason, you should
857 probably use `make-temp-file' instead, except in three circumstances:
859 * If you are creating the file in the user's home directory.
860 * If you are creating a directory rather than an ordinary file.
861 * If you are taking special precautions as `make-temp-file' does. */)
864 return make_temp_name (prefix
, 0);
869 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
870 doc
: /* Convert filename NAME to absolute, and canonicalize it.
871 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
872 \(does not start with slash or tilde); both the directory name and
873 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
874 missing, the current buffer's value of `default-directory' is used.
875 NAME should be a string that is a valid file name for the underlying
877 File name components that are `.' are removed, and
878 so are file name components followed by `..', along with the `..' itself;
879 note that these simplifications are done without checking the resulting
880 file names in the file system.
881 Multiple consecutive slashes are collapsed into a single slash,
882 except at the beginning of the file name when they are significant (e.g.,
883 UNC file names on MS-Windows.)
884 An initial `~/' expands to your home directory.
885 An initial `~USER/' expands to USER's home directory.
886 See also the function `substitute-in-file-name'.
888 For technical reasons, this function can return correct but
889 non-intuitive results for the root directory; for instance,
890 \(expand-file-name ".." "/") returns "/..". For this reason, use
891 \(directory-file-name (file-name-directory dirname)) to traverse a
892 filesystem tree, not (expand-file-name ".." dirname). */)
893 (Lisp_Object name
, Lisp_Object default_directory
)
895 /* These point to SDATA and need to be careful with string-relocation
896 during GC (via DECODE_FILE). */
899 /* This should only point to alloca'd data. */
906 bool collapse_newdir
= 1;
910 Lisp_Object handler
, result
, handled_name
;
917 /* If the file name has special constructs in it,
918 call the corresponding file handler. */
919 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
922 handled_name
= call3 (handler
, Qexpand_file_name
,
923 name
, default_directory
);
924 if (STRINGP (handled_name
))
926 error ("Invalid handler in `file-name-handler-alist'");
930 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
931 if (NILP (default_directory
))
932 default_directory
= BVAR (current_buffer
, directory
);
933 if (! STRINGP (default_directory
))
936 /* "/" is not considered a root directory on DOS_NT, so using "/"
937 here causes an infinite recursion in, e.g., the following:
939 (let (default-directory)
940 (expand-file-name "a"))
942 To avoid this, we set default_directory to the root of the
944 default_directory
= build_string (emacs_root_dir ());
946 default_directory
= build_string ("/");
950 if (!NILP (default_directory
))
952 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
955 handled_name
= call3 (handler
, Qexpand_file_name
,
956 name
, default_directory
);
957 if (STRINGP (handled_name
))
959 error ("Invalid handler in `file-name-handler-alist'");
964 char *o
= SSDATA (default_directory
);
966 /* Make sure DEFAULT_DIRECTORY is properly expanded.
967 It would be better to do this down below where we actually use
968 default_directory. Unfortunately, calling Fexpand_file_name recursively
969 could invoke GC, and the strings might be relocated. This would
970 be annoying because we have pointers into strings lying around
971 that would need adjusting, and people would add new pointers to
972 the code and forget to adjust them, resulting in intermittent bugs.
973 Putting this call here avoids all that crud.
975 The EQ test avoids infinite recursion. */
976 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
977 /* Save time in some common cases - as long as default_directory
978 is not relative, it can be canonicalized with name below (if it
979 is needed at all) without requiring it to be expanded now. */
981 /* Detect MSDOS file names with drive specifiers. */
982 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
983 && IS_DIRECTORY_SEP (o
[2]))
985 /* Detect Windows file names in UNC format. */
986 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
988 #else /* not DOS_NT */
989 /* Detect Unix absolute file names (/... alone is not absolute on
991 && ! (IS_DIRECTORY_SEP (o
[0]))
992 #endif /* not DOS_NT */
998 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
1002 multibyte
= STRING_MULTIBYTE (name
);
1003 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
1007 unsigned char *p
= SDATA (name
);
1009 while (*p
&& ASCII_CHAR_P (*p
))
1013 /* NAME is a pure ASCII string, and DEFAULT_DIRECTORY is
1014 unibyte. Do not convert DEFAULT_DIRECTORY to
1015 multibyte; instead, convert NAME to a unibyte string,
1016 so that the result of this function is also a unibyte
1017 string. This is needed during bootstrapping and
1018 dumping, when Emacs cannot decode file names, because
1019 the locale environment is not set up. */
1020 name
= make_unibyte_string (SSDATA (name
), SBYTES (name
));
1024 default_directory
= string_to_multibyte (default_directory
);
1028 name
= string_to_multibyte (name
);
1034 if (!NILP (Vw32_downcase_file_names
))
1035 default_directory
= Fdowncase (default_directory
);
1038 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
1039 nm
= xlispstrdupa (name
);
1042 /* Note if special escape prefix is present, but remove for now. */
1043 if (nm
[0] == '/' && nm
[1] == ':')
1049 /* Find and remove drive specifier if present; this makes nm absolute
1050 even if the rest of the name appears to be relative. Only look for
1051 drive specifier at the beginning. */
1052 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1054 drive
= (unsigned char) nm
[0];
1059 /* If we see "c://somedir", we want to strip the first slash after the
1060 colon when stripping the drive letter. Otherwise, this expands to
1062 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1065 /* Discard any previous drive specifier if nm is now in UNC format. */
1066 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1067 && !IS_DIRECTORY_SEP (nm
[2]))
1069 #endif /* WINDOWSNT */
1072 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1073 none are found, we can probably return right away. We will avoid
1074 allocating a new string if name is already fully expanded. */
1076 IS_DIRECTORY_SEP (nm
[0])
1078 && drive
&& !is_escaped
1081 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1085 /* If it turns out that the filename we want to return is just a
1086 suffix of FILENAME, we don't need to go through and edit
1087 things; we just need to construct a new string using data
1088 starting at the middle of FILENAME. If we set LOSE, that
1089 means we've discovered that we can't do that cool trick. */
1095 /* Since we know the name is absolute, we can assume that each
1096 element starts with a "/". */
1098 /* "." and ".." are hairy. */
1099 if (IS_DIRECTORY_SEP (p
[0])
1101 && (IS_DIRECTORY_SEP (p
[2])
1103 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1106 /* Replace multiple slashes with a single one, except
1107 leave leading "//" alone. */
1108 else if (IS_DIRECTORY_SEP (p
[0])
1109 && IS_DIRECTORY_SEP (p
[1])
1110 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1117 /* Make sure directories are all separated with /, but
1118 avoid allocation of a new string when not required. */
1119 dostounix_filename (nm
);
1121 if (IS_DIRECTORY_SEP (nm
[1]))
1123 if (strcmp (nm
, SSDATA (name
)) != 0)
1124 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1128 /* Drive must be set, so this is okay. */
1129 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1133 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1134 temp
[0] = DRIVE_LETTER (drive
);
1135 name
= concat2 (build_string (temp
), name
);
1138 if (!NILP (Vw32_downcase_file_names
))
1139 name
= Fdowncase (name
);
1142 #else /* not DOS_NT */
1143 if (strcmp (nm
, SSDATA (name
)) == 0)
1145 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1146 #endif /* not DOS_NT */
1150 /* At this point, nm might or might not be an absolute file name. We
1151 need to expand ~ or ~user if present, otherwise prefix nm with
1152 default_directory if nm is not absolute, and finally collapse /./
1153 and /foo/../ sequences.
1155 We set newdir to be the appropriate prefix if one is needed:
1156 - the relevant user directory if nm starts with ~ or ~user
1157 - the specified drive's working dir (DOS/NT only) if nm does not
1159 - the value of default_directory.
1161 Note that these prefixes are not guaranteed to be absolute (except
1162 for the working dir of a drive). Therefore, to ensure we always
1163 return an absolute name, if the final prefix is not absolute we
1164 append it to the current working directory. */
1168 if (nm
[0] == '~') /* prefix ~ */
1170 if (IS_DIRECTORY_SEP (nm
[1])
1171 || nm
[1] == 0) /* ~ by itself */
1175 if (!(newdir
= egetenv ("HOME")))
1178 /* `egetenv' may return a unibyte string, which will bite us since
1179 we expect the directory to be multibyte. */
1183 char newdir_utf8
[MAX_UTF8_PATH
];
1185 filename_from_ansi (newdir
, newdir_utf8
);
1186 tem
= build_string (newdir_utf8
);
1190 tem
= build_string (newdir
);
1191 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1193 hdir
= DECODE_FILE (tem
);
1194 newdir
= SSDATA (hdir
);
1197 collapse_newdir
= 0;
1200 else /* ~user/filename */
1203 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1205 o
= SAFE_ALLOCA (p
- nm
+ 1);
1206 memcpy (o
, nm
, p
- nm
);
1210 pw
= getpwnam (o
+ 1);
1216 newdir
= pw
->pw_dir
;
1217 /* `getpwnam' may return a unibyte string, which will
1218 bite us since we expect the directory to be
1220 tem
= build_string (newdir
);
1221 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1223 hdir
= DECODE_FILE (tem
);
1224 newdir
= SSDATA (hdir
);
1228 collapse_newdir
= 0;
1232 /* If we don't find a user of that name, leave the name
1233 unchanged; don't move nm forward to p. */
1238 /* On DOS and Windows, nm is absolute if a drive name was specified;
1239 use the drive's current directory as the prefix if needed. */
1240 if (!newdir
&& drive
)
1242 /* Get default directory if needed to make nm absolute. */
1244 if (!IS_DIRECTORY_SEP (nm
[0]))
1246 adir
= alloca (MAXPATHLEN
+ 1);
1247 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1251 Lisp_Object tem
= build_string (adir
);
1253 tem
= DECODE_FILE (tem
);
1254 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1259 /* Either nm starts with /, or drive isn't mounted. */
1261 adir
[0] = DRIVE_LETTER (drive
);
1270 /* Finally, if no prefix has been specified and nm is not absolute,
1271 then it must be expanded relative to default_directory. */
1275 /* /... alone is not absolute on DOS and Windows. */
1276 && !IS_DIRECTORY_SEP (nm
[0])
1279 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1280 && !IS_DIRECTORY_SEP (nm
[2]))
1284 newdir
= SSDATA (default_directory
);
1286 /* Note if special escape prefix is present, but remove for now. */
1287 if (newdir
[0] == '/' && newdir
[1] == ':')
1298 /* First ensure newdir is an absolute name. */
1300 /* Detect MSDOS file names with drive specifiers. */
1301 ! (IS_DRIVE (newdir
[0])
1302 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1304 /* Detect Windows file names in UNC format. */
1305 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1306 && !IS_DIRECTORY_SEP (newdir
[2]))
1310 /* Effectively, let newdir be (expand-file-name newdir cwd).
1311 Because of the admonition against calling expand-file-name
1312 when we have pointers into lisp strings, we accomplish this
1313 indirectly by prepending newdir to nm if necessary, and using
1314 cwd (or the wd of newdir's drive) as the new newdir. */
1317 const int adir_size
= MAX_UTF8_PATH
;
1319 const int adir_size
= MAXPATHLEN
+ 1;
1322 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1324 drive
= (unsigned char) newdir
[0];
1327 if (!IS_DIRECTORY_SEP (nm
[0]))
1329 ptrdiff_t newlen
= strlen (newdir
);
1330 char *tmp
= alloca (newlen
+ file_name_as_directory_slop
1332 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1336 adir
= alloca (adir_size
);
1339 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1343 getcwd (adir
, adir_size
);
1346 Lisp_Object tem
= build_string (adir
);
1348 tem
= DECODE_FILE (tem
);
1349 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1354 /* Strip off drive name from prefix, if present. */
1355 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1361 /* Keep only a prefix from newdir if nm starts with slash
1362 (//server/share for UNC, nothing otherwise). */
1363 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1366 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1367 && !IS_DIRECTORY_SEP (newdir
[2]))
1369 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1371 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1373 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1386 /* Ignore any slash at the end of newdir, unless newdir is
1387 just "/" or "//". */
1388 length
= strlen (newdir
);
1389 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1390 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1396 /* Now concatenate the directory and name to new space in the stack frame. */
1397 tlen
= length
+ file_name_as_directory_slop
+ strlen (nm
) + 1;
1399 /* Reserve space for drive specifier and escape prefix, since either
1400 or both may need to be inserted. (The Microsoft x86 compiler
1401 produces incorrect code if the following two lines are combined.) */
1402 target
= alloca (tlen
+ 4);
1404 #else /* not DOS_NT */
1405 target
= SAFE_ALLOCA (tlen
);
1406 #endif /* not DOS_NT */
1411 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1414 /* If newdir is effectively "C:/", then the drive letter will have
1415 been stripped and newdir will be "/". Concatenating with an
1416 absolute directory in nm produces "//", which will then be
1417 incorrectly treated as a network share. Ignore newdir in
1418 this case (keeping the drive letter). */
1419 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1420 && newdir
[1] == '\0'))
1423 memcpy (target
, newdir
, length
);
1428 file_name_as_directory (target
, newdir
, length
, multibyte
);
1431 strcat (target
, nm
);
1433 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1441 if (!IS_DIRECTORY_SEP (*p
))
1445 else if (p
[1] == '.'
1446 && (IS_DIRECTORY_SEP (p
[2])
1449 /* If "/." is the entire filename, keep the "/". Otherwise,
1450 just delete the whole "/.". */
1451 if (o
== target
&& p
[2] == '\0')
1455 else if (p
[1] == '.' && p
[2] == '.'
1456 /* `/../' is the "superroot" on certain file systems.
1457 Turned off on DOS_NT systems because they have no
1458 "superroot" and because this causes us to produce
1459 file names like "d:/../foo" which fail file-related
1460 functions of the underlying OS. (To reproduce, try a
1461 long series of "../../" in default_directory, longer
1462 than the number of levels from the root.) */
1466 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1471 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1474 /* Don't go below server level in UNC filenames. */
1475 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1476 && IS_DIRECTORY_SEP (*target
))
1480 /* Keep initial / only if this is the whole name. */
1481 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1485 else if (IS_DIRECTORY_SEP (p
[1])
1486 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1487 /* Collapse multiple "/", except leave leading "//" alone. */
1496 /* At last, set drive name. */
1498 /* Except for network file name. */
1499 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1500 #endif /* WINDOWSNT */
1502 if (!drive
) emacs_abort ();
1504 target
[0] = DRIVE_LETTER (drive
);
1507 /* Reinsert the escape prefix if required. */
1514 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1515 dostounix_filename (SSDATA (result
));
1517 if (!NILP (Vw32_downcase_file_names
))
1518 result
= Fdowncase (result
);
1521 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1522 #endif /* !DOS_NT */
1525 /* Again look to see if the file name has special constructs in it
1526 and perhaps call the corresponding file handler. This is needed
1527 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1528 the ".." component gives us "/user@host:/bar/../baz" which needs
1529 to be expanded again. */
1530 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1531 if (!NILP (handler
))
1533 handled_name
= call3 (handler
, Qexpand_file_name
,
1534 result
, default_directory
);
1535 if (! STRINGP (handled_name
))
1536 error ("Invalid handler in `file-name-handler-alist'");
1537 result
= handled_name
;
1545 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1546 This is the old version of expand-file-name, before it was thoroughly
1547 rewritten for Emacs 10.31. We leave this version here commented-out,
1548 because the code is very complex and likely to have subtle bugs. If
1549 bugs _are_ found, it might be of interest to look at the old code and
1550 see what did it do in the relevant situation.
1552 Don't remove this code: it's true that it will be accessible
1553 from the repository, but a few years from deletion, people will
1554 forget it is there. */
1556 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1557 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1558 "Convert FILENAME to absolute, and canonicalize it.\n\
1559 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1560 \(does not start with slash); if DEFAULT is nil or missing,\n\
1561 the current buffer's value of default-directory is used.\n\
1562 Filenames containing `.' or `..' as components are simplified;\n\
1563 initial `~/' expands to your home directory.\n\
1564 See also the function `substitute-in-file-name'.")
1566 Lisp_Object name
, defalt
;
1570 register unsigned char *newdir
, *p
, *o
;
1572 unsigned char *target
;
1575 CHECK_STRING (name
);
1578 /* If nm is absolute, flush ...// and detect /./ and /../.
1579 If no /./ or /../ we can return right away. */
1586 if (p
[0] == '/' && p
[1] == '/')
1588 if (p
[0] == '/' && p
[1] == '~')
1589 nm
= p
+ 1, lose
= 1;
1590 if (p
[0] == '/' && p
[1] == '.'
1591 && (p
[2] == '/' || p
[2] == 0
1592 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1598 if (nm
== SDATA (name
))
1600 return build_string (nm
);
1604 /* Now determine directory to start with and put it in NEWDIR. */
1608 if (nm
[0] == '~') /* prefix ~ */
1609 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1611 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1612 newdir
= (unsigned char *) "";
1615 else /* ~user/filename */
1617 /* Get past ~ to user. */
1618 unsigned char *user
= nm
+ 1;
1619 /* Find end of name. */
1620 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1621 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1622 /* Copy the user name into temp storage. */
1623 o
= alloca (len
+ 1);
1624 memcpy (o
, user
, len
);
1627 /* Look up the user name. */
1629 pw
= (struct passwd
*) getpwnam (o
+ 1);
1632 error ("\"%s\" isn't a registered user", o
+ 1);
1634 newdir
= (unsigned char *) pw
->pw_dir
;
1636 /* Discard the user name from NM. */
1640 if (nm
[0] != '/' && !newdir
)
1643 defalt
= current_buffer
->directory
;
1644 CHECK_STRING (defalt
);
1645 newdir
= SDATA (defalt
);
1648 /* Now concatenate the directory and name to new space in the stack frame. */
1650 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1651 target
= alloca (tlen
);
1656 if (nm
[0] == 0 || nm
[0] == '/')
1657 strcpy (target
, newdir
);
1659 file_name_as_directory (target
, newdir
);
1662 strcat (target
, nm
);
1664 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1675 else if (!strncmp (p
, "//", 2)
1681 else if (p
[0] == '/' && p
[1] == '.'
1682 && (p
[2] == '/' || p
[2] == 0))
1684 else if (!strncmp (p
, "/..", 3)
1685 /* `/../' is the "superroot" on certain file systems. */
1687 && (p
[3] == '/' || p
[3] == 0))
1689 while (o
!= target
&& *--o
!= '/')
1691 if (o
== target
&& *o
== '/')
1701 return make_string (target
, o
- target
);
1705 /* If /~ or // appears, discard everything through first slash. */
1707 file_name_absolute_p (const char *filename
)
1710 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1712 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1713 && IS_DIRECTORY_SEP (filename
[2]))
1719 search_embedded_absfilename (char *nm
, char *endp
)
1723 for (p
= nm
+ 1; p
< endp
; p
++)
1725 if (IS_DIRECTORY_SEP (p
[-1])
1726 && file_name_absolute_p (p
)
1727 #if defined (WINDOWSNT) || defined (CYGWIN)
1728 /* // at start of file name is meaningful in Apollo,
1729 WindowsNT and Cygwin systems. */
1730 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1731 #endif /* not (WINDOWSNT || CYGWIN) */
1734 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1735 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1737 char *o
= alloca (s
- p
+ 1);
1739 memcpy (o
, p
, s
- p
);
1742 /* If we have ~user and `user' exists, discard
1743 everything up to ~. But if `user' does not exist, leave
1744 ~user alone, it might be a literal file name. */
1746 pw
= getpwnam (o
+ 1);
1758 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1759 Ssubstitute_in_file_name
, 1, 1, 0,
1760 doc
: /* Substitute environment variables referred to in FILENAME.
1761 `$FOO' where FOO is an environment variable name means to substitute
1762 the value of that variable. The variable name should be terminated
1763 with a character not a letter, digit or underscore; otherwise, enclose
1764 the entire variable name in braces.
1766 If `/~' appears, all of FILENAME through that `/' is discarded.
1767 If `//' appears, everything up to and including the first of
1768 those `/' is discarded. */)
1769 (Lisp_Object filename
)
1771 char *nm
, *p
, *x
, *endp
;
1772 bool substituted
= false;
1775 Lisp_Object handler
;
1777 CHECK_STRING (filename
);
1779 multibyte
= STRING_MULTIBYTE (filename
);
1781 /* If the file name has special constructs in it,
1782 call the corresponding file handler. */
1783 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1784 if (!NILP (handler
))
1786 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1788 if (STRINGP (handled_name
))
1789 return handled_name
;
1790 error ("Invalid handler in `file-name-handler-alist'");
1793 /* Always work on a copy of the string, in case GC happens during
1794 decode of environment variables, causing the original Lisp_String
1795 data to be relocated. */
1796 nm
= xlispstrdupa (filename
);
1799 dostounix_filename (nm
);
1800 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1802 endp
= nm
+ SBYTES (filename
);
1804 /* If /~ or // appears, discard everything through first slash. */
1805 p
= search_embedded_absfilename (nm
, endp
);
1807 /* Start over with the new string, so we check the file-name-handler
1808 again. Important with filenames like "/home/foo//:/hello///there"
1809 which would substitute to "/:/hello///there" rather than "/there". */
1810 return Fsubstitute_in_file_name
1811 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1813 /* See if any variables are substituted into the string. */
1815 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1818 = (!substituted
? filename
1819 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1820 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1822 if (!EQ (tmp
, name
))
1830 if (!NILP (Vw32_downcase_file_names
))
1831 filename
= Fdowncase (filename
);
1836 xnm
= SSDATA (filename
);
1837 x
= xnm
+ SBYTES (filename
);
1839 /* If /~ or // appears, discard everything through first slash. */
1840 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1841 /* This time we do not start over because we've already expanded envvars
1842 and replaced $$ with $. Maybe we should start over as well, but we'd
1843 need to quote some $ to $$ first. */
1847 if (!NILP (Vw32_downcase_file_names
))
1849 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1851 xname
= Fdowncase (xname
);
1856 return (xnm
== SSDATA (filename
)
1858 : make_specified_string (xnm
, -1, x
- xnm
, multibyte
));
1861 /* A slightly faster and more convenient way to get
1862 (directory-file-name (expand-file-name FOO)). */
1865 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1867 register Lisp_Object absname
;
1869 absname
= Fexpand_file_name (filename
, defdir
);
1871 /* Remove final slash, if any (unless this is the root dir).
1872 stat behaves differently depending! */
1873 if (SCHARS (absname
) > 1
1874 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1875 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1876 /* We cannot take shortcuts; they might be wrong for magic file names. */
1877 absname
= Fdirectory_file_name (absname
);
1881 /* Signal an error if the file ABSNAME already exists.
1882 If KNOWN_TO_EXIST, the file is known to exist.
1883 QUERYSTRING is a name for the action that is being considered
1885 If INTERACTIVE, ask the user whether to proceed,
1886 and bypass the error if the user says to go ahead.
1887 If QUICK, ask for y or n, not yes or no. */
1890 barf_or_query_if_file_exists (Lisp_Object absname
, bool known_to_exist
,
1891 const char *querystring
, bool interactive
,
1894 Lisp_Object tem
, encoded_filename
;
1895 struct stat statbuf
;
1896 struct gcpro gcpro1
;
1898 encoded_filename
= ENCODE_FILE (absname
);
1900 if (! known_to_exist
&& lstat (SSDATA (encoded_filename
), &statbuf
) == 0)
1902 if (S_ISDIR (statbuf
.st_mode
))
1903 xsignal2 (Qfile_error
,
1904 build_string ("File is a directory"), absname
);
1905 known_to_exist
= true;
1911 xsignal2 (Qfile_already_exists
,
1912 build_string ("File already exists"), absname
);
1914 tem
= format2 ("File %s already exists; %s anyway? ",
1915 absname
, build_string (querystring
));
1917 tem
= call1 (intern ("y-or-n-p"), tem
);
1919 tem
= do_yes_or_no_p (tem
);
1922 xsignal2 (Qfile_already_exists
,
1923 build_string ("File already exists"), absname
);
1927 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1928 "fCopy file: \nGCopy %s to file: \np\nP",
1929 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1930 If NEWNAME names a directory, copy FILE there.
1932 This function always sets the file modes of the output file to match
1935 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1936 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1937 signal a `file-already-exists' error without overwriting. If
1938 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1939 about overwriting; this is what happens in interactive use with M-x.
1940 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1943 Fourth arg KEEP-TIME non-nil means give the output file the same
1944 last-modified time as the old one. (This works on only some systems.)
1946 A prefix arg makes KEEP-TIME non-nil.
1948 If PRESERVE-UID-GID is non-nil, we try to transfer the
1949 uid and gid of FILE to NEWNAME.
1951 If PRESERVE-PERMISSIONS is non-nil, copy permissions of FILE to NEWNAME;
1952 this includes the file modes, along with ACL entries and SELinux
1953 context if present. Otherwise, if NEWNAME is created its file
1954 permission bits are those of FILE, masked by the default file
1956 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
,
1957 Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
,
1958 Lisp_Object preserve_permissions
)
1960 Lisp_Object handler
;
1961 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1963 Lisp_Object encoded_file
, encoded_newname
;
1965 security_context_t con
;
1971 bool already_exists
= false;
1975 char buf
[16 * 1024];
1979 encoded_file
= encoded_newname
= Qnil
;
1980 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1981 CHECK_STRING (file
);
1982 CHECK_STRING (newname
);
1984 if (!NILP (Ffile_directory_p (newname
)))
1985 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1987 newname
= Fexpand_file_name (newname
, Qnil
);
1989 file
= Fexpand_file_name (file
, Qnil
);
1991 /* If the input file name has special constructs in it,
1992 call the corresponding file handler. */
1993 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1994 /* Likewise for output file name. */
1996 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1997 if (!NILP (handler
)) {
1999 return call7 (handler
, Qcopy_file
, file
, newname
, ok_if_already_exists
, keep_time
, preserve_uid_gid
, preserve_permissions
);
2002 encoded_file
= ENCODE_FILE (file
);
2003 encoded_newname
= ENCODE_FILE (newname
);
2006 if (NILP (ok_if_already_exists
)
2007 || INTEGERP (ok_if_already_exists
))
2008 barf_or_query_if_file_exists (newname
, false, "copy to it",
2009 INTEGERP (ok_if_already_exists
), false);
2011 result
= w32_copy_file (SSDATA (encoded_file
), SSDATA (encoded_newname
),
2012 !NILP (keep_time
), !NILP (preserve_uid_gid
),
2013 !NILP (preserve_permissions
));
2017 report_file_error ("Copying file", list2 (file
, newname
));
2019 report_file_error ("Copying permissions from", file
);
2021 xsignal2 (Qfile_date_error
,
2022 build_string ("Resetting file times"), newname
);
2024 report_file_error ("Copying permissions to", newname
);
2026 #else /* not WINDOWSNT */
2028 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2032 report_file_error ("Opening input file", file
);
2034 record_unwind_protect_int_1 (close_file_unwind
, ifd
, false);
2036 if (fstat (ifd
, &st
) != 0)
2037 report_file_error ("Input file status", file
);
2039 if (!NILP (preserve_permissions
))
2042 if (is_selinux_enabled ())
2044 conlength
= fgetfilecon (ifd
, &con
);
2045 if (conlength
== -1)
2046 report_file_error ("Doing fgetfilecon", file
);
2051 /* We can copy only regular files. */
2052 if (!S_ISREG (st
.st_mode
))
2053 report_file_errno ("Non-regular file", file
,
2054 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
2057 new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0700 : 0777);
2059 new_mask
= S_IREAD
| S_IWRITE
;
2062 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
| O_CREAT
| O_EXCL
,
2064 if (ofd
< 0 && errno
== EEXIST
)
2066 if (NILP (ok_if_already_exists
) || INTEGERP (ok_if_already_exists
))
2067 barf_or_query_if_file_exists (newname
, true, "copy to it",
2068 INTEGERP (ok_if_already_exists
), false);
2069 already_exists
= true;
2070 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
, 0);
2073 report_file_error ("Opening output file", newname
);
2075 record_unwind_protect_int_1 (close_file_unwind
, ofd
, false);
2080 if (fstat (ofd
, &out_st
) != 0)
2081 report_file_error ("Output file status", newname
);
2082 if (st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2083 report_file_errno ("Input and output files are the same",
2084 list2 (file
, newname
), 0);
2085 if (ftruncate (ofd
, 0) != 0)
2086 report_file_error ("Truncating output file", newname
);
2091 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2092 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2093 report_file_error ("Write error", newname
);
2097 /* Preserve the original file permissions, and if requested, also its
2100 mode_t preserved_permissions
= st
.st_mode
& 07777;
2101 mode_t default_permissions
= st
.st_mode
& 0777 & ~realmask
;
2102 if (!NILP (preserve_uid_gid
))
2104 /* Attempt to change owner and group. If that doesn't work
2105 attempt to change just the group, as that is sometimes allowed.
2106 Adjust the mode mask to eliminate setuid or setgid bits
2107 or group permissions bits that are inappropriate if the
2108 owner or group are wrong. */
2109 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2111 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2112 preserved_permissions
&= ~04000;
2115 preserved_permissions
&= ~06000;
2117 /* Copy the other bits to the group bits, since the
2119 preserved_permissions
&= ~070;
2120 preserved_permissions
|= (preserved_permissions
& 7) << 3;
2121 default_permissions
&= ~070;
2122 default_permissions
|= (default_permissions
& 7) << 3;
2127 switch (!NILP (preserve_permissions
)
2128 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2129 SSDATA (encoded_newname
), ofd
,
2130 preserved_permissions
)
2132 || (new_mask
& ~realmask
) == default_permissions
)
2134 : fchmod (ofd
, default_permissions
))
2136 case -2: report_file_error ("Copying permissions from", file
);
2137 case -1: report_file_error ("Copying permissions to", newname
);
2140 #endif /* not MSDOS */
2145 /* Set the modified context back to the file. */
2146 bool fail
= fsetfilecon (ofd
, con
) != 0;
2147 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2148 if (fail
&& errno
!= ENOTSUP
)
2149 report_file_error ("Doing fsetfilecon", newname
);
2155 if (!NILP (keep_time
))
2157 struct timespec atime
= get_stat_atime (&st
);
2158 struct timespec mtime
= get_stat_mtime (&st
);
2159 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
) != 0)
2160 xsignal2 (Qfile_date_error
,
2161 build_string ("Cannot set file date"), newname
);
2164 if (emacs_close (ofd
) < 0)
2165 report_file_error ("Write error", newname
);
2170 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2171 and if it can't, it tells so. Otherwise, under MSDOS we usually
2172 get only the READ bit, which will make the copied file read-only,
2173 so it's better not to chmod at all. */
2174 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2175 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2177 #endif /* not WINDOWSNT */
2185 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2186 Smake_directory_internal
, 1, 1, 0,
2187 doc
: /* Create a new directory named DIRECTORY. */)
2188 (Lisp_Object directory
)
2191 Lisp_Object handler
;
2192 Lisp_Object encoded_dir
;
2194 CHECK_STRING (directory
);
2195 directory
= Fexpand_file_name (directory
, Qnil
);
2197 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2198 if (!NILP (handler
))
2199 return call2 (handler
, Qmake_directory_internal
, directory
);
2201 encoded_dir
= ENCODE_FILE (directory
);
2203 dir
= SSDATA (encoded_dir
);
2206 if (mkdir (dir
) != 0)
2208 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2210 report_file_error ("Creating directory", directory
);
2215 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2216 Sdelete_directory_internal
, 1, 1, 0,
2217 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2218 (Lisp_Object directory
)
2221 Lisp_Object encoded_dir
;
2223 CHECK_STRING (directory
);
2224 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2225 encoded_dir
= ENCODE_FILE (directory
);
2226 dir
= SSDATA (encoded_dir
);
2228 if (rmdir (dir
) != 0)
2229 report_file_error ("Removing directory", directory
);
2234 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2235 "(list (read-file-name \
2236 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2237 \"Move file to trash: \" \"Delete file: \") \
2238 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2239 (null current-prefix-arg))",
2240 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2241 If file has multiple names, it continues to exist with the other names.
2242 TRASH non-nil means to trash the file instead of deleting, provided
2243 `delete-by-moving-to-trash' is non-nil.
2245 When called interactively, TRASH is t if no prefix argument is given.
2246 With a prefix argument, TRASH is nil. */)
2247 (Lisp_Object filename
, Lisp_Object trash
)
2249 Lisp_Object handler
;
2250 Lisp_Object encoded_file
;
2251 struct gcpro gcpro1
;
2254 if (!NILP (Ffile_directory_p (filename
))
2255 && NILP (Ffile_symlink_p (filename
)))
2256 xsignal2 (Qfile_error
,
2257 build_string ("Removing old name: is a directory"),
2260 filename
= Fexpand_file_name (filename
, Qnil
);
2262 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2263 if (!NILP (handler
))
2264 return call3 (handler
, Qdelete_file
, filename
, trash
);
2266 if (delete_by_moving_to_trash
&& !NILP (trash
))
2267 return call1 (Qmove_file_to_trash
, filename
);
2269 encoded_file
= ENCODE_FILE (filename
);
2271 if (unlink (SSDATA (encoded_file
)) < 0)
2272 report_file_error ("Removing old name", filename
);
2277 internal_delete_file_1 (Lisp_Object ignore
)
2282 /* Delete file FILENAME, returning true if successful.
2283 This ignores `delete-by-moving-to-trash'. */
2286 internal_delete_file (Lisp_Object filename
)
2290 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2291 Qt
, internal_delete_file_1
);
2295 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2296 "fRename file: \nGRename %s to file: \np",
2297 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2298 If file has names other than FILE, it continues to have those names.
2299 Signals a `file-already-exists' error if a file NEWNAME already exists
2300 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2301 A number as third arg means request confirmation if NEWNAME already exists.
2302 This is what happens in interactive use with M-x. */)
2303 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2305 Lisp_Object handler
;
2306 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2307 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2309 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2310 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2311 CHECK_STRING (file
);
2312 CHECK_STRING (newname
);
2313 file
= Fexpand_file_name (file
, Qnil
);
2315 if ((!NILP (Ffile_directory_p (newname
)))
2317 /* If the file names are identical but for the case,
2318 don't attempt to move directory to itself. */
2319 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2323 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2324 ? file
: Fdirectory_file_name (file
));
2325 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2328 newname
= Fexpand_file_name (newname
, Qnil
);
2330 /* If the file name has special constructs in it,
2331 call the corresponding file handler. */
2332 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2334 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2335 if (!NILP (handler
))
2336 return call4 (handler
, Qrename_file
, file
, newname
, ok_if_already_exists
);
2338 encoded_file
= ENCODE_FILE (file
);
2339 encoded_newname
= ENCODE_FILE (newname
);
2342 /* If the file names are identical but for the case, don't ask for
2343 confirmation: they simply want to change the letter-case of the
2345 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2347 if (NILP (ok_if_already_exists
)
2348 || INTEGERP (ok_if_already_exists
))
2349 barf_or_query_if_file_exists (newname
, false, "rename to it",
2350 INTEGERP (ok_if_already_exists
), false);
2351 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2353 int rename_errno
= errno
;
2354 if (rename_errno
== EXDEV
)
2357 symlink_target
= Ffile_symlink_p (file
);
2358 if (! NILP (symlink_target
))
2359 Fmake_symbolic_link (symlink_target
, newname
,
2360 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2361 else if (!NILP (Ffile_directory_p (file
)))
2362 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2364 /* We have already prompted if it was an integer, so don't
2365 have copy-file prompt again. */
2366 Fcopy_file (file
, newname
,
2367 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2371 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2373 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2374 call2 (Qdelete_directory
, file
, Qt
);
2376 Fdelete_file (file
, Qnil
);
2380 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2386 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2387 "fAdd name to file: \nGName to add to %s: \np",
2388 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2389 Signals a `file-already-exists' error if a file NEWNAME already exists
2390 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2391 A number as third arg means request confirmation if NEWNAME already exists.
2392 This is what happens in interactive use with M-x. */)
2393 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2395 Lisp_Object handler
;
2396 Lisp_Object encoded_file
, encoded_newname
;
2397 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2399 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2400 encoded_file
= encoded_newname
= Qnil
;
2401 CHECK_STRING (file
);
2402 CHECK_STRING (newname
);
2403 file
= Fexpand_file_name (file
, Qnil
);
2405 if (!NILP (Ffile_directory_p (newname
)))
2406 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2408 newname
= Fexpand_file_name (newname
, Qnil
);
2410 /* If the file name has special constructs in it,
2411 call the corresponding file handler. */
2412 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2413 if (!NILP (handler
))
2414 return call4 (handler
, Qadd_name_to_file
, file
, newname
, ok_if_already_exists
);
2416 /* If the new name has special constructs in it,
2417 call the corresponding file handler. */
2418 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2419 if (!NILP (handler
))
2420 return call4 (handler
, Qadd_name_to_file
, file
, newname
, ok_if_already_exists
);
2422 encoded_file
= ENCODE_FILE (file
);
2423 encoded_newname
= ENCODE_FILE (newname
);
2425 if (NILP (ok_if_already_exists
)
2426 || INTEGERP (ok_if_already_exists
))
2427 barf_or_query_if_file_exists (newname
, false, "make it a new name",
2428 INTEGERP (ok_if_already_exists
), false);
2430 unlink (SSDATA (newname
));
2431 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2433 int link_errno
= errno
;
2434 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2441 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2442 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2443 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2444 Both args must be strings.
2445 Signals a `file-already-exists' error if a file LINKNAME already exists
2446 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2447 A number as third arg means request confirmation if LINKNAME already exists.
2448 This happens for interactive use with M-x. */)
2449 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2451 Lisp_Object handler
;
2452 Lisp_Object encoded_filename
, encoded_linkname
;
2453 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2455 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2456 encoded_filename
= encoded_linkname
= Qnil
;
2457 CHECK_STRING (filename
);
2458 CHECK_STRING (linkname
);
2459 /* If the link target has a ~, we must expand it to get
2460 a truly valid file name. Otherwise, do not expand;
2461 we want to permit links to relative file names. */
2462 if (SREF (filename
, 0) == '~')
2463 filename
= Fexpand_file_name (filename
, Qnil
);
2465 if (!NILP (Ffile_directory_p (linkname
)))
2466 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2468 linkname
= Fexpand_file_name (linkname
, Qnil
);
2470 /* If the file name has special constructs in it,
2471 call the corresponding file handler. */
2472 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2473 if (!NILP (handler
))
2474 return call4 (handler
, Qmake_symbolic_link
, filename
, linkname
, ok_if_already_exists
);
2476 /* If the new link name has special constructs in it,
2477 call the corresponding file handler. */
2478 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2479 if (!NILP (handler
))
2480 return call4 (handler
, Qmake_symbolic_link
, filename
, linkname
, ok_if_already_exists
);
2482 encoded_filename
= ENCODE_FILE (filename
);
2483 encoded_linkname
= ENCODE_FILE (linkname
);
2485 if (NILP (ok_if_already_exists
)
2486 || INTEGERP (ok_if_already_exists
))
2487 barf_or_query_if_file_exists (linkname
, false, "make it a link",
2488 INTEGERP (ok_if_already_exists
), false);
2489 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2491 /* If we didn't complain already, silently delete existing file. */
2493 if (errno
== EEXIST
)
2495 unlink (SSDATA (encoded_linkname
));
2496 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2503 if (errno
== ENOSYS
)
2506 xsignal1 (Qfile_error
,
2507 build_string ("Symbolic links are not supported"));
2510 symlink_errno
= errno
;
2511 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2519 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2521 doc
: /* Return t if file FILENAME specifies an absolute file name.
2522 On Unix, this is a name starting with a `/' or a `~'. */)
2523 (Lisp_Object filename
)
2525 CHECK_STRING (filename
);
2526 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2529 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2530 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2531 See also `file-readable-p' and `file-attributes'.
2532 This returns nil for a symlink to a nonexistent file.
2533 Use `file-symlink-p' to test for such links. */)
2534 (Lisp_Object filename
)
2536 Lisp_Object absname
;
2537 Lisp_Object handler
;
2539 CHECK_STRING (filename
);
2540 absname
= Fexpand_file_name (filename
, Qnil
);
2542 /* If the file name has special constructs in it,
2543 call the corresponding file handler. */
2544 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2545 if (!NILP (handler
))
2547 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2552 absname
= ENCODE_FILE (absname
);
2554 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2557 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2558 doc
: /* Return t if FILENAME can be executed by you.
2559 For a directory, this means you can access files in that directory.
2560 \(It is generally better to use `file-accessible-directory-p' for that
2561 purpose, though.) */)
2562 (Lisp_Object filename
)
2564 Lisp_Object absname
;
2565 Lisp_Object handler
;
2567 CHECK_STRING (filename
);
2568 absname
= Fexpand_file_name (filename
, Qnil
);
2570 /* If the file name has special constructs in it,
2571 call the corresponding file handler. */
2572 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2573 if (!NILP (handler
))
2574 return call2 (handler
, Qfile_executable_p
, absname
);
2576 absname
= ENCODE_FILE (absname
);
2578 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2581 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2582 doc
: /* Return t if file FILENAME exists and you can read it.
2583 See also `file-exists-p' and `file-attributes'. */)
2584 (Lisp_Object filename
)
2586 Lisp_Object absname
;
2587 Lisp_Object handler
;
2589 CHECK_STRING (filename
);
2590 absname
= Fexpand_file_name (filename
, Qnil
);
2592 /* If the file name has special constructs in it,
2593 call the corresponding file handler. */
2594 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2595 if (!NILP (handler
))
2596 return call2 (handler
, Qfile_readable_p
, absname
);
2598 absname
= ENCODE_FILE (absname
);
2599 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2603 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2604 doc
: /* Return t if file FILENAME can be written or created by you. */)
2605 (Lisp_Object filename
)
2607 Lisp_Object absname
, dir
, encoded
;
2608 Lisp_Object handler
;
2610 CHECK_STRING (filename
);
2611 absname
= Fexpand_file_name (filename
, Qnil
);
2613 /* If the file name has special constructs in it,
2614 call the corresponding file handler. */
2615 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2616 if (!NILP (handler
))
2617 return call2 (handler
, Qfile_writable_p
, absname
);
2619 encoded
= ENCODE_FILE (absname
);
2620 if (check_writable (SSDATA (encoded
), W_OK
))
2622 if (errno
!= ENOENT
)
2625 dir
= Ffile_name_directory (absname
);
2626 eassert (!NILP (dir
));
2628 dir
= Fdirectory_file_name (dir
);
2631 dir
= ENCODE_FILE (dir
);
2633 /* The read-only attribute of the parent directory doesn't affect
2634 whether a file or directory can be created within it. Some day we
2635 should check ACLs though, which do affect this. */
2636 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2638 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2642 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2643 doc
: /* Access file FILENAME, and get an error if that does not work.
2644 The second argument STRING is used in the error message.
2645 If there is no error, returns nil. */)
2646 (Lisp_Object filename
, Lisp_Object string
)
2648 Lisp_Object handler
, encoded_filename
, absname
;
2650 CHECK_STRING (filename
);
2651 absname
= Fexpand_file_name (filename
, Qnil
);
2653 CHECK_STRING (string
);
2655 /* If the file name has special constructs in it,
2656 call the corresponding file handler. */
2657 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2658 if (!NILP (handler
))
2659 return call3 (handler
, Qaccess_file
, absname
, string
);
2661 encoded_filename
= ENCODE_FILE (absname
);
2663 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2664 report_file_error (SSDATA (string
), filename
);
2669 /* Relative to directory FD, return the symbolic link value of FILENAME.
2670 On failure, return nil. */
2672 emacs_readlinkat (int fd
, char const *filename
)
2674 static struct allocator
const emacs_norealloc_allocator
=
2675 { xmalloc
, NULL
, xfree
, memory_full
};
2677 char readlink_buf
[1024];
2678 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2679 &emacs_norealloc_allocator
, readlinkat
);
2683 val
= build_unibyte_string (buf
);
2684 if (buf
[0] == '/' && strchr (buf
, ':'))
2685 val
= concat2 (build_unibyte_string ("/:"), val
);
2686 if (buf
!= readlink_buf
)
2688 val
= DECODE_FILE (val
);
2692 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2693 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2694 The value is the link target, as a string.
2695 Otherwise it returns nil.
2697 This function does not check whether the link target exists. */)
2698 (Lisp_Object filename
)
2700 Lisp_Object handler
;
2702 CHECK_STRING (filename
);
2703 filename
= Fexpand_file_name (filename
, Qnil
);
2705 /* If the file name has special constructs in it,
2706 call the corresponding file handler. */
2707 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2708 if (!NILP (handler
))
2709 return call2 (handler
, Qfile_symlink_p
, filename
);
2711 filename
= ENCODE_FILE (filename
);
2713 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2716 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2717 doc
: /* Return t if FILENAME names an existing directory.
2718 Symbolic links to directories count as directories.
2719 See `file-symlink-p' to distinguish symlinks. */)
2720 (Lisp_Object filename
)
2722 Lisp_Object absname
;
2723 Lisp_Object handler
;
2725 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2727 /* If the file name has special constructs in it,
2728 call the corresponding file handler. */
2729 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2730 if (!NILP (handler
))
2731 return call2 (handler
, Qfile_directory_p
, absname
);
2733 absname
= ENCODE_FILE (absname
);
2735 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2738 /* Return true if FILE is a directory or a symlink to a directory. */
2740 file_directory_p (char const *file
)
2743 /* This is cheaper than 'stat'. */
2744 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2747 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2751 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2752 Sfile_accessible_directory_p
, 1, 1, 0,
2753 doc
: /* Return t if file FILENAME names a directory you can open.
2754 For the value to be t, FILENAME must specify the name of a directory as a file,
2755 and the directory must allow you to open files in it. In order to use a
2756 directory as a buffer's current directory, this predicate must return true.
2757 A directory name spec may be given instead; then the value is t
2758 if the directory so specified exists and really is a readable and
2759 searchable directory. */)
2760 (Lisp_Object filename
)
2762 Lisp_Object absname
;
2763 Lisp_Object handler
;
2765 CHECK_STRING (filename
);
2766 absname
= Fexpand_file_name (filename
, Qnil
);
2768 /* If the file name has special constructs in it,
2769 call the corresponding file handler. */
2770 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2771 if (!NILP (handler
))
2773 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2778 absname
= ENCODE_FILE (absname
);
2779 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2782 /* If FILE is a searchable directory or a symlink to a
2783 searchable directory, return true. Otherwise return
2784 false and set errno to an error number. */
2786 file_accessible_directory_p (char const *file
)
2789 /* There's no need to test whether FILE is searchable, as the
2790 searchable/executable bit is invented on DOS_NT platforms. */
2791 return file_directory_p (file
);
2793 /* On POSIXish platforms, use just one system call; this avoids a
2794 race and is typically faster. */
2795 ptrdiff_t len
= strlen (file
);
2801 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2802 There are three exceptions: "", "/", and "//". Leave "" alone,
2803 as it's invalid. Append only "." to the other two exceptions as
2804 "/" and "//" are distinct on some platforms, whereas "/", "///",
2805 "////", etc. are all equivalent. */
2810 /* Just check for trailing '/' when deciding whether to append '/'.
2811 That's simpler than testing the two special cases "/" and "//",
2812 and it's a safe optimization here. */
2813 char *buf
= SAFE_ALLOCA (len
+ 3);
2814 memcpy (buf
, file
, len
);
2815 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2819 ok
= check_existing (dir
);
2820 saved_errno
= errno
;
2822 errno
= saved_errno
;
2827 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2828 doc
: /* Return t if FILENAME names a regular file.
2829 This is the sort of file that holds an ordinary stream of data bytes.
2830 Symbolic links to regular files count as regular files.
2831 See `file-symlink-p' to distinguish symlinks. */)
2832 (Lisp_Object filename
)
2834 register Lisp_Object absname
;
2836 Lisp_Object handler
;
2838 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2840 /* If the file name has special constructs in it,
2841 call the corresponding file handler. */
2842 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2843 if (!NILP (handler
))
2844 return call2 (handler
, Qfile_regular_p
, absname
);
2846 absname
= ENCODE_FILE (absname
);
2851 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2853 /* Tell stat to use expensive method to get accurate info. */
2854 Vw32_get_true_file_attributes
= Qt
;
2855 result
= stat (SDATA (absname
), &st
);
2856 Vw32_get_true_file_attributes
= tem
;
2860 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2863 if (stat (SSDATA (absname
), &st
) < 0)
2865 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2869 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2870 Sfile_selinux_context
, 1, 1, 0,
2871 doc
: /* Return SELinux context of file named FILENAME.
2872 The return value is a list (USER ROLE TYPE RANGE), where the list
2873 elements are strings naming the user, role, type, and range of the
2874 file's SELinux security context.
2876 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2877 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2878 (Lisp_Object filename
)
2880 Lisp_Object absname
;
2881 Lisp_Object values
[4];
2882 Lisp_Object handler
;
2884 security_context_t con
;
2889 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2891 /* If the file name has special constructs in it,
2892 call the corresponding file handler. */
2893 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2894 if (!NILP (handler
))
2895 return call2 (handler
, Qfile_selinux_context
, absname
);
2897 absname
= ENCODE_FILE (absname
);
2904 if (is_selinux_enabled ())
2906 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2909 context
= context_new (con
);
2910 if (context_user_get (context
))
2911 values
[0] = build_string (context_user_get (context
));
2912 if (context_role_get (context
))
2913 values
[1] = build_string (context_role_get (context
));
2914 if (context_type_get (context
))
2915 values
[2] = build_string (context_type_get (context
));
2916 if (context_range_get (context
))
2917 values
[3] = build_string (context_range_get (context
));
2918 context_free (context
);
2924 return Flist (ARRAYELTS (values
), values
);
2927 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2928 Sset_file_selinux_context
, 2, 2, 0,
2929 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2930 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2931 elements are strings naming the components of a SELinux context.
2933 Value is t if setting of SELinux context was successful, nil otherwise.
2935 This function does nothing and returns nil if SELinux is disabled,
2936 or if Emacs was not compiled with SELinux support. */)
2937 (Lisp_Object filename
, Lisp_Object context
)
2939 Lisp_Object absname
;
2940 Lisp_Object handler
;
2942 Lisp_Object encoded_absname
;
2943 Lisp_Object user
= CAR_SAFE (context
);
2944 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2945 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2946 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2947 security_context_t con
;
2950 context_t parsed_con
;
2953 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2955 /* If the file name has special constructs in it,
2956 call the corresponding file handler. */
2957 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2958 if (!NILP (handler
))
2959 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2962 if (is_selinux_enabled ())
2964 /* Get current file context. */
2965 encoded_absname
= ENCODE_FILE (absname
);
2966 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2969 parsed_con
= context_new (con
);
2970 /* Change the parts defined in the parameter.*/
2973 if (context_user_set (parsed_con
, SSDATA (user
)))
2974 error ("Doing context_user_set");
2978 if (context_role_set (parsed_con
, SSDATA (role
)))
2979 error ("Doing context_role_set");
2983 if (context_type_set (parsed_con
, SSDATA (type
)))
2984 error ("Doing context_type_set");
2986 if (STRINGP (range
))
2988 if (context_range_set (parsed_con
, SSDATA (range
)))
2989 error ("Doing context_range_set");
2992 /* Set the modified context back to the file. */
2993 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2994 context_str (parsed_con
))
2996 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2997 if (fail
&& errno
!= ENOTSUP
)
2998 report_file_error ("Doing lsetfilecon", absname
);
3000 context_free (parsed_con
);
3002 return fail
? Qnil
: Qt
;
3005 report_file_error ("Doing lgetfilecon", absname
);
3012 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3013 doc
: /* Return ACL entries of file named FILENAME.
3014 The entries are returned in a format suitable for use in `set-file-acl'
3015 but is otherwise undocumented and subject to change.
3016 Return nil if file does not exist or is not accessible, or if Emacs
3017 was unable to determine the ACL entries. */)
3018 (Lisp_Object filename
)
3020 Lisp_Object absname
;
3021 Lisp_Object handler
;
3022 #ifdef HAVE_ACL_SET_FILE
3024 Lisp_Object acl_string
;
3026 # ifndef HAVE_ACL_TYPE_EXTENDED
3027 acl_type_t ACL_TYPE_EXTENDED
= ACL_TYPE_ACCESS
;
3031 absname
= expand_and_dir_to_file (filename
,
3032 BVAR (current_buffer
, directory
));
3034 /* If the file name has special constructs in it,
3035 call the corresponding file handler. */
3036 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3037 if (!NILP (handler
))
3038 return call2 (handler
, Qfile_acl
, absname
);
3040 #ifdef HAVE_ACL_SET_FILE
3041 absname
= ENCODE_FILE (absname
);
3043 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_EXTENDED
);
3047 str
= acl_to_text (acl
, NULL
);
3054 acl_string
= build_string (str
);
3064 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3066 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3067 ACL-STRING should contain the textual representation of the ACL
3068 entries in a format suitable for the platform.
3070 Value is t if setting of ACL was successful, nil otherwise.
3072 Setting ACL for local files requires Emacs to be built with ACL
3074 (Lisp_Object filename
, Lisp_Object acl_string
)
3076 Lisp_Object absname
;
3077 Lisp_Object handler
;
3078 #ifdef HAVE_ACL_SET_FILE
3079 Lisp_Object encoded_absname
;
3084 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3086 /* If the file name has special constructs in it,
3087 call the corresponding file handler. */
3088 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3089 if (!NILP (handler
))
3090 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3092 #ifdef HAVE_ACL_SET_FILE
3093 if (STRINGP (acl_string
))
3095 acl
= acl_from_text (SSDATA (acl_string
));
3098 report_file_error ("Converting ACL", absname
);
3102 encoded_absname
= ENCODE_FILE (absname
);
3104 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3107 if (fail
&& acl_errno_valid (errno
))
3108 report_file_error ("Setting ACL", absname
);
3111 return fail
? Qnil
: Qt
;
3118 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3119 doc
: /* Return mode bits of file named FILENAME, as an integer.
3120 Return nil, if file does not exist or is not accessible. */)
3121 (Lisp_Object filename
)
3123 Lisp_Object absname
;
3125 Lisp_Object handler
;
3127 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3129 /* If the file name has special constructs in it,
3130 call the corresponding file handler. */
3131 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3132 if (!NILP (handler
))
3133 return call2 (handler
, Qfile_modes
, absname
);
3135 absname
= ENCODE_FILE (absname
);
3137 if (stat (SSDATA (absname
), &st
) < 0)
3140 return make_number (st
.st_mode
& 07777);
3143 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3144 "(let ((file (read-file-name \"File: \"))) \
3145 (list file (read-file-modes nil file)))",
3146 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3147 Only the 12 low bits of MODE are used.
3149 Interactively, mode bits are read by `read-file-modes', which accepts
3150 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3151 (Lisp_Object filename
, Lisp_Object mode
)
3153 Lisp_Object absname
, encoded_absname
;
3154 Lisp_Object handler
;
3156 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3157 CHECK_NUMBER (mode
);
3159 /* If the file name has special constructs in it,
3160 call the corresponding file handler. */
3161 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3162 if (!NILP (handler
))
3163 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3165 encoded_absname
= ENCODE_FILE (absname
);
3167 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3168 report_file_error ("Doing chmod", absname
);
3173 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3174 doc
: /* Set the file permission bits for newly created files.
3175 The argument MODE should be an integer; only the low 9 bits are used.
3176 This setting is inherited by subprocesses. */)
3179 mode_t oldrealmask
, oldumask
, newumask
;
3180 CHECK_NUMBER (mode
);
3181 oldrealmask
= realmask
;
3182 newumask
= ~ XINT (mode
) & 0777;
3185 realmask
= newumask
;
3186 oldumask
= umask (newumask
);
3189 eassert (oldumask
== oldrealmask
);
3193 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3194 doc
: /* Return the default file protection for created files.
3195 The value is an integer. */)
3199 XSETINT (value
, (~ realmask
) & 0777);
3204 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3205 doc
: /* Set times of file FILENAME to TIMESTAMP.
3206 Set both access and modification times.
3207 Return t on success, else nil.
3208 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3210 (Lisp_Object filename
, Lisp_Object timestamp
)
3212 Lisp_Object absname
, encoded_absname
;
3213 Lisp_Object handler
;
3214 struct timespec t
= lisp_time_argument (timestamp
);
3216 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3218 /* If the file name has special constructs in it,
3219 call the corresponding file handler. */
3220 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3221 if (!NILP (handler
))
3222 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3224 encoded_absname
= ENCODE_FILE (absname
);
3227 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
) != 0)
3230 /* Setting times on a directory always fails. */
3231 if (file_directory_p (SSDATA (encoded_absname
)))
3234 report_file_error ("Setting file times", absname
);
3242 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3243 doc
: /* Tell Unix to finish all pending disk updates. */)
3250 #endif /* HAVE_SYNC */
3252 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3253 doc
: /* Return t if file FILE1 is newer than file FILE2.
3254 If FILE1 does not exist, the answer is nil;
3255 otherwise, if FILE2 does not exist, the answer is t. */)
3256 (Lisp_Object file1
, Lisp_Object file2
)
3258 Lisp_Object absname1
, absname2
;
3259 struct stat st1
, st2
;
3260 Lisp_Object handler
;
3261 struct gcpro gcpro1
, gcpro2
;
3263 CHECK_STRING (file1
);
3264 CHECK_STRING (file2
);
3267 GCPRO2 (absname1
, file2
);
3268 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3269 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3272 /* If the file name has special constructs in it,
3273 call the corresponding file handler. */
3274 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3276 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3277 if (!NILP (handler
))
3278 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3280 GCPRO2 (absname1
, absname2
);
3281 absname1
= ENCODE_FILE (absname1
);
3282 absname2
= ENCODE_FILE (absname2
);
3285 if (stat (SSDATA (absname1
), &st1
) < 0)
3288 if (stat (SSDATA (absname2
), &st2
) < 0)
3291 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3295 #ifndef READ_BUF_SIZE
3296 #define READ_BUF_SIZE (64 << 10)
3298 /* Some buffer offsets are stored in 'int' variables. */
3299 verify (READ_BUF_SIZE
<= INT_MAX
);
3301 /* This function is called after Lisp functions to decide a coding
3302 system are called, or when they cause an error. Before they are
3303 called, the current buffer is set unibyte and it contains only a
3304 newly inserted text (thus the buffer was empty before the
3307 The functions may set markers, overlays, text properties, or even
3308 alter the buffer contents, change the current buffer.
3310 Here, we reset all those changes by:
3311 o set back the current buffer.
3312 o move all markers and overlays to BEG.
3313 o remove all text properties.
3314 o set back the buffer multibyteness. */
3317 decide_coding_unwind (Lisp_Object unwind_data
)
3319 Lisp_Object multibyte
, undo_list
, buffer
;
3321 multibyte
= XCAR (unwind_data
);
3322 unwind_data
= XCDR (unwind_data
);
3323 undo_list
= XCAR (unwind_data
);
3324 buffer
= XCDR (unwind_data
);
3326 set_buffer_internal (XBUFFER (buffer
));
3327 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3328 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3329 set_buffer_intervals (current_buffer
, NULL
);
3330 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3332 /* Now we are safe to change the buffer's multibyteness directly. */
3333 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3334 bset_undo_list (current_buffer
, undo_list
);
3337 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3338 object where slot 0 is the file descriptor, slot 1 specifies
3339 an offset to put the read bytes, and slot 2 is the maximum
3340 amount of bytes to read. Value is the number of bytes read. */
3343 read_non_regular (Lisp_Object state
)
3349 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3350 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3351 + XSAVE_INTEGER (state
, 1)),
3352 XSAVE_INTEGER (state
, 2));
3354 /* Fast recycle this object for the likely next call. */
3356 return make_number (nbytes
);
3360 /* Condition-case handler used when reading from non-regular files
3361 in insert-file-contents. */
3364 read_non_regular_quit (Lisp_Object ignore
)
3369 /* Return the file offset that VAL represents, checking for type
3370 errors and overflow. */
3372 file_offset (Lisp_Object val
)
3374 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3379 double v
= XFLOAT_DATA (val
);
3381 && (sizeof (off_t
) < sizeof v
3382 ? v
<= TYPE_MAXIMUM (off_t
)
3383 : v
< TYPE_MAXIMUM (off_t
)))
3387 wrong_type_argument (intern ("file-offset"), val
);
3390 /* Return a special time value indicating the error number ERRNUM. */
3391 static struct timespec
3392 time_error_value (int errnum
)
3394 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3395 ? NONEXISTENT_MODTIME_NSECS
3396 : UNKNOWN_MODTIME_NSECS
);
3397 return make_timespec (0, ns
);
3400 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3402 doc
: /* Insert contents of file FILENAME after point.
3403 Returns list of absolute file name and number of characters inserted.
3404 If second argument VISIT is non-nil, the buffer's visited filename and
3405 last save file modtime are set, and it is marked unmodified. If
3406 visiting and the file does not exist, visiting is completed before the
3409 The optional third and fourth arguments BEG and END specify what portion
3410 of the file to insert. These arguments count bytes in the file, not
3411 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3413 If optional fifth argument REPLACE is non-nil, replace the current
3414 buffer contents (in the accessible portion) with the file contents.
3415 This is better than simply deleting and inserting the whole thing
3416 because (1) it preserves some marker positions and (2) it puts less data
3417 in the undo list. When REPLACE is non-nil, the second return value is
3418 the number of characters that replace previous buffer contents.
3420 This function does code conversion according to the value of
3421 `coding-system-for-read' or `file-coding-system-alist', and sets the
3422 variable `last-coding-system-used' to the coding system actually used.
3424 In addition, this function decodes the inserted text from known formats
3425 by calling `format-decode', which see. */)
3426 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3429 struct timespec mtime
;
3431 ptrdiff_t inserted
= 0;
3433 off_t beg_offset
, end_offset
;
3435 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3436 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3438 ptrdiff_t total
= 0;
3439 bool not_regular
= 0;
3441 char read_buf
[READ_BUF_SIZE
];
3442 struct coding_system coding
;
3443 bool replace_handled
= 0;
3444 bool set_coding_system
= 0;
3445 Lisp_Object coding_system
;
3447 /* If the undo log only contains the insertion, there's no point
3448 keeping it. It's typically when we first fill a file-buffer. */
3449 bool empty_undo_list_p
3450 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3452 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3453 bool we_locked_file
= 0;
3457 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3458 error ("Cannot do file visiting in an indirect buffer");
3460 if (!NILP (BVAR (current_buffer
, read_only
)))
3461 Fbarf_if_buffer_read_only ();
3465 orig_filename
= Qnil
;
3468 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3470 CHECK_STRING (filename
);
3471 filename
= Fexpand_file_name (filename
, Qnil
);
3473 /* The value Qnil means that the coding system is not yet
3475 coding_system
= Qnil
;
3477 /* If the file name has special constructs in it,
3478 call the corresponding file handler. */
3479 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3480 if (!NILP (handler
))
3482 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3483 visit
, beg
, end
, replace
);
3484 if (CONSP (val
) && CONSP (XCDR (val
))
3485 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3486 inserted
= XINT (XCAR (XCDR (val
)));
3490 orig_filename
= filename
;
3491 filename
= ENCODE_FILE (filename
);
3493 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3498 report_file_error ("Opening input file", orig_filename
);
3499 mtime
= time_error_value (save_errno
);
3501 if (!NILP (Vcoding_system_for_read
))
3502 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3506 record_unwind_protect_ptr (close_file_ptr_unwind
, &fd
);
3508 /* Replacement should preserve point as it preserves markers. */
3509 if (!NILP (replace
))
3510 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3512 if (fstat (fd
, &st
) != 0)
3513 report_file_error ("Input file status", orig_filename
);
3514 mtime
= get_stat_mtime (&st
);
3516 /* This code will need to be changed in order to work on named
3517 pipes, and it's probably just not worth it. So we should at
3518 least signal an error. */
3519 if (!S_ISREG (st
.st_mode
))
3526 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3527 xsignal2 (Qfile_error
,
3528 build_string ("not a regular file"), orig_filename
);
3533 if (!NILP (beg
) || !NILP (end
))
3534 error ("Attempt to visit less than an entire file");
3535 if (BEG
< Z
&& NILP (replace
))
3536 error ("Cannot do file visiting in a non-empty buffer");
3540 beg_offset
= file_offset (beg
);
3545 end_offset
= file_offset (end
);
3549 end_offset
= TYPE_MAXIMUM (off_t
);
3552 end_offset
= st
.st_size
;
3554 /* A negative size can happen on a platform that allows file
3555 sizes greater than the maximum off_t value. */
3559 /* The file size returned from stat may be zero, but data
3560 may be readable nonetheless, for example when this is a
3561 file in the /proc filesystem. */
3562 if (end_offset
== 0)
3563 end_offset
= READ_BUF_SIZE
;
3567 /* Check now whether the buffer will become too large,
3568 in the likely case where the file's length is not changing.
3569 This saves a lot of needless work before a buffer overflow. */
3572 /* The likely offset where we will stop reading. We could read
3573 more (or less), if the file grows (or shrinks) as we read it. */
3574 off_t likely_end
= min (end_offset
, st
.st_size
);
3576 if (beg_offset
< likely_end
)
3579 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3580 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3581 off_t likely_growth
= likely_end
- beg_offset
;
3582 if (buf_growth_max
< likely_growth
)
3587 /* Prevent redisplay optimizations. */
3588 current_buffer
->clip_changed
= 1;
3590 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3592 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3593 setup_coding_system (coding_system
, &coding
);
3594 /* Ensure we set Vlast_coding_system_used. */
3595 set_coding_system
= 1;
3599 /* Decide the coding system to use for reading the file now
3600 because we can't use an optimized method for handling
3601 `coding:' tag if the current buffer is not empty. */
3602 if (!NILP (Vcoding_system_for_read
))
3603 coding_system
= Vcoding_system_for_read
;
3606 /* Don't try looking inside a file for a coding system
3607 specification if it is not seekable. */
3608 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3610 /* Find a coding system specified in the heading two
3611 lines or in the tailing several lines of the file.
3612 We assume that the 1K-byte and 3K-byte for heading
3613 and tailing respectively are sufficient for this
3617 if (st
.st_size
<= (1024 * 4))
3618 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3621 nread
= emacs_read (fd
, read_buf
, 1024);
3625 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3626 report_file_error ("Setting file position",
3628 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3629 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3634 report_file_error ("Read error", orig_filename
);
3637 Lisp_Object workbuf
;
3641 record_unwind_current_buffer ();
3643 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3644 buf
= XBUFFER (workbuf
);
3646 delete_all_overlays (buf
);
3647 bset_directory (buf
, BVAR (current_buffer
, directory
));
3648 bset_read_only (buf
, Qnil
);
3649 bset_filename (buf
, Qnil
);
3650 bset_undo_list (buf
, Qt
);
3651 eassert (buf
->overlays_before
== NULL
);
3652 eassert (buf
->overlays_after
== NULL
);
3654 set_buffer_internal (buf
);
3656 bset_enable_multibyte_characters (buf
, Qnil
);
3658 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3659 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3660 coding_system
= call2 (Vset_auto_coding_function
,
3661 filename
, make_number (nread
));
3665 /* Rewind the file for the actual read done later. */
3666 if (lseek (fd
, 0, SEEK_SET
) < 0)
3667 report_file_error ("Setting file position", orig_filename
);
3671 if (NILP (coding_system
))
3673 /* If we have not yet decided a coding system, check
3674 file-coding-system-alist. */
3675 Lisp_Object args
[6];
3677 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3678 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3679 coding_system
= Ffind_operation_coding_system (6, args
);
3680 if (CONSP (coding_system
))
3681 coding_system
= XCAR (coding_system
);
3685 if (NILP (coding_system
))
3686 coding_system
= Qundecided
;
3688 CHECK_CODING_SYSTEM (coding_system
);
3690 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3691 /* We must suppress all character code conversion except for
3692 end-of-line conversion. */
3693 coding_system
= raw_text_coding_system (coding_system
);
3695 setup_coding_system (coding_system
, &coding
);
3696 /* Ensure we set Vlast_coding_system_used. */
3697 set_coding_system
= 1;
3700 /* If requested, replace the accessible part of the buffer
3701 with the file contents. Avoid replacing text at the
3702 beginning or end of the buffer that matches the file contents;
3703 that preserves markers pointing to the unchanged parts.
3705 Here we implement this feature in an optimized way
3706 for the case where code conversion is NOT needed.
3707 The following if-statement handles the case of conversion
3708 in a less optimal way.
3710 If the code conversion is "automatic" then we try using this
3711 method and hope for the best.
3712 But if we discover the need for conversion, we give up on this method
3713 and let the following if-statement handle the replace job. */
3716 && (NILP (coding_system
)
3717 || ! CODING_REQUIRE_DECODING (&coding
)))
3719 /* same_at_start and same_at_end count bytes,
3720 because file access counts bytes
3721 and BEG and END count bytes. */
3722 ptrdiff_t same_at_start
= BEGV_BYTE
;
3723 ptrdiff_t same_at_end
= ZV_BYTE
;
3725 /* There is still a possibility we will find the need to do code
3726 conversion. If that happens, set this variable to
3727 give up on handling REPLACE in the optimized way. */
3728 bool giveup_match_end
= 0;
3730 if (beg_offset
!= 0)
3732 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3733 report_file_error ("Setting file position", orig_filename
);
3738 /* Count how many chars at the start of the file
3739 match the text at the beginning of the buffer. */
3744 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3746 report_file_error ("Read error", orig_filename
);
3747 else if (nread
== 0)
3750 if (CODING_REQUIRE_DETECTION (&coding
))
3752 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3755 setup_coding_system (coding_system
, &coding
);
3758 if (CODING_REQUIRE_DECODING (&coding
))
3759 /* We found that the file should be decoded somehow.
3760 Let's give up here. */
3762 giveup_match_end
= 1;
3767 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3768 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3769 same_at_start
++, bufpos
++;
3770 /* If we found a discrepancy, stop the scan.
3771 Otherwise loop around and scan the next bufferful. */
3772 if (bufpos
!= nread
)
3776 /* If the file matches the buffer completely,
3777 there's no need to replace anything. */
3778 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3783 /* Truncate the buffer to the size of the file. */
3784 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3789 /* Count how many chars at the end of the file
3790 match the text at the end of the buffer. But, if we have
3791 already found that decoding is necessary, don't waste time. */
3792 while (!giveup_match_end
)
3794 int total_read
, nread
, bufpos
, trial
;
3797 /* At what file position are we now scanning? */
3798 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3799 /* If the entire file matches the buffer tail, stop the scan. */
3802 /* How much can we scan in the next step? */
3803 trial
= min (curpos
, sizeof read_buf
);
3804 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3805 report_file_error ("Setting file position", orig_filename
);
3807 total_read
= nread
= 0;
3808 while (total_read
< trial
)
3810 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3812 report_file_error ("Read error", orig_filename
);
3813 else if (nread
== 0)
3815 total_read
+= nread
;
3818 /* Scan this bufferful from the end, comparing with
3819 the Emacs buffer. */
3820 bufpos
= total_read
;
3822 /* Compare with same_at_start to avoid counting some buffer text
3823 as matching both at the file's beginning and at the end. */
3824 while (bufpos
> 0 && same_at_end
> same_at_start
3825 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3826 same_at_end
--, bufpos
--;
3828 /* If we found a discrepancy, stop the scan.
3829 Otherwise loop around and scan the preceding bufferful. */
3832 /* If this discrepancy is because of code conversion,
3833 we cannot use this method; giveup and try the other. */
3834 if (same_at_end
> same_at_start
3835 && FETCH_BYTE (same_at_end
- 1) >= 0200
3836 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3837 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3838 giveup_match_end
= 1;
3847 if (! giveup_match_end
)
3851 /* We win! We can handle REPLACE the optimized way. */
3853 /* Extend the start of non-matching text area to multibyte
3854 character boundary. */
3855 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3856 while (same_at_start
> BEGV_BYTE
3857 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3860 /* Extend the end of non-matching text area to multibyte
3861 character boundary. */
3862 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3863 while (same_at_end
< ZV_BYTE
3864 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3867 /* Don't try to reuse the same piece of text twice. */
3868 overlap
= (same_at_start
- BEGV_BYTE
3870 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3872 same_at_end
+= overlap
;
3874 /* Arrange to read only the nonmatching middle part of the file. */
3875 beg_offset
+= same_at_start
- BEGV_BYTE
;
3876 end_offset
-= ZV_BYTE
- same_at_end
;
3878 invalidate_buffer_caches (current_buffer
,
3879 BYTE_TO_CHAR (same_at_start
),
3880 BYTE_TO_CHAR (same_at_end
));
3881 del_range_byte (same_at_start
, same_at_end
, 0);
3882 /* Insert from the file at the proper position. */
3883 temp
= BYTE_TO_CHAR (same_at_start
);
3884 SET_PT_BOTH (temp
, same_at_start
);
3886 /* If display currently starts at beginning of line,
3887 keep it that way. */
3888 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3889 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3891 replace_handled
= 1;
3895 /* If requested, replace the accessible part of the buffer
3896 with the file contents. Avoid replacing text at the
3897 beginning or end of the buffer that matches the file contents;
3898 that preserves markers pointing to the unchanged parts.
3900 Here we implement this feature for the case where code conversion
3901 is needed, in a simple way that needs a lot of memory.
3902 The preceding if-statement handles the case of no conversion
3903 in a more optimized way. */
3904 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3906 ptrdiff_t same_at_start
= BEGV_BYTE
;
3907 ptrdiff_t same_at_end
= ZV_BYTE
;
3908 ptrdiff_t same_at_start_charpos
;
3909 ptrdiff_t inserted_chars
;
3912 unsigned char *decoded
;
3916 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3917 Lisp_Object conversion_buffer
;
3918 struct gcpro gcpro1
;
3921 conversion_buffer
= code_conversion_save (1, multibyte
);
3923 /* First read the whole file, performing code conversion into
3924 CONVERSION_BUFFER. */
3926 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3927 report_file_error ("Setting file position", orig_filename
);
3929 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3930 unprocessed
= 0; /* Bytes not processed in previous loop. */
3932 GCPRO1 (conversion_buffer
);
3935 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3936 quitting while reading a huge file. */
3938 /* Allow quitting out of the actual I/O. */
3941 this = emacs_read (fd
, read_buf
+ unprocessed
,
3942 READ_BUF_SIZE
- unprocessed
);
3948 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3949 BUF_Z (XBUFFER (conversion_buffer
)));
3950 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3951 unprocessed
+ this, conversion_buffer
);
3952 unprocessed
= coding
.carryover_bytes
;
3953 if (coding
.carryover_bytes
> 0)
3954 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3958 report_file_error ("Read error", orig_filename
);
3962 if (unprocessed
> 0)
3964 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3965 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3966 unprocessed
, conversion_buffer
);
3967 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3970 coding_system
= CODING_ID_NAME (coding
.id
);
3971 set_coding_system
= 1;
3972 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3973 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3974 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3976 /* Compare the beginning of the converted string with the buffer
3980 while (bufpos
< inserted
&& same_at_start
< same_at_end
3981 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3982 same_at_start
++, bufpos
++;
3984 /* If the file matches the head of buffer completely,
3985 there's no need to replace anything. */
3987 if (bufpos
== inserted
)
3989 /* Truncate the buffer to the size of the file. */
3990 if (same_at_start
!= same_at_end
)
3992 invalidate_buffer_caches (current_buffer
,
3993 BYTE_TO_CHAR (same_at_start
),
3994 BYTE_TO_CHAR (same_at_end
));
3995 del_range_byte (same_at_start
, same_at_end
, 0);
4003 /* Extend the start of non-matching text area to the previous
4004 multibyte character boundary. */
4005 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4006 while (same_at_start
> BEGV_BYTE
4007 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4010 /* Scan this bufferful from the end, comparing with
4011 the Emacs buffer. */
4014 /* Compare with same_at_start to avoid counting some buffer text
4015 as matching both at the file's beginning and at the end. */
4016 while (bufpos
> 0 && same_at_end
> same_at_start
4017 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4018 same_at_end
--, bufpos
--;
4020 /* Extend the end of non-matching text area to the next
4021 multibyte character boundary. */
4022 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4023 while (same_at_end
< ZV_BYTE
4024 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4027 /* Don't try to reuse the same piece of text twice. */
4028 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4030 same_at_end
+= overlap
;
4032 /* If display currently starts at beginning of line,
4033 keep it that way. */
4034 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4035 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4037 /* Replace the chars that we need to replace,
4038 and update INSERTED to equal the number of bytes
4039 we are taking from the decoded string. */
4040 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4042 if (same_at_end
!= same_at_start
)
4044 invalidate_buffer_caches (current_buffer
,
4045 BYTE_TO_CHAR (same_at_start
),
4046 BYTE_TO_CHAR (same_at_end
));
4047 del_range_byte (same_at_start
, same_at_end
, 0);
4049 eassert (same_at_start
== GPT_BYTE
);
4050 same_at_start
= GPT_BYTE
;
4054 temp
= BYTE_TO_CHAR (same_at_start
);
4056 /* Insert from the file at the proper position. */
4057 SET_PT_BOTH (temp
, same_at_start
);
4058 same_at_start_charpos
4059 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4060 same_at_start
- BEGV_BYTE
4061 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4062 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4064 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4065 same_at_start
+ inserted
- BEGV_BYTE
4066 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4067 - same_at_start_charpos
);
4068 /* This binding is to avoid ask-user-about-supersession-threat
4069 being called in insert_from_buffer (via in
4070 prepare_to_modify_buffer). */
4071 specbind (intern ("buffer-file-name"), Qnil
);
4072 insert_from_buffer (XBUFFER (conversion_buffer
),
4073 same_at_start_charpos
, inserted_chars
, 0);
4074 /* Set `inserted' to the number of inserted characters. */
4075 inserted
= PT
- temp
;
4076 /* Set point before the inserted characters. */
4077 SET_PT_BOTH (temp
, same_at_start
);
4085 total
= end_offset
- beg_offset
;
4087 /* For a special file, all we can do is guess. */
4088 total
= READ_BUF_SIZE
;
4090 if (NILP (visit
) && total
> 0)
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 prepare_to_modify_buffer (PT
, PT
, NULL
);
4100 move_gap_both (PT
, PT_BYTE
);
4101 if (GAP_SIZE
< total
)
4102 make_gap (total
- GAP_SIZE
);
4104 if (beg_offset
!= 0 || !NILP (replace
))
4106 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4107 report_file_error ("Setting file position", orig_filename
);
4110 /* In the following loop, HOW_MUCH contains the total bytes read so
4111 far for a regular file, and not changed for a special file. But,
4112 before exiting the loop, it is set to a negative value if I/O
4116 /* Total bytes inserted. */
4119 /* Here, we don't do code conversion in the loop. It is done by
4120 decode_coding_gap after all data are read into the buffer. */
4122 ptrdiff_t gap_size
= GAP_SIZE
;
4124 while (how_much
< total
)
4126 /* try is reserved in some compilers (Microsoft C) */
4127 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4134 /* Maybe make more room. */
4135 if (gap_size
< trytry
)
4137 make_gap (trytry
- gap_size
);
4138 gap_size
= GAP_SIZE
- inserted
;
4141 /* Read from the file, capturing `quit'. When an
4142 error occurs, end the loop, and arrange for a quit
4143 to be signaled after decoding the text we read. */
4144 nbytes
= internal_condition_case_1
4146 make_save_int_int_int (fd
, inserted
, trytry
),
4147 Qerror
, read_non_regular_quit
);
4155 this = XINT (nbytes
);
4159 /* Allow quitting out of the actual I/O. We don't make text
4160 part of the buffer until all the reading is done, so a C-g
4161 here doesn't do any harm. */
4164 this = emacs_read (fd
,
4165 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4179 /* For a regular file, where TOTAL is the real size,
4180 count HOW_MUCH to compare with it.
4181 For a special file, where TOTAL is just a buffer size,
4182 so don't bother counting in HOW_MUCH.
4183 (INSERTED is where we count the number of characters inserted.) */
4190 /* Now we have either read all the file data into the gap,
4191 or stop reading on I/O error or quit. If nothing was
4192 read, undo marking the buffer modified. */
4197 unlock_file (BVAR (current_buffer
, file_truename
));
4198 Vdeactivate_mark
= old_Vdeactivate_mark
;
4201 Vdeactivate_mark
= Qt
;
4207 report_file_error ("Read error", orig_filename
);
4209 /* Make the text read part of the buffer. */
4210 GAP_SIZE
-= inserted
;
4212 GPT_BYTE
+= inserted
;
4214 ZV_BYTE
+= inserted
;
4219 /* Put an anchor to ensure multi-byte form ends at gap. */
4224 if (NILP (coding_system
))
4226 /* The coding system is not yet decided. Decide it by an
4227 optimized method for handling `coding:' tag.
4229 Note that we can get here only if the buffer was empty
4230 before the insertion. */
4232 if (!NILP (Vcoding_system_for_read
))
4233 coding_system
= Vcoding_system_for_read
;
4236 /* Since we are sure that the current buffer was empty
4237 before the insertion, we can toggle
4238 enable-multibyte-characters directly here without taking
4239 care of marker adjustment. By this way, we can run Lisp
4240 program safely before decoding the inserted text. */
4241 Lisp_Object unwind_data
;
4244 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4245 Fcons (BVAR (current_buffer
, undo_list
),
4246 Fcurrent_buffer ()));
4247 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4248 bset_undo_list (current_buffer
, Qt
);
4249 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4251 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4253 coding_system
= call2 (Vset_auto_coding_function
,
4254 filename
, make_number (inserted
));
4257 if (NILP (coding_system
))
4259 /* If the coding system is not yet decided, check
4260 file-coding-system-alist. */
4261 Lisp_Object args
[6];
4263 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4264 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4265 coding_system
= Ffind_operation_coding_system (6, args
);
4266 if (CONSP (coding_system
))
4267 coding_system
= XCAR (coding_system
);
4270 inserted
= Z_BYTE
- BEG_BYTE
;
4273 if (NILP (coding_system
))
4274 coding_system
= Qundecided
;
4276 CHECK_CODING_SYSTEM (coding_system
);
4278 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4279 /* We must suppress all character code conversion except for
4280 end-of-line conversion. */
4281 coding_system
= raw_text_coding_system (coding_system
);
4282 setup_coding_system (coding_system
, &coding
);
4283 /* Ensure we set Vlast_coding_system_used. */
4284 set_coding_system
= 1;
4289 /* When we visit a file by raw-text, we change the buffer to
4291 if (CODING_FOR_UNIBYTE (&coding
)
4292 /* Can't do this if part of the buffer might be preserved. */
4294 /* Visiting a file with these coding system makes the buffer
4296 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4299 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4300 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4301 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4303 move_gap_both (PT
, PT_BYTE
);
4304 GAP_SIZE
+= inserted
;
4305 ZV_BYTE
-= inserted
;
4309 decode_coding_gap (&coding
, inserted
, inserted
);
4310 inserted
= coding
.produced_char
;
4311 coding_system
= CODING_ID_NAME (coding
.id
);
4313 else if (inserted
> 0)
4314 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4317 /* Call after-change hooks for the inserted text, aside from the case
4318 of normal visiting (not with REPLACE), which is done in a new buffer
4319 "before" the buffer is changed. */
4320 if (inserted
> 0 && total
> 0
4321 && (NILP (visit
) || !NILP (replace
)))
4323 signal_after_change (PT
, 0, inserted
);
4324 update_compositions (PT
, PT
, CHECK_BORDER
);
4327 /* Now INSERTED is measured in characters. */
4333 if (empty_undo_list_p
)
4334 bset_undo_list (current_buffer
, Qnil
);
4338 current_buffer
->modtime
= mtime
;
4339 current_buffer
->modtime_size
= st
.st_size
;
4340 bset_filename (current_buffer
, orig_filename
);
4343 SAVE_MODIFF
= MODIFF
;
4344 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4345 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4348 if (!NILP (BVAR (current_buffer
, file_truename
)))
4349 unlock_file (BVAR (current_buffer
, file_truename
));
4350 unlock_file (filename
);
4353 xsignal2 (Qfile_error
,
4354 build_string ("not a regular file"), orig_filename
);
4357 if (set_coding_system
)
4358 Vlast_coding_system_used
= coding_system
;
4360 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4362 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4364 if (! NILP (insval
))
4366 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4367 wrong_type_argument (intern ("inserted-chars"), insval
);
4368 inserted
= XFASTINT (insval
);
4372 /* Decode file format. */
4375 /* Don't run point motion or modification hooks when decoding. */
4376 ptrdiff_t old_inserted
= inserted
;
4378 specbind (Qinhibit_point_motion_hooks
, Qt
);
4379 specbind (Qinhibit_modification_hooks
, Qt
);
4381 /* Save old undo list and don't record undo for decoding. */
4382 old_undo
= BVAR (current_buffer
, undo_list
);
4383 bset_undo_list (current_buffer
, Qt
);
4387 insval
= call3 (Qformat_decode
,
4388 Qnil
, make_number (inserted
), visit
);
4389 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4390 wrong_type_argument (intern ("inserted-chars"), insval
);
4391 inserted
= XFASTINT (insval
);
4395 /* If REPLACE is non-nil and we succeeded in not replacing the
4396 beginning or end of the buffer text with the file's contents,
4397 call format-decode with `point' positioned at the beginning
4398 of the buffer and `inserted' equaling the number of
4399 characters in the buffer. Otherwise, format-decode might
4400 fail to correctly analyze the beginning or end of the buffer.
4401 Hence we temporarily save `point' and `inserted' here and
4402 restore `point' iff format-decode did not insert or delete
4403 any text. Otherwise we leave `point' at point-min. */
4404 ptrdiff_t opoint
= PT
;
4405 ptrdiff_t opoint_byte
= PT_BYTE
;
4406 ptrdiff_t oinserted
= ZV
- BEGV
;
4407 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4409 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4410 insval
= call3 (Qformat_decode
,
4411 Qnil
, make_number (oinserted
), visit
);
4412 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4413 wrong_type_argument (intern ("inserted-chars"), insval
);
4414 if (ochars_modiff
== CHARS_MODIFF
)
4415 /* format_decode didn't modify buffer's characters => move
4416 point back to position before inserted text and leave
4417 value of inserted alone. */
4418 SET_PT_BOTH (opoint
, opoint_byte
);
4420 /* format_decode modified buffer's characters => consider
4421 entire buffer changed and leave point at point-min. */
4422 inserted
= XFASTINT (insval
);
4425 /* For consistency with format-decode call these now iff inserted > 0
4426 (martin 2007-06-28). */
4427 p
= Vafter_insert_file_functions
;
4432 insval
= call1 (XCAR (p
), make_number (inserted
));
4435 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4436 wrong_type_argument (intern ("inserted-chars"), insval
);
4437 inserted
= XFASTINT (insval
);
4442 /* For the rationale of this see the comment on
4443 format-decode above. */
4444 ptrdiff_t opoint
= PT
;
4445 ptrdiff_t opoint_byte
= PT_BYTE
;
4446 ptrdiff_t oinserted
= ZV
- BEGV
;
4447 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4449 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4450 insval
= call1 (XCAR (p
), make_number (oinserted
));
4453 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4454 wrong_type_argument (intern ("inserted-chars"), insval
);
4455 if (ochars_modiff
== CHARS_MODIFF
)
4456 /* after_insert_file_functions didn't modify
4457 buffer's characters => move point back to
4458 position before inserted text and leave value of
4460 SET_PT_BOTH (opoint
, opoint_byte
);
4462 /* after_insert_file_functions did modify buffer's
4463 characters => consider entire buffer changed and
4464 leave point at point-min. */
4465 inserted
= XFASTINT (insval
);
4473 if (!empty_undo_list_p
)
4475 bset_undo_list (current_buffer
, old_undo
);
4476 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4478 /* Adjust the last undo record for the size change during
4479 the format conversion. */
4480 Lisp_Object tem
= XCAR (old_undo
);
4481 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4482 && INTEGERP (XCDR (tem
))
4483 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4484 XSETCDR (tem
, make_number (PT
+ inserted
));
4488 /* If undo_list was Qt before, keep it that way.
4489 Otherwise start with an empty undo_list. */
4490 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4496 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4498 /* If visiting nonexistent file, return nil. */
4499 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4502 /* We made a lot of deletions and insertions above, so invalidate
4503 the newline cache for the entire region of the inserted
4505 if (current_buffer
->base_buffer
&& current_buffer
->base_buffer
->newline_cache
)
4506 invalidate_region_cache (current_buffer
->base_buffer
,
4507 current_buffer
->base_buffer
->newline_cache
,
4508 PT
- BEG
, Z
- PT
- inserted
);
4509 else if (current_buffer
->newline_cache
)
4510 invalidate_region_cache (current_buffer
,
4511 current_buffer
->newline_cache
,
4512 PT
- BEG
, Z
- PT
- inserted
);
4515 Fsignal (Qquit
, Qnil
);
4517 /* Retval needs to be dealt with in all cases consistently. */
4519 val
= list2 (orig_filename
, make_number (inserted
));
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 Lisp_Object handler
;
4710 Lisp_Object visit_file
;
4711 Lisp_Object annotations
;
4712 Lisp_Object encoded_filename
;
4713 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4714 bool quietly
= !NILP (visit
);
4715 bool file_locked
= 0;
4716 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4717 struct buffer
*given_buffer
;
4718 struct coding_system coding
;
4720 if (current_buffer
->base_buffer
&& visiting
)
4721 error ("Cannot do file visiting in an indirect buffer");
4723 if (!NILP (start
) && !STRINGP (start
))
4724 validate_region (&start
, &end
);
4727 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4729 filename
= Fexpand_file_name (filename
, Qnil
);
4731 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4732 barf_or_query_if_file_exists (filename
, false, "overwrite", true, true);
4734 if (STRINGP (visit
))
4735 visit_file
= Fexpand_file_name (visit
, Qnil
);
4737 visit_file
= filename
;
4739 if (NILP (lockname
))
4740 lockname
= visit_file
;
4744 /* If the file name has special constructs in it,
4745 call the corresponding file handler. */
4746 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4747 /* If FILENAME has no handler, see if VISIT has one. */
4748 if (NILP (handler
) && STRINGP (visit
))
4749 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4751 if (!NILP (handler
))
4754 val
= call6 (handler
, Qwrite_region
, start
, end
,
4755 filename
, append
, visit
);
4759 SAVE_MODIFF
= MODIFF
;
4760 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4761 bset_filename (current_buffer
, visit_file
);
4768 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4770 /* Special kludge to simplify auto-saving. */
4773 /* Do it later, so write-region-annotate-function can work differently
4774 if we save "the buffer" vs "a region".
4775 This is useful in tar-mode. --Stef
4776 XSETFASTINT (start, BEG);
4777 XSETFASTINT (end, Z); */
4781 record_unwind_protect (build_annotations_unwind
,
4782 Vwrite_region_annotation_buffers
);
4783 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4785 given_buffer
= current_buffer
;
4787 if (!STRINGP (start
))
4789 annotations
= build_annotations (start
, end
);
4791 if (current_buffer
!= given_buffer
)
4793 XSETFASTINT (start
, BEGV
);
4794 XSETFASTINT (end
, ZV
);
4800 XSETFASTINT (start
, BEGV
);
4801 XSETFASTINT (end
, ZV
);
4806 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4808 /* Decide the coding-system to encode the data with.
4809 We used to make this choice before calling build_annotations, but that
4810 leads to problems when a write-annotate-function takes care of
4811 unsavable chars (as was the case with X-Symbol). */
4812 Vlast_coding_system_used
=
4813 Fchoose_write_coding_system (start
, end
, filename
,
4814 append
, visit
, lockname
);
4816 setup_coding_system (Vlast_coding_system_used
, &coding
);
4818 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4819 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4821 if (open_and_close_file
&& !auto_saving
)
4823 lock_file (lockname
);
4827 encoded_filename
= ENCODE_FILE (filename
);
4828 fn
= SSDATA (encoded_filename
);
4829 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4830 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4831 if (NUMBERP (append
))
4832 offset
= file_offset (append
);
4833 else if (!NILP (append
))
4834 open_flags
|= O_APPEND
;
4836 mode
= S_IREAD
| S_IWRITE
;
4838 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4841 if (open_and_close_file
)
4843 desc
= emacs_open (fn
, open_flags
, mode
);
4846 int open_errno
= errno
;
4848 unlock_file (lockname
);
4850 report_file_errno ("Opening output file", filename
, open_errno
);
4854 record_unwind_protect_int_1 (close_file_unwind
, desc
, false);
4857 if (NUMBERP (append
))
4859 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4862 int lseek_errno
= errno
;
4864 unlock_file (lockname
);
4866 report_file_errno ("Lseek error", filename
, lseek_errno
);
4874 if (STRINGP (start
))
4875 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4876 else if (XINT (start
) != XINT (end
))
4877 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4878 &annotations
, &coding
);
4881 /* If file was empty, still need to write the annotations. */
4882 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4883 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4887 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4888 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4890 /* We have to flush out a data. */
4891 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4892 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4898 /* fsync is not crucial for temporary files. Nor for auto-save
4899 files, since they might lose some work anyway. */
4900 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4902 /* Transfer data and metadata to disk, retrying if interrupted.
4903 fsync can report a write failure here, e.g., due to disk full
4904 under NFS. But ignore EINVAL, which means fsync is not
4905 supported on this file. */
4906 while (fsync (desc
) != 0)
4909 if (errno
!= EINVAL
)
4910 ok
= 0, save_errno
= errno
;
4915 modtime
= invalid_timespec ();
4918 if (fstat (desc
, &st
) == 0)
4919 modtime
= get_stat_mtime (&st
);
4921 ok
= 0, save_errno
= errno
;
4924 if (open_and_close_file
)
4926 /* NFS can report a write failure now. */
4927 if (emacs_close (desc
) < 0)
4928 ok
= 0, save_errno
= errno
;
4933 /* Some file systems have a bug where st_mtime is not updated
4934 properly after a write. For example, CIFS might not see the
4935 st_mtime change until after the file is opened again.
4937 Attempt to detect this file system bug, and update MODTIME to the
4938 newer st_mtime if the bug appears to be present. This introduces
4939 a race condition, so to avoid most instances of the race condition
4940 on non-buggy file systems, skip this check if the most recently
4941 encountered non-buggy file system was the current file system.
4943 A race condition can occur if some other process modifies the
4944 file between the fstat above and the fstat below, but the race is
4945 unlikely and a similar race between the last write and the fstat
4946 above cannot possibly be closed anyway. */
4948 if (timespec_valid_p (modtime
)
4949 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4951 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4955 if (fstat (desc1
, &st1
) == 0
4956 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4958 /* Use the heuristic if it appears to be valid. With neither
4959 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4960 file, the time stamp won't change. Also, some non-POSIX
4961 systems don't update an empty file's time stamp when
4962 truncating it. Finally, file systems with 100 ns or worse
4963 resolution sometimes seem to have bugs: on a system with ns
4964 resolution, checking ns % 100 incorrectly avoids the heuristic
4965 1% of the time, but the problem should be temporary as we will
4966 try again on the next time stamp. */
4968 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4970 && modtime
.tv_nsec
% 100 != 0);
4972 struct timespec modtime1
= get_stat_mtime (&st1
);
4974 && timespec_cmp (modtime
, modtime1
) == 0
4975 && st
.st_size
== st1
.st_size
)
4977 timestamp_file_system
= st
.st_dev
;
4978 valid_timestamp_file_system
= 1;
4982 st
.st_size
= st1
.st_size
;
4986 emacs_close (desc1
);
4990 /* Call write-region-post-annotation-function. */
4991 while (CONSP (Vwrite_region_annotation_buffers
))
4993 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4994 if (!NILP (Fbuffer_live_p (buf
)))
4997 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4998 call0 (Vwrite_region_post_annotation_function
);
5000 Vwrite_region_annotation_buffers
5001 = XCDR (Vwrite_region_annotation_buffers
);
5007 unlock_file (lockname
);
5009 /* Do this before reporting IO error
5010 to avoid a "file has changed on disk" warning on
5011 next attempt to save. */
5012 if (timespec_valid_p (modtime
))
5014 current_buffer
->modtime
= modtime
;
5015 current_buffer
->modtime_size
= st
.st_size
;
5019 report_file_errno ("Write error", filename
, save_errno
);
5023 SAVE_MODIFF
= MODIFF
;
5024 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5025 bset_filename (current_buffer
, visit_file
);
5026 update_mode_lines
= 14;
5031 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5032 BVAR (current_buffer
, auto_save_file_name
))))
5033 SAVE_MODIFF
= MODIFF
;
5039 message_with_string ((NUMBERP (append
)
5049 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5050 doc
: /* Return t if (car A) is numerically less than (car B). */)
5051 (Lisp_Object a
, Lisp_Object b
)
5053 Lisp_Object args
[2];
5056 return Flss (2, args
);
5059 /* Build the complete list of annotations appropriate for writing out
5060 the text between START and END, by calling all the functions in
5061 write-region-annotate-functions and merging the lists they return.
5062 If one of these functions switches to a different buffer, we assume
5063 that buffer contains altered text. Therefore, the caller must
5064 make sure to restore the current buffer in all cases,
5065 as save-excursion would do. */
5068 build_annotations (Lisp_Object start
, Lisp_Object end
)
5070 Lisp_Object annotations
;
5072 struct gcpro gcpro1
, gcpro2
;
5073 Lisp_Object original_buffer
;
5075 bool used_global
= 0;
5077 XSETBUFFER (original_buffer
, current_buffer
);
5080 p
= Vwrite_region_annotate_functions
;
5081 GCPRO2 (annotations
, p
);
5084 struct buffer
*given_buffer
= current_buffer
;
5085 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5086 { /* Use the global value of the hook. */
5089 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5091 p
= Fappend (2, arg
);
5094 Vwrite_region_annotations_so_far
= annotations
;
5095 res
= call2 (XCAR (p
), start
, end
);
5096 /* If the function makes a different buffer current,
5097 assume that means this buffer contains altered text to be output.
5098 Reset START and END from the buffer bounds
5099 and discard all previous annotations because they should have
5100 been dealt with by this function. */
5101 if (current_buffer
!= given_buffer
)
5103 Vwrite_region_annotation_buffers
5104 = Fcons (Fcurrent_buffer (),
5105 Vwrite_region_annotation_buffers
);
5106 XSETFASTINT (start
, BEGV
);
5107 XSETFASTINT (end
, ZV
);
5110 Flength (res
); /* Check basic validity of return value */
5111 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5115 /* Now do the same for annotation functions implied by the file-format */
5116 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5117 p
= BVAR (current_buffer
, auto_save_file_format
);
5119 p
= BVAR (current_buffer
, file_format
);
5120 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5122 struct buffer
*given_buffer
= current_buffer
;
5124 Vwrite_region_annotations_so_far
= annotations
;
5126 /* Value is either a list of annotations or nil if the function
5127 has written annotations to a temporary buffer, which is now
5129 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5130 original_buffer
, make_number (i
));
5131 if (current_buffer
!= given_buffer
)
5133 XSETFASTINT (start
, BEGV
);
5134 XSETFASTINT (end
, ZV
);
5139 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5147 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5148 If STRING is nil, POS is the character position in the current buffer.
5149 Intersperse with them the annotations from *ANNOT
5150 which fall within the range of POS to POS + NCHARS,
5151 each at its appropriate position.
5153 We modify *ANNOT by discarding elements as we use them up.
5155 Return true if successful. */
5158 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5159 ptrdiff_t nchars
, Lisp_Object
*annot
,
5160 struct coding_system
*coding
)
5164 ptrdiff_t lastpos
= pos
+ nchars
;
5166 while (NILP (*annot
) || CONSP (*annot
))
5168 tem
= Fcar_safe (Fcar (*annot
));
5171 nextpos
= XFASTINT (tem
);
5173 /* If there are no more annotations in this range,
5174 output the rest of the range all at once. */
5175 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5176 return e_write (desc
, string
, pos
, lastpos
, coding
);
5178 /* Output buffer text up to the next annotation's position. */
5181 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5185 /* Output the annotation. */
5186 tem
= Fcdr (Fcar (*annot
));
5189 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5192 *annot
= Fcdr (*annot
);
5197 /* Maximum number of characters that the next
5198 function encodes per one loop iteration. */
5200 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5202 /* Write text in the range START and END into descriptor DESC,
5203 encoding them with coding system CODING. If STRING is nil, START
5204 and END are character positions of the current buffer, else they
5205 are indexes to the string STRING. Return true if successful. */
5208 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5209 struct coding_system
*coding
)
5211 if (STRINGP (string
))
5214 end
= SCHARS (string
);
5217 /* We used to have a code for handling selective display here. But,
5218 now it is handled within encode_coding. */
5222 if (STRINGP (string
))
5224 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5225 if (CODING_REQUIRE_ENCODING (coding
))
5227 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5229 /* Avoid creating huge Lisp string in encode_coding_object. */
5230 if (nchars
== E_WRITE_MAX
)
5231 coding
->raw_destination
= 1;
5233 encode_coding_object
5234 (coding
, string
, start
, string_char_to_byte (string
, start
),
5235 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5240 coding
->dst_object
= string
;
5241 coding
->consumed_char
= SCHARS (string
);
5242 coding
->produced
= SBYTES (string
);
5247 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5248 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5250 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5251 if (CODING_REQUIRE_ENCODING (coding
))
5253 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5256 if (nchars
== E_WRITE_MAX
)
5257 coding
->raw_destination
= 1;
5259 encode_coding_object
5260 (coding
, Fcurrent_buffer (), start
, start_byte
,
5261 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5265 coding
->dst_object
= Qnil
;
5266 coding
->dst_pos_byte
= start_byte
;
5267 if (start
>= GPT
|| end
<= GPT
)
5269 coding
->consumed_char
= end
- start
;
5270 coding
->produced
= end_byte
- start_byte
;
5274 coding
->consumed_char
= GPT
- start
;
5275 coding
->produced
= GPT_BYTE
- start_byte
;
5280 if (coding
->produced
> 0)
5282 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5283 : (STRINGP (coding
->dst_object
)
5284 ? SSDATA (coding
->dst_object
)
5285 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5286 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5288 if (coding
->raw_destination
)
5290 /* We're responsible for freeing this, see
5291 encode_coding_object to check why. */
5292 xfree (coding
->destination
);
5293 coding
->raw_destination
= 0;
5295 if (coding
->produced
)
5298 start
+= coding
->consumed_char
;
5304 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5305 Sverify_visited_file_modtime
, 0, 1, 0,
5306 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5307 This means that the file has not been changed since it was visited or saved.
5308 If BUF is omitted or nil, it defaults to the current buffer.
5309 See Info node `(elisp)Modification Time' for more details. */)
5314 Lisp_Object handler
;
5315 Lisp_Object filename
;
5316 struct timespec mtime
;
5326 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5327 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5329 /* If the file name has special constructs in it,
5330 call the corresponding file handler. */
5331 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5332 Qverify_visited_file_modtime
);
5333 if (!NILP (handler
))
5334 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5336 filename
= ENCODE_FILE (BVAR (b
, filename
));
5338 mtime
= (stat (SSDATA (filename
), &st
) == 0
5339 ? get_stat_mtime (&st
)
5340 : time_error_value (errno
));
5341 if (timespec_cmp (mtime
, b
->modtime
) == 0
5342 && (b
->modtime_size
< 0
5343 || st
.st_size
== b
->modtime_size
))
5348 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5349 Svisited_file_modtime
, 0, 0, 0,
5350 doc
: /* Return the current buffer's recorded visited file modification time.
5351 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5352 `file-attributes' returns. If the current buffer has no recorded file
5353 modification time, this function returns 0. If the visited file
5354 doesn't exist, return -1.
5355 See Info node `(elisp)Modification Time' for more details. */)
5358 int ns
= current_buffer
->modtime
.tv_nsec
;
5360 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5361 return make_lisp_time (current_buffer
->modtime
);
5364 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5365 Sset_visited_file_modtime
, 0, 1, 0,
5366 doc
: /* Update buffer's recorded modification time from the visited file's time.
5367 Useful if the buffer was not read from the file normally
5368 or if the file itself has been changed for some known benign reason.
5369 An argument specifies the modification time value to use
5370 \(instead of that of the visited file), in the form of a list
5371 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5372 `visited-file-modtime'. */)
5373 (Lisp_Object time_flag
)
5375 if (!NILP (time_flag
))
5377 struct timespec mtime
;
5378 if (INTEGERP (time_flag
))
5380 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5381 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5384 mtime
= lisp_time_argument (time_flag
);
5386 current_buffer
->modtime
= mtime
;
5387 current_buffer
->modtime_size
= -1;
5391 register Lisp_Object filename
;
5393 Lisp_Object handler
;
5395 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5397 /* If the file name has special constructs in it,
5398 call the corresponding file handler. */
5399 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5400 if (!NILP (handler
))
5401 /* The handler can find the file name the same way we did. */
5402 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5404 filename
= ENCODE_FILE (filename
);
5406 if (stat (SSDATA (filename
), &st
) >= 0)
5408 current_buffer
->modtime
= get_stat_mtime (&st
);
5409 current_buffer
->modtime_size
= st
.st_size
;
5417 auto_save_error (Lisp_Object error_val
)
5419 Lisp_Object args
[3], msg
;
5421 struct gcpro gcpro1
;
5423 auto_save_error_occurred
= 1;
5425 ring_bell (XFRAME (selected_frame
));
5427 args
[0] = build_string ("Auto-saving %s: %s");
5428 args
[1] = BVAR (current_buffer
, name
);
5429 args
[2] = Ferror_message_string (error_val
);
5430 msg
= Fformat (3, args
);
5433 for (i
= 0; i
< 3; ++i
)
5438 message3_nolog (msg
);
5439 Fsleep_for (make_number (1), Qnil
);
5452 auto_save_mode_bits
= 0666;
5454 /* Get visited file's mode to become the auto save file's mode. */
5455 if (! NILP (BVAR (current_buffer
, filename
)))
5457 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5458 /* But make sure we can overwrite it later! */
5459 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5460 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5462 /* Remote files don't cooperate with stat. */
5463 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5467 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5468 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5472 struct auto_save_unwind
5479 do_auto_save_unwind (void *arg
)
5481 struct auto_save_unwind
*p
= arg
;
5482 FILE *stream
= p
->stream
;
5483 minibuffer_auto_raise
= p
->auto_raise
;
5494 do_auto_save_make_dir (Lisp_Object dir
)
5498 auto_saving_dir_umask
= 077;
5499 result
= call2 (Qmake_directory
, dir
, Qt
);
5500 auto_saving_dir_umask
= 0;
5505 do_auto_save_eh (Lisp_Object ignore
)
5507 auto_saving_dir_umask
= 0;
5511 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5512 doc
: /* Auto-save all buffers that need it.
5513 This is all buffers that have auto-saving enabled
5514 and are changed since last auto-saved.
5515 Auto-saving writes the buffer into a file
5516 so that your editing is not lost if the system crashes.
5517 This file is not the file you visited; that changes only when you save.
5518 Normally we run the normal hook `auto-save-hook' before saving.
5520 A non-nil NO-MESSAGE argument means do not print any message if successful.
5521 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5522 (Lisp_Object no_message
, Lisp_Object current_only
)
5524 struct buffer
*old
= current_buffer
, *b
;
5525 Lisp_Object tail
, buf
, hook
;
5526 bool auto_saved
= 0;
5527 int do_handled_files
;
5529 FILE *stream
= NULL
;
5531 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5532 bool old_message_p
= 0;
5533 struct auto_save_unwind auto_save_unwind
;
5534 struct gcpro gcpro1
, gcpro2
;
5536 if (max_specpdl_size
< specpdl_size
+ 40)
5537 max_specpdl_size
= specpdl_size
+ 40;
5542 if (NILP (no_message
))
5544 old_message_p
= push_message ();
5545 record_unwind_protect_void (pop_message_unwind
);
5548 /* Ordinarily don't quit within this function,
5549 but don't make it impossible to quit (in case we get hung in I/O). */
5553 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5554 point to non-strings reached from Vbuffer_alist. */
5556 hook
= intern ("auto-save-hook");
5557 safe_run_hooks (hook
);
5559 if (STRINGP (Vauto_save_list_file_name
))
5561 Lisp_Object listfile
;
5563 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5565 /* Don't try to create the directory when shutting down Emacs,
5566 because creating the directory might signal an error, and
5567 that would leave Emacs in a strange state. */
5568 if (!NILP (Vrun_hooks
))
5572 GCPRO2 (dir
, listfile
);
5573 dir
= Ffile_name_directory (listfile
);
5574 if (NILP (Ffile_directory_p (dir
)))
5575 internal_condition_case_1 (do_auto_save_make_dir
,
5581 stream
= emacs_fopen (SSDATA (listfile
), "w");
5584 auto_save_unwind
.stream
= stream
;
5585 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5586 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5587 minibuffer_auto_raise
= 0;
5589 auto_save_error_occurred
= 0;
5591 /* On first pass, save all files that don't have handlers.
5592 On second pass, save all files that do have handlers.
5594 If Emacs is crashing, the handlers may tweak what is causing
5595 Emacs to crash in the first place, and it would be a shame if
5596 Emacs failed to autosave perfectly ordinary files because it
5597 couldn't handle some ange-ftp'd file. */
5599 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5600 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5604 /* Record all the buffers that have auto save mode
5605 in the special file that lists them. For each of these buffers,
5606 Record visited name (if any) and auto save name. */
5607 if (STRINGP (BVAR (b
, auto_save_file_name
))
5608 && stream
!= NULL
&& do_handled_files
== 0)
5611 if (!NILP (BVAR (b
, filename
)))
5613 fwrite (SDATA (BVAR (b
, filename
)), 1,
5614 SBYTES (BVAR (b
, filename
)), stream
);
5616 putc ('\n', stream
);
5617 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5618 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5619 putc ('\n', stream
);
5623 if (!NILP (current_only
)
5624 && b
!= current_buffer
)
5627 /* Don't auto-save indirect buffers.
5628 The base buffer takes care of it. */
5632 /* Check for auto save enabled
5633 and file changed since last auto save
5634 and file changed since last real save. */
5635 if (STRINGP (BVAR (b
, auto_save_file_name
))
5636 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5637 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5638 /* -1 means we've turned off autosaving for a while--see below. */
5639 && XINT (BVAR (b
, save_length
)) >= 0
5640 && (do_handled_files
5641 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5644 struct timespec before_time
= current_timespec ();
5645 struct timespec after_time
;
5647 /* If we had a failure, don't try again for 20 minutes. */
5648 if (b
->auto_save_failure_time
> 0
5649 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5652 set_buffer_internal (b
);
5653 if (NILP (Vauto_save_include_big_deletions
)
5654 && (XFASTINT (BVAR (b
, save_length
)) * 10
5655 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5656 /* A short file is likely to change a large fraction;
5657 spare the user annoying messages. */
5658 && XFASTINT (BVAR (b
, save_length
)) > 5000
5659 /* These messages are frequent and annoying for `*mail*'. */
5660 && !EQ (BVAR (b
, filename
), Qnil
)
5661 && NILP (no_message
))
5663 /* It has shrunk too much; turn off auto-saving here. */
5664 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5665 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5667 minibuffer_auto_raise
= 0;
5668 /* Turn off auto-saving until there's a real save,
5669 and prevent any more warnings. */
5670 XSETINT (BVAR (b
, save_length
), -1);
5671 Fsleep_for (make_number (1), Qnil
);
5674 if (!auto_saved
&& NILP (no_message
))
5675 message1 ("Auto-saving...");
5676 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5678 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5679 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5680 set_buffer_internal (old
);
5682 after_time
= current_timespec ();
5684 /* If auto-save took more than 60 seconds,
5685 assume it was an NFS failure that got a timeout. */
5686 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5687 b
->auto_save_failure_time
= after_time
.tv_sec
;
5691 /* Prevent another auto save till enough input events come in. */
5692 record_auto_save ();
5694 if (auto_saved
&& NILP (no_message
))
5698 /* If we are going to restore an old message,
5699 give time to read ours. */
5700 sit_for (make_number (1), 0, 0);
5703 else if (!auto_save_error_occurred
)
5704 /* Don't overwrite the error message if an error occurred.
5705 If we displayed a message and then restored a state
5706 with no message, leave a "done" message on the screen. */
5707 message1 ("Auto-saving...done");
5712 /* This restores the message-stack status. */
5717 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5718 Sset_buffer_auto_saved
, 0, 0, 0,
5719 doc
: /* Mark current buffer as auto-saved with its current text.
5720 No auto-save file will be written until the buffer changes again. */)
5723 /* FIXME: This should not be called in indirect buffers, since
5724 they're not autosaved. */
5725 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5726 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5727 current_buffer
->auto_save_failure_time
= 0;
5731 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5732 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5733 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5736 current_buffer
->auto_save_failure_time
= 0;
5740 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5742 doc
: /* Return t if current buffer has been auto-saved recently.
5743 More precisely, if it has been auto-saved since last read from or saved
5744 in the visited file. If the buffer has no visited file,
5745 then any auto-save counts as "recent". */)
5748 /* FIXME: maybe we should return nil for indirect buffers since
5749 they're never autosaved. */
5750 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5753 /* Reading and completing file names */
5755 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5756 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5757 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5758 The return value is only relevant for a call to `read-file-name' that happens
5759 before any other event (mouse or keypress) is handled. */)
5762 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5763 || defined (HAVE_NS)
5764 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5767 && window_system_available (SELECTED_FRAME ()))
5776 realmask
= umask (0);
5779 valid_timestamp_file_system
= 0;
5781 /* fsync can be a significant performance hit. Often it doesn't
5782 suffice to make the file-save operation survive a crash. For
5783 batch scripts, which are typically part of larger shell commands
5784 that don't fsync other files, its effect on performance can be
5785 significant so its utility is particularly questionable.
5786 Hence, for now by default fsync is used only when interactive.
5788 For more on why fsync often fails to work on today's hardware, see:
5789 Zheng M et al. Understanding the robustness of SSDs under power fault.
5790 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5791 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5793 For more on why fsync does not suffice even if it works properly, see:
5794 Roche X. Necessary step(s) to synchronize filename operations on disk.
5795 Austin Group Defect 672, 2013-03-19
5796 http://austingroupbugs.net/view.php?id=672 */
5797 write_region_inhibit_fsync
= noninteractive
;
5801 syms_of_fileio (void)
5805 DEFSYM (Qoperations
, "operations");
5806 DEFSYM (Qexpand_file_name
, "expand-file-name");
5807 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5808 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5809 DEFSYM (Qfile_name_directory
, "file-name-directory");
5810 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5811 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5812 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5813 DEFSYM (Qcopy_file
, "copy-file");
5814 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5815 DEFSYM (Qmake_directory
, "make-directory");
5816 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5817 DEFSYM (Qdelete_file
, "delete-file");
5818 DEFSYM (Qrename_file
, "rename-file");
5819 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5820 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5821 DEFSYM (Qfile_exists_p
, "file-exists-p");
5822 DEFSYM (Qfile_executable_p
, "file-executable-p");
5823 DEFSYM (Qfile_readable_p
, "file-readable-p");
5824 DEFSYM (Qfile_writable_p
, "file-writable-p");
5825 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5826 DEFSYM (Qaccess_file
, "access-file");
5827 DEFSYM (Qfile_directory_p
, "file-directory-p");
5828 DEFSYM (Qfile_regular_p
, "file-regular-p");
5829 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5830 DEFSYM (Qfile_modes
, "file-modes");
5831 DEFSYM (Qset_file_modes
, "set-file-modes");
5832 DEFSYM (Qset_file_times
, "set-file-times");
5833 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5834 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5835 DEFSYM (Qfile_acl
, "file-acl");
5836 DEFSYM (Qset_file_acl
, "set-file-acl");
5837 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5838 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5839 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5840 DEFSYM (Qwrite_region
, "write-region");
5841 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5842 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5843 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5845 DEFSYM (Qfile_name_history
, "file-name-history");
5846 Fset (Qfile_name_history
, Qnil
);
5848 DEFSYM (Qfile_error
, "file-error");
5849 DEFSYM (Qfile_already_exists
, "file-already-exists");
5850 DEFSYM (Qfile_date_error
, "file-date-error");
5851 DEFSYM (Qfile_notify_error
, "file-notify-error");
5852 DEFSYM (Qexcl
, "excl");
5854 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5855 doc
: /* Coding system for encoding file names.
5856 If it is nil, `default-file-name-coding-system' (which see) is used.
5858 On MS-Windows, the value of this variable is largely ignored if
5859 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5860 behaves as if file names were encoded in `utf-8'. */);
5861 Vfile_name_coding_system
= Qnil
;
5863 DEFVAR_LISP ("default-file-name-coding-system",
5864 Vdefault_file_name_coding_system
,
5865 doc
: /* Default coding system for encoding file names.
5866 This variable is used only when `file-name-coding-system' is nil.
5868 This variable is set/changed by the command `set-language-environment'.
5869 User should not set this variable manually,
5870 instead use `file-name-coding-system' to get a constant encoding
5871 of file names regardless of the current language environment.
5873 On MS-Windows, the value of this variable is largely ignored if
5874 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5875 behaves as if file names were encoded in `utf-8'. */);
5876 Vdefault_file_name_coding_system
= Qnil
;
5878 DEFSYM (Qformat_decode
, "format-decode");
5879 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5880 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5881 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5883 Fput (Qfile_error
, Qerror_conditions
,
5884 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5885 Fput (Qfile_error
, Qerror_message
,
5886 build_pure_c_string ("File error"));
5888 Fput (Qfile_already_exists
, Qerror_conditions
,
5889 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5890 Fput (Qfile_already_exists
, Qerror_message
,
5891 build_pure_c_string ("File already exists"));
5893 Fput (Qfile_date_error
, Qerror_conditions
,
5894 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5895 Fput (Qfile_date_error
, Qerror_message
,
5896 build_pure_c_string ("Cannot set file date"));
5898 Fput (Qfile_notify_error
, Qerror_conditions
,
5899 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5900 Fput (Qfile_notify_error
, Qerror_message
,
5901 build_pure_c_string ("File notification error"));
5903 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5904 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5905 If a file name matches REGEXP, all I/O on that file is done by calling
5906 HANDLER. If a file name matches more than one handler, the handler
5907 whose match starts last in the file name gets precedence. The
5908 function `find-file-name-handler' checks this list for a handler for
5911 HANDLER should be a function. The first argument given to it is the
5912 name of the I/O primitive to be handled; the remaining arguments are
5913 the arguments that were passed to that primitive. For example, if you
5914 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5915 HANDLER is called like this:
5917 (funcall HANDLER 'file-exists-p FILENAME)
5919 Note that HANDLER must be able to handle all I/O primitives; if it has
5920 nothing special to do for a primitive, it should reinvoke the
5921 primitive to handle the operation \"the usual way\".
5922 See Info node `(elisp)Magic File Names' for more details. */);
5923 Vfile_name_handler_alist
= Qnil
;
5925 DEFVAR_LISP ("set-auto-coding-function",
5926 Vset_auto_coding_function
,
5927 doc
: /* If non-nil, a function to call to decide a coding system of file.
5928 Two arguments are passed to this function: the file name
5929 and the length of a file contents following the point.
5930 This function should return a coding system to decode the file contents.
5931 It should check the file name against `auto-coding-alist'.
5932 If no coding system is decided, it should check a coding system
5933 specified in the heading lines with the format:
5934 -*- ... coding: CODING-SYSTEM; ... -*-
5935 or local variable spec of the tailing lines with `coding:' tag. */);
5936 Vset_auto_coding_function
= Qnil
;
5938 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5939 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5940 Each is passed one argument, the number of characters inserted,
5941 with point at the start of the inserted text. Each function
5942 should leave point the same, and return the new character count.
5943 If `insert-file-contents' is intercepted by a handler from
5944 `file-name-handler-alist', that handler is responsible for calling the
5945 functions in `after-insert-file-functions' if appropriate. */);
5946 Vafter_insert_file_functions
= Qnil
;
5948 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5949 doc
: /* A list of functions to be called at the start of `write-region'.
5950 Each is passed two arguments, START and END as for `write-region'.
5951 These are usually two numbers but not always; see the documentation
5952 for `write-region'. The function should return a list of pairs
5953 of the form (POSITION . STRING), consisting of strings to be effectively
5954 inserted at the specified positions of the file being written (1 means to
5955 insert before the first byte written). The POSITIONs must be sorted into
5958 If there are several annotation functions, the lists returned by these
5959 functions are merged destructively. As each annotation function runs,
5960 the variable `write-region-annotations-so-far' contains a list of all
5961 annotations returned by previous annotation functions.
5963 An annotation function can return with a different buffer current.
5964 Doing so removes the annotations returned by previous functions, and
5965 resets START and END to `point-min' and `point-max' of the new buffer.
5967 After `write-region' completes, Emacs calls the function stored in
5968 `write-region-post-annotation-function', once for each buffer that was
5969 current when building the annotations (i.e., at least once), with that
5970 buffer current. */);
5971 Vwrite_region_annotate_functions
= Qnil
;
5972 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5974 DEFVAR_LISP ("write-region-post-annotation-function",
5975 Vwrite_region_post_annotation_function
,
5976 doc
: /* Function to call after `write-region' completes.
5977 The function is called with no arguments. If one or more of the
5978 annotation functions in `write-region-annotate-functions' changed the
5979 current buffer, the function stored in this variable is called for
5980 each of those additional buffers as well, in addition to the original
5981 buffer. The relevant buffer is current during each function call. */);
5982 Vwrite_region_post_annotation_function
= Qnil
;
5983 staticpro (&Vwrite_region_annotation_buffers
);
5985 DEFVAR_LISP ("write-region-annotations-so-far",
5986 Vwrite_region_annotations_so_far
,
5987 doc
: /* When an annotation function is called, this holds the previous annotations.
5988 These are the annotations made by other annotation functions
5989 that were already called. See also `write-region-annotate-functions'. */);
5990 Vwrite_region_annotations_so_far
= Qnil
;
5992 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5993 doc
: /* A list of file name handlers that temporarily should not be used.
5994 This applies only to the operation `inhibit-file-name-operation'. */);
5995 Vinhibit_file_name_handlers
= Qnil
;
5997 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5998 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5999 Vinhibit_file_name_operation
= Qnil
;
6001 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6002 doc
: /* File name in which we write a list of all auto save file names.
6003 This variable is initialized automatically from `auto-save-list-file-prefix'
6004 shortly after Emacs reads your init file, if you have not yet given it
6005 a non-nil value. */);
6006 Vauto_save_list_file_name
= Qnil
;
6008 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6009 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6010 Normally auto-save files are written under other names. */);
6011 Vauto_save_visited_file_name
= Qnil
;
6013 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6014 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6015 If nil, deleting a substantial portion of the text disables auto-save
6016 in the buffer; this is the default behavior, because the auto-save
6017 file is usually more useful if it contains the deleted text. */);
6018 Vauto_save_include_big_deletions
= Qnil
;
6020 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6021 doc
: /* Non-nil means don't call fsync in `write-region'.
6022 This variable affects calls to `write-region' as well as save commands.
6023 Setting this to nil may avoid data loss if the system loses power or
6024 the operating system crashes. By default, it is non-nil in batch mode. */);
6025 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6027 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6028 doc
: /* Specifies whether to use the system's trash can.
6029 When non-nil, certain file deletion commands use the function
6030 `move-file-to-trash' instead of deleting files outright.
6031 This includes interactive calls to `delete-file' and
6032 `delete-directory' and the Dired deletion commands. */);
6033 delete_by_moving_to_trash
= 0;
6034 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6036 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6037 DEFSYM (Qcopy_directory
, "copy-directory");
6038 DEFSYM (Qdelete_directory
, "delete-directory");
6039 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");