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
;
1962 ptrdiff_t count
= SPECPDL_INDEX ();
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
))
1998 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1999 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
2000 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 */
2179 unbind_to (count
, Qnil
);
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_UNGCPRO (call4 (handler
, Qrename_file
,
2337 file
, newname
, ok_if_already_exists
));
2339 encoded_file
= ENCODE_FILE (file
);
2340 encoded_newname
= ENCODE_FILE (newname
);
2343 /* If the file names are identical but for the case, don't ask for
2344 confirmation: they simply want to change the letter-case of the
2346 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2348 if (NILP (ok_if_already_exists
)
2349 || INTEGERP (ok_if_already_exists
))
2350 barf_or_query_if_file_exists (newname
, false, "rename to it",
2351 INTEGERP (ok_if_already_exists
), false);
2352 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2354 int rename_errno
= errno
;
2355 if (rename_errno
== EXDEV
)
2358 symlink_target
= Ffile_symlink_p (file
);
2359 if (! NILP (symlink_target
))
2360 Fmake_symbolic_link (symlink_target
, newname
,
2361 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2362 else if (!NILP (Ffile_directory_p (file
)))
2363 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2365 /* We have already prompted if it was an integer, so don't
2366 have copy-file prompt again. */
2367 Fcopy_file (file
, newname
,
2368 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2371 count
= SPECPDL_INDEX ();
2372 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2374 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2375 call2 (Qdelete_directory
, file
, Qt
);
2377 Fdelete_file (file
, Qnil
);
2378 unbind_to (count
, Qnil
);
2381 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2387 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2388 "fAdd name to file: \nGName to add to %s: \np",
2389 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2390 Signals a `file-already-exists' error if a file NEWNAME already exists
2391 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2392 A number as third arg means request confirmation if NEWNAME already exists.
2393 This is what happens in interactive use with M-x. */)
2394 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2396 Lisp_Object handler
;
2397 Lisp_Object encoded_file
, encoded_newname
;
2398 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2400 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2401 encoded_file
= encoded_newname
= Qnil
;
2402 CHECK_STRING (file
);
2403 CHECK_STRING (newname
);
2404 file
= Fexpand_file_name (file
, Qnil
);
2406 if (!NILP (Ffile_directory_p (newname
)))
2407 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2409 newname
= Fexpand_file_name (newname
, Qnil
);
2411 /* If the file name has special constructs in it,
2412 call the corresponding file handler. */
2413 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2414 if (!NILP (handler
))
2415 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2416 newname
, ok_if_already_exists
));
2418 /* If the new name has special constructs in it,
2419 call the corresponding file handler. */
2420 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2421 if (!NILP (handler
))
2422 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2423 newname
, ok_if_already_exists
));
2425 encoded_file
= ENCODE_FILE (file
);
2426 encoded_newname
= ENCODE_FILE (newname
);
2428 if (NILP (ok_if_already_exists
)
2429 || INTEGERP (ok_if_already_exists
))
2430 barf_or_query_if_file_exists (newname
, false, "make it a new name",
2431 INTEGERP (ok_if_already_exists
), false);
2433 unlink (SSDATA (newname
));
2434 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2436 int link_errno
= errno
;
2437 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2444 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2445 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2446 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2447 Both args must be strings.
2448 Signals a `file-already-exists' error if a file LINKNAME already exists
2449 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2450 A number as third arg means request confirmation if LINKNAME already exists.
2451 This happens for interactive use with M-x. */)
2452 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2454 Lisp_Object handler
;
2455 Lisp_Object encoded_filename
, encoded_linkname
;
2456 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2458 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2459 encoded_filename
= encoded_linkname
= Qnil
;
2460 CHECK_STRING (filename
);
2461 CHECK_STRING (linkname
);
2462 /* If the link target has a ~, we must expand it to get
2463 a truly valid file name. Otherwise, do not expand;
2464 we want to permit links to relative file names. */
2465 if (SREF (filename
, 0) == '~')
2466 filename
= Fexpand_file_name (filename
, Qnil
);
2468 if (!NILP (Ffile_directory_p (linkname
)))
2469 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2471 linkname
= Fexpand_file_name (linkname
, Qnil
);
2473 /* If the file name has special constructs in it,
2474 call the corresponding file handler. */
2475 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2476 if (!NILP (handler
))
2477 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2478 linkname
, ok_if_already_exists
));
2480 /* If the new link name has special constructs in it,
2481 call the corresponding file handler. */
2482 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2483 if (!NILP (handler
))
2484 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2485 linkname
, ok_if_already_exists
));
2487 encoded_filename
= ENCODE_FILE (filename
);
2488 encoded_linkname
= ENCODE_FILE (linkname
);
2490 if (NILP (ok_if_already_exists
)
2491 || INTEGERP (ok_if_already_exists
))
2492 barf_or_query_if_file_exists (linkname
, false, "make it a link",
2493 INTEGERP (ok_if_already_exists
), false);
2494 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2496 /* If we didn't complain already, silently delete existing file. */
2498 if (errno
== EEXIST
)
2500 unlink (SSDATA (encoded_linkname
));
2501 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2508 if (errno
== ENOSYS
)
2511 xsignal1 (Qfile_error
,
2512 build_string ("Symbolic links are not supported"));
2515 symlink_errno
= errno
;
2516 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2524 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2526 doc
: /* Return t if file FILENAME specifies an absolute file name.
2527 On Unix, this is a name starting with a `/' or a `~'. */)
2528 (Lisp_Object filename
)
2530 CHECK_STRING (filename
);
2531 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2534 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2535 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2536 See also `file-readable-p' and `file-attributes'.
2537 This returns nil for a symlink to a nonexistent file.
2538 Use `file-symlink-p' to test for such links. */)
2539 (Lisp_Object filename
)
2541 Lisp_Object absname
;
2542 Lisp_Object handler
;
2544 CHECK_STRING (filename
);
2545 absname
= Fexpand_file_name (filename
, Qnil
);
2547 /* If the file name has special constructs in it,
2548 call the corresponding file handler. */
2549 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2550 if (!NILP (handler
))
2552 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2557 absname
= ENCODE_FILE (absname
);
2559 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2562 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2563 doc
: /* Return t if FILENAME can be executed by you.
2564 For a directory, this means you can access files in that directory.
2565 \(It is generally better to use `file-accessible-directory-p' for that
2566 purpose, though.) */)
2567 (Lisp_Object filename
)
2569 Lisp_Object absname
;
2570 Lisp_Object handler
;
2572 CHECK_STRING (filename
);
2573 absname
= Fexpand_file_name (filename
, Qnil
);
2575 /* If the file name has special constructs in it,
2576 call the corresponding file handler. */
2577 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2578 if (!NILP (handler
))
2579 return call2 (handler
, Qfile_executable_p
, absname
);
2581 absname
= ENCODE_FILE (absname
);
2583 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2586 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2587 doc
: /* Return t if file FILENAME exists and you can read it.
2588 See also `file-exists-p' and `file-attributes'. */)
2589 (Lisp_Object filename
)
2591 Lisp_Object absname
;
2592 Lisp_Object handler
;
2594 CHECK_STRING (filename
);
2595 absname
= Fexpand_file_name (filename
, Qnil
);
2597 /* If the file name has special constructs in it,
2598 call the corresponding file handler. */
2599 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2600 if (!NILP (handler
))
2601 return call2 (handler
, Qfile_readable_p
, absname
);
2603 absname
= ENCODE_FILE (absname
);
2604 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2608 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2609 doc
: /* Return t if file FILENAME can be written or created by you. */)
2610 (Lisp_Object filename
)
2612 Lisp_Object absname
, dir
, encoded
;
2613 Lisp_Object handler
;
2615 CHECK_STRING (filename
);
2616 absname
= Fexpand_file_name (filename
, Qnil
);
2618 /* If the file name has special constructs in it,
2619 call the corresponding file handler. */
2620 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2621 if (!NILP (handler
))
2622 return call2 (handler
, Qfile_writable_p
, absname
);
2624 encoded
= ENCODE_FILE (absname
);
2625 if (check_writable (SSDATA (encoded
), W_OK
))
2627 if (errno
!= ENOENT
)
2630 dir
= Ffile_name_directory (absname
);
2631 eassert (!NILP (dir
));
2633 dir
= Fdirectory_file_name (dir
);
2636 dir
= ENCODE_FILE (dir
);
2638 /* The read-only attribute of the parent directory doesn't affect
2639 whether a file or directory can be created within it. Some day we
2640 should check ACLs though, which do affect this. */
2641 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2643 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2647 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2648 doc
: /* Access file FILENAME, and get an error if that does not work.
2649 The second argument STRING is used in the error message.
2650 If there is no error, returns nil. */)
2651 (Lisp_Object filename
, Lisp_Object string
)
2653 Lisp_Object handler
, encoded_filename
, absname
;
2655 CHECK_STRING (filename
);
2656 absname
= Fexpand_file_name (filename
, Qnil
);
2658 CHECK_STRING (string
);
2660 /* If the file name has special constructs in it,
2661 call the corresponding file handler. */
2662 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2663 if (!NILP (handler
))
2664 return call3 (handler
, Qaccess_file
, absname
, string
);
2666 encoded_filename
= ENCODE_FILE (absname
);
2668 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2669 report_file_error (SSDATA (string
), filename
);
2674 /* Relative to directory FD, return the symbolic link value of FILENAME.
2675 On failure, return nil. */
2677 emacs_readlinkat (int fd
, char const *filename
)
2679 static struct allocator
const emacs_norealloc_allocator
=
2680 { xmalloc
, NULL
, xfree
, memory_full
};
2682 char readlink_buf
[1024];
2683 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2684 &emacs_norealloc_allocator
, readlinkat
);
2688 val
= build_unibyte_string (buf
);
2689 if (buf
[0] == '/' && strchr (buf
, ':'))
2690 val
= concat2 (build_unibyte_string ("/:"), val
);
2691 if (buf
!= readlink_buf
)
2693 val
= DECODE_FILE (val
);
2697 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2698 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2699 The value is the link target, as a string.
2700 Otherwise it returns nil.
2702 This function does not check whether the link target exists. */)
2703 (Lisp_Object filename
)
2705 Lisp_Object handler
;
2707 CHECK_STRING (filename
);
2708 filename
= Fexpand_file_name (filename
, Qnil
);
2710 /* If the file name has special constructs in it,
2711 call the corresponding file handler. */
2712 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2713 if (!NILP (handler
))
2714 return call2 (handler
, Qfile_symlink_p
, filename
);
2716 filename
= ENCODE_FILE (filename
);
2718 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2721 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2722 doc
: /* Return t if FILENAME names an existing directory.
2723 Symbolic links to directories count as directories.
2724 See `file-symlink-p' to distinguish symlinks. */)
2725 (Lisp_Object filename
)
2727 Lisp_Object absname
;
2728 Lisp_Object handler
;
2730 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2732 /* If the file name has special constructs in it,
2733 call the corresponding file handler. */
2734 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2735 if (!NILP (handler
))
2736 return call2 (handler
, Qfile_directory_p
, absname
);
2738 absname
= ENCODE_FILE (absname
);
2740 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2743 /* Return true if FILE is a directory or a symlink to a directory. */
2745 file_directory_p (char const *file
)
2748 /* This is cheaper than 'stat'. */
2749 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2752 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2756 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2757 Sfile_accessible_directory_p
, 1, 1, 0,
2758 doc
: /* Return t if file FILENAME names a directory you can open.
2759 For the value to be t, FILENAME must specify the name of a directory as a file,
2760 and the directory must allow you to open files in it. In order to use a
2761 directory as a buffer's current directory, this predicate must return true.
2762 A directory name spec may be given instead; then the value is t
2763 if the directory so specified exists and really is a readable and
2764 searchable directory. */)
2765 (Lisp_Object filename
)
2767 Lisp_Object absname
;
2768 Lisp_Object handler
;
2770 CHECK_STRING (filename
);
2771 absname
= Fexpand_file_name (filename
, Qnil
);
2773 /* If the file name has special constructs in it,
2774 call the corresponding file handler. */
2775 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2776 if (!NILP (handler
))
2778 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2783 absname
= ENCODE_FILE (absname
);
2784 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2787 /* If FILE is a searchable directory or a symlink to a
2788 searchable directory, return true. Otherwise return
2789 false and set errno to an error number. */
2791 file_accessible_directory_p (char const *file
)
2794 /* There's no need to test whether FILE is searchable, as the
2795 searchable/executable bit is invented on DOS_NT platforms. */
2796 return file_directory_p (file
);
2798 /* On POSIXish platforms, use just one system call; this avoids a
2799 race and is typically faster. */
2800 ptrdiff_t len
= strlen (file
);
2806 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2807 There are three exceptions: "", "/", and "//". Leave "" alone,
2808 as it's invalid. Append only "." to the other two exceptions as
2809 "/" and "//" are distinct on some platforms, whereas "/", "///",
2810 "////", etc. are all equivalent. */
2815 /* Just check for trailing '/' when deciding whether to append '/'.
2816 That's simpler than testing the two special cases "/" and "//",
2817 and it's a safe optimization here. */
2818 char *buf
= SAFE_ALLOCA (len
+ 3);
2819 memcpy (buf
, file
, len
);
2820 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2824 ok
= check_existing (dir
);
2825 saved_errno
= errno
;
2827 errno
= saved_errno
;
2832 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2833 doc
: /* Return t if FILENAME names a regular file.
2834 This is the sort of file that holds an ordinary stream of data bytes.
2835 Symbolic links to regular files count as regular files.
2836 See `file-symlink-p' to distinguish symlinks. */)
2837 (Lisp_Object filename
)
2839 register Lisp_Object absname
;
2841 Lisp_Object handler
;
2843 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2845 /* If the file name has special constructs in it,
2846 call the corresponding file handler. */
2847 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2848 if (!NILP (handler
))
2849 return call2 (handler
, Qfile_regular_p
, absname
);
2851 absname
= ENCODE_FILE (absname
);
2856 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2858 /* Tell stat to use expensive method to get accurate info. */
2859 Vw32_get_true_file_attributes
= Qt
;
2860 result
= stat (SDATA (absname
), &st
);
2861 Vw32_get_true_file_attributes
= tem
;
2865 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2868 if (stat (SSDATA (absname
), &st
) < 0)
2870 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2874 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2875 Sfile_selinux_context
, 1, 1, 0,
2876 doc
: /* Return SELinux context of file named FILENAME.
2877 The return value is a list (USER ROLE TYPE RANGE), where the list
2878 elements are strings naming the user, role, type, and range of the
2879 file's SELinux security context.
2881 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2882 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2883 (Lisp_Object filename
)
2885 Lisp_Object absname
;
2886 Lisp_Object values
[4];
2887 Lisp_Object handler
;
2889 security_context_t con
;
2894 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2896 /* If the file name has special constructs in it,
2897 call the corresponding file handler. */
2898 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2899 if (!NILP (handler
))
2900 return call2 (handler
, Qfile_selinux_context
, absname
);
2902 absname
= ENCODE_FILE (absname
);
2909 if (is_selinux_enabled ())
2911 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2914 context
= context_new (con
);
2915 if (context_user_get (context
))
2916 values
[0] = build_string (context_user_get (context
));
2917 if (context_role_get (context
))
2918 values
[1] = build_string (context_role_get (context
));
2919 if (context_type_get (context
))
2920 values
[2] = build_string (context_type_get (context
));
2921 if (context_range_get (context
))
2922 values
[3] = build_string (context_range_get (context
));
2923 context_free (context
);
2929 return Flist (ARRAYELTS (values
), values
);
2932 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2933 Sset_file_selinux_context
, 2, 2, 0,
2934 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2935 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2936 elements are strings naming the components of a SELinux context.
2938 Value is t if setting of SELinux context was successful, nil otherwise.
2940 This function does nothing and returns nil if SELinux is disabled,
2941 or if Emacs was not compiled with SELinux support. */)
2942 (Lisp_Object filename
, Lisp_Object context
)
2944 Lisp_Object absname
;
2945 Lisp_Object handler
;
2947 Lisp_Object encoded_absname
;
2948 Lisp_Object user
= CAR_SAFE (context
);
2949 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2950 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2951 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2952 security_context_t con
;
2955 context_t parsed_con
;
2958 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2960 /* If the file name has special constructs in it,
2961 call the corresponding file handler. */
2962 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2963 if (!NILP (handler
))
2964 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2967 if (is_selinux_enabled ())
2969 /* Get current file context. */
2970 encoded_absname
= ENCODE_FILE (absname
);
2971 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2974 parsed_con
= context_new (con
);
2975 /* Change the parts defined in the parameter.*/
2978 if (context_user_set (parsed_con
, SSDATA (user
)))
2979 error ("Doing context_user_set");
2983 if (context_role_set (parsed_con
, SSDATA (role
)))
2984 error ("Doing context_role_set");
2988 if (context_type_set (parsed_con
, SSDATA (type
)))
2989 error ("Doing context_type_set");
2991 if (STRINGP (range
))
2993 if (context_range_set (parsed_con
, SSDATA (range
)))
2994 error ("Doing context_range_set");
2997 /* Set the modified context back to the file. */
2998 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2999 context_str (parsed_con
))
3001 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3002 if (fail
&& errno
!= ENOTSUP
)
3003 report_file_error ("Doing lsetfilecon", absname
);
3005 context_free (parsed_con
);
3007 return fail
? Qnil
: Qt
;
3010 report_file_error ("Doing lgetfilecon", absname
);
3017 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3018 doc
: /* Return ACL entries of file named FILENAME.
3019 The entries are returned in a format suitable for use in `set-file-acl'
3020 but is otherwise undocumented and subject to change.
3021 Return nil if file does not exist or is not accessible, or if Emacs
3022 was unable to determine the ACL entries. */)
3023 (Lisp_Object filename
)
3025 Lisp_Object absname
;
3026 Lisp_Object handler
;
3027 #ifdef HAVE_ACL_SET_FILE
3029 Lisp_Object acl_string
;
3031 # ifndef HAVE_ACL_TYPE_EXTENDED
3032 acl_type_t ACL_TYPE_EXTENDED
= ACL_TYPE_ACCESS
;
3036 absname
= expand_and_dir_to_file (filename
,
3037 BVAR (current_buffer
, directory
));
3039 /* If the file name has special constructs in it,
3040 call the corresponding file handler. */
3041 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3042 if (!NILP (handler
))
3043 return call2 (handler
, Qfile_acl
, absname
);
3045 #ifdef HAVE_ACL_SET_FILE
3046 absname
= ENCODE_FILE (absname
);
3048 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_EXTENDED
);
3052 str
= acl_to_text (acl
, NULL
);
3059 acl_string
= build_string (str
);
3069 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3071 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3072 ACL-STRING should contain the textual representation of the ACL
3073 entries in a format suitable for the platform.
3075 Value is t if setting of ACL was successful, nil otherwise.
3077 Setting ACL for local files requires Emacs to be built with ACL
3079 (Lisp_Object filename
, Lisp_Object acl_string
)
3081 Lisp_Object absname
;
3082 Lisp_Object handler
;
3083 #ifdef HAVE_ACL_SET_FILE
3084 Lisp_Object encoded_absname
;
3089 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3091 /* If the file name has special constructs in it,
3092 call the corresponding file handler. */
3093 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3094 if (!NILP (handler
))
3095 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3097 #ifdef HAVE_ACL_SET_FILE
3098 if (STRINGP (acl_string
))
3100 acl
= acl_from_text (SSDATA (acl_string
));
3103 report_file_error ("Converting ACL", absname
);
3107 encoded_absname
= ENCODE_FILE (absname
);
3109 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3112 if (fail
&& acl_errno_valid (errno
))
3113 report_file_error ("Setting ACL", absname
);
3116 return fail
? Qnil
: Qt
;
3123 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3124 doc
: /* Return mode bits of file named FILENAME, as an integer.
3125 Return nil, if file does not exist or is not accessible. */)
3126 (Lisp_Object filename
)
3128 Lisp_Object absname
;
3130 Lisp_Object handler
;
3132 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3134 /* If the file name has special constructs in it,
3135 call the corresponding file handler. */
3136 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3137 if (!NILP (handler
))
3138 return call2 (handler
, Qfile_modes
, absname
);
3140 absname
= ENCODE_FILE (absname
);
3142 if (stat (SSDATA (absname
), &st
) < 0)
3145 return make_number (st
.st_mode
& 07777);
3148 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3149 "(let ((file (read-file-name \"File: \"))) \
3150 (list file (read-file-modes nil file)))",
3151 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3152 Only the 12 low bits of MODE are used.
3154 Interactively, mode bits are read by `read-file-modes', which accepts
3155 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3156 (Lisp_Object filename
, Lisp_Object mode
)
3158 Lisp_Object absname
, encoded_absname
;
3159 Lisp_Object handler
;
3161 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3162 CHECK_NUMBER (mode
);
3164 /* If the file name has special constructs in it,
3165 call the corresponding file handler. */
3166 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3167 if (!NILP (handler
))
3168 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3170 encoded_absname
= ENCODE_FILE (absname
);
3172 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3173 report_file_error ("Doing chmod", absname
);
3178 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3179 doc
: /* Set the file permission bits for newly created files.
3180 The argument MODE should be an integer; only the low 9 bits are used.
3181 This setting is inherited by subprocesses. */)
3184 mode_t oldrealmask
, oldumask
, newumask
;
3185 CHECK_NUMBER (mode
);
3186 oldrealmask
= realmask
;
3187 newumask
= ~ XINT (mode
) & 0777;
3190 realmask
= newumask
;
3191 oldumask
= umask (newumask
);
3194 eassert (oldumask
== oldrealmask
);
3198 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3199 doc
: /* Return the default file protection for created files.
3200 The value is an integer. */)
3204 XSETINT (value
, (~ realmask
) & 0777);
3209 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3210 doc
: /* Set times of file FILENAME to TIMESTAMP.
3211 Set both access and modification times.
3212 Return t on success, else nil.
3213 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3215 (Lisp_Object filename
, Lisp_Object timestamp
)
3217 Lisp_Object absname
, encoded_absname
;
3218 Lisp_Object handler
;
3219 struct timespec t
= lisp_time_argument (timestamp
);
3221 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3223 /* If the file name has special constructs in it,
3224 call the corresponding file handler. */
3225 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3226 if (!NILP (handler
))
3227 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3229 encoded_absname
= ENCODE_FILE (absname
);
3232 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
) != 0)
3235 /* Setting times on a directory always fails. */
3236 if (file_directory_p (SSDATA (encoded_absname
)))
3239 report_file_error ("Setting file times", absname
);
3247 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3248 doc
: /* Tell Unix to finish all pending disk updates. */)
3255 #endif /* HAVE_SYNC */
3257 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3258 doc
: /* Return t if file FILE1 is newer than file FILE2.
3259 If FILE1 does not exist, the answer is nil;
3260 otherwise, if FILE2 does not exist, the answer is t. */)
3261 (Lisp_Object file1
, Lisp_Object file2
)
3263 Lisp_Object absname1
, absname2
;
3264 struct stat st1
, st2
;
3265 Lisp_Object handler
;
3266 struct gcpro gcpro1
, gcpro2
;
3268 CHECK_STRING (file1
);
3269 CHECK_STRING (file2
);
3272 GCPRO2 (absname1
, file2
);
3273 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3274 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3277 /* If the file name has special constructs in it,
3278 call the corresponding file handler. */
3279 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3281 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3282 if (!NILP (handler
))
3283 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3285 GCPRO2 (absname1
, absname2
);
3286 absname1
= ENCODE_FILE (absname1
);
3287 absname2
= ENCODE_FILE (absname2
);
3290 if (stat (SSDATA (absname1
), &st1
) < 0)
3293 if (stat (SSDATA (absname2
), &st2
) < 0)
3296 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3300 #ifndef READ_BUF_SIZE
3301 #define READ_BUF_SIZE (64 << 10)
3303 /* Some buffer offsets are stored in 'int' variables. */
3304 verify (READ_BUF_SIZE
<= INT_MAX
);
3306 /* This function is called after Lisp functions to decide a coding
3307 system are called, or when they cause an error. Before they are
3308 called, the current buffer is set unibyte and it contains only a
3309 newly inserted text (thus the buffer was empty before the
3312 The functions may set markers, overlays, text properties, or even
3313 alter the buffer contents, change the current buffer.
3315 Here, we reset all those changes by:
3316 o set back the current buffer.
3317 o move all markers and overlays to BEG.
3318 o remove all text properties.
3319 o set back the buffer multibyteness. */
3322 decide_coding_unwind (Lisp_Object unwind_data
)
3324 Lisp_Object multibyte
, undo_list
, buffer
;
3326 multibyte
= XCAR (unwind_data
);
3327 unwind_data
= XCDR (unwind_data
);
3328 undo_list
= XCAR (unwind_data
);
3329 buffer
= XCDR (unwind_data
);
3331 set_buffer_internal (XBUFFER (buffer
));
3332 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3333 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3334 set_buffer_intervals (current_buffer
, NULL
);
3335 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3337 /* Now we are safe to change the buffer's multibyteness directly. */
3338 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3339 bset_undo_list (current_buffer
, undo_list
);
3342 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3343 object where slot 0 is the file descriptor, slot 1 specifies
3344 an offset to put the read bytes, and slot 2 is the maximum
3345 amount of bytes to read. Value is the number of bytes read. */
3348 read_non_regular (Lisp_Object state
)
3354 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3355 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3356 + XSAVE_INTEGER (state
, 1)),
3357 XSAVE_INTEGER (state
, 2));
3359 /* Fast recycle this object for the likely next call. */
3361 return make_number (nbytes
);
3365 /* Condition-case handler used when reading from non-regular files
3366 in insert-file-contents. */
3369 read_non_regular_quit (Lisp_Object ignore
)
3374 /* Return the file offset that VAL represents, checking for type
3375 errors and overflow. */
3377 file_offset (Lisp_Object val
)
3379 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3384 double v
= XFLOAT_DATA (val
);
3386 && (sizeof (off_t
) < sizeof v
3387 ? v
<= TYPE_MAXIMUM (off_t
)
3388 : v
< TYPE_MAXIMUM (off_t
)))
3392 wrong_type_argument (intern ("file-offset"), val
);
3395 /* Return a special time value indicating the error number ERRNUM. */
3396 static struct timespec
3397 time_error_value (int errnum
)
3399 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3400 ? NONEXISTENT_MODTIME_NSECS
3401 : UNKNOWN_MODTIME_NSECS
);
3402 return make_timespec (0, ns
);
3405 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3407 doc
: /* Insert contents of file FILENAME after point.
3408 Returns list of absolute file name and number of characters inserted.
3409 If second argument VISIT is non-nil, the buffer's visited filename and
3410 last save file modtime are set, and it is marked unmodified. If
3411 visiting and the file does not exist, visiting is completed before the
3414 The optional third and fourth arguments BEG and END specify what portion
3415 of the file to insert. These arguments count bytes in the file, not
3416 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3418 If optional fifth argument REPLACE is non-nil, replace the current
3419 buffer contents (in the accessible portion) with the file contents.
3420 This is better than simply deleting and inserting the whole thing
3421 because (1) it preserves some marker positions and (2) it puts less data
3422 in the undo list. When REPLACE is non-nil, the second return value is
3423 the number of characters that replace previous buffer contents.
3425 This function does code conversion according to the value of
3426 `coding-system-for-read' or `file-coding-system-alist', and sets the
3427 variable `last-coding-system-used' to the coding system actually used.
3429 In addition, this function decodes the inserted text from known formats
3430 by calling `format-decode', which see. */)
3431 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3434 struct timespec mtime
;
3436 ptrdiff_t inserted
= 0;
3438 off_t beg_offset
, end_offset
;
3440 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3441 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3443 ptrdiff_t total
= 0;
3444 bool not_regular
= 0;
3446 char read_buf
[READ_BUF_SIZE
];
3447 struct coding_system coding
;
3448 bool replace_handled
= 0;
3449 bool set_coding_system
= 0;
3450 Lisp_Object coding_system
;
3452 /* If the undo log only contains the insertion, there's no point
3453 keeping it. It's typically when we first fill a file-buffer. */
3454 bool empty_undo_list_p
3455 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3457 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3458 bool we_locked_file
= 0;
3462 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3463 error ("Cannot do file visiting in an indirect buffer");
3465 if (!NILP (BVAR (current_buffer
, read_only
)))
3466 Fbarf_if_buffer_read_only ();
3470 orig_filename
= Qnil
;
3473 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3475 CHECK_STRING (filename
);
3476 filename
= Fexpand_file_name (filename
, Qnil
);
3478 /* The value Qnil means that the coding system is not yet
3480 coding_system
= Qnil
;
3482 /* If the file name has special constructs in it,
3483 call the corresponding file handler. */
3484 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3485 if (!NILP (handler
))
3487 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3488 visit
, beg
, end
, replace
);
3489 if (CONSP (val
) && CONSP (XCDR (val
))
3490 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3491 inserted
= XINT (XCAR (XCDR (val
)));
3495 orig_filename
= filename
;
3496 filename
= ENCODE_FILE (filename
);
3498 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3503 report_file_error ("Opening input file", orig_filename
);
3504 mtime
= time_error_value (save_errno
);
3506 if (!NILP (Vcoding_system_for_read
))
3507 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3511 record_unwind_protect_ptr (close_file_ptr_unwind
, &fd
);
3513 /* Replacement should preserve point as it preserves markers. */
3514 if (!NILP (replace
))
3515 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3517 if (fstat (fd
, &st
) != 0)
3518 report_file_error ("Input file status", orig_filename
);
3519 mtime
= get_stat_mtime (&st
);
3521 /* This code will need to be changed in order to work on named
3522 pipes, and it's probably just not worth it. So we should at
3523 least signal an error. */
3524 if (!S_ISREG (st
.st_mode
))
3531 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3532 xsignal2 (Qfile_error
,
3533 build_string ("not a regular file"), orig_filename
);
3538 if (!NILP (beg
) || !NILP (end
))
3539 error ("Attempt to visit less than an entire file");
3540 if (BEG
< Z
&& NILP (replace
))
3541 error ("Cannot do file visiting in a non-empty buffer");
3545 beg_offset
= file_offset (beg
);
3550 end_offset
= file_offset (end
);
3554 end_offset
= TYPE_MAXIMUM (off_t
);
3557 end_offset
= st
.st_size
;
3559 /* A negative size can happen on a platform that allows file
3560 sizes greater than the maximum off_t value. */
3564 /* The file size returned from stat may be zero, but data
3565 may be readable nonetheless, for example when this is a
3566 file in the /proc filesystem. */
3567 if (end_offset
== 0)
3568 end_offset
= READ_BUF_SIZE
;
3572 /* Check now whether the buffer will become too large,
3573 in the likely case where the file's length is not changing.
3574 This saves a lot of needless work before a buffer overflow. */
3577 /* The likely offset where we will stop reading. We could read
3578 more (or less), if the file grows (or shrinks) as we read it. */
3579 off_t likely_end
= min (end_offset
, st
.st_size
);
3581 if (beg_offset
< likely_end
)
3584 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3585 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3586 off_t likely_growth
= likely_end
- beg_offset
;
3587 if (buf_growth_max
< likely_growth
)
3592 /* Prevent redisplay optimizations. */
3593 current_buffer
->clip_changed
= 1;
3595 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3597 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3598 setup_coding_system (coding_system
, &coding
);
3599 /* Ensure we set Vlast_coding_system_used. */
3600 set_coding_system
= 1;
3604 /* Decide the coding system to use for reading the file now
3605 because we can't use an optimized method for handling
3606 `coding:' tag if the current buffer is not empty. */
3607 if (!NILP (Vcoding_system_for_read
))
3608 coding_system
= Vcoding_system_for_read
;
3611 /* Don't try looking inside a file for a coding system
3612 specification if it is not seekable. */
3613 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3615 /* Find a coding system specified in the heading two
3616 lines or in the tailing several lines of the file.
3617 We assume that the 1K-byte and 3K-byte for heading
3618 and tailing respectively are sufficient for this
3622 if (st
.st_size
<= (1024 * 4))
3623 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3626 nread
= emacs_read (fd
, read_buf
, 1024);
3630 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3631 report_file_error ("Setting file position",
3633 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3634 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3639 report_file_error ("Read error", orig_filename
);
3642 Lisp_Object workbuf
;
3646 record_unwind_current_buffer ();
3648 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3649 buf
= XBUFFER (workbuf
);
3651 delete_all_overlays (buf
);
3652 bset_directory (buf
, BVAR (current_buffer
, directory
));
3653 bset_read_only (buf
, Qnil
);
3654 bset_filename (buf
, Qnil
);
3655 bset_undo_list (buf
, Qt
);
3656 eassert (buf
->overlays_before
== NULL
);
3657 eassert (buf
->overlays_after
== NULL
);
3659 set_buffer_internal (buf
);
3661 bset_enable_multibyte_characters (buf
, Qnil
);
3663 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3664 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3665 coding_system
= call2 (Vset_auto_coding_function
,
3666 filename
, make_number (nread
));
3670 /* Rewind the file for the actual read done later. */
3671 if (lseek (fd
, 0, SEEK_SET
) < 0)
3672 report_file_error ("Setting file position", orig_filename
);
3676 if (NILP (coding_system
))
3678 /* If we have not yet decided a coding system, check
3679 file-coding-system-alist. */
3680 Lisp_Object args
[6];
3682 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3683 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3684 coding_system
= Ffind_operation_coding_system (6, args
);
3685 if (CONSP (coding_system
))
3686 coding_system
= XCAR (coding_system
);
3690 if (NILP (coding_system
))
3691 coding_system
= Qundecided
;
3693 CHECK_CODING_SYSTEM (coding_system
);
3695 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3696 /* We must suppress all character code conversion except for
3697 end-of-line conversion. */
3698 coding_system
= raw_text_coding_system (coding_system
);
3700 setup_coding_system (coding_system
, &coding
);
3701 /* Ensure we set Vlast_coding_system_used. */
3702 set_coding_system
= 1;
3705 /* If requested, replace the accessible part of the buffer
3706 with the file contents. Avoid replacing text at the
3707 beginning or end of the buffer that matches the file contents;
3708 that preserves markers pointing to the unchanged parts.
3710 Here we implement this feature in an optimized way
3711 for the case where code conversion is NOT needed.
3712 The following if-statement handles the case of conversion
3713 in a less optimal way.
3715 If the code conversion is "automatic" then we try using this
3716 method and hope for the best.
3717 But if we discover the need for conversion, we give up on this method
3718 and let the following if-statement handle the replace job. */
3721 && (NILP (coding_system
)
3722 || ! CODING_REQUIRE_DECODING (&coding
)))
3724 /* same_at_start and same_at_end count bytes,
3725 because file access counts bytes
3726 and BEG and END count bytes. */
3727 ptrdiff_t same_at_start
= BEGV_BYTE
;
3728 ptrdiff_t same_at_end
= ZV_BYTE
;
3730 /* There is still a possibility we will find the need to do code
3731 conversion. If that happens, set this variable to
3732 give up on handling REPLACE in the optimized way. */
3733 bool giveup_match_end
= 0;
3735 if (beg_offset
!= 0)
3737 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3738 report_file_error ("Setting file position", orig_filename
);
3743 /* Count how many chars at the start of the file
3744 match the text at the beginning of the buffer. */
3749 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3751 report_file_error ("Read error", orig_filename
);
3752 else if (nread
== 0)
3755 if (CODING_REQUIRE_DETECTION (&coding
))
3757 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3760 setup_coding_system (coding_system
, &coding
);
3763 if (CODING_REQUIRE_DECODING (&coding
))
3764 /* We found that the file should be decoded somehow.
3765 Let's give up here. */
3767 giveup_match_end
= 1;
3772 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3773 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3774 same_at_start
++, bufpos
++;
3775 /* If we found a discrepancy, stop the scan.
3776 Otherwise loop around and scan the next bufferful. */
3777 if (bufpos
!= nread
)
3781 /* If the file matches the buffer completely,
3782 there's no need to replace anything. */
3783 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3788 /* Truncate the buffer to the size of the file. */
3789 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3794 /* Count how many chars at the end of the file
3795 match the text at the end of the buffer. But, if we have
3796 already found that decoding is necessary, don't waste time. */
3797 while (!giveup_match_end
)
3799 int total_read
, nread
, bufpos
, trial
;
3802 /* At what file position are we now scanning? */
3803 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3804 /* If the entire file matches the buffer tail, stop the scan. */
3807 /* How much can we scan in the next step? */
3808 trial
= min (curpos
, sizeof read_buf
);
3809 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3810 report_file_error ("Setting file position", orig_filename
);
3812 total_read
= nread
= 0;
3813 while (total_read
< trial
)
3815 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3817 report_file_error ("Read error", orig_filename
);
3818 else if (nread
== 0)
3820 total_read
+= nread
;
3823 /* Scan this bufferful from the end, comparing with
3824 the Emacs buffer. */
3825 bufpos
= total_read
;
3827 /* Compare with same_at_start to avoid counting some buffer text
3828 as matching both at the file's beginning and at the end. */
3829 while (bufpos
> 0 && same_at_end
> same_at_start
3830 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3831 same_at_end
--, bufpos
--;
3833 /* If we found a discrepancy, stop the scan.
3834 Otherwise loop around and scan the preceding bufferful. */
3837 /* If this discrepancy is because of code conversion,
3838 we cannot use this method; giveup and try the other. */
3839 if (same_at_end
> same_at_start
3840 && FETCH_BYTE (same_at_end
- 1) >= 0200
3841 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3842 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3843 giveup_match_end
= 1;
3852 if (! giveup_match_end
)
3856 /* We win! We can handle REPLACE the optimized way. */
3858 /* Extend the start of non-matching text area to multibyte
3859 character boundary. */
3860 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3861 while (same_at_start
> BEGV_BYTE
3862 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3865 /* Extend the end of non-matching text area to multibyte
3866 character boundary. */
3867 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3868 while (same_at_end
< ZV_BYTE
3869 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3872 /* Don't try to reuse the same piece of text twice. */
3873 overlap
= (same_at_start
- BEGV_BYTE
3875 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3877 same_at_end
+= overlap
;
3879 /* Arrange to read only the nonmatching middle part of the file. */
3880 beg_offset
+= same_at_start
- BEGV_BYTE
;
3881 end_offset
-= ZV_BYTE
- same_at_end
;
3883 invalidate_buffer_caches (current_buffer
,
3884 BYTE_TO_CHAR (same_at_start
),
3885 BYTE_TO_CHAR (same_at_end
));
3886 del_range_byte (same_at_start
, same_at_end
, 0);
3887 /* Insert from the file at the proper position. */
3888 temp
= BYTE_TO_CHAR (same_at_start
);
3889 SET_PT_BOTH (temp
, same_at_start
);
3891 /* If display currently starts at beginning of line,
3892 keep it that way. */
3893 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3894 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3896 replace_handled
= 1;
3900 /* If requested, replace the accessible part of the buffer
3901 with the file contents. Avoid replacing text at the
3902 beginning or end of the buffer that matches the file contents;
3903 that preserves markers pointing to the unchanged parts.
3905 Here we implement this feature for the case where code conversion
3906 is needed, in a simple way that needs a lot of memory.
3907 The preceding if-statement handles the case of no conversion
3908 in a more optimized way. */
3909 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3911 ptrdiff_t same_at_start
= BEGV_BYTE
;
3912 ptrdiff_t same_at_end
= ZV_BYTE
;
3913 ptrdiff_t same_at_start_charpos
;
3914 ptrdiff_t inserted_chars
;
3917 unsigned char *decoded
;
3921 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3922 Lisp_Object conversion_buffer
;
3923 struct gcpro gcpro1
;
3926 conversion_buffer
= code_conversion_save (1, multibyte
);
3928 /* First read the whole file, performing code conversion into
3929 CONVERSION_BUFFER. */
3931 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3932 report_file_error ("Setting file position", orig_filename
);
3934 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3935 unprocessed
= 0; /* Bytes not processed in previous loop. */
3937 GCPRO1 (conversion_buffer
);
3940 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3941 quitting while reading a huge file. */
3943 /* Allow quitting out of the actual I/O. */
3946 this = emacs_read (fd
, read_buf
+ unprocessed
,
3947 READ_BUF_SIZE
- unprocessed
);
3953 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3954 BUF_Z (XBUFFER (conversion_buffer
)));
3955 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3956 unprocessed
+ this, conversion_buffer
);
3957 unprocessed
= coding
.carryover_bytes
;
3958 if (coding
.carryover_bytes
> 0)
3959 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3963 report_file_error ("Read error", orig_filename
);
3967 if (unprocessed
> 0)
3969 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3970 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3971 unprocessed
, conversion_buffer
);
3972 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3975 coding_system
= CODING_ID_NAME (coding
.id
);
3976 set_coding_system
= 1;
3977 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3978 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3979 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3981 /* Compare the beginning of the converted string with the buffer
3985 while (bufpos
< inserted
&& same_at_start
< same_at_end
3986 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3987 same_at_start
++, bufpos
++;
3989 /* If the file matches the head of buffer completely,
3990 there's no need to replace anything. */
3992 if (bufpos
== inserted
)
3994 /* Truncate the buffer to the size of the file. */
3995 if (same_at_start
!= same_at_end
)
3997 invalidate_buffer_caches (current_buffer
,
3998 BYTE_TO_CHAR (same_at_start
),
3999 BYTE_TO_CHAR (same_at_end
));
4000 del_range_byte (same_at_start
, same_at_end
, 0);
4008 /* Extend the start of non-matching text area to the previous
4009 multibyte character boundary. */
4010 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4011 while (same_at_start
> BEGV_BYTE
4012 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4015 /* Scan this bufferful from the end, comparing with
4016 the Emacs buffer. */
4019 /* Compare with same_at_start to avoid counting some buffer text
4020 as matching both at the file's beginning and at the end. */
4021 while (bufpos
> 0 && same_at_end
> same_at_start
4022 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4023 same_at_end
--, bufpos
--;
4025 /* Extend the end of non-matching text area to the next
4026 multibyte character boundary. */
4027 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4028 while (same_at_end
< ZV_BYTE
4029 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4032 /* Don't try to reuse the same piece of text twice. */
4033 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4035 same_at_end
+= overlap
;
4037 /* If display currently starts at beginning of line,
4038 keep it that way. */
4039 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4040 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4042 /* Replace the chars that we need to replace,
4043 and update INSERTED to equal the number of bytes
4044 we are taking from the decoded string. */
4045 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4047 if (same_at_end
!= same_at_start
)
4049 invalidate_buffer_caches (current_buffer
,
4050 BYTE_TO_CHAR (same_at_start
),
4051 BYTE_TO_CHAR (same_at_end
));
4052 del_range_byte (same_at_start
, same_at_end
, 0);
4054 eassert (same_at_start
== GPT_BYTE
);
4055 same_at_start
= GPT_BYTE
;
4059 temp
= BYTE_TO_CHAR (same_at_start
);
4061 /* Insert from the file at the proper position. */
4062 SET_PT_BOTH (temp
, same_at_start
);
4063 same_at_start_charpos
4064 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4065 same_at_start
- BEGV_BYTE
4066 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4067 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4069 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4070 same_at_start
+ inserted
- BEGV_BYTE
4071 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4072 - same_at_start_charpos
);
4073 /* This binding is to avoid ask-user-about-supersession-threat
4074 being called in insert_from_buffer (via in
4075 prepare_to_modify_buffer). */
4076 specbind (intern ("buffer-file-name"), Qnil
);
4077 insert_from_buffer (XBUFFER (conversion_buffer
),
4078 same_at_start_charpos
, inserted_chars
, 0);
4079 /* Set `inserted' to the number of inserted characters. */
4080 inserted
= PT
- temp
;
4081 /* Set point before the inserted characters. */
4082 SET_PT_BOTH (temp
, same_at_start
);
4090 total
= end_offset
- beg_offset
;
4092 /* For a special file, all we can do is guess. */
4093 total
= READ_BUF_SIZE
;
4095 if (NILP (visit
) && total
> 0)
4097 if (!NILP (BVAR (current_buffer
, file_truename
))
4098 /* Make binding buffer-file-name to nil effective. */
4099 && !NILP (BVAR (current_buffer
, filename
))
4100 && SAVE_MODIFF
>= MODIFF
)
4102 prepare_to_modify_buffer (PT
, PT
, NULL
);
4105 move_gap_both (PT
, PT_BYTE
);
4106 if (GAP_SIZE
< total
)
4107 make_gap (total
- GAP_SIZE
);
4109 if (beg_offset
!= 0 || !NILP (replace
))
4111 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4112 report_file_error ("Setting file position", orig_filename
);
4115 /* In the following loop, HOW_MUCH contains the total bytes read so
4116 far for a regular file, and not changed for a special file. But,
4117 before exiting the loop, it is set to a negative value if I/O
4121 /* Total bytes inserted. */
4124 /* Here, we don't do code conversion in the loop. It is done by
4125 decode_coding_gap after all data are read into the buffer. */
4127 ptrdiff_t gap_size
= GAP_SIZE
;
4129 while (how_much
< total
)
4131 /* try is reserved in some compilers (Microsoft C) */
4132 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4139 /* Maybe make more room. */
4140 if (gap_size
< trytry
)
4142 make_gap (trytry
- gap_size
);
4143 gap_size
= GAP_SIZE
- inserted
;
4146 /* Read from the file, capturing `quit'. When an
4147 error occurs, end the loop, and arrange for a quit
4148 to be signaled after decoding the text we read. */
4149 nbytes
= internal_condition_case_1
4151 make_save_int_int_int (fd
, inserted
, trytry
),
4152 Qerror
, read_non_regular_quit
);
4160 this = XINT (nbytes
);
4164 /* Allow quitting out of the actual I/O. We don't make text
4165 part of the buffer until all the reading is done, so a C-g
4166 here doesn't do any harm. */
4169 this = emacs_read (fd
,
4170 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4184 /* For a regular file, where TOTAL is the real size,
4185 count HOW_MUCH to compare with it.
4186 For a special file, where TOTAL is just a buffer size,
4187 so don't bother counting in HOW_MUCH.
4188 (INSERTED is where we count the number of characters inserted.) */
4195 /* Now we have either read all the file data into the gap,
4196 or stop reading on I/O error or quit. If nothing was
4197 read, undo marking the buffer modified. */
4202 unlock_file (BVAR (current_buffer
, file_truename
));
4203 Vdeactivate_mark
= old_Vdeactivate_mark
;
4206 Vdeactivate_mark
= Qt
;
4212 report_file_error ("Read error", orig_filename
);
4214 /* Make the text read part of the buffer. */
4215 GAP_SIZE
-= inserted
;
4217 GPT_BYTE
+= inserted
;
4219 ZV_BYTE
+= inserted
;
4224 /* Put an anchor to ensure multi-byte form ends at gap. */
4229 if (NILP (coding_system
))
4231 /* The coding system is not yet decided. Decide it by an
4232 optimized method for handling `coding:' tag.
4234 Note that we can get here only if the buffer was empty
4235 before the insertion. */
4237 if (!NILP (Vcoding_system_for_read
))
4238 coding_system
= Vcoding_system_for_read
;
4241 /* Since we are sure that the current buffer was empty
4242 before the insertion, we can toggle
4243 enable-multibyte-characters directly here without taking
4244 care of marker adjustment. By this way, we can run Lisp
4245 program safely before decoding the inserted text. */
4246 Lisp_Object unwind_data
;
4249 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4250 Fcons (BVAR (current_buffer
, undo_list
),
4251 Fcurrent_buffer ()));
4252 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4253 bset_undo_list (current_buffer
, Qt
);
4254 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4256 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4258 coding_system
= call2 (Vset_auto_coding_function
,
4259 filename
, make_number (inserted
));
4262 if (NILP (coding_system
))
4264 /* If the coding system is not yet decided, check
4265 file-coding-system-alist. */
4266 Lisp_Object args
[6];
4268 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4269 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4270 coding_system
= Ffind_operation_coding_system (6, args
);
4271 if (CONSP (coding_system
))
4272 coding_system
= XCAR (coding_system
);
4275 inserted
= Z_BYTE
- BEG_BYTE
;
4278 if (NILP (coding_system
))
4279 coding_system
= Qundecided
;
4281 CHECK_CODING_SYSTEM (coding_system
);
4283 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4284 /* We must suppress all character code conversion except for
4285 end-of-line conversion. */
4286 coding_system
= raw_text_coding_system (coding_system
);
4287 setup_coding_system (coding_system
, &coding
);
4288 /* Ensure we set Vlast_coding_system_used. */
4289 set_coding_system
= 1;
4294 /* When we visit a file by raw-text, we change the buffer to
4296 if (CODING_FOR_UNIBYTE (&coding
)
4297 /* Can't do this if part of the buffer might be preserved. */
4299 /* Visiting a file with these coding system makes the buffer
4301 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4304 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4305 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4306 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4308 move_gap_both (PT
, PT_BYTE
);
4309 GAP_SIZE
+= inserted
;
4310 ZV_BYTE
-= inserted
;
4314 decode_coding_gap (&coding
, inserted
, inserted
);
4315 inserted
= coding
.produced_char
;
4316 coding_system
= CODING_ID_NAME (coding
.id
);
4318 else if (inserted
> 0)
4319 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4322 /* Call after-change hooks for the inserted text, aside from the case
4323 of normal visiting (not with REPLACE), which is done in a new buffer
4324 "before" the buffer is changed. */
4325 if (inserted
> 0 && total
> 0
4326 && (NILP (visit
) || !NILP (replace
)))
4328 signal_after_change (PT
, 0, inserted
);
4329 update_compositions (PT
, PT
, CHECK_BORDER
);
4332 /* Now INSERTED is measured in characters. */
4338 if (empty_undo_list_p
)
4339 bset_undo_list (current_buffer
, Qnil
);
4343 current_buffer
->modtime
= mtime
;
4344 current_buffer
->modtime_size
= st
.st_size
;
4345 bset_filename (current_buffer
, orig_filename
);
4348 SAVE_MODIFF
= MODIFF
;
4349 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4350 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4353 if (!NILP (BVAR (current_buffer
, file_truename
)))
4354 unlock_file (BVAR (current_buffer
, file_truename
));
4355 unlock_file (filename
);
4358 xsignal2 (Qfile_error
,
4359 build_string ("not a regular file"), orig_filename
);
4362 if (set_coding_system
)
4363 Vlast_coding_system_used
= coding_system
;
4365 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4367 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4369 if (! NILP (insval
))
4371 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4372 wrong_type_argument (intern ("inserted-chars"), insval
);
4373 inserted
= XFASTINT (insval
);
4377 /* Decode file format. */
4380 /* Don't run point motion or modification hooks when decoding. */
4381 ptrdiff_t old_inserted
= inserted
;
4383 specbind (Qinhibit_point_motion_hooks
, Qt
);
4384 specbind (Qinhibit_modification_hooks
, Qt
);
4386 /* Save old undo list and don't record undo for decoding. */
4387 old_undo
= BVAR (current_buffer
, undo_list
);
4388 bset_undo_list (current_buffer
, Qt
);
4392 insval
= call3 (Qformat_decode
,
4393 Qnil
, make_number (inserted
), visit
);
4394 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4395 wrong_type_argument (intern ("inserted-chars"), insval
);
4396 inserted
= XFASTINT (insval
);
4400 /* If REPLACE is non-nil and we succeeded in not replacing the
4401 beginning or end of the buffer text with the file's contents,
4402 call format-decode with `point' positioned at the beginning
4403 of the buffer and `inserted' equaling the number of
4404 characters in the buffer. Otherwise, format-decode might
4405 fail to correctly analyze the beginning or end of the buffer.
4406 Hence we temporarily save `point' and `inserted' here and
4407 restore `point' iff format-decode did not insert or delete
4408 any text. Otherwise we leave `point' at point-min. */
4409 ptrdiff_t opoint
= PT
;
4410 ptrdiff_t opoint_byte
= PT_BYTE
;
4411 ptrdiff_t oinserted
= ZV
- BEGV
;
4412 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4414 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4415 insval
= call3 (Qformat_decode
,
4416 Qnil
, make_number (oinserted
), visit
);
4417 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4418 wrong_type_argument (intern ("inserted-chars"), insval
);
4419 if (ochars_modiff
== CHARS_MODIFF
)
4420 /* format_decode didn't modify buffer's characters => move
4421 point back to position before inserted text and leave
4422 value of inserted alone. */
4423 SET_PT_BOTH (opoint
, opoint_byte
);
4425 /* format_decode modified buffer's characters => consider
4426 entire buffer changed and leave point at point-min. */
4427 inserted
= XFASTINT (insval
);
4430 /* For consistency with format-decode call these now iff inserted > 0
4431 (martin 2007-06-28). */
4432 p
= Vafter_insert_file_functions
;
4437 insval
= call1 (XCAR (p
), make_number (inserted
));
4440 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4441 wrong_type_argument (intern ("inserted-chars"), insval
);
4442 inserted
= XFASTINT (insval
);
4447 /* For the rationale of this see the comment on
4448 format-decode above. */
4449 ptrdiff_t opoint
= PT
;
4450 ptrdiff_t opoint_byte
= PT_BYTE
;
4451 ptrdiff_t oinserted
= ZV
- BEGV
;
4452 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4454 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4455 insval
= call1 (XCAR (p
), make_number (oinserted
));
4458 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4459 wrong_type_argument (intern ("inserted-chars"), insval
);
4460 if (ochars_modiff
== CHARS_MODIFF
)
4461 /* after_insert_file_functions didn't modify
4462 buffer's characters => move point back to
4463 position before inserted text and leave value of
4465 SET_PT_BOTH (opoint
, opoint_byte
);
4467 /* after_insert_file_functions did modify buffer's
4468 characters => consider entire buffer changed and
4469 leave point at point-min. */
4470 inserted
= XFASTINT (insval
);
4478 if (!empty_undo_list_p
)
4480 bset_undo_list (current_buffer
, old_undo
);
4481 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4483 /* Adjust the last undo record for the size change during
4484 the format conversion. */
4485 Lisp_Object tem
= XCAR (old_undo
);
4486 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4487 && INTEGERP (XCDR (tem
))
4488 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4489 XSETCDR (tem
, make_number (PT
+ inserted
));
4493 /* If undo_list was Qt before, keep it that way.
4494 Otherwise start with an empty undo_list. */
4495 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4501 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4503 /* If visiting nonexistent file, return nil. */
4504 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4507 /* We made a lot of deletions and insertions above, so invalidate
4508 the newline cache for the entire region of the inserted
4510 if (current_buffer
->base_buffer
&& current_buffer
->base_buffer
->newline_cache
)
4511 invalidate_region_cache (current_buffer
->base_buffer
,
4512 current_buffer
->base_buffer
->newline_cache
,
4513 PT
- BEG
, Z
- PT
- inserted
);
4514 else if (current_buffer
->newline_cache
)
4515 invalidate_region_cache (current_buffer
,
4516 current_buffer
->newline_cache
,
4517 PT
- BEG
, Z
- PT
- inserted
);
4520 Fsignal (Qquit
, Qnil
);
4522 /* Retval needs to be dealt with in all cases consistently. */
4524 val
= list2 (orig_filename
, make_number (inserted
));
4530 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4533 build_annotations_unwind (Lisp_Object arg
)
4535 Vwrite_region_annotation_buffers
= arg
;
4538 /* Decide the coding-system to encode the data with. */
4540 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4541 Schoose_write_coding_system
, 3, 6, 0,
4542 doc
: /* Choose the coding system for writing a file.
4543 Arguments are as for `write-region'.
4544 This function is for internal use only. It may prompt the user. */ )
4545 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4546 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4549 Lisp_Object eol_parent
= Qnil
;
4551 /* Mimic write-region behavior. */
4554 XSETFASTINT (start
, BEGV
);
4555 XSETFASTINT (end
, ZV
);
4559 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4560 BVAR (current_buffer
, auto_save_file_name
))))
4565 else if (!NILP (Vcoding_system_for_write
))
4567 val
= Vcoding_system_for_write
;
4568 if (coding_system_require_warning
4569 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4570 /* Confirm that VAL can surely encode the current region. */
4571 val
= call5 (Vselect_safe_coding_system_function
,
4572 start
, end
, list2 (Qt
, val
),
4577 /* If the variable `buffer-file-coding-system' is set locally,
4578 it means that the file was read with some kind of code
4579 conversion or the variable is explicitly set by users. We
4580 had better write it out with the same coding system even if
4581 `enable-multibyte-characters' is nil.
4583 If it is not set locally, we anyway have to convert EOL
4584 format if the default value of `buffer-file-coding-system'
4585 tells that it is not Unix-like (LF only) format. */
4586 bool using_default_coding
= 0;
4587 bool force_raw_text
= 0;
4589 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4591 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4594 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4600 /* Check file-coding-system-alist. */
4601 Lisp_Object args
[7], coding_systems
;
4603 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4604 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4606 coding_systems
= Ffind_operation_coding_system (7, args
);
4607 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4608 val
= XCDR (coding_systems
);
4613 /* If we still have not decided a coding system, use the
4614 default value of buffer-file-coding-system. */
4615 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4616 using_default_coding
= 1;
4619 if (! NILP (val
) && ! force_raw_text
)
4621 Lisp_Object spec
, attrs
;
4623 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4624 attrs
= AREF (spec
, 0);
4625 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4630 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4631 /* Confirm that VAL can surely encode the current region. */
4632 val
= call5 (Vselect_safe_coding_system_function
,
4633 start
, end
, val
, Qnil
, filename
);
4635 /* If the decided coding-system doesn't specify end-of-line
4636 format, we use that of
4637 `default-buffer-file-coding-system'. */
4638 if (! using_default_coding
4639 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4640 val
= (coding_inherit_eol_type
4641 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4643 /* If we decide not to encode text, use `raw-text' or one of its
4646 val
= raw_text_coding_system (val
);
4649 val
= coding_inherit_eol_type (val
, eol_parent
);
4653 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4654 "r\nFWrite region to file: \ni\ni\ni\np",
4655 doc
: /* Write current region into specified file.
4656 When called from a program, requires three arguments:
4657 START, END and FILENAME. START and END are normally buffer positions
4658 specifying the part of the buffer to write.
4659 If START is nil, that means to use the entire buffer contents.
4660 If START is a string, then output that string to the file
4661 instead of any buffer contents; END is ignored.
4663 Optional fourth argument APPEND if non-nil means
4664 append to existing file contents (if any). If it is a number,
4665 seek to that offset in the file before writing.
4666 Optional fifth argument VISIT, if t or a string, means
4667 set the last-save-file-modtime of buffer to this file's modtime
4668 and mark buffer not modified.
4669 If VISIT is a string, it is a second file name;
4670 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4671 VISIT is also the file name to lock and unlock for clash detection.
4672 If VISIT is neither t nor nil nor a string,
4673 that means do not display the \"Wrote file\" message.
4674 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4675 use for locking and unlocking, overriding FILENAME and VISIT.
4676 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4677 for an existing file with the same name. If MUSTBENEW is `excl',
4678 that means to get an error if the file already exists; never overwrite.
4679 If MUSTBENEW is neither nil nor `excl', that means ask for
4680 confirmation before overwriting, but do go ahead and overwrite the file
4681 if the user confirms.
4683 This does code conversion according to the value of
4684 `coding-system-for-write', `buffer-file-coding-system', or
4685 `file-coding-system-alist', and sets the variable
4686 `last-coding-system-used' to the coding system actually used.
4688 This calls `write-region-annotate-functions' at the start, and
4689 `write-region-post-annotation-function' at the end. */)
4690 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4691 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4693 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4697 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4698 descriptor for FILENAME, so do not open or close FILENAME. */
4701 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4702 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4703 Lisp_Object mustbenew
, int desc
)
4707 off_t offset
IF_LINT (= 0);
4708 bool open_and_close_file
= desc
< 0;
4713 struct timespec modtime
;
4714 Lisp_Object handler
;
4715 Lisp_Object visit_file
;
4716 Lisp_Object annotations
;
4717 Lisp_Object encoded_filename
;
4718 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4719 bool quietly
= !NILP (visit
);
4720 bool file_locked
= 0;
4721 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4722 struct buffer
*given_buffer
;
4723 struct coding_system coding
;
4725 if (current_buffer
->base_buffer
&& visiting
)
4726 error ("Cannot do file visiting in an indirect buffer");
4728 if (!NILP (start
) && !STRINGP (start
))
4729 validate_region (&start
, &end
);
4732 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4734 filename
= Fexpand_file_name (filename
, Qnil
);
4736 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4737 barf_or_query_if_file_exists (filename
, false, "overwrite", true, true);
4739 if (STRINGP (visit
))
4740 visit_file
= Fexpand_file_name (visit
, Qnil
);
4742 visit_file
= filename
;
4744 if (NILP (lockname
))
4745 lockname
= visit_file
;
4749 /* If the file name has special constructs in it,
4750 call the corresponding file handler. */
4751 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4752 /* If FILENAME has no handler, see if VISIT has one. */
4753 if (NILP (handler
) && STRINGP (visit
))
4754 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4756 if (!NILP (handler
))
4759 val
= call6 (handler
, Qwrite_region
, start
, end
,
4760 filename
, append
, visit
);
4764 SAVE_MODIFF
= MODIFF
;
4765 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4766 bset_filename (current_buffer
, visit_file
);
4773 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4775 /* Special kludge to simplify auto-saving. */
4778 /* Do it later, so write-region-annotate-function can work differently
4779 if we save "the buffer" vs "a region".
4780 This is useful in tar-mode. --Stef
4781 XSETFASTINT (start, BEG);
4782 XSETFASTINT (end, Z); */
4786 record_unwind_protect (build_annotations_unwind
,
4787 Vwrite_region_annotation_buffers
);
4788 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4790 given_buffer
= current_buffer
;
4792 if (!STRINGP (start
))
4794 annotations
= build_annotations (start
, end
);
4796 if (current_buffer
!= given_buffer
)
4798 XSETFASTINT (start
, BEGV
);
4799 XSETFASTINT (end
, ZV
);
4805 XSETFASTINT (start
, BEGV
);
4806 XSETFASTINT (end
, ZV
);
4811 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4813 /* Decide the coding-system to encode the data with.
4814 We used to make this choice before calling build_annotations, but that
4815 leads to problems when a write-annotate-function takes care of
4816 unsavable chars (as was the case with X-Symbol). */
4817 Vlast_coding_system_used
=
4818 Fchoose_write_coding_system (start
, end
, filename
,
4819 append
, visit
, lockname
);
4821 setup_coding_system (Vlast_coding_system_used
, &coding
);
4823 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4824 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4826 if (open_and_close_file
&& !auto_saving
)
4828 lock_file (lockname
);
4832 encoded_filename
= ENCODE_FILE (filename
);
4833 fn
= SSDATA (encoded_filename
);
4834 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4835 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4836 if (NUMBERP (append
))
4837 offset
= file_offset (append
);
4838 else if (!NILP (append
))
4839 open_flags
|= O_APPEND
;
4841 mode
= S_IREAD
| S_IWRITE
;
4843 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4846 if (open_and_close_file
)
4848 desc
= emacs_open (fn
, open_flags
, mode
);
4851 int open_errno
= errno
;
4853 unlock_file (lockname
);
4855 report_file_errno ("Opening output file", filename
, open_errno
);
4859 record_unwind_protect_int_1 (close_file_unwind
, desc
, false);
4862 if (NUMBERP (append
))
4864 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4867 int lseek_errno
= errno
;
4869 unlock_file (lockname
);
4871 report_file_errno ("Lseek error", filename
, lseek_errno
);
4879 if (STRINGP (start
))
4880 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4881 else if (XINT (start
) != XINT (end
))
4882 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4883 &annotations
, &coding
);
4886 /* If file was empty, still need to write the annotations. */
4887 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4888 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4892 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4893 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4895 /* We have to flush out a data. */
4896 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4897 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4903 /* fsync is not crucial for temporary files. Nor for auto-save
4904 files, since they might lose some work anyway. */
4905 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4907 /* Transfer data and metadata to disk, retrying if interrupted.
4908 fsync can report a write failure here, e.g., due to disk full
4909 under NFS. But ignore EINVAL, which means fsync is not
4910 supported on this file. */
4911 while (fsync (desc
) != 0)
4914 if (errno
!= EINVAL
)
4915 ok
= 0, save_errno
= errno
;
4920 modtime
= invalid_timespec ();
4923 if (fstat (desc
, &st
) == 0)
4924 modtime
= get_stat_mtime (&st
);
4926 ok
= 0, save_errno
= errno
;
4929 if (open_and_close_file
)
4931 /* NFS can report a write failure now. */
4932 if (emacs_close (desc
) < 0)
4933 ok
= 0, save_errno
= errno
;
4938 /* Some file systems have a bug where st_mtime is not updated
4939 properly after a write. For example, CIFS might not see the
4940 st_mtime change until after the file is opened again.
4942 Attempt to detect this file system bug, and update MODTIME to the
4943 newer st_mtime if the bug appears to be present. This introduces
4944 a race condition, so to avoid most instances of the race condition
4945 on non-buggy file systems, skip this check if the most recently
4946 encountered non-buggy file system was the current file system.
4948 A race condition can occur if some other process modifies the
4949 file between the fstat above and the fstat below, but the race is
4950 unlikely and a similar race between the last write and the fstat
4951 above cannot possibly be closed anyway. */
4953 if (timespec_valid_p (modtime
)
4954 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4956 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4960 if (fstat (desc1
, &st1
) == 0
4961 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4963 /* Use the heuristic if it appears to be valid. With neither
4964 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4965 file, the time stamp won't change. Also, some non-POSIX
4966 systems don't update an empty file's time stamp when
4967 truncating it. Finally, file systems with 100 ns or worse
4968 resolution sometimes seem to have bugs: on a system with ns
4969 resolution, checking ns % 100 incorrectly avoids the heuristic
4970 1% of the time, but the problem should be temporary as we will
4971 try again on the next time stamp. */
4973 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4975 && modtime
.tv_nsec
% 100 != 0);
4977 struct timespec modtime1
= get_stat_mtime (&st1
);
4979 && timespec_cmp (modtime
, modtime1
) == 0
4980 && st
.st_size
== st1
.st_size
)
4982 timestamp_file_system
= st
.st_dev
;
4983 valid_timestamp_file_system
= 1;
4987 st
.st_size
= st1
.st_size
;
4991 emacs_close (desc1
);
4995 /* Call write-region-post-annotation-function. */
4996 while (CONSP (Vwrite_region_annotation_buffers
))
4998 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4999 if (!NILP (Fbuffer_live_p (buf
)))
5002 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5003 call0 (Vwrite_region_post_annotation_function
);
5005 Vwrite_region_annotation_buffers
5006 = XCDR (Vwrite_region_annotation_buffers
);
5012 unlock_file (lockname
);
5014 /* Do this before reporting IO error
5015 to avoid a "file has changed on disk" warning on
5016 next attempt to save. */
5017 if (timespec_valid_p (modtime
))
5019 current_buffer
->modtime
= modtime
;
5020 current_buffer
->modtime_size
= st
.st_size
;
5024 report_file_errno ("Write error", filename
, save_errno
);
5028 SAVE_MODIFF
= MODIFF
;
5029 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5030 bset_filename (current_buffer
, visit_file
);
5031 update_mode_lines
= 14;
5036 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5037 BVAR (current_buffer
, auto_save_file_name
))))
5038 SAVE_MODIFF
= MODIFF
;
5044 message_with_string ((NUMBERP (append
)
5054 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5055 doc
: /* Return t if (car A) is numerically less than (car B). */)
5056 (Lisp_Object a
, Lisp_Object b
)
5058 Lisp_Object args
[2];
5061 return Flss (2, args
);
5064 /* Build the complete list of annotations appropriate for writing out
5065 the text between START and END, by calling all the functions in
5066 write-region-annotate-functions and merging the lists they return.
5067 If one of these functions switches to a different buffer, we assume
5068 that buffer contains altered text. Therefore, the caller must
5069 make sure to restore the current buffer in all cases,
5070 as save-excursion would do. */
5073 build_annotations (Lisp_Object start
, Lisp_Object end
)
5075 Lisp_Object annotations
;
5077 struct gcpro gcpro1
, gcpro2
;
5078 Lisp_Object original_buffer
;
5080 bool used_global
= 0;
5082 XSETBUFFER (original_buffer
, current_buffer
);
5085 p
= Vwrite_region_annotate_functions
;
5086 GCPRO2 (annotations
, p
);
5089 struct buffer
*given_buffer
= current_buffer
;
5090 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5091 { /* Use the global value of the hook. */
5094 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5096 p
= Fappend (2, arg
);
5099 Vwrite_region_annotations_so_far
= annotations
;
5100 res
= call2 (XCAR (p
), start
, end
);
5101 /* If the function makes a different buffer current,
5102 assume that means this buffer contains altered text to be output.
5103 Reset START and END from the buffer bounds
5104 and discard all previous annotations because they should have
5105 been dealt with by this function. */
5106 if (current_buffer
!= given_buffer
)
5108 Vwrite_region_annotation_buffers
5109 = Fcons (Fcurrent_buffer (),
5110 Vwrite_region_annotation_buffers
);
5111 XSETFASTINT (start
, BEGV
);
5112 XSETFASTINT (end
, ZV
);
5115 Flength (res
); /* Check basic validity of return value */
5116 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5120 /* Now do the same for annotation functions implied by the file-format */
5121 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5122 p
= BVAR (current_buffer
, auto_save_file_format
);
5124 p
= BVAR (current_buffer
, file_format
);
5125 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5127 struct buffer
*given_buffer
= current_buffer
;
5129 Vwrite_region_annotations_so_far
= annotations
;
5131 /* Value is either a list of annotations or nil if the function
5132 has written annotations to a temporary buffer, which is now
5134 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5135 original_buffer
, make_number (i
));
5136 if (current_buffer
!= given_buffer
)
5138 XSETFASTINT (start
, BEGV
);
5139 XSETFASTINT (end
, ZV
);
5144 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5152 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5153 If STRING is nil, POS is the character position in the current buffer.
5154 Intersperse with them the annotations from *ANNOT
5155 which fall within the range of POS to POS + NCHARS,
5156 each at its appropriate position.
5158 We modify *ANNOT by discarding elements as we use them up.
5160 Return true if successful. */
5163 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5164 ptrdiff_t nchars
, Lisp_Object
*annot
,
5165 struct coding_system
*coding
)
5169 ptrdiff_t lastpos
= pos
+ nchars
;
5171 while (NILP (*annot
) || CONSP (*annot
))
5173 tem
= Fcar_safe (Fcar (*annot
));
5176 nextpos
= XFASTINT (tem
);
5178 /* If there are no more annotations in this range,
5179 output the rest of the range all at once. */
5180 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5181 return e_write (desc
, string
, pos
, lastpos
, coding
);
5183 /* Output buffer text up to the next annotation's position. */
5186 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5190 /* Output the annotation. */
5191 tem
= Fcdr (Fcar (*annot
));
5194 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5197 *annot
= Fcdr (*annot
);
5202 /* Maximum number of characters that the next
5203 function encodes per one loop iteration. */
5205 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5207 /* Write text in the range START and END into descriptor DESC,
5208 encoding them with coding system CODING. If STRING is nil, START
5209 and END are character positions of the current buffer, else they
5210 are indexes to the string STRING. Return true if successful. */
5213 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5214 struct coding_system
*coding
)
5216 if (STRINGP (string
))
5219 end
= SCHARS (string
);
5222 /* We used to have a code for handling selective display here. But,
5223 now it is handled within encode_coding. */
5227 if (STRINGP (string
))
5229 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5230 if (CODING_REQUIRE_ENCODING (coding
))
5232 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5234 /* Avoid creating huge Lisp string in encode_coding_object. */
5235 if (nchars
== E_WRITE_MAX
)
5236 coding
->raw_destination
= 1;
5238 encode_coding_object
5239 (coding
, string
, start
, string_char_to_byte (string
, start
),
5240 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5245 coding
->dst_object
= string
;
5246 coding
->consumed_char
= SCHARS (string
);
5247 coding
->produced
= SBYTES (string
);
5252 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5253 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5255 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5256 if (CODING_REQUIRE_ENCODING (coding
))
5258 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5261 if (nchars
== E_WRITE_MAX
)
5262 coding
->raw_destination
= 1;
5264 encode_coding_object
5265 (coding
, Fcurrent_buffer (), start
, start_byte
,
5266 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5270 coding
->dst_object
= Qnil
;
5271 coding
->dst_pos_byte
= start_byte
;
5272 if (start
>= GPT
|| end
<= GPT
)
5274 coding
->consumed_char
= end
- start
;
5275 coding
->produced
= end_byte
- start_byte
;
5279 coding
->consumed_char
= GPT
- start
;
5280 coding
->produced
= GPT_BYTE
- start_byte
;
5285 if (coding
->produced
> 0)
5287 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5288 : (STRINGP (coding
->dst_object
)
5289 ? SSDATA (coding
->dst_object
)
5290 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5291 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5293 if (coding
->raw_destination
)
5295 /* We're responsible for freeing this, see
5296 encode_coding_object to check why. */
5297 xfree (coding
->destination
);
5298 coding
->raw_destination
= 0;
5300 if (coding
->produced
)
5303 start
+= coding
->consumed_char
;
5309 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5310 Sverify_visited_file_modtime
, 0, 1, 0,
5311 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5312 This means that the file has not been changed since it was visited or saved.
5313 If BUF is omitted or nil, it defaults to the current buffer.
5314 See Info node `(elisp)Modification Time' for more details. */)
5319 Lisp_Object handler
;
5320 Lisp_Object filename
;
5321 struct timespec mtime
;
5331 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5332 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5334 /* If the file name has special constructs in it,
5335 call the corresponding file handler. */
5336 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5337 Qverify_visited_file_modtime
);
5338 if (!NILP (handler
))
5339 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5341 filename
= ENCODE_FILE (BVAR (b
, filename
));
5343 mtime
= (stat (SSDATA (filename
), &st
) == 0
5344 ? get_stat_mtime (&st
)
5345 : time_error_value (errno
));
5346 if (timespec_cmp (mtime
, b
->modtime
) == 0
5347 && (b
->modtime_size
< 0
5348 || st
.st_size
== b
->modtime_size
))
5353 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5354 Svisited_file_modtime
, 0, 0, 0,
5355 doc
: /* Return the current buffer's recorded visited file modification time.
5356 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5357 `file-attributes' returns. If the current buffer has no recorded file
5358 modification time, this function returns 0. If the visited file
5359 doesn't exist, return -1.
5360 See Info node `(elisp)Modification Time' for more details. */)
5363 int ns
= current_buffer
->modtime
.tv_nsec
;
5365 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5366 return make_lisp_time (current_buffer
->modtime
);
5369 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5370 Sset_visited_file_modtime
, 0, 1, 0,
5371 doc
: /* Update buffer's recorded modification time from the visited file's time.
5372 Useful if the buffer was not read from the file normally
5373 or if the file itself has been changed for some known benign reason.
5374 An argument specifies the modification time value to use
5375 \(instead of that of the visited file), in the form of a list
5376 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5377 `visited-file-modtime'. */)
5378 (Lisp_Object time_flag
)
5380 if (!NILP (time_flag
))
5382 struct timespec mtime
;
5383 if (INTEGERP (time_flag
))
5385 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5386 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5389 mtime
= lisp_time_argument (time_flag
);
5391 current_buffer
->modtime
= mtime
;
5392 current_buffer
->modtime_size
= -1;
5396 register Lisp_Object filename
;
5398 Lisp_Object handler
;
5400 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5402 /* If the file name has special constructs in it,
5403 call the corresponding file handler. */
5404 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5405 if (!NILP (handler
))
5406 /* The handler can find the file name the same way we did. */
5407 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5409 filename
= ENCODE_FILE (filename
);
5411 if (stat (SSDATA (filename
), &st
) >= 0)
5413 current_buffer
->modtime
= get_stat_mtime (&st
);
5414 current_buffer
->modtime_size
= st
.st_size
;
5422 auto_save_error (Lisp_Object error_val
)
5424 Lisp_Object args
[3], msg
;
5426 struct gcpro gcpro1
;
5428 auto_save_error_occurred
= 1;
5430 ring_bell (XFRAME (selected_frame
));
5432 args
[0] = build_string ("Auto-saving %s: %s");
5433 args
[1] = BVAR (current_buffer
, name
);
5434 args
[2] = Ferror_message_string (error_val
);
5435 msg
= Fformat (3, args
);
5438 for (i
= 0; i
< 3; ++i
)
5443 message3_nolog (msg
);
5444 Fsleep_for (make_number (1), Qnil
);
5457 auto_save_mode_bits
= 0666;
5459 /* Get visited file's mode to become the auto save file's mode. */
5460 if (! NILP (BVAR (current_buffer
, filename
)))
5462 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5463 /* But make sure we can overwrite it later! */
5464 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5465 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5467 /* Remote files don't cooperate with stat. */
5468 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5472 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5473 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5477 struct auto_save_unwind
5484 do_auto_save_unwind (void *arg
)
5486 struct auto_save_unwind
*p
= arg
;
5487 FILE *stream
= p
->stream
;
5488 minibuffer_auto_raise
= p
->auto_raise
;
5499 do_auto_save_make_dir (Lisp_Object dir
)
5503 auto_saving_dir_umask
= 077;
5504 result
= call2 (Qmake_directory
, dir
, Qt
);
5505 auto_saving_dir_umask
= 0;
5510 do_auto_save_eh (Lisp_Object ignore
)
5512 auto_saving_dir_umask
= 0;
5516 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5517 doc
: /* Auto-save all buffers that need it.
5518 This is all buffers that have auto-saving enabled
5519 and are changed since last auto-saved.
5520 Auto-saving writes the buffer into a file
5521 so that your editing is not lost if the system crashes.
5522 This file is not the file you visited; that changes only when you save.
5523 Normally we run the normal hook `auto-save-hook' before saving.
5525 A non-nil NO-MESSAGE argument means do not print any message if successful.
5526 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5527 (Lisp_Object no_message
, Lisp_Object current_only
)
5529 struct buffer
*old
= current_buffer
, *b
;
5530 Lisp_Object tail
, buf
, hook
;
5531 bool auto_saved
= 0;
5532 int do_handled_files
;
5534 FILE *stream
= NULL
;
5535 ptrdiff_t count
= SPECPDL_INDEX ();
5536 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5537 bool old_message_p
= 0;
5538 struct auto_save_unwind auto_save_unwind
;
5539 struct gcpro gcpro1
, gcpro2
;
5541 if (max_specpdl_size
< specpdl_size
+ 40)
5542 max_specpdl_size
= specpdl_size
+ 40;
5547 if (NILP (no_message
))
5549 old_message_p
= push_message ();
5550 record_unwind_protect_void (pop_message_unwind
);
5553 /* Ordinarily don't quit within this function,
5554 but don't make it impossible to quit (in case we get hung in I/O). */
5558 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5559 point to non-strings reached from Vbuffer_alist. */
5561 hook
= intern ("auto-save-hook");
5562 safe_run_hooks (hook
);
5564 if (STRINGP (Vauto_save_list_file_name
))
5566 Lisp_Object listfile
;
5568 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5570 /* Don't try to create the directory when shutting down Emacs,
5571 because creating the directory might signal an error, and
5572 that would leave Emacs in a strange state. */
5573 if (!NILP (Vrun_hooks
))
5577 GCPRO2 (dir
, listfile
);
5578 dir
= Ffile_name_directory (listfile
);
5579 if (NILP (Ffile_directory_p (dir
)))
5580 internal_condition_case_1 (do_auto_save_make_dir
,
5586 stream
= emacs_fopen (SSDATA (listfile
), "w");
5589 auto_save_unwind
.stream
= stream
;
5590 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5591 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5592 minibuffer_auto_raise
= 0;
5594 auto_save_error_occurred
= 0;
5596 /* On first pass, save all files that don't have handlers.
5597 On second pass, save all files that do have handlers.
5599 If Emacs is crashing, the handlers may tweak what is causing
5600 Emacs to crash in the first place, and it would be a shame if
5601 Emacs failed to autosave perfectly ordinary files because it
5602 couldn't handle some ange-ftp'd file. */
5604 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5605 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5609 /* Record all the buffers that have auto save mode
5610 in the special file that lists them. For each of these buffers,
5611 Record visited name (if any) and auto save name. */
5612 if (STRINGP (BVAR (b
, auto_save_file_name
))
5613 && stream
!= NULL
&& do_handled_files
== 0)
5616 if (!NILP (BVAR (b
, filename
)))
5618 fwrite (SDATA (BVAR (b
, filename
)), 1,
5619 SBYTES (BVAR (b
, filename
)), stream
);
5621 putc ('\n', stream
);
5622 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5623 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5624 putc ('\n', stream
);
5628 if (!NILP (current_only
)
5629 && b
!= current_buffer
)
5632 /* Don't auto-save indirect buffers.
5633 The base buffer takes care of it. */
5637 /* Check for auto save enabled
5638 and file changed since last auto save
5639 and file changed since last real save. */
5640 if (STRINGP (BVAR (b
, auto_save_file_name
))
5641 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5642 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5643 /* -1 means we've turned off autosaving for a while--see below. */
5644 && XINT (BVAR (b
, save_length
)) >= 0
5645 && (do_handled_files
5646 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5649 struct timespec before_time
= current_timespec ();
5650 struct timespec after_time
;
5652 /* If we had a failure, don't try again for 20 minutes. */
5653 if (b
->auto_save_failure_time
> 0
5654 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5657 set_buffer_internal (b
);
5658 if (NILP (Vauto_save_include_big_deletions
)
5659 && (XFASTINT (BVAR (b
, save_length
)) * 10
5660 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5661 /* A short file is likely to change a large fraction;
5662 spare the user annoying messages. */
5663 && XFASTINT (BVAR (b
, save_length
)) > 5000
5664 /* These messages are frequent and annoying for `*mail*'. */
5665 && !EQ (BVAR (b
, filename
), Qnil
)
5666 && NILP (no_message
))
5668 /* It has shrunk too much; turn off auto-saving here. */
5669 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5670 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5672 minibuffer_auto_raise
= 0;
5673 /* Turn off auto-saving until there's a real save,
5674 and prevent any more warnings. */
5675 XSETINT (BVAR (b
, save_length
), -1);
5676 Fsleep_for (make_number (1), Qnil
);
5679 if (!auto_saved
&& NILP (no_message
))
5680 message1 ("Auto-saving...");
5681 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5683 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5684 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5685 set_buffer_internal (old
);
5687 after_time
= current_timespec ();
5689 /* If auto-save took more than 60 seconds,
5690 assume it was an NFS failure that got a timeout. */
5691 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5692 b
->auto_save_failure_time
= after_time
.tv_sec
;
5696 /* Prevent another auto save till enough input events come in. */
5697 record_auto_save ();
5699 if (auto_saved
&& NILP (no_message
))
5703 /* If we are going to restore an old message,
5704 give time to read ours. */
5705 sit_for (make_number (1), 0, 0);
5708 else if (!auto_save_error_occurred
)
5709 /* Don't overwrite the error message if an error occurred.
5710 If we displayed a message and then restored a state
5711 with no message, leave a "done" message on the screen. */
5712 message1 ("Auto-saving...done");
5717 /* This restores the message-stack status. */
5718 unbind_to (count
, Qnil
);
5722 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5723 Sset_buffer_auto_saved
, 0, 0, 0,
5724 doc
: /* Mark current buffer as auto-saved with its current text.
5725 No auto-save file will be written until the buffer changes again. */)
5728 /* FIXME: This should not be called in indirect buffers, since
5729 they're not autosaved. */
5730 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5731 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5732 current_buffer
->auto_save_failure_time
= 0;
5736 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5737 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5738 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5741 current_buffer
->auto_save_failure_time
= 0;
5745 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5747 doc
: /* Return t if current buffer has been auto-saved recently.
5748 More precisely, if it has been auto-saved since last read from or saved
5749 in the visited file. If the buffer has no visited file,
5750 then any auto-save counts as "recent". */)
5753 /* FIXME: maybe we should return nil for indirect buffers since
5754 they're never autosaved. */
5755 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5758 /* Reading and completing file names */
5760 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5761 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5762 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5763 The return value is only relevant for a call to `read-file-name' that happens
5764 before any other event (mouse or keypress) is handled. */)
5767 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5768 || defined (HAVE_NS)
5769 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5772 && window_system_available (SELECTED_FRAME ()))
5781 realmask
= umask (0);
5784 valid_timestamp_file_system
= 0;
5786 /* fsync can be a significant performance hit. Often it doesn't
5787 suffice to make the file-save operation survive a crash. For
5788 batch scripts, which are typically part of larger shell commands
5789 that don't fsync other files, its effect on performance can be
5790 significant so its utility is particularly questionable.
5791 Hence, for now by default fsync is used only when interactive.
5793 For more on why fsync often fails to work on today's hardware, see:
5794 Zheng M et al. Understanding the robustness of SSDs under power fault.
5795 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5796 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5798 For more on why fsync does not suffice even if it works properly, see:
5799 Roche X. Necessary step(s) to synchronize filename operations on disk.
5800 Austin Group Defect 672, 2013-03-19
5801 http://austingroupbugs.net/view.php?id=672 */
5802 write_region_inhibit_fsync
= noninteractive
;
5806 syms_of_fileio (void)
5810 DEFSYM (Qoperations
, "operations");
5811 DEFSYM (Qexpand_file_name
, "expand-file-name");
5812 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5813 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5814 DEFSYM (Qfile_name_directory
, "file-name-directory");
5815 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5816 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5817 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5818 DEFSYM (Qcopy_file
, "copy-file");
5819 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5820 DEFSYM (Qmake_directory
, "make-directory");
5821 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5822 DEFSYM (Qdelete_file
, "delete-file");
5823 DEFSYM (Qrename_file
, "rename-file");
5824 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5825 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5826 DEFSYM (Qfile_exists_p
, "file-exists-p");
5827 DEFSYM (Qfile_executable_p
, "file-executable-p");
5828 DEFSYM (Qfile_readable_p
, "file-readable-p");
5829 DEFSYM (Qfile_writable_p
, "file-writable-p");
5830 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5831 DEFSYM (Qaccess_file
, "access-file");
5832 DEFSYM (Qfile_directory_p
, "file-directory-p");
5833 DEFSYM (Qfile_regular_p
, "file-regular-p");
5834 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5835 DEFSYM (Qfile_modes
, "file-modes");
5836 DEFSYM (Qset_file_modes
, "set-file-modes");
5837 DEFSYM (Qset_file_times
, "set-file-times");
5838 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5839 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5840 DEFSYM (Qfile_acl
, "file-acl");
5841 DEFSYM (Qset_file_acl
, "set-file-acl");
5842 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5843 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5844 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5845 DEFSYM (Qwrite_region
, "write-region");
5846 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5847 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5848 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5850 DEFSYM (Qfile_name_history
, "file-name-history");
5851 Fset (Qfile_name_history
, Qnil
);
5853 DEFSYM (Qfile_error
, "file-error");
5854 DEFSYM (Qfile_already_exists
, "file-already-exists");
5855 DEFSYM (Qfile_date_error
, "file-date-error");
5856 DEFSYM (Qfile_notify_error
, "file-notify-error");
5857 DEFSYM (Qexcl
, "excl");
5859 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5860 doc
: /* Coding system for encoding file names.
5861 If it is nil, `default-file-name-coding-system' (which see) is used.
5863 On MS-Windows, the value of this variable is largely ignored if
5864 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5865 behaves as if file names were encoded in `utf-8'. */);
5866 Vfile_name_coding_system
= Qnil
;
5868 DEFVAR_LISP ("default-file-name-coding-system",
5869 Vdefault_file_name_coding_system
,
5870 doc
: /* Default coding system for encoding file names.
5871 This variable is used only when `file-name-coding-system' is nil.
5873 This variable is set/changed by the command `set-language-environment'.
5874 User should not set this variable manually,
5875 instead use `file-name-coding-system' to get a constant encoding
5876 of file names regardless of the current language environment.
5878 On MS-Windows, the value of this variable is largely ignored if
5879 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5880 behaves as if file names were encoded in `utf-8'. */);
5881 Vdefault_file_name_coding_system
= Qnil
;
5883 DEFSYM (Qformat_decode
, "format-decode");
5884 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5885 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5886 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5888 Fput (Qfile_error
, Qerror_conditions
,
5889 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5890 Fput (Qfile_error
, Qerror_message
,
5891 build_pure_c_string ("File error"));
5893 Fput (Qfile_already_exists
, Qerror_conditions
,
5894 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5895 Fput (Qfile_already_exists
, Qerror_message
,
5896 build_pure_c_string ("File already exists"));
5898 Fput (Qfile_date_error
, Qerror_conditions
,
5899 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5900 Fput (Qfile_date_error
, Qerror_message
,
5901 build_pure_c_string ("Cannot set file date"));
5903 Fput (Qfile_notify_error
, Qerror_conditions
,
5904 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5905 Fput (Qfile_notify_error
, Qerror_message
,
5906 build_pure_c_string ("File notification error"));
5908 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5909 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5910 If a file name matches REGEXP, all I/O on that file is done by calling
5911 HANDLER. If a file name matches more than one handler, the handler
5912 whose match starts last in the file name gets precedence. The
5913 function `find-file-name-handler' checks this list for a handler for
5916 HANDLER should be a function. The first argument given to it is the
5917 name of the I/O primitive to be handled; the remaining arguments are
5918 the arguments that were passed to that primitive. For example, if you
5919 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5920 HANDLER is called like this:
5922 (funcall HANDLER 'file-exists-p FILENAME)
5924 Note that HANDLER must be able to handle all I/O primitives; if it has
5925 nothing special to do for a primitive, it should reinvoke the
5926 primitive to handle the operation \"the usual way\".
5927 See Info node `(elisp)Magic File Names' for more details. */);
5928 Vfile_name_handler_alist
= Qnil
;
5930 DEFVAR_LISP ("set-auto-coding-function",
5931 Vset_auto_coding_function
,
5932 doc
: /* If non-nil, a function to call to decide a coding system of file.
5933 Two arguments are passed to this function: the file name
5934 and the length of a file contents following the point.
5935 This function should return a coding system to decode the file contents.
5936 It should check the file name against `auto-coding-alist'.
5937 If no coding system is decided, it should check a coding system
5938 specified in the heading lines with the format:
5939 -*- ... coding: CODING-SYSTEM; ... -*-
5940 or local variable spec of the tailing lines with `coding:' tag. */);
5941 Vset_auto_coding_function
= Qnil
;
5943 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5944 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5945 Each is passed one argument, the number of characters inserted,
5946 with point at the start of the inserted text. Each function
5947 should leave point the same, and return the new character count.
5948 If `insert-file-contents' is intercepted by a handler from
5949 `file-name-handler-alist', that handler is responsible for calling the
5950 functions in `after-insert-file-functions' if appropriate. */);
5951 Vafter_insert_file_functions
= Qnil
;
5953 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5954 doc
: /* A list of functions to be called at the start of `write-region'.
5955 Each is passed two arguments, START and END as for `write-region'.
5956 These are usually two numbers but not always; see the documentation
5957 for `write-region'. The function should return a list of pairs
5958 of the form (POSITION . STRING), consisting of strings to be effectively
5959 inserted at the specified positions of the file being written (1 means to
5960 insert before the first byte written). The POSITIONs must be sorted into
5963 If there are several annotation functions, the lists returned by these
5964 functions are merged destructively. As each annotation function runs,
5965 the variable `write-region-annotations-so-far' contains a list of all
5966 annotations returned by previous annotation functions.
5968 An annotation function can return with a different buffer current.
5969 Doing so removes the annotations returned by previous functions, and
5970 resets START and END to `point-min' and `point-max' of the new buffer.
5972 After `write-region' completes, Emacs calls the function stored in
5973 `write-region-post-annotation-function', once for each buffer that was
5974 current when building the annotations (i.e., at least once), with that
5975 buffer current. */);
5976 Vwrite_region_annotate_functions
= Qnil
;
5977 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5979 DEFVAR_LISP ("write-region-post-annotation-function",
5980 Vwrite_region_post_annotation_function
,
5981 doc
: /* Function to call after `write-region' completes.
5982 The function is called with no arguments. If one or more of the
5983 annotation functions in `write-region-annotate-functions' changed the
5984 current buffer, the function stored in this variable is called for
5985 each of those additional buffers as well, in addition to the original
5986 buffer. The relevant buffer is current during each function call. */);
5987 Vwrite_region_post_annotation_function
= Qnil
;
5988 staticpro (&Vwrite_region_annotation_buffers
);
5990 DEFVAR_LISP ("write-region-annotations-so-far",
5991 Vwrite_region_annotations_so_far
,
5992 doc
: /* When an annotation function is called, this holds the previous annotations.
5993 These are the annotations made by other annotation functions
5994 that were already called. See also `write-region-annotate-functions'. */);
5995 Vwrite_region_annotations_so_far
= Qnil
;
5997 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5998 doc
: /* A list of file name handlers that temporarily should not be used.
5999 This applies only to the operation `inhibit-file-name-operation'. */);
6000 Vinhibit_file_name_handlers
= Qnil
;
6002 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6003 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6004 Vinhibit_file_name_operation
= Qnil
;
6006 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6007 doc
: /* File name in which we write a list of all auto save file names.
6008 This variable is initialized automatically from `auto-save-list-file-prefix'
6009 shortly after Emacs reads your init file, if you have not yet given it
6010 a non-nil value. */);
6011 Vauto_save_list_file_name
= Qnil
;
6013 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6014 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6015 Normally auto-save files are written under other names. */);
6016 Vauto_save_visited_file_name
= Qnil
;
6018 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6019 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6020 If nil, deleting a substantial portion of the text disables auto-save
6021 in the buffer; this is the default behavior, because the auto-save
6022 file is usually more useful if it contains the deleted text. */);
6023 Vauto_save_include_big_deletions
= Qnil
;
6025 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6026 doc
: /* Non-nil means don't call fsync in `write-region'.
6027 This variable affects calls to `write-region' as well as save commands.
6028 Setting this to nil may avoid data loss if the system loses power or
6029 the operating system crashes. By default, it is non-nil in batch mode. */);
6030 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6032 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6033 doc
: /* Specifies whether to use the system's trash can.
6034 When non-nil, certain file deletion commands use the function
6035 `move-file-to-trash' instead of deleting files outright.
6036 This includes interactive calls to `delete-file' and
6037 `delete-directory' and the Dired deletion commands. */);
6038 delete_by_moving_to_trash
= 0;
6039 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6041 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6042 DEFSYM (Qcopy_directory
, "copy-directory");
6043 DEFSYM (Qdelete_directory
, "delete-directory");
6044 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");