1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
39 #ifdef HAVE_ACL_SET_FILE
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
52 #include "region-cache.h"
54 #include "dispextern.h"
61 #endif /* not WINDOWSNT */
65 #include <sys/param.h>
69 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
70 redirector allows the six letters between 'Z' and 'a' as well. */
72 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
75 #define IS_DRIVE(x) c_isalpha (x)
77 /* Need to lower-case the drive letter, or else expanded
78 filenames will sometimes compare unequal, because
79 `expand-file-name' doesn't always down-case the drive letter. */
80 #define DRIVE_LETTER(x) c_tolower (x)
85 #include <allocator.h>
86 #include <careadlinkat.h>
87 #include <stat-time.h>
95 /* True during writing of auto-save files. */
96 static bool auto_saving
;
98 /* Nonzero umask during creation of auto-save directories. */
99 static mode_t auto_saving_dir_umask
;
101 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
102 a new file with the same mode as the original. */
103 static mode_t auto_save_mode_bits
;
105 /* Set by auto_save_1 if an error occurred during the last auto-save. */
106 static bool auto_save_error_occurred
;
108 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
109 number of a file system where time stamps were observed to to work. */
110 static bool valid_timestamp_file_system
;
111 static dev_t timestamp_file_system
;
113 /* The symbol bound to coding-system-for-read when
114 insert-file-contents is called for recovering a file. This is not
115 an actual coding system name, but just an indicator to tell
116 insert-file-contents to use `emacs-mule' with a special flag for
117 auto saving and recovering a file. */
118 static Lisp_Object Qauto_save_coding
;
120 /* Property name of a file name handler,
121 which gives a list of operations it handles.. */
122 static Lisp_Object Qoperations
;
124 /* Lisp functions for translating file formats. */
125 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
127 /* Lisp function for setting buffer-file-coding-system and the
128 multibyteness of the current buffer after inserting a file. */
129 static Lisp_Object Qafter_insert_file_set_coding
;
131 static Lisp_Object Qwrite_region_annotate_functions
;
132 /* Each time an annotation function changes the buffer, the new buffer
134 static Lisp_Object Vwrite_region_annotation_buffers
;
136 static Lisp_Object Qdelete_by_moving_to_trash
;
138 /* Lisp function for moving files to trash. */
139 static Lisp_Object Qmove_file_to_trash
;
141 /* Lisp function for recursively copying directories. */
142 static Lisp_Object Qcopy_directory
;
144 /* Lisp function for recursively deleting directories. */
145 static Lisp_Object Qdelete_directory
;
147 static Lisp_Object Qsubstitute_env_in_file_name
;
152 Lisp_Object Qfile_error
, Qfile_notify_error
;
153 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
154 static Lisp_Object Qexcl
;
155 Lisp_Object Qfile_name_history
;
157 static Lisp_Object Qcar_less_than_car
;
159 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
160 Lisp_Object
*, struct coding_system
*);
161 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
162 struct coding_system
*);
165 /* Return true if FILENAME exists. */
168 check_existing (const char *filename
)
170 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
173 /* Return true if file FILENAME exists and can be executed. */
176 check_executable (char *filename
)
178 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
181 /* Return true if file FILENAME exists and can be accessed
182 according to AMODE, which should include W_OK.
183 On failure, return false and set errno. */
186 check_writable (const char *filename
, int amode
)
189 /* FIXME: an faccessat implementation should be added to the
190 DOS/Windows ports and this #ifdef branch should be removed. */
192 if (stat (filename
, &st
) < 0)
195 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
196 #else /* not MSDOS */
197 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
199 /* faccessat may have returned failure because Cygwin couldn't
200 determine the file's UID or GID; if so, we return success. */
203 int faccessat_errno
= errno
;
205 if (stat (filename
, &st
) < 0)
207 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
208 errno
= faccessat_errno
;
212 #endif /* not MSDOS */
215 /* Signal a file-access failure. STRING describes the failure,
216 NAME the file involved, and ERRORNO the errno value.
218 If NAME is neither null nor a pair, package it up as a singleton
219 list before reporting it; this saves report_file_errno's caller the
220 trouble of preserving errno before calling list1. */
223 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
225 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
226 Lisp_Object errstring
;
229 synchronize_system_messages_locale ();
230 str
= strerror (errorno
);
231 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
232 Vlocale_coding_system
, 0);
238 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
241 /* System error messages are capitalized. Downcase the initial
242 unless it is followed by a slash. (The slash case caters to
243 error messages that begin with "I/O" or, in German, "E/A".) */
244 if (STRING_MULTIBYTE (errstring
)
245 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
249 str
= SSDATA (errstring
);
250 c
= STRING_CHAR ((unsigned char *) str
);
251 Faset (errstring
, make_number (0), make_number (downcase (c
)));
254 xsignal (Qfile_error
,
255 Fcons (build_string (string
), Fcons (errstring
, data
)));
259 /* Signal a file-access failure that set errno. STRING describes the
260 failure, NAME the file involved. When invoking this function, take
261 care to not use arguments such as build_string ("foo") that involve
262 side effects that may set errno. */
265 report_file_error (char const *string
, Lisp_Object name
)
267 report_file_errno (string
, name
, errno
);
271 close_file_unwind (int fd
)
277 fclose_unwind (void *arg
)
283 /* Restore point, having saved it as a marker. */
286 restore_point_unwind (Lisp_Object location
)
288 Fgoto_char (location
);
289 unchain_marker (XMARKER (location
));
293 static Lisp_Object Qexpand_file_name
;
294 static Lisp_Object Qsubstitute_in_file_name
;
295 static Lisp_Object Qdirectory_file_name
;
296 static Lisp_Object Qfile_name_directory
;
297 static Lisp_Object Qfile_name_nondirectory
;
298 static Lisp_Object Qunhandled_file_name_directory
;
299 static Lisp_Object Qfile_name_as_directory
;
300 static Lisp_Object Qcopy_file
;
301 static Lisp_Object Qmake_directory_internal
;
302 static Lisp_Object Qmake_directory
;
303 static Lisp_Object Qdelete_directory_internal
;
304 Lisp_Object Qdelete_file
;
305 static Lisp_Object Qrename_file
;
306 static Lisp_Object Qadd_name_to_file
;
307 static Lisp_Object Qmake_symbolic_link
;
308 Lisp_Object Qfile_exists_p
;
309 static Lisp_Object Qfile_executable_p
;
310 static Lisp_Object Qfile_readable_p
;
311 static Lisp_Object Qfile_writable_p
;
312 static Lisp_Object Qfile_symlink_p
;
313 static Lisp_Object Qaccess_file
;
314 Lisp_Object Qfile_directory_p
;
315 static Lisp_Object Qfile_regular_p
;
316 static Lisp_Object Qfile_accessible_directory_p
;
317 static Lisp_Object Qfile_modes
;
318 static Lisp_Object Qset_file_modes
;
319 static Lisp_Object Qset_file_times
;
320 static Lisp_Object Qfile_selinux_context
;
321 static Lisp_Object Qset_file_selinux_context
;
322 static Lisp_Object Qfile_acl
;
323 static Lisp_Object Qset_file_acl
;
324 static Lisp_Object Qfile_newer_than_file_p
;
325 Lisp_Object Qinsert_file_contents
;
326 static Lisp_Object Qchoose_write_coding_system
;
327 Lisp_Object Qwrite_region
;
328 static Lisp_Object Qverify_visited_file_modtime
;
329 static Lisp_Object Qset_visited_file_modtime
;
331 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
332 Sfind_file_name_handler
, 2, 2, 0,
333 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
334 Otherwise, return nil.
335 A file name is handled if one of the regular expressions in
336 `file-name-handler-alist' matches it.
338 If OPERATION equals `inhibit-file-name-operation', then we ignore
339 any handlers that are members of `inhibit-file-name-handlers',
340 but we still do run any other handlers. This lets handlers
341 use the standard functions without calling themselves recursively. */)
342 (Lisp_Object filename
, Lisp_Object operation
)
344 /* This function must not munge the match data. */
345 Lisp_Object chain
, inhibited_handlers
, result
;
349 CHECK_STRING (filename
);
351 if (EQ (operation
, Vinhibit_file_name_operation
))
352 inhibited_handlers
= Vinhibit_file_name_handlers
;
354 inhibited_handlers
= Qnil
;
356 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
357 chain
= XCDR (chain
))
363 Lisp_Object string
= XCAR (elt
);
365 Lisp_Object handler
= XCDR (elt
);
366 Lisp_Object operations
= Qnil
;
368 if (SYMBOLP (handler
))
369 operations
= Fget (handler
, Qoperations
);
372 && (match_pos
= fast_string_match (string
, filename
)) > pos
373 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
377 handler
= XCDR (elt
);
378 tem
= Fmemq (handler
, inhibited_handlers
);
392 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
394 doc
: /* Return the directory component in file name FILENAME.
395 Return nil if FILENAME does not include a directory.
396 Otherwise return a directory name.
397 Given a Unix syntax file name, returns a string ending in slash. */)
398 (Lisp_Object filename
)
401 register const char *beg
;
406 register const char *p
;
409 CHECK_STRING (filename
);
411 /* If the file name has special constructs in it,
412 call the corresponding file handler. */
413 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
416 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
418 return STRINGP (handled_name
) ? handled_name
: Qnil
;
422 beg
= xlispstrdupa (filename
);
424 beg
= SSDATA (filename
);
426 p
= beg
+ SBYTES (filename
);
428 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
430 /* only recognize drive specifier at the beginning */
432 /* handle the "/:d:foo" and "/:foo" cases correctly */
433 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
434 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
441 /* Expansion of "c:" to drive and default directory. */
444 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
445 char *res
= alloca (MAXPATHLEN
+ 1);
448 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
450 memcpy (res
, beg
, 2);
455 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
457 size_t l
= strlen (res
);
459 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
462 p
= beg
+ strlen (beg
);
463 dostounix_filename (beg
);
464 /* FIXME: Figure out the multibyte vs unibyte stuff here. */
465 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
466 STRING_MULTIBYTE (filename
));
469 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
470 STRING_MULTIBYTE (filename
));
472 else if (STRING_MULTIBYTE (filename
))
474 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
475 dostounix_filename (SSDATA (tem_fn
));
477 if (!NILP (Vw32_downcase_file_names
))
478 tem_fn
= Fdowncase (tem_fn
);
483 dostounix_filename (beg
);
484 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
488 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
492 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
493 Sfile_name_nondirectory
, 1, 1, 0,
494 doc
: /* Return file name FILENAME sans its directory.
495 For example, in a Unix-syntax file name,
496 this is everything after the last slash,
497 or the entire name if it contains no slash. */)
498 (Lisp_Object filename
)
500 register const char *beg
, *p
, *end
;
503 CHECK_STRING (filename
);
505 /* If the file name has special constructs in it,
506 call the corresponding file handler. */
507 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
510 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
512 if (STRINGP (handled_name
))
514 error ("Invalid handler in `file-name-handler-alist'");
517 beg
= SSDATA (filename
);
518 end
= p
= beg
+ SBYTES (filename
);
520 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
522 /* only recognize drive specifier at beginning */
524 /* handle the "/:d:foo" case correctly */
525 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
530 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
533 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
534 Sunhandled_file_name_directory
, 1, 1, 0,
535 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
536 A `directly usable' directory name is one that may be used without the
537 intervention of any file handler.
538 If FILENAME is a directly usable file itself, return
539 \(file-name-directory FILENAME).
540 If FILENAME refers to a file which is not accessible from a local process,
541 then this should return nil.
542 The `call-process' and `start-process' functions use this function to
543 get a current directory to run processes in. */)
544 (Lisp_Object filename
)
548 /* If the file name has special constructs in it,
549 call the corresponding file handler. */
550 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
553 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
555 return STRINGP (handled_name
) ? handled_name
: Qnil
;
558 return Ffile_name_directory (filename
);
561 /* Maximum number of bytes that DST will be longer than SRC
562 in file_name_as_directory. This occurs when SRCLEN == 0. */
563 enum { file_name_as_directory_slop
= 2 };
565 /* Convert from file name SRC of length SRCLEN to directory name in
566 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
567 string. On UNIX, just make sure there is a terminating /. Return
568 the length of DST in bytes. */
571 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
582 memcpy (dst
, src
, srclen
);
583 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
584 dst
[srclen
++] = DIRECTORY_SEP
;
587 dostounix_filename (dst
);
592 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
593 Sfile_name_as_directory
, 1, 1, 0,
594 doc
: /* Return a string representing the file name FILE interpreted as a directory.
595 This operation exists because a directory is also a file, but its name as
596 a directory is different from its name as a file.
597 The result can be used as the value of `default-directory'
598 or passed as second argument to `expand-file-name'.
599 For a Unix-syntax file name, just appends a slash. */)
604 Lisp_Object handler
, val
;
611 /* If the file name has special constructs in it,
612 call the corresponding file handler. */
613 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
616 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
618 if (STRINGP (handled_name
))
620 error ("Invalid handler in `file-name-handler-alist'");
624 if (!NILP (Vw32_downcase_file_names
))
625 file
= Fdowncase (file
);
627 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
628 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
629 STRING_MULTIBYTE (file
));
630 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
635 /* Convert from directory name SRC of length SRCLEN to file name in
636 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
637 string. On UNIX, just make sure there isn't a terminating /.
638 Return the length of DST in bytes. */
641 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
643 /* Process as Unix format: just remove any final slash.
644 But leave "/" and "//" unchanged. */
647 && !IS_ANY_SEP (src
[srclen
- 2])
649 && IS_DIRECTORY_SEP (src
[srclen
- 1])
650 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
653 memcpy (dst
, src
, srclen
);
656 dostounix_filename (dst
);
661 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
663 doc
: /* Returns the file name of the directory named DIRECTORY.
664 This is the name of the file that holds the data for the directory DIRECTORY.
665 This operation exists because a directory is also a file, but its name as
666 a directory is different from its name as a file.
667 In Unix-syntax, this function just removes the final slash. */)
668 (Lisp_Object directory
)
672 Lisp_Object handler
, val
;
675 CHECK_STRING (directory
);
677 if (NILP (directory
))
680 /* If the file name has special constructs in it,
681 call the corresponding file handler. */
682 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
685 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
687 if (STRINGP (handled_name
))
689 error ("Invalid handler in `file-name-handler-alist'");
693 if (!NILP (Vw32_downcase_file_names
))
694 directory
= Fdowncase (directory
);
696 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
697 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
698 STRING_MULTIBYTE (directory
));
699 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
704 static const char make_temp_name_tbl
[64] =
706 'A','B','C','D','E','F','G','H',
707 'I','J','K','L','M','N','O','P',
708 'Q','R','S','T','U','V','W','X',
709 'Y','Z','a','b','c','d','e','f',
710 'g','h','i','j','k','l','m','n',
711 'o','p','q','r','s','t','u','v',
712 'w','x','y','z','0','1','2','3',
713 '4','5','6','7','8','9','-','_'
716 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
718 /* Value is a temporary file name starting with PREFIX, a string.
720 The Emacs process number forms part of the result, so there is
721 no danger of generating a name being used by another process.
722 In addition, this function makes an attempt to choose a name
723 which has no existing file. To make this work, PREFIX should be
724 an absolute file name.
726 BASE64_P means add the pid as 3 characters in base64
727 encoding. In this case, 6 characters will be added to PREFIX to
728 form the file name. Otherwise, if Emacs is running on a system
729 with long file names, add the pid as a decimal number.
731 This function signals an error if no unique file name could be
735 make_temp_name (Lisp_Object prefix
, bool base64_p
)
737 Lisp_Object val
, encoded_prefix
;
741 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
744 CHECK_STRING (prefix
);
746 /* VAL is created by adding 6 characters to PREFIX. The first
747 three are the PID of this process, in base 64, and the second
748 three are incremented if the file already exists. This ensures
749 262144 unique file names per PID per PREFIX. */
755 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
756 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
757 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
762 #ifdef HAVE_LONG_FILE_NAMES
763 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
765 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
766 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
767 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
772 encoded_prefix
= ENCODE_FILE (prefix
);
773 len
= SBYTES (encoded_prefix
);
774 val
= make_uninit_string (len
+ 3 + pidlen
);
776 memcpy (data
, SSDATA (encoded_prefix
), len
);
779 memcpy (p
, pidbuf
, pidlen
);
782 /* Here we try to minimize useless stat'ing when this function is
783 invoked many times successively with the same PREFIX. We achieve
784 this by initializing count to a random value, and incrementing it
787 We don't want make-temp-name to be called while dumping,
788 because then make_temp_name_count_initialized_p would get set
789 and then make_temp_name_count would not be set when Emacs starts. */
791 if (!make_temp_name_count_initialized_p
)
793 make_temp_name_count
= time (NULL
);
794 make_temp_name_count_initialized_p
= 1;
799 unsigned num
= make_temp_name_count
;
801 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
802 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
803 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
805 /* Poor man's congruential RN generator. Replace with
806 ++make_temp_name_count for debugging. */
807 make_temp_name_count
+= 25229;
808 make_temp_name_count
%= 225307;
810 if (!check_existing (data
))
812 /* We want to return only if errno is ENOENT. */
814 return DECODE_FILE (val
);
816 /* The error here is dubious, but there is little else we
817 can do. The alternatives are to return nil, which is
818 as bad as (and in many cases worse than) throwing the
819 error, or to ignore the error, which will likely result
820 in looping through 225307 stat's, which is not only
821 dog-slow, but also useless since eventually nil would
822 have to be returned anyway. */
823 report_file_error ("Cannot create temporary name for prefix",
831 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
832 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
833 The Emacs process number forms part of the result,
834 so there is no danger of generating a name being used by another process.
836 In addition, this function makes an attempt to choose a name
837 which has no existing file. To make this work,
838 PREFIX should be an absolute file name.
840 There is a race condition between calling `make-temp-name' and creating the
841 file which opens all kinds of security holes. For that reason, you should
842 probably use `make-temp-file' instead, except in three circumstances:
844 * If you are creating the file in the user's home directory.
845 * If you are creating a directory rather than an ordinary file.
846 * If you are taking special precautions as `make-temp-file' does. */)
849 return make_temp_name (prefix
, 0);
854 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
855 doc
: /* Convert filename NAME to absolute, and canonicalize it.
856 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
857 \(does not start with slash or tilde); both the directory name and
858 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
859 missing, the current buffer's value of `default-directory' is used.
860 NAME should be a string that is a valid file name for the underlying
862 File name components that are `.' are removed, and
863 so are file name components followed by `..', along with the `..' itself;
864 note that these simplifications are done without checking the resulting
865 file names in the file system.
866 Multiple consecutive slashes are collapsed into a single slash,
867 except at the beginning of the file name when they are significant (e.g.,
868 UNC file names on MS-Windows.)
869 An initial `~/' expands to your home directory.
870 An initial `~USER/' expands to USER's home directory.
871 See also the function `substitute-in-file-name'.
873 For technical reasons, this function can return correct but
874 non-intuitive results for the root directory; for instance,
875 \(expand-file-name ".." "/") returns "/..". For this reason, use
876 \(directory-file-name (file-name-directory dirname)) to traverse a
877 filesystem tree, not (expand-file-name ".." dirname). */)
878 (Lisp_Object name
, Lisp_Object default_directory
)
880 /* These point to SDATA and need to be careful with string-relocation
881 during GC (via DECODE_FILE). */
884 /* This should only point to alloca'd data. */
891 bool collapse_newdir
= 1;
895 Lisp_Object handler
, result
, handled_name
;
902 /* If the file name has special constructs in it,
903 call the corresponding file handler. */
904 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
907 handled_name
= call3 (handler
, Qexpand_file_name
,
908 name
, default_directory
);
909 if (STRINGP (handled_name
))
911 error ("Invalid handler in `file-name-handler-alist'");
915 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
916 if (NILP (default_directory
))
917 default_directory
= BVAR (current_buffer
, directory
);
918 if (! STRINGP (default_directory
))
921 /* "/" is not considered a root directory on DOS_NT, so using "/"
922 here causes an infinite recursion in, e.g., the following:
924 (let (default-directory)
925 (expand-file-name "a"))
927 To avoid this, we set default_directory to the root of the
929 default_directory
= build_string (emacs_root_dir ());
931 default_directory
= build_string ("/");
935 if (!NILP (default_directory
))
937 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
940 handled_name
= call3 (handler
, Qexpand_file_name
,
941 name
, default_directory
);
942 if (STRINGP (handled_name
))
944 error ("Invalid handler in `file-name-handler-alist'");
949 char *o
= SSDATA (default_directory
);
951 /* Make sure DEFAULT_DIRECTORY is properly expanded.
952 It would be better to do this down below where we actually use
953 default_directory. Unfortunately, calling Fexpand_file_name recursively
954 could invoke GC, and the strings might be relocated. This would
955 be annoying because we have pointers into strings lying around
956 that would need adjusting, and people would add new pointers to
957 the code and forget to adjust them, resulting in intermittent bugs.
958 Putting this call here avoids all that crud.
960 The EQ test avoids infinite recursion. */
961 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
962 /* Save time in some common cases - as long as default_directory
963 is not relative, it can be canonicalized with name below (if it
964 is needed at all) without requiring it to be expanded now. */
966 /* Detect MSDOS file names with drive specifiers. */
967 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
968 && IS_DIRECTORY_SEP (o
[2]))
970 /* Detect Windows file names in UNC format. */
971 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
973 #else /* not DOS_NT */
974 /* Detect Unix absolute file names (/... alone is not absolute on
976 && ! (IS_DIRECTORY_SEP (o
[0]))
977 #endif /* not DOS_NT */
983 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
987 multibyte
= STRING_MULTIBYTE (name
);
988 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
992 unsigned char *p
= SDATA (name
);
994 while (*p
&& ASCII_BYTE_P (*p
))
998 /* NAME is a pure ASCII string, and DEFAULT_DIRECTORY is
999 unibyte. Do not convert DEFAULT_DIRECTORY to
1000 multibyte; instead, convert NAME to a unibyte string,
1001 so that the result of this function is also a unibyte
1002 string. This is needed during bootstrapping and
1003 dumping, when Emacs cannot decode file names, because
1004 the locale environment is not set up. */
1005 name
= make_unibyte_string (SSDATA (name
), SBYTES (name
));
1009 default_directory
= string_to_multibyte (default_directory
);
1013 name
= string_to_multibyte (name
);
1019 if (!NILP (Vw32_downcase_file_names
))
1020 default_directory
= Fdowncase (default_directory
);
1023 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
1024 nm
= xlispstrdupa (name
);
1027 /* Note if special escape prefix is present, but remove for now. */
1028 if (nm
[0] == '/' && nm
[1] == ':')
1034 /* Find and remove drive specifier if present; this makes nm absolute
1035 even if the rest of the name appears to be relative. Only look for
1036 drive specifier at the beginning. */
1037 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1039 drive
= (unsigned char) nm
[0];
1044 /* If we see "c://somedir", we want to strip the first slash after the
1045 colon when stripping the drive letter. Otherwise, this expands to
1047 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1050 /* Discard any previous drive specifier if nm is now in UNC format. */
1051 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1055 #endif /* WINDOWSNT */
1058 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1059 none are found, we can probably return right away. We will avoid
1060 allocating a new string if name is already fully expanded. */
1062 IS_DIRECTORY_SEP (nm
[0])
1064 && drive
&& !is_escaped
1067 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1071 /* If it turns out that the filename we want to return is just a
1072 suffix of FILENAME, we don't need to go through and edit
1073 things; we just need to construct a new string using data
1074 starting at the middle of FILENAME. If we set LOSE, that
1075 means we've discovered that we can't do that cool trick. */
1081 /* Since we know the name is absolute, we can assume that each
1082 element starts with a "/". */
1084 /* "." and ".." are hairy. */
1085 if (IS_DIRECTORY_SEP (p
[0])
1087 && (IS_DIRECTORY_SEP (p
[2])
1089 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1092 /* Replace multiple slashes with a single one, except
1093 leave leading "//" alone. */
1094 else if (IS_DIRECTORY_SEP (p
[0])
1095 && IS_DIRECTORY_SEP (p
[1])
1096 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1103 /* Make sure directories are all separated with /, but
1104 avoid allocation of a new string when not required. */
1105 /* FIXME: Figure out multibyte and downcase here. */
1106 dostounix_filename (nm
);
1108 if (IS_DIRECTORY_SEP (nm
[1]))
1110 if (strcmp (nm
, SSDATA (name
)) != 0)
1111 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1115 /* Drive must be set, so this is okay. */
1116 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1120 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1121 temp
[0] = DRIVE_LETTER (drive
);
1122 name
= concat2 (build_string (temp
), name
);
1125 if (!NILP (Vw32_downcase_file_names
))
1126 name
= Fdowncase (name
);
1129 #else /* not DOS_NT */
1130 if (strcmp (nm
, SSDATA (name
)) == 0)
1132 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1133 #endif /* not DOS_NT */
1137 /* At this point, nm might or might not be an absolute file name. We
1138 need to expand ~ or ~user if present, otherwise prefix nm with
1139 default_directory if nm is not absolute, and finally collapse /./
1140 and /foo/../ sequences.
1142 We set newdir to be the appropriate prefix if one is needed:
1143 - the relevant user directory if nm starts with ~ or ~user
1144 - the specified drive's working dir (DOS/NT only) if nm does not
1146 - the value of default_directory.
1148 Note that these prefixes are not guaranteed to be absolute (except
1149 for the working dir of a drive). Therefore, to ensure we always
1150 return an absolute name, if the final prefix is not absolute we
1151 append it to the current working directory. */
1155 if (nm
[0] == '~') /* prefix ~ */
1157 if (IS_DIRECTORY_SEP (nm
[1])
1158 || nm
[1] == 0) /* ~ by itself */
1162 if (!(newdir
= egetenv ("HOME")))
1165 /* `egetenv' may return a unibyte string, which will bite us since
1166 we expect the directory to be multibyte. */
1170 char newdir_utf8
[MAX_UTF8_PATH
];
1172 filename_from_ansi (newdir
, newdir_utf8
);
1173 tem
= build_string (newdir_utf8
);
1177 tem
= build_string (newdir
);
1179 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1181 hdir
= DECODE_FILE (tem
);
1182 newdir
= SSDATA (hdir
);
1185 collapse_newdir
= 0;
1188 else /* ~user/filename */
1191 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1193 o
= SAFE_ALLOCA (p
- nm
+ 1);
1194 memcpy (o
, nm
, p
- nm
);
1198 pw
= getpwnam (o
+ 1);
1204 newdir
= pw
->pw_dir
;
1205 /* `getpwnam' may return a unibyte string, which will
1206 bite us since we expect the directory to be
1208 tem
= build_string (newdir
);
1209 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1211 hdir
= DECODE_FILE (tem
);
1212 newdir
= SSDATA (hdir
);
1216 collapse_newdir
= 0;
1220 /* If we don't find a user of that name, leave the name
1221 unchanged; don't move nm forward to p. */
1226 /* On DOS and Windows, nm is absolute if a drive name was specified;
1227 use the drive's current directory as the prefix if needed. */
1228 if (!newdir
&& drive
)
1230 /* Get default directory if needed to make nm absolute. */
1232 if (!IS_DIRECTORY_SEP (nm
[0]))
1234 adir
= alloca (MAXPATHLEN
+ 1);
1235 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1239 Lisp_Object tem
= build_string (adir
);
1241 tem
= DECODE_FILE (tem
);
1242 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1247 /* Either nm starts with /, or drive isn't mounted. */
1249 adir
[0] = DRIVE_LETTER (drive
);
1258 /* Finally, if no prefix has been specified and nm is not absolute,
1259 then it must be expanded relative to default_directory. */
1263 /* /... alone is not absolute on DOS and Windows. */
1264 && !IS_DIRECTORY_SEP (nm
[0])
1267 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1271 newdir
= SSDATA (default_directory
);
1273 /* Note if special escape prefix is present, but remove for now. */
1274 if (newdir
[0] == '/' && newdir
[1] == ':')
1285 /* First ensure newdir is an absolute name. */
1287 /* Detect MSDOS file names with drive specifiers. */
1288 ! (IS_DRIVE (newdir
[0])
1289 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1291 /* Detect Windows file names in UNC format. */
1292 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1296 /* Effectively, let newdir be (expand-file-name newdir cwd).
1297 Because of the admonition against calling expand-file-name
1298 when we have pointers into lisp strings, we accomplish this
1299 indirectly by prepending newdir to nm if necessary, and using
1300 cwd (or the wd of newdir's drive) as the new newdir. */
1303 const int adir_size
= MAX_UTF8_PATH
;
1305 const int adir_size
= MAXPATHLEN
+ 1;
1308 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1310 drive
= (unsigned char) newdir
[0];
1313 if (!IS_DIRECTORY_SEP (nm
[0]))
1315 ptrdiff_t newlen
= strlen (newdir
);
1316 char *tmp
= alloca (newlen
+ file_name_as_directory_slop
1318 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1322 adir
= alloca (adir_size
);
1325 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1329 getcwd (adir
, adir_size
);
1332 Lisp_Object tem
= build_string (adir
);
1334 tem
= DECODE_FILE (tem
);
1335 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1340 /* Strip off drive name from prefix, if present. */
1341 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1347 /* Keep only a prefix from newdir if nm starts with slash
1348 (//server/share for UNC, nothing otherwise). */
1349 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1352 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1354 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1356 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1358 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1371 /* Ignore any slash at the end of newdir, unless newdir is
1372 just "/" or "//". */
1373 length
= strlen (newdir
);
1374 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1375 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1381 /* Now concatenate the directory and name to new space in the stack frame. */
1382 tlen
= length
+ file_name_as_directory_slop
+ strlen (nm
) + 1;
1384 /* Reserve space for drive specifier and escape prefix, since either
1385 or both may need to be inserted. (The Microsoft x86 compiler
1386 produces incorrect code if the following two lines are combined.) */
1387 target
= alloca (tlen
+ 4);
1389 #else /* not DOS_NT */
1390 target
= SAFE_ALLOCA (tlen
);
1391 #endif /* not DOS_NT */
1396 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1399 /* If newdir is effectively "C:/", then the drive letter will have
1400 been stripped and newdir will be "/". Concatenating with an
1401 absolute directory in nm produces "//", which will then be
1402 incorrectly treated as a network share. Ignore newdir in
1403 this case (keeping the drive letter). */
1404 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1405 && newdir
[1] == '\0'))
1408 memcpy (target
, newdir
, length
);
1413 file_name_as_directory (target
, newdir
, length
, multibyte
);
1416 strcat (target
, nm
);
1418 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1426 if (!IS_DIRECTORY_SEP (*p
))
1430 else if (p
[1] == '.'
1431 && (IS_DIRECTORY_SEP (p
[2])
1434 /* If "/." is the entire filename, keep the "/". Otherwise,
1435 just delete the whole "/.". */
1436 if (o
== target
&& p
[2] == '\0')
1440 else if (p
[1] == '.' && p
[2] == '.'
1441 /* `/../' is the "superroot" on certain file systems.
1442 Turned off on DOS_NT systems because they have no
1443 "superroot" and because this causes us to produce
1444 file names like "d:/../foo" which fail file-related
1445 functions of the underlying OS. (To reproduce, try a
1446 long series of "../../" in default_directory, longer
1447 than the number of levels from the root.) */
1451 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1456 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1459 /* Don't go below server level in UNC filenames. */
1460 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1461 && IS_DIRECTORY_SEP (*target
))
1465 /* Keep initial / only if this is the whole name. */
1466 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1470 else if (IS_DIRECTORY_SEP (p
[1])
1471 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1472 /* Collapse multiple "/", except leave leading "//" alone. */
1481 /* At last, set drive name. */
1483 /* Except for network file name. */
1484 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1485 #endif /* WINDOWSNT */
1487 if (!drive
) emacs_abort ();
1489 target
[0] = DRIVE_LETTER (drive
);
1492 /* Reinsert the escape prefix if required. */
1499 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1500 /* FIXME: Figure out the multibyte and downcase here. */
1501 dostounix_filename (SSDATA (result
));
1503 if (!NILP (Vw32_downcase_file_names
))
1504 result
= Fdowncase (result
);
1507 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1508 #endif /* !DOS_NT */
1511 /* Again look to see if the file name has special constructs in it
1512 and perhaps call the corresponding file handler. This is needed
1513 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1514 the ".." component gives us "/user@host:/bar/../baz" which needs
1515 to be expanded again. */
1516 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1517 if (!NILP (handler
))
1519 handled_name
= call3 (handler
, Qexpand_file_name
,
1520 result
, default_directory
);
1521 if (! STRINGP (handled_name
))
1522 error ("Invalid handler in `file-name-handler-alist'");
1523 result
= handled_name
;
1531 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1532 This is the old version of expand-file-name, before it was thoroughly
1533 rewritten for Emacs 10.31. We leave this version here commented-out,
1534 because the code is very complex and likely to have subtle bugs. If
1535 bugs _are_ found, it might be of interest to look at the old code and
1536 see what did it do in the relevant situation.
1538 Don't remove this code: it's true that it will be accessible
1539 from the repository, but a few years from deletion, people will
1540 forget it is there. */
1542 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1543 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1544 "Convert FILENAME to absolute, and canonicalize it.\n\
1545 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1546 \(does not start with slash); if DEFAULT is nil or missing,\n\
1547 the current buffer's value of default-directory is used.\n\
1548 Filenames containing `.' or `..' as components are simplified;\n\
1549 initial `~/' expands to your home directory.\n\
1550 See also the function `substitute-in-file-name'.")
1552 Lisp_Object name
, defalt
;
1556 register unsigned char *newdir
, *p
, *o
;
1558 unsigned char *target
;
1561 CHECK_STRING (name
);
1564 /* If nm is absolute, flush ...// and detect /./ and /../.
1565 If no /./ or /../ we can return right away. */
1572 if (p
[0] == '/' && p
[1] == '/')
1574 if (p
[0] == '/' && p
[1] == '~')
1575 nm
= p
+ 1, lose
= 1;
1576 if (p
[0] == '/' && p
[1] == '.'
1577 && (p
[2] == '/' || p
[2] == 0
1578 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1584 if (nm
== SDATA (name
))
1586 return build_string (nm
);
1590 /* Now determine directory to start with and put it in NEWDIR. */
1594 if (nm
[0] == '~') /* prefix ~ */
1595 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1597 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1598 newdir
= (unsigned char *) "";
1601 else /* ~user/filename */
1603 /* Get past ~ to user. */
1604 unsigned char *user
= nm
+ 1;
1605 /* Find end of name. */
1606 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1607 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1608 /* Copy the user name into temp storage. */
1609 o
= alloca (len
+ 1);
1610 memcpy (o
, user
, len
);
1613 /* Look up the user name. */
1615 pw
= (struct passwd
*) getpwnam (o
+ 1);
1618 error ("\"%s\" isn't a registered user", o
+ 1);
1620 newdir
= (unsigned char *) pw
->pw_dir
;
1622 /* Discard the user name from NM. */
1626 if (nm
[0] != '/' && !newdir
)
1629 defalt
= current_buffer
->directory
;
1630 CHECK_STRING (defalt
);
1631 newdir
= SDATA (defalt
);
1634 /* Now concatenate the directory and name to new space in the stack frame. */
1636 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1637 target
= alloca (tlen
);
1642 if (nm
[0] == 0 || nm
[0] == '/')
1643 strcpy (target
, newdir
);
1645 file_name_as_directory (target
, newdir
);
1648 strcat (target
, nm
);
1650 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1661 else if (!strncmp (p
, "//", 2)
1667 else if (p
[0] == '/' && p
[1] == '.'
1668 && (p
[2] == '/' || p
[2] == 0))
1670 else if (!strncmp (p
, "/..", 3)
1671 /* `/../' is the "superroot" on certain file systems. */
1673 && (p
[3] == '/' || p
[3] == 0))
1675 while (o
!= target
&& *--o
!= '/')
1677 if (o
== target
&& *o
== '/')
1687 return make_string (target
, o
- target
);
1691 /* If /~ or // appears, discard everything through first slash. */
1693 file_name_absolute_p (const char *filename
)
1696 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1698 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1699 && IS_DIRECTORY_SEP (filename
[2]))
1705 search_embedded_absfilename (char *nm
, char *endp
)
1709 for (p
= nm
+ 1; p
< endp
; p
++)
1711 if (IS_DIRECTORY_SEP (p
[-1])
1712 && file_name_absolute_p (p
)
1713 #if defined (WINDOWSNT) || defined (CYGWIN)
1714 /* // at start of file name is meaningful in Apollo,
1715 WindowsNT and Cygwin systems. */
1716 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1717 #endif /* not (WINDOWSNT || CYGWIN) */
1720 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1721 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1723 char *o
= alloca (s
- p
+ 1);
1725 memcpy (o
, p
, s
- p
);
1728 /* If we have ~user and `user' exists, discard
1729 everything up to ~. But if `user' does not exist, leave
1730 ~user alone, it might be a literal file name. */
1732 pw
= getpwnam (o
+ 1);
1744 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1745 Ssubstitute_in_file_name
, 1, 1, 0,
1746 doc
: /* Substitute environment variables referred to in FILENAME.
1747 `$FOO' where FOO is an environment variable name means to substitute
1748 the value of that variable. The variable name should be terminated
1749 with a character not a letter, digit or underscore; otherwise, enclose
1750 the entire variable name in braces.
1752 If `/~' appears, all of FILENAME through that `/' is discarded.
1753 If `//' appears, everything up to and including the first of
1754 those `/' is discarded. */)
1755 (Lisp_Object filename
)
1757 char *nm
, *p
, *x
, *endp
;
1758 bool substituted
= false;
1761 Lisp_Object handler
;
1763 CHECK_STRING (filename
);
1765 multibyte
= STRING_MULTIBYTE (filename
);
1767 /* If the file name has special constructs in it,
1768 call the corresponding file handler. */
1769 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1770 if (!NILP (handler
))
1772 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1774 if (STRINGP (handled_name
))
1775 return handled_name
;
1776 error ("Invalid handler in `file-name-handler-alist'");
1779 /* Always work on a copy of the string, in case GC happens during
1780 decode of environment variables, causing the original Lisp_String
1781 data to be relocated. */
1782 nm
= xlispstrdupa (filename
);
1785 /* FIXME: Figure out multibyte and downcase. */
1786 dostounix_filename (nm
);
1787 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1789 endp
= nm
+ SBYTES (filename
);
1791 /* If /~ or // appears, discard everything through first slash. */
1792 p
= search_embedded_absfilename (nm
, endp
);
1794 /* Start over with the new string, so we check the file-name-handler
1795 again. Important with filenames like "/home/foo//:/hello///there"
1796 which would substitute to "/:/hello///there" rather than "/there". */
1797 return Fsubstitute_in_file_name
1798 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1800 /* See if any variables are substituted into the string. */
1802 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1805 = (!substituted
? filename
1806 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1807 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1809 if (!EQ (tmp
, name
))
1817 if (!NILP (Vw32_downcase_file_names
))
1818 filename
= Fdowncase (filename
);
1823 xnm
= SSDATA (filename
);
1824 x
= xnm
+ SBYTES (filename
);
1826 /* If /~ or // appears, discard everything through first slash. */
1827 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1828 /* This time we do not start over because we've already expanded envvars
1829 and replaced $$ with $. Maybe we should start over as well, but we'd
1830 need to quote some $ to $$ first. */
1834 if (!NILP (Vw32_downcase_file_names
))
1836 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1838 xname
= Fdowncase (xname
);
1843 return (xnm
== SSDATA (filename
)
1845 : make_specified_string (xnm
, -1, x
- xnm
, multibyte
));
1848 /* A slightly faster and more convenient way to get
1849 (directory-file-name (expand-file-name FOO)). */
1852 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1854 register Lisp_Object absname
;
1856 absname
= Fexpand_file_name (filename
, defdir
);
1858 /* Remove final slash, if any (unless this is the root dir).
1859 stat behaves differently depending! */
1860 if (SCHARS (absname
) > 1
1861 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1862 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1863 /* We cannot take shortcuts; they might be wrong for magic file names. */
1864 absname
= Fdirectory_file_name (absname
);
1868 /* Signal an error if the file ABSNAME already exists.
1869 If INTERACTIVE, ask the user whether to proceed,
1870 and bypass the error if the user says to go ahead.
1871 QUERYSTRING is a name for the action that is being considered
1874 *STATPTR is used to store the stat information if the file exists.
1875 If the file does not exist, STATPTR->st_mode is set to 0.
1876 If STATPTR is null, we don't store into it.
1878 If QUICK, ask for y or n, not yes or no. */
1881 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1882 bool interactive
, struct stat
*statptr
,
1885 Lisp_Object tem
, encoded_filename
;
1886 struct stat statbuf
;
1887 struct gcpro gcpro1
;
1889 encoded_filename
= ENCODE_FILE (absname
);
1891 /* `stat' is a good way to tell whether the file exists,
1892 regardless of what access permissions it has. */
1893 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1895 if (S_ISDIR (statbuf
.st_mode
))
1896 xsignal2 (Qfile_error
,
1897 build_string ("File is a directory"), absname
);
1900 xsignal2 (Qfile_already_exists
,
1901 build_string ("File already exists"), absname
);
1903 tem
= format2 ("File %s already exists; %s anyway? ",
1904 absname
, build_string (querystring
));
1906 tem
= call1 (intern ("y-or-n-p"), tem
);
1908 tem
= do_yes_or_no_p (tem
);
1911 xsignal2 (Qfile_already_exists
,
1912 build_string ("File already exists"), absname
);
1919 statptr
->st_mode
= 0;
1924 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1925 "fCopy file: \nGCopy %s to file: \np\nP",
1926 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1927 If NEWNAME names a directory, copy FILE there.
1929 This function always sets the file modes of the output file to match
1932 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1933 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1934 signal a `file-already-exists' error without overwriting. If
1935 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1936 about overwriting; this is what happens in interactive use with M-x.
1937 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1940 Fourth arg KEEP-TIME non-nil means give the output file the same
1941 last-modified time as the old one. (This works on only some systems.)
1943 A prefix arg makes KEEP-TIME non-nil.
1945 If PRESERVE-UID-GID is non-nil, we try to transfer the
1946 uid and gid of FILE to NEWNAME.
1948 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1949 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1950 entries (depending on how Emacs was built). */)
1951 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
, Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
, Lisp_Object preserve_extended_attributes
)
1955 char buf
[16 * 1024];
1956 struct stat st
, out_st
;
1957 Lisp_Object handler
;
1958 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1959 ptrdiff_t count
= SPECPDL_INDEX ();
1960 Lisp_Object encoded_file
, encoded_newname
;
1962 security_context_t con
;
1969 encoded_file
= encoded_newname
= Qnil
;
1970 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1971 CHECK_STRING (file
);
1972 CHECK_STRING (newname
);
1974 if (!NILP (Ffile_directory_p (newname
)))
1975 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1977 newname
= Fexpand_file_name (newname
, Qnil
);
1979 file
= Fexpand_file_name (file
, Qnil
);
1981 /* If the input file name has special constructs in it,
1982 call the corresponding file handler. */
1983 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1984 /* Likewise for output file name. */
1986 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1987 if (!NILP (handler
))
1988 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1989 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1990 preserve_extended_attributes
));
1992 encoded_file
= ENCODE_FILE (file
);
1993 encoded_newname
= ENCODE_FILE (newname
);
1995 if (NILP (ok_if_already_exists
)
1996 || INTEGERP (ok_if_already_exists
))
1997 barf_or_query_if_file_exists (newname
, "copy to it",
1998 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1999 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
2003 if (!NILP (preserve_extended_attributes
))
2005 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2006 if (acl
== NULL
&& acl_errno_valid (errno
))
2007 report_file_error ("Getting ACL", file
);
2009 if (!CopyFile (SDATA (encoded_file
),
2010 SDATA (encoded_newname
),
2013 /* CopyFile doesn't set errno when it fails. By far the most
2014 "popular" reason is that the target is read-only. */
2015 report_file_errno ("Copying file", list2 (file
, newname
),
2016 GetLastError () == 5 ? EACCES
: EPERM
);
2018 /* CopyFile retains the timestamp by default. */
2019 else if (NILP (keep_time
))
2021 struct timespec now
;
2025 filename
= SDATA (encoded_newname
);
2027 /* Ensure file is writable while its modified time is set. */
2028 attributes
= GetFileAttributes (filename
);
2029 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2030 now
= current_timespec ();
2031 if (set_file_times (-1, filename
, now
, now
))
2033 /* Restore original attributes. */
2034 SetFileAttributes (filename
, attributes
);
2035 xsignal2 (Qfile_date_error
,
2036 build_string ("Cannot set file date"), newname
);
2038 /* Restore original attributes. */
2039 SetFileAttributes (filename
, attributes
);
2044 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2045 if (fail
&& acl_errno_valid (errno
))
2046 report_file_error ("Setting ACL", newname
);
2050 #else /* not WINDOWSNT */
2052 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2056 report_file_error ("Opening input file", file
);
2058 record_unwind_protect_int (close_file_unwind
, ifd
);
2060 if (fstat (ifd
, &st
) != 0)
2061 report_file_error ("Input file status", file
);
2063 if (!NILP (preserve_extended_attributes
))
2066 if (is_selinux_enabled ())
2068 conlength
= fgetfilecon (ifd
, &con
);
2069 if (conlength
== -1)
2070 report_file_error ("Doing fgetfilecon", file
);
2075 if (out_st
.st_mode
!= 0
2076 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2077 report_file_errno ("Input and output files are the same",
2078 list2 (file
, newname
), 0);
2080 /* We can copy only regular files. */
2081 if (!S_ISREG (st
.st_mode
))
2082 report_file_errno ("Non-regular file", file
,
2083 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
2087 int new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0600 : 0666);
2089 int new_mask
= S_IREAD
| S_IWRITE
;
2091 ofd
= emacs_open (SSDATA (encoded_newname
),
2092 (O_WRONLY
| O_TRUNC
| O_CREAT
2093 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2097 report_file_error ("Opening output file", newname
);
2099 record_unwind_protect_int (close_file_unwind
, ofd
);
2103 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2104 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2105 report_file_error ("Write error", newname
);
2109 /* Preserve the original file permissions, and if requested, also its
2112 mode_t mode_mask
= 07777;
2113 if (!NILP (preserve_uid_gid
))
2115 /* Attempt to change owner and group. If that doesn't work
2116 attempt to change just the group, as that is sometimes allowed.
2117 Adjust the mode mask to eliminate setuid or setgid bits
2118 that are inappropriate if the owner and group are wrong. */
2119 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2121 mode_mask
&= ~06000;
2122 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2127 switch (!NILP (preserve_extended_attributes
)
2128 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2129 SSDATA (encoded_newname
), ofd
,
2130 st
.st_mode
& mode_mask
)
2131 : fchmod (ofd
, st
.st_mode
& mode_mask
))
2133 case -2: report_file_error ("Copying permissions from", file
);
2134 case -1: report_file_error ("Copying permissions to", newname
);
2137 #endif /* not MSDOS */
2142 /* Set the modified context back to the file. */
2143 bool fail
= fsetfilecon (ofd
, con
) != 0;
2144 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2145 if (fail
&& errno
!= ENOTSUP
)
2146 report_file_error ("Doing fsetfilecon", newname
);
2152 if (!NILP (keep_time
))
2154 struct timespec atime
= get_stat_atime (&st
);
2155 struct timespec mtime
= get_stat_mtime (&st
);
2156 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2157 xsignal2 (Qfile_date_error
,
2158 build_string ("Cannot set file date"), newname
);
2161 if (emacs_close (ofd
) < 0)
2162 report_file_error ("Write error", newname
);
2167 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2168 and if it can't, it tells so. Otherwise, under MSDOS we usually
2169 get only the READ bit, which will make the copied file read-only,
2170 so it's better not to chmod at all. */
2171 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2172 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2174 #endif /* not WINDOWSNT */
2176 /* Discard the unwind protects. */
2177 specpdl_ptr
= specpdl
+ count
;
2183 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2184 Smake_directory_internal
, 1, 1, 0,
2185 doc
: /* Create a new directory named DIRECTORY. */)
2186 (Lisp_Object directory
)
2189 Lisp_Object handler
;
2190 Lisp_Object encoded_dir
;
2192 CHECK_STRING (directory
);
2193 directory
= Fexpand_file_name (directory
, Qnil
);
2195 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2196 if (!NILP (handler
))
2197 return call2 (handler
, Qmake_directory_internal
, directory
);
2199 encoded_dir
= ENCODE_FILE (directory
);
2201 dir
= SSDATA (encoded_dir
);
2204 if (mkdir (dir
) != 0)
2206 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2208 report_file_error ("Creating directory", directory
);
2213 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2214 Sdelete_directory_internal
, 1, 1, 0,
2215 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2216 (Lisp_Object directory
)
2219 Lisp_Object encoded_dir
;
2221 CHECK_STRING (directory
);
2222 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2223 encoded_dir
= ENCODE_FILE (directory
);
2224 dir
= SSDATA (encoded_dir
);
2226 if (rmdir (dir
) != 0)
2227 report_file_error ("Removing directory", directory
);
2232 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2233 "(list (read-file-name \
2234 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2235 \"Move file to trash: \" \"Delete file: \") \
2236 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2237 (null current-prefix-arg))",
2238 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2239 If file has multiple names, it continues to exist with the other names.
2240 TRASH non-nil means to trash the file instead of deleting, provided
2241 `delete-by-moving-to-trash' is non-nil.
2243 When called interactively, TRASH is t if no prefix argument is given.
2244 With a prefix argument, TRASH is nil. */)
2245 (Lisp_Object filename
, Lisp_Object trash
)
2247 Lisp_Object handler
;
2248 Lisp_Object encoded_file
;
2249 struct gcpro gcpro1
;
2252 if (!NILP (Ffile_directory_p (filename
))
2253 && NILP (Ffile_symlink_p (filename
)))
2254 xsignal2 (Qfile_error
,
2255 build_string ("Removing old name: is a directory"),
2258 filename
= Fexpand_file_name (filename
, Qnil
);
2260 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2261 if (!NILP (handler
))
2262 return call3 (handler
, Qdelete_file
, filename
, trash
);
2264 if (delete_by_moving_to_trash
&& !NILP (trash
))
2265 return call1 (Qmove_file_to_trash
, filename
);
2267 encoded_file
= ENCODE_FILE (filename
);
2269 if (unlink (SSDATA (encoded_file
)) < 0)
2270 report_file_error ("Removing old name", filename
);
2275 internal_delete_file_1 (Lisp_Object ignore
)
2280 /* Delete file FILENAME, returning true if successful.
2281 This ignores `delete-by-moving-to-trash'. */
2284 internal_delete_file (Lisp_Object filename
)
2288 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2289 Qt
, internal_delete_file_1
);
2293 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2294 "fRename file: \nGRename %s to file: \np",
2295 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2296 If file has names other than FILE, it continues to have those names.
2297 Signals a `file-already-exists' error if a file NEWNAME already exists
2298 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2299 A number as third arg means request confirmation if NEWNAME already exists.
2300 This is what happens in interactive use with M-x. */)
2301 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2303 Lisp_Object handler
;
2304 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2305 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2307 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2308 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2309 CHECK_STRING (file
);
2310 CHECK_STRING (newname
);
2311 file
= Fexpand_file_name (file
, Qnil
);
2313 if ((!NILP (Ffile_directory_p (newname
)))
2315 /* If the file names are identical but for the case,
2316 don't attempt to move directory to itself. */
2317 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2321 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2322 ? file
: Fdirectory_file_name (file
));
2323 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2326 newname
= Fexpand_file_name (newname
, Qnil
);
2328 /* If the file name has special constructs in it,
2329 call the corresponding file handler. */
2330 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2332 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2333 if (!NILP (handler
))
2334 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2335 file
, newname
, ok_if_already_exists
));
2337 encoded_file
= ENCODE_FILE (file
);
2338 encoded_newname
= ENCODE_FILE (newname
);
2341 /* If the file names are identical but for the case, don't ask for
2342 confirmation: they simply want to change the letter-case of the
2344 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2346 if (NILP (ok_if_already_exists
)
2347 || INTEGERP (ok_if_already_exists
))
2348 barf_or_query_if_file_exists (newname
, "rename to it",
2349 INTEGERP (ok_if_already_exists
), 0, 0);
2350 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2352 int rename_errno
= errno
;
2353 if (rename_errno
== EXDEV
)
2356 symlink_target
= Ffile_symlink_p (file
);
2357 if (! NILP (symlink_target
))
2358 Fmake_symbolic_link (symlink_target
, newname
,
2359 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2360 else if (!NILP (Ffile_directory_p (file
)))
2361 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2363 /* We have already prompted if it was an integer, so don't
2364 have copy-file prompt again. */
2365 Fcopy_file (file
, newname
,
2366 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2369 count
= SPECPDL_INDEX ();
2370 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2372 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2373 call2 (Qdelete_directory
, file
, Qt
);
2375 Fdelete_file (file
, Qnil
);
2376 unbind_to (count
, Qnil
);
2379 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2385 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2386 "fAdd name to file: \nGName to add to %s: \np",
2387 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2388 Signals a `file-already-exists' error if a file NEWNAME already exists
2389 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2390 A number as third arg means request confirmation if NEWNAME already exists.
2391 This is what happens in interactive use with M-x. */)
2392 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2394 Lisp_Object handler
;
2395 Lisp_Object encoded_file
, encoded_newname
;
2396 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2398 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2399 encoded_file
= encoded_newname
= Qnil
;
2400 CHECK_STRING (file
);
2401 CHECK_STRING (newname
);
2402 file
= Fexpand_file_name (file
, Qnil
);
2404 if (!NILP (Ffile_directory_p (newname
)))
2405 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2407 newname
= Fexpand_file_name (newname
, Qnil
);
2409 /* If the file name has special constructs in it,
2410 call the corresponding file handler. */
2411 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2412 if (!NILP (handler
))
2413 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2414 newname
, ok_if_already_exists
));
2416 /* If the new name has special constructs in it,
2417 call the corresponding file handler. */
2418 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2419 if (!NILP (handler
))
2420 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2421 newname
, ok_if_already_exists
));
2423 encoded_file
= ENCODE_FILE (file
);
2424 encoded_newname
= ENCODE_FILE (newname
);
2426 if (NILP (ok_if_already_exists
)
2427 || INTEGERP (ok_if_already_exists
))
2428 barf_or_query_if_file_exists (newname
, "make it a new name",
2429 INTEGERP (ok_if_already_exists
), 0, 0);
2431 unlink (SSDATA (newname
));
2432 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2434 int link_errno
= errno
;
2435 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2442 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2443 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2444 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2445 Both args must be strings.
2446 Signals a `file-already-exists' error if a file LINKNAME already exists
2447 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2448 A number as third arg means request confirmation if LINKNAME already exists.
2449 This happens for interactive use with M-x. */)
2450 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2452 Lisp_Object handler
;
2453 Lisp_Object encoded_filename
, encoded_linkname
;
2454 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2456 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2457 encoded_filename
= encoded_linkname
= Qnil
;
2458 CHECK_STRING (filename
);
2459 CHECK_STRING (linkname
);
2460 /* If the link target has a ~, we must expand it to get
2461 a truly valid file name. Otherwise, do not expand;
2462 we want to permit links to relative file names. */
2463 if (SREF (filename
, 0) == '~')
2464 filename
= Fexpand_file_name (filename
, Qnil
);
2466 if (!NILP (Ffile_directory_p (linkname
)))
2467 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2469 linkname
= Fexpand_file_name (linkname
, Qnil
);
2471 /* If the file name has special constructs in it,
2472 call the corresponding file handler. */
2473 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2474 if (!NILP (handler
))
2475 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2476 linkname
, ok_if_already_exists
));
2478 /* If the new link name has special constructs in it,
2479 call the corresponding file handler. */
2480 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2481 if (!NILP (handler
))
2482 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2483 linkname
, ok_if_already_exists
));
2485 encoded_filename
= ENCODE_FILE (filename
);
2486 encoded_linkname
= ENCODE_FILE (linkname
);
2488 if (NILP (ok_if_already_exists
)
2489 || INTEGERP (ok_if_already_exists
))
2490 barf_or_query_if_file_exists (linkname
, "make it a link",
2491 INTEGERP (ok_if_already_exists
), 0, 0);
2492 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2494 /* If we didn't complain already, silently delete existing file. */
2496 if (errno
== EEXIST
)
2498 unlink (SSDATA (encoded_linkname
));
2499 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2506 if (errno
== ENOSYS
)
2509 xsignal1 (Qfile_error
,
2510 build_string ("Symbolic links are not supported"));
2513 symlink_errno
= errno
;
2514 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2522 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2524 doc
: /* Return t if file FILENAME specifies an absolute file name.
2525 On Unix, this is a name starting with a `/' or a `~'. */)
2526 (Lisp_Object filename
)
2528 CHECK_STRING (filename
);
2529 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2532 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2533 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2534 See also `file-readable-p' and `file-attributes'.
2535 This returns nil for a symlink to a nonexistent file.
2536 Use `file-symlink-p' to test for such links. */)
2537 (Lisp_Object filename
)
2539 Lisp_Object absname
;
2540 Lisp_Object handler
;
2542 CHECK_STRING (filename
);
2543 absname
= Fexpand_file_name (filename
, Qnil
);
2545 /* If the file name has special constructs in it,
2546 call the corresponding file handler. */
2547 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2548 if (!NILP (handler
))
2550 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2555 absname
= ENCODE_FILE (absname
);
2557 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2560 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2561 doc
: /* Return t if FILENAME can be executed by you.
2562 For a directory, this means you can access files in that directory. */)
2563 (Lisp_Object filename
)
2565 Lisp_Object absname
;
2566 Lisp_Object handler
;
2568 CHECK_STRING (filename
);
2569 absname
= Fexpand_file_name (filename
, Qnil
);
2571 /* If the file name has special constructs in it,
2572 call the corresponding file handler. */
2573 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2574 if (!NILP (handler
))
2575 return call2 (handler
, Qfile_executable_p
, absname
);
2577 absname
= ENCODE_FILE (absname
);
2579 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2582 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2583 doc
: /* Return t if file FILENAME exists and you can read it.
2584 See also `file-exists-p' and `file-attributes'. */)
2585 (Lisp_Object filename
)
2587 Lisp_Object absname
;
2588 Lisp_Object handler
;
2590 CHECK_STRING (filename
);
2591 absname
= Fexpand_file_name (filename
, Qnil
);
2593 /* If the file name has special constructs in it,
2594 call the corresponding file handler. */
2595 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2596 if (!NILP (handler
))
2597 return call2 (handler
, Qfile_readable_p
, absname
);
2599 absname
= ENCODE_FILE (absname
);
2600 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2604 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2605 doc
: /* Return t if file FILENAME can be written or created by you. */)
2606 (Lisp_Object filename
)
2608 Lisp_Object absname
, dir
, encoded
;
2609 Lisp_Object handler
;
2611 CHECK_STRING (filename
);
2612 absname
= Fexpand_file_name (filename
, Qnil
);
2614 /* If the file name has special constructs in it,
2615 call the corresponding file handler. */
2616 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2617 if (!NILP (handler
))
2618 return call2 (handler
, Qfile_writable_p
, absname
);
2620 encoded
= ENCODE_FILE (absname
);
2621 if (check_writable (SSDATA (encoded
), W_OK
))
2623 if (errno
!= ENOENT
)
2626 dir
= Ffile_name_directory (absname
);
2627 eassert (!NILP (dir
));
2629 dir
= Fdirectory_file_name (dir
);
2632 dir
= ENCODE_FILE (dir
);
2634 /* The read-only attribute of the parent directory doesn't affect
2635 whether a file or directory can be created within it. Some day we
2636 should check ACLs though, which do affect this. */
2637 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2639 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2643 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2644 doc
: /* Access file FILENAME, and get an error if that does not work.
2645 The second argument STRING is used in the error message.
2646 If there is no error, returns nil. */)
2647 (Lisp_Object filename
, Lisp_Object string
)
2649 Lisp_Object handler
, encoded_filename
, absname
;
2651 CHECK_STRING (filename
);
2652 absname
= Fexpand_file_name (filename
, Qnil
);
2654 CHECK_STRING (string
);
2656 /* If the file name has special constructs in it,
2657 call the corresponding file handler. */
2658 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2659 if (!NILP (handler
))
2660 return call3 (handler
, Qaccess_file
, absname
, string
);
2662 encoded_filename
= ENCODE_FILE (absname
);
2664 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2665 report_file_error (SSDATA (string
), filename
);
2670 /* Relative to directory FD, return the symbolic link value of FILENAME.
2671 On failure, return nil. */
2673 emacs_readlinkat (int fd
, char const *filename
)
2675 static struct allocator
const emacs_norealloc_allocator
=
2676 { xmalloc
, NULL
, xfree
, memory_full
};
2678 char readlink_buf
[1024];
2679 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2680 &emacs_norealloc_allocator
, readlinkat
);
2684 val
= build_unibyte_string (buf
);
2685 if (buf
[0] == '/' && strchr (buf
, ':'))
2686 val
= concat2 (build_unibyte_string ("/:"), val
);
2687 if (buf
!= readlink_buf
)
2689 val
= DECODE_FILE (val
);
2693 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2694 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2695 The value is the link target, as a string.
2696 Otherwise it returns nil.
2698 This function returns t when given the name of a symlink that
2699 points to a nonexistent file. */)
2700 (Lisp_Object filename
)
2702 Lisp_Object handler
;
2704 CHECK_STRING (filename
);
2705 filename
= Fexpand_file_name (filename
, Qnil
);
2707 /* If the file name has special constructs in it,
2708 call the corresponding file handler. */
2709 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2710 if (!NILP (handler
))
2711 return call2 (handler
, Qfile_symlink_p
, filename
);
2713 filename
= ENCODE_FILE (filename
);
2715 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2718 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2719 doc
: /* Return t if FILENAME names an existing directory.
2720 Symbolic links to directories count as directories.
2721 See `file-symlink-p' to distinguish symlinks. */)
2722 (Lisp_Object filename
)
2724 Lisp_Object absname
;
2725 Lisp_Object handler
;
2727 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2729 /* If the file name has special constructs in it,
2730 call the corresponding file handler. */
2731 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2732 if (!NILP (handler
))
2733 return call2 (handler
, Qfile_directory_p
, absname
);
2735 absname
= ENCODE_FILE (absname
);
2737 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2740 /* Return true if FILE is a directory or a symlink to a directory. */
2742 file_directory_p (char const *file
)
2745 /* This is cheaper than 'stat'. */
2746 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2749 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2753 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2754 Sfile_accessible_directory_p
, 1, 1, 0,
2755 doc
: /* Return t if file FILENAME names a directory you can open.
2756 For the value to be t, FILENAME must specify the name of a directory as a file,
2757 and the directory must allow you to open files in it. In order to use a
2758 directory as a buffer's current directory, this predicate must return true.
2759 A directory name spec may be given instead; then the value is t
2760 if the directory so specified exists and really is a readable and
2761 searchable directory. */)
2762 (Lisp_Object filename
)
2764 Lisp_Object absname
;
2765 Lisp_Object handler
;
2767 CHECK_STRING (filename
);
2768 absname
= Fexpand_file_name (filename
, Qnil
);
2770 /* If the file name has special constructs in it,
2771 call the corresponding file handler. */
2772 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2773 if (!NILP (handler
))
2775 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2780 absname
= ENCODE_FILE (absname
);
2781 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2784 /* If FILE is a searchable directory or a symlink to a
2785 searchable directory, return true. Otherwise return
2786 false and set errno to an error number. */
2788 file_accessible_directory_p (char const *file
)
2791 /* There's no need to test whether FILE is searchable, as the
2792 searchable/executable bit is invented on DOS_NT platforms. */
2793 return file_directory_p (file
);
2795 /* On POSIXish platforms, use just one system call; this avoids a
2796 race and is typically faster. */
2797 ptrdiff_t len
= strlen (file
);
2803 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2804 There are three exceptions: "", "/", and "//". Leave "" alone,
2805 as it's invalid. Append only "." to the other two exceptions as
2806 "/" and "//" are distinct on some platforms, whereas "/", "///",
2807 "////", etc. are all equivalent. */
2812 /* Just check for trailing '/' when deciding whether to append '/'.
2813 That's simpler than testing the two special cases "/" and "//",
2814 and it's a safe optimization here. */
2815 char *buf
= SAFE_ALLOCA (len
+ 3);
2816 memcpy (buf
, file
, len
);
2817 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2821 ok
= check_existing (dir
);
2822 saved_errno
= errno
;
2824 errno
= saved_errno
;
2829 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2830 doc
: /* Return t if FILENAME names a regular file.
2831 This is the sort of file that holds an ordinary stream of data bytes.
2832 Symbolic links to regular files count as regular files.
2833 See `file-symlink-p' to distinguish symlinks. */)
2834 (Lisp_Object filename
)
2836 register Lisp_Object absname
;
2838 Lisp_Object handler
;
2840 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2842 /* If the file name has special constructs in it,
2843 call the corresponding file handler. */
2844 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2845 if (!NILP (handler
))
2846 return call2 (handler
, Qfile_regular_p
, absname
);
2848 absname
= ENCODE_FILE (absname
);
2853 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2855 /* Tell stat to use expensive method to get accurate info. */
2856 Vw32_get_true_file_attributes
= Qt
;
2857 result
= stat (SDATA (absname
), &st
);
2858 Vw32_get_true_file_attributes
= tem
;
2862 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2865 if (stat (SSDATA (absname
), &st
) < 0)
2867 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2871 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2872 Sfile_selinux_context
, 1, 1, 0,
2873 doc
: /* Return SELinux context of file named FILENAME.
2874 The return value is a list (USER ROLE TYPE RANGE), where the list
2875 elements are strings naming the user, role, type, and range of the
2876 file's SELinux security context.
2878 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2879 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2880 (Lisp_Object filename
)
2882 Lisp_Object absname
;
2883 Lisp_Object values
[4];
2884 Lisp_Object handler
;
2886 security_context_t con
;
2891 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2893 /* If the file name has special constructs in it,
2894 call the corresponding file handler. */
2895 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2896 if (!NILP (handler
))
2897 return call2 (handler
, Qfile_selinux_context
, absname
);
2899 absname
= ENCODE_FILE (absname
);
2906 if (is_selinux_enabled ())
2908 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2911 context
= context_new (con
);
2912 if (context_user_get (context
))
2913 values
[0] = build_string (context_user_get (context
));
2914 if (context_role_get (context
))
2915 values
[1] = build_string (context_role_get (context
));
2916 if (context_type_get (context
))
2917 values
[2] = build_string (context_type_get (context
));
2918 if (context_range_get (context
))
2919 values
[3] = build_string (context_range_get (context
));
2920 context_free (context
);
2926 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2929 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2930 Sset_file_selinux_context
, 2, 2, 0,
2931 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2932 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2933 elements are strings naming the components of a SELinux context.
2935 Value is t if setting of SELinux context was successful, nil otherwise.
2937 This function does nothing and returns nil if SELinux is disabled,
2938 or if Emacs was not compiled with SELinux support. */)
2939 (Lisp_Object filename
, Lisp_Object context
)
2941 Lisp_Object absname
;
2942 Lisp_Object handler
;
2944 Lisp_Object encoded_absname
;
2945 Lisp_Object user
= CAR_SAFE (context
);
2946 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2947 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2948 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2949 security_context_t con
;
2952 context_t parsed_con
;
2955 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2957 /* If the file name has special constructs in it,
2958 call the corresponding file handler. */
2959 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2960 if (!NILP (handler
))
2961 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2964 if (is_selinux_enabled ())
2966 /* Get current file context. */
2967 encoded_absname
= ENCODE_FILE (absname
);
2968 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2971 parsed_con
= context_new (con
);
2972 /* Change the parts defined in the parameter.*/
2975 if (context_user_set (parsed_con
, SSDATA (user
)))
2976 error ("Doing context_user_set");
2980 if (context_role_set (parsed_con
, SSDATA (role
)))
2981 error ("Doing context_role_set");
2985 if (context_type_set (parsed_con
, SSDATA (type
)))
2986 error ("Doing context_type_set");
2988 if (STRINGP (range
))
2990 if (context_range_set (parsed_con
, SSDATA (range
)))
2991 error ("Doing context_range_set");
2994 /* Set the modified context back to the file. */
2995 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2996 context_str (parsed_con
))
2998 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2999 if (fail
&& errno
!= ENOTSUP
)
3000 report_file_error ("Doing lsetfilecon", absname
);
3002 context_free (parsed_con
);
3004 return fail
? Qnil
: Qt
;
3007 report_file_error ("Doing lgetfilecon", absname
);
3014 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3015 doc
: /* Return ACL entries of file named FILENAME.
3016 The entries are returned in a format suitable for use in `set-file-acl'
3017 but is otherwise undocumented and subject to change.
3018 Return nil if file does not exist or is not accessible, or if Emacs
3019 was unable to determine the ACL entries. */)
3020 (Lisp_Object filename
)
3022 Lisp_Object absname
;
3023 Lisp_Object handler
;
3024 #ifdef HAVE_ACL_SET_FILE
3026 Lisp_Object acl_string
;
3030 absname
= expand_and_dir_to_file (filename
,
3031 BVAR (current_buffer
, directory
));
3033 /* If the file name has special constructs in it,
3034 call the corresponding file handler. */
3035 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3036 if (!NILP (handler
))
3037 return call2 (handler
, Qfile_acl
, absname
);
3039 #ifdef HAVE_ACL_SET_FILE
3040 absname
= ENCODE_FILE (absname
);
3042 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3046 str
= acl_to_text (acl
, NULL
);
3053 acl_string
= build_string (str
);
3063 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3065 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3066 ACL-STRING should contain the textual representation of the ACL
3067 entries in a format suitable for the platform.
3069 Value is t if setting of ACL was successful, nil otherwise.
3071 Setting ACL for local files requires Emacs to be built with ACL
3073 (Lisp_Object filename
, Lisp_Object acl_string
)
3075 Lisp_Object absname
;
3076 Lisp_Object handler
;
3077 #ifdef HAVE_ACL_SET_FILE
3078 Lisp_Object encoded_absname
;
3083 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3085 /* If the file name has special constructs in it,
3086 call the corresponding file handler. */
3087 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3088 if (!NILP (handler
))
3089 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3091 #ifdef HAVE_ACL_SET_FILE
3092 if (STRINGP (acl_string
))
3094 acl
= acl_from_text (SSDATA (acl_string
));
3097 report_file_error ("Converting ACL", absname
);
3101 encoded_absname
= ENCODE_FILE (absname
);
3103 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3106 if (fail
&& acl_errno_valid (errno
))
3107 report_file_error ("Setting ACL", absname
);
3110 return fail
? Qnil
: Qt
;
3117 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3118 doc
: /* Return mode bits of file named FILENAME, as an integer.
3119 Return nil, if file does not exist or is not accessible. */)
3120 (Lisp_Object filename
)
3122 Lisp_Object absname
;
3124 Lisp_Object handler
;
3126 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3128 /* If the file name has special constructs in it,
3129 call the corresponding file handler. */
3130 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3131 if (!NILP (handler
))
3132 return call2 (handler
, Qfile_modes
, absname
);
3134 absname
= ENCODE_FILE (absname
);
3136 if (stat (SSDATA (absname
), &st
) < 0)
3139 return make_number (st
.st_mode
& 07777);
3142 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3143 "(let ((file (read-file-name \"File: \"))) \
3144 (list file (read-file-modes nil file)))",
3145 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3146 Only the 12 low bits of MODE are used.
3148 Interactively, mode bits are read by `read-file-modes', which accepts
3149 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3150 (Lisp_Object filename
, Lisp_Object mode
)
3152 Lisp_Object absname
, encoded_absname
;
3153 Lisp_Object handler
;
3155 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3156 CHECK_NUMBER (mode
);
3158 /* If the file name has special constructs in it,
3159 call the corresponding file handler. */
3160 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3161 if (!NILP (handler
))
3162 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3164 encoded_absname
= ENCODE_FILE (absname
);
3166 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3167 report_file_error ("Doing chmod", absname
);
3172 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3173 doc
: /* Set the file permission bits for newly created files.
3174 The argument MODE should be an integer; only the low 9 bits are used.
3175 This setting is inherited by subprocesses. */)
3178 CHECK_NUMBER (mode
);
3180 umask ((~ XINT (mode
)) & 0777);
3185 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3186 doc
: /* Return the default file protection for created files.
3187 The value is an integer. */)
3194 realmask
= umask (0);
3198 XSETINT (value
, (~ realmask
) & 0777);
3203 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3204 doc
: /* Set times of file FILENAME to TIMESTAMP.
3205 Set both access and modification times.
3206 Return t on success, else nil.
3207 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3209 (Lisp_Object filename
, Lisp_Object timestamp
)
3211 Lisp_Object absname
, encoded_absname
;
3212 Lisp_Object handler
;
3213 struct timespec t
= lisp_time_argument (timestamp
);
3215 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3217 /* If the file name has special constructs in it,
3218 call the corresponding file handler. */
3219 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3220 if (!NILP (handler
))
3221 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3223 encoded_absname
= ENCODE_FILE (absname
);
3226 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3229 /* Setting times on a directory always fails. */
3230 if (file_directory_p (SSDATA (encoded_absname
)))
3233 report_file_error ("Setting file times", absname
);
3241 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3242 doc
: /* Tell Unix to finish all pending disk updates. */)
3249 #endif /* HAVE_SYNC */
3251 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3252 doc
: /* Return t if file FILE1 is newer than file FILE2.
3253 If FILE1 does not exist, the answer is nil;
3254 otherwise, if FILE2 does not exist, the answer is t. */)
3255 (Lisp_Object file1
, Lisp_Object file2
)
3257 Lisp_Object absname1
, absname2
;
3258 struct stat st1
, st2
;
3259 Lisp_Object handler
;
3260 struct gcpro gcpro1
, gcpro2
;
3262 CHECK_STRING (file1
);
3263 CHECK_STRING (file2
);
3266 GCPRO2 (absname1
, file2
);
3267 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3268 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3271 /* If the file name has special constructs in it,
3272 call the corresponding file handler. */
3273 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3275 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3276 if (!NILP (handler
))
3277 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3279 GCPRO2 (absname1
, absname2
);
3280 absname1
= ENCODE_FILE (absname1
);
3281 absname2
= ENCODE_FILE (absname2
);
3284 if (stat (SSDATA (absname1
), &st1
) < 0)
3287 if (stat (SSDATA (absname2
), &st2
) < 0)
3290 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3294 #ifndef READ_BUF_SIZE
3295 #define READ_BUF_SIZE (64 << 10)
3297 /* Some buffer offsets are stored in 'int' variables. */
3298 verify (READ_BUF_SIZE
<= INT_MAX
);
3300 /* This function is called after Lisp functions to decide a coding
3301 system are called, or when they cause an error. Before they are
3302 called, the current buffer is set unibyte and it contains only a
3303 newly inserted text (thus the buffer was empty before the
3306 The functions may set markers, overlays, text properties, or even
3307 alter the buffer contents, change the current buffer.
3309 Here, we reset all those changes by:
3310 o set back the current buffer.
3311 o move all markers and overlays to BEG.
3312 o remove all text properties.
3313 o set back the buffer multibyteness. */
3316 decide_coding_unwind (Lisp_Object unwind_data
)
3318 Lisp_Object multibyte
, undo_list
, buffer
;
3320 multibyte
= XCAR (unwind_data
);
3321 unwind_data
= XCDR (unwind_data
);
3322 undo_list
= XCAR (unwind_data
);
3323 buffer
= XCDR (unwind_data
);
3325 set_buffer_internal (XBUFFER (buffer
));
3326 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3327 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3328 set_buffer_intervals (current_buffer
, NULL
);
3329 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3331 /* Now we are safe to change the buffer's multibyteness directly. */
3332 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3333 bset_undo_list (current_buffer
, undo_list
);
3336 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3337 object where slot 0 is the file descriptor, slot 1 specifies
3338 an offset to put the read bytes, and slot 2 is the maximum
3339 amount of bytes to read. Value is the number of bytes read. */
3342 read_non_regular (Lisp_Object state
)
3348 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3349 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3350 + XSAVE_INTEGER (state
, 1)),
3351 XSAVE_INTEGER (state
, 2));
3353 /* Fast recycle this object for the likely next call. */
3355 return make_number (nbytes
);
3359 /* Condition-case handler used when reading from non-regular files
3360 in insert-file-contents. */
3363 read_non_regular_quit (Lisp_Object ignore
)
3368 /* Return the file offset that VAL represents, checking for type
3369 errors and overflow. */
3371 file_offset (Lisp_Object val
)
3373 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3378 double v
= XFLOAT_DATA (val
);
3380 && (sizeof (off_t
) < sizeof v
3381 ? v
<= TYPE_MAXIMUM (off_t
)
3382 : v
< TYPE_MAXIMUM (off_t
)))
3386 wrong_type_argument (intern ("file-offset"), val
);
3389 /* Return a special time value indicating the error number ERRNUM. */
3390 static struct timespec
3391 time_error_value (int errnum
)
3393 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3394 ? NONEXISTENT_MODTIME_NSECS
3395 : UNKNOWN_MODTIME_NSECS
);
3396 return make_timespec (0, ns
);
3399 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3401 doc
: /* Insert contents of file FILENAME after point.
3402 Returns list of absolute file name and number of characters inserted.
3403 If second argument VISIT is non-nil, the buffer's visited filename and
3404 last save file modtime are set, and it is marked unmodified. If
3405 visiting and the file does not exist, visiting is completed before the
3408 The optional third and fourth arguments BEG and END specify what portion
3409 of the file to insert. These arguments count bytes in the file, not
3410 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3412 If optional fifth argument REPLACE is non-nil, replace the current
3413 buffer contents (in the accessible portion) with the file contents.
3414 This is better than simply deleting and inserting the whole thing
3415 because (1) it preserves some marker positions and (2) it puts less data
3416 in the undo list. When REPLACE is non-nil, the second return value is
3417 the number of characters that replace previous buffer contents.
3419 This function does code conversion according to the value of
3420 `coding-system-for-read' or `file-coding-system-alist', and sets the
3421 variable `last-coding-system-used' to the coding system actually used.
3423 In addition, this function decodes the inserted text from known formats
3424 by calling `format-decode', which see. */)
3425 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3428 struct timespec mtime
;
3430 ptrdiff_t inserted
= 0;
3432 off_t beg_offset
, end_offset
;
3434 ptrdiff_t count
= SPECPDL_INDEX ();
3435 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3436 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3438 ptrdiff_t total
= 0;
3439 bool not_regular
= 0;
3441 char read_buf
[READ_BUF_SIZE
];
3442 struct coding_system coding
;
3443 bool replace_handled
= 0;
3444 bool set_coding_system
= 0;
3445 Lisp_Object coding_system
;
3447 /* If the undo log only contains the insertion, there's no point
3448 keeping it. It's typically when we first fill a file-buffer. */
3449 bool empty_undo_list_p
3450 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3452 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3453 bool we_locked_file
= 0;
3456 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3457 error ("Cannot do file visiting in an indirect buffer");
3459 if (!NILP (BVAR (current_buffer
, read_only
)))
3460 Fbarf_if_buffer_read_only ();
3464 orig_filename
= Qnil
;
3467 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3469 CHECK_STRING (filename
);
3470 filename
= Fexpand_file_name (filename
, Qnil
);
3472 /* The value Qnil means that the coding system is not yet
3474 coding_system
= Qnil
;
3476 /* If the file name has special constructs in it,
3477 call the corresponding file handler. */
3478 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3479 if (!NILP (handler
))
3481 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3482 visit
, beg
, end
, replace
);
3483 if (CONSP (val
) && CONSP (XCDR (val
))
3484 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3485 inserted
= XINT (XCAR (XCDR (val
)));
3489 orig_filename
= filename
;
3490 filename
= ENCODE_FILE (filename
);
3492 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3497 report_file_error ("Opening input file", orig_filename
);
3498 mtime
= time_error_value (save_errno
);
3500 if (!NILP (Vcoding_system_for_read
))
3501 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3505 fd_index
= SPECPDL_INDEX ();
3506 record_unwind_protect_int (close_file_unwind
, fd
);
3508 /* Replacement should preserve point as it preserves markers. */
3509 if (!NILP (replace
))
3510 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3512 if (fstat (fd
, &st
) != 0)
3513 report_file_error ("Input file status", orig_filename
);
3514 mtime
= get_stat_mtime (&st
);
3516 /* This code will need to be changed in order to work on named
3517 pipes, and it's probably just not worth it. So we should at
3518 least signal an error. */
3519 if (!S_ISREG (st
.st_mode
))
3526 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3527 xsignal2 (Qfile_error
,
3528 build_string ("not a regular file"), orig_filename
);
3533 if (!NILP (beg
) || !NILP (end
))
3534 error ("Attempt to visit less than an entire file");
3535 if (BEG
< Z
&& NILP (replace
))
3536 error ("Cannot do file visiting in a non-empty buffer");
3540 beg_offset
= file_offset (beg
);
3545 end_offset
= file_offset (end
);
3549 end_offset
= TYPE_MAXIMUM (off_t
);
3552 end_offset
= st
.st_size
;
3554 /* A negative size can happen on a platform that allows file
3555 sizes greater than the maximum off_t value. */
3559 /* The file size returned from stat may be zero, but data
3560 may be readable nonetheless, for example when this is a
3561 file in the /proc filesystem. */
3562 if (end_offset
== 0)
3563 end_offset
= READ_BUF_SIZE
;
3567 /* Check now whether the buffer will become too large,
3568 in the likely case where the file's length is not changing.
3569 This saves a lot of needless work before a buffer overflow. */
3572 /* The likely offset where we will stop reading. We could read
3573 more (or less), if the file grows (or shrinks) as we read it. */
3574 off_t likely_end
= min (end_offset
, st
.st_size
);
3576 if (beg_offset
< likely_end
)
3579 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3580 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3581 off_t likely_growth
= likely_end
- beg_offset
;
3582 if (buf_growth_max
< likely_growth
)
3587 /* Prevent redisplay optimizations. */
3588 current_buffer
->clip_changed
= 1;
3590 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3592 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3593 setup_coding_system (coding_system
, &coding
);
3594 /* Ensure we set Vlast_coding_system_used. */
3595 set_coding_system
= 1;
3599 /* Decide the coding system to use for reading the file now
3600 because we can't use an optimized method for handling
3601 `coding:' tag if the current buffer is not empty. */
3602 if (!NILP (Vcoding_system_for_read
))
3603 coding_system
= Vcoding_system_for_read
;
3606 /* Don't try looking inside a file for a coding system
3607 specification if it is not seekable. */
3608 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3610 /* Find a coding system specified in the heading two
3611 lines or in the tailing several lines of the file.
3612 We assume that the 1K-byte and 3K-byte for heading
3613 and tailing respectively are sufficient for this
3617 if (st
.st_size
<= (1024 * 4))
3618 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3621 nread
= emacs_read (fd
, read_buf
, 1024);
3625 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3626 report_file_error ("Setting file position",
3628 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3629 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3634 report_file_error ("Read error", orig_filename
);
3637 struct buffer
*prev
= current_buffer
;
3638 Lisp_Object workbuf
;
3641 record_unwind_current_buffer ();
3643 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3644 buf
= XBUFFER (workbuf
);
3646 delete_all_overlays (buf
);
3647 bset_directory (buf
, BVAR (current_buffer
, directory
));
3648 bset_read_only (buf
, Qnil
);
3649 bset_filename (buf
, Qnil
);
3650 bset_undo_list (buf
, Qt
);
3651 eassert (buf
->overlays_before
== NULL
);
3652 eassert (buf
->overlays_after
== NULL
);
3654 set_buffer_internal (buf
);
3656 bset_enable_multibyte_characters (buf
, Qnil
);
3658 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3659 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3660 coding_system
= call2 (Vset_auto_coding_function
,
3661 filename
, make_number (nread
));
3662 set_buffer_internal (prev
);
3664 /* Discard the unwind protect for recovering the
3668 /* Rewind the file for the actual read done later. */
3669 if (lseek (fd
, 0, SEEK_SET
) < 0)
3670 report_file_error ("Setting file position", orig_filename
);
3674 if (NILP (coding_system
))
3676 /* If we have not yet decided a coding system, check
3677 file-coding-system-alist. */
3678 Lisp_Object args
[6];
3680 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3681 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3682 coding_system
= Ffind_operation_coding_system (6, args
);
3683 if (CONSP (coding_system
))
3684 coding_system
= XCAR (coding_system
);
3688 if (NILP (coding_system
))
3689 coding_system
= Qundecided
;
3691 CHECK_CODING_SYSTEM (coding_system
);
3693 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3694 /* We must suppress all character code conversion except for
3695 end-of-line conversion. */
3696 coding_system
= raw_text_coding_system (coding_system
);
3698 setup_coding_system (coding_system
, &coding
);
3699 /* Ensure we set Vlast_coding_system_used. */
3700 set_coding_system
= 1;
3703 /* If requested, replace the accessible part of the buffer
3704 with the file contents. Avoid replacing text at the
3705 beginning or end of the buffer that matches the file contents;
3706 that preserves markers pointing to the unchanged parts.
3708 Here we implement this feature in an optimized way
3709 for the case where code conversion is NOT needed.
3710 The following if-statement handles the case of conversion
3711 in a less optimal way.
3713 If the code conversion is "automatic" then we try using this
3714 method and hope for the best.
3715 But if we discover the need for conversion, we give up on this method
3716 and let the following if-statement handle the replace job. */
3719 && (NILP (coding_system
)
3720 || ! CODING_REQUIRE_DECODING (&coding
)))
3722 /* same_at_start and same_at_end count bytes,
3723 because file access counts bytes
3724 and BEG and END count bytes. */
3725 ptrdiff_t same_at_start
= BEGV_BYTE
;
3726 ptrdiff_t same_at_end
= ZV_BYTE
;
3728 /* There is still a possibility we will find the need to do code
3729 conversion. If that happens, set this variable to
3730 give up on handling REPLACE in the optimized way. */
3731 bool giveup_match_end
= 0;
3733 if (beg_offset
!= 0)
3735 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3736 report_file_error ("Setting file position", orig_filename
);
3741 /* Count how many chars at the start of the file
3742 match the text at the beginning of the buffer. */
3747 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3749 report_file_error ("Read error", orig_filename
);
3750 else if (nread
== 0)
3753 if (CODING_REQUIRE_DETECTION (&coding
))
3755 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3758 setup_coding_system (coding_system
, &coding
);
3761 if (CODING_REQUIRE_DECODING (&coding
))
3762 /* We found that the file should be decoded somehow.
3763 Let's give up here. */
3765 giveup_match_end
= 1;
3770 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3771 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3772 same_at_start
++, bufpos
++;
3773 /* If we found a discrepancy, stop the scan.
3774 Otherwise loop around and scan the next bufferful. */
3775 if (bufpos
!= nread
)
3779 /* If the file matches the buffer completely,
3780 there's no need to replace anything. */
3781 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3784 clear_unwind_protect (fd_index
);
3786 /* Truncate the buffer to the size of the file. */
3787 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3792 /* Count how many chars at the end of the file
3793 match the text at the end of the buffer. But, if we have
3794 already found that decoding is necessary, don't waste time. */
3795 while (!giveup_match_end
)
3797 int total_read
, nread
, bufpos
, trial
;
3800 /* At what file position are we now scanning? */
3801 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3802 /* If the entire file matches the buffer tail, stop the scan. */
3805 /* How much can we scan in the next step? */
3806 trial
= min (curpos
, sizeof read_buf
);
3807 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3808 report_file_error ("Setting file position", orig_filename
);
3810 total_read
= nread
= 0;
3811 while (total_read
< trial
)
3813 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3815 report_file_error ("Read error", orig_filename
);
3816 else if (nread
== 0)
3818 total_read
+= nread
;
3821 /* Scan this bufferful from the end, comparing with
3822 the Emacs buffer. */
3823 bufpos
= total_read
;
3825 /* Compare with same_at_start to avoid counting some buffer text
3826 as matching both at the file's beginning and at the end. */
3827 while (bufpos
> 0 && same_at_end
> same_at_start
3828 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3829 same_at_end
--, bufpos
--;
3831 /* If we found a discrepancy, stop the scan.
3832 Otherwise loop around and scan the preceding bufferful. */
3835 /* If this discrepancy is because of code conversion,
3836 we cannot use this method; giveup and try the other. */
3837 if (same_at_end
> same_at_start
3838 && FETCH_BYTE (same_at_end
- 1) >= 0200
3839 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3840 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3841 giveup_match_end
= 1;
3850 if (! giveup_match_end
)
3854 /* We win! We can handle REPLACE the optimized way. */
3856 /* Extend the start of non-matching text area to multibyte
3857 character boundary. */
3858 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3859 while (same_at_start
> BEGV_BYTE
3860 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3863 /* Extend the end of non-matching text area to multibyte
3864 character boundary. */
3865 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3866 while (same_at_end
< ZV_BYTE
3867 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3870 /* Don't try to reuse the same piece of text twice. */
3871 overlap
= (same_at_start
- BEGV_BYTE
3873 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3875 same_at_end
+= overlap
;
3877 /* Arrange to read only the nonmatching middle part of the file. */
3878 beg_offset
+= same_at_start
- BEGV_BYTE
;
3879 end_offset
-= ZV_BYTE
- same_at_end
;
3881 invalidate_buffer_caches (current_buffer
,
3882 BYTE_TO_CHAR (same_at_start
),
3883 BYTE_TO_CHAR (same_at_end
));
3884 del_range_byte (same_at_start
, same_at_end
, 0);
3885 /* Insert from the file at the proper position. */
3886 temp
= BYTE_TO_CHAR (same_at_start
);
3887 SET_PT_BOTH (temp
, same_at_start
);
3889 /* If display currently starts at beginning of line,
3890 keep it that way. */
3891 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3892 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3894 replace_handled
= 1;
3898 /* If requested, replace the accessible part of the buffer
3899 with the file contents. Avoid replacing text at the
3900 beginning or end of the buffer that matches the file contents;
3901 that preserves markers pointing to the unchanged parts.
3903 Here we implement this feature for the case where code conversion
3904 is needed, in a simple way that needs a lot of memory.
3905 The preceding if-statement handles the case of no conversion
3906 in a more optimized way. */
3907 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3909 ptrdiff_t same_at_start
= BEGV_BYTE
;
3910 ptrdiff_t same_at_end
= ZV_BYTE
;
3911 ptrdiff_t same_at_start_charpos
;
3912 ptrdiff_t inserted_chars
;
3915 unsigned char *decoded
;
3918 ptrdiff_t this_count
= SPECPDL_INDEX ();
3920 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3921 Lisp_Object conversion_buffer
;
3922 struct gcpro gcpro1
;
3924 conversion_buffer
= code_conversion_save (1, multibyte
);
3926 /* First read the whole file, performing code conversion into
3927 CONVERSION_BUFFER. */
3929 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3930 report_file_error ("Setting file position", orig_filename
);
3932 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3933 unprocessed
= 0; /* Bytes not processed in previous loop. */
3935 GCPRO1 (conversion_buffer
);
3938 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3939 quitting while reading a huge file. */
3941 /* Allow quitting out of the actual I/O. */
3944 this = emacs_read (fd
, read_buf
+ unprocessed
,
3945 READ_BUF_SIZE
- unprocessed
);
3951 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3952 BUF_Z (XBUFFER (conversion_buffer
)));
3953 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3954 unprocessed
+ this, conversion_buffer
);
3955 unprocessed
= coding
.carryover_bytes
;
3956 if (coding
.carryover_bytes
> 0)
3957 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3961 report_file_error ("Read error", orig_filename
);
3963 clear_unwind_protect (fd_index
);
3965 if (unprocessed
> 0)
3967 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3968 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3969 unprocessed
, conversion_buffer
);
3970 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3973 coding_system
= CODING_ID_NAME (coding
.id
);
3974 set_coding_system
= 1;
3975 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3976 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3977 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3979 /* Compare the beginning of the converted string with the buffer
3983 while (bufpos
< inserted
&& same_at_start
< same_at_end
3984 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3985 same_at_start
++, bufpos
++;
3987 /* If the file matches the head of buffer completely,
3988 there's no need to replace anything. */
3990 if (bufpos
== inserted
)
3992 /* Truncate the buffer to the size of the file. */
3993 if (same_at_start
!= same_at_end
)
3995 invalidate_buffer_caches (current_buffer
,
3996 BYTE_TO_CHAR (same_at_start
),
3997 BYTE_TO_CHAR (same_at_end
));
3998 del_range_byte (same_at_start
, same_at_end
, 0);
4002 unbind_to (this_count
, Qnil
);
4006 /* Extend the start of non-matching text area to the previous
4007 multibyte character boundary. */
4008 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4009 while (same_at_start
> BEGV_BYTE
4010 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4013 /* Scan this bufferful from the end, comparing with
4014 the Emacs buffer. */
4017 /* Compare with same_at_start to avoid counting some buffer text
4018 as matching both at the file's beginning and at the end. */
4019 while (bufpos
> 0 && same_at_end
> same_at_start
4020 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4021 same_at_end
--, bufpos
--;
4023 /* Extend the end of non-matching text area to the next
4024 multibyte character boundary. */
4025 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4026 while (same_at_end
< ZV_BYTE
4027 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4030 /* Don't try to reuse the same piece of text twice. */
4031 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4033 same_at_end
+= overlap
;
4035 /* If display currently starts at beginning of line,
4036 keep it that way. */
4037 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4038 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4040 /* Replace the chars that we need to replace,
4041 and update INSERTED to equal the number of bytes
4042 we are taking from the decoded string. */
4043 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4045 if (same_at_end
!= same_at_start
)
4047 invalidate_buffer_caches (current_buffer
,
4048 BYTE_TO_CHAR (same_at_start
),
4049 BYTE_TO_CHAR (same_at_end
));
4050 del_range_byte (same_at_start
, same_at_end
, 0);
4052 eassert (same_at_start
== GPT_BYTE
);
4053 same_at_start
= GPT_BYTE
;
4057 temp
= BYTE_TO_CHAR (same_at_start
);
4059 /* Insert from the file at the proper position. */
4060 SET_PT_BOTH (temp
, same_at_start
);
4061 same_at_start_charpos
4062 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4063 same_at_start
- BEGV_BYTE
4064 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4065 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4067 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4068 same_at_start
+ inserted
- BEGV_BYTE
4069 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4070 - same_at_start_charpos
);
4071 /* This binding is to avoid ask-user-about-supersession-threat
4072 being called in insert_from_buffer (via in
4073 prepare_to_modify_buffer). */
4074 specbind (intern ("buffer-file-name"), Qnil
);
4075 insert_from_buffer (XBUFFER (conversion_buffer
),
4076 same_at_start_charpos
, inserted_chars
, 0);
4077 /* Set `inserted' to the number of inserted characters. */
4078 inserted
= PT
- temp
;
4079 /* Set point before the inserted characters. */
4080 SET_PT_BOTH (temp
, same_at_start
);
4082 unbind_to (this_count
, Qnil
);
4088 total
= end_offset
- beg_offset
;
4090 /* For a special file, all we can do is guess. */
4091 total
= READ_BUF_SIZE
;
4093 if (NILP (visit
) && total
> 0)
4095 #ifdef CLASH_DETECTION
4096 if (!NILP (BVAR (current_buffer
, file_truename
))
4097 /* Make binding buffer-file-name to nil effective. */
4098 && !NILP (BVAR (current_buffer
, filename
))
4099 && SAVE_MODIFF
>= MODIFF
)
4101 #endif /* CLASH_DETECTION */
4102 prepare_to_modify_buffer (GPT
, GPT
, 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. */
4201 #ifdef CLASH_DETECTION
4203 unlock_file (BVAR (current_buffer
, file_truename
));
4205 Vdeactivate_mark
= old_Vdeactivate_mark
;
4208 Vdeactivate_mark
= Qt
;
4211 clear_unwind_protect (fd_index
);
4214 report_file_error ("Read error", orig_filename
);
4216 /* Make the text read part of the buffer. */
4217 GAP_SIZE
-= inserted
;
4219 GPT_BYTE
+= inserted
;
4221 ZV_BYTE
+= inserted
;
4226 /* Put an anchor to ensure multi-byte form ends at gap. */
4231 if (NILP (coding_system
))
4233 /* The coding system is not yet decided. Decide it by an
4234 optimized method for handling `coding:' tag.
4236 Note that we can get here only if the buffer was empty
4237 before the insertion. */
4239 if (!NILP (Vcoding_system_for_read
))
4240 coding_system
= Vcoding_system_for_read
;
4243 /* Since we are sure that the current buffer was empty
4244 before the insertion, we can toggle
4245 enable-multibyte-characters directly here without taking
4246 care of marker adjustment. By this way, we can run Lisp
4247 program safely before decoding the inserted text. */
4248 Lisp_Object unwind_data
;
4249 ptrdiff_t count1
= SPECPDL_INDEX ();
4251 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4252 Fcons (BVAR (current_buffer
, undo_list
),
4253 Fcurrent_buffer ()));
4254 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4255 bset_undo_list (current_buffer
, Qt
);
4256 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4258 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4260 coding_system
= call2 (Vset_auto_coding_function
,
4261 filename
, make_number (inserted
));
4264 if (NILP (coding_system
))
4266 /* If the coding system is not yet decided, check
4267 file-coding-system-alist. */
4268 Lisp_Object args
[6];
4270 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4271 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4272 coding_system
= Ffind_operation_coding_system (6, args
);
4273 if (CONSP (coding_system
))
4274 coding_system
= XCAR (coding_system
);
4276 unbind_to (count1
, Qnil
);
4277 inserted
= Z_BYTE
- BEG_BYTE
;
4280 if (NILP (coding_system
))
4281 coding_system
= Qundecided
;
4283 CHECK_CODING_SYSTEM (coding_system
);
4285 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4286 /* We must suppress all character code conversion except for
4287 end-of-line conversion. */
4288 coding_system
= raw_text_coding_system (coding_system
);
4289 setup_coding_system (coding_system
, &coding
);
4290 /* Ensure we set Vlast_coding_system_used. */
4291 set_coding_system
= 1;
4296 /* When we visit a file by raw-text, we change the buffer to
4298 if (CODING_FOR_UNIBYTE (&coding
)
4299 /* Can't do this if part of the buffer might be preserved. */
4301 /* Visiting a file with these coding system makes the buffer
4303 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4306 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4307 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4308 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4310 move_gap_both (PT
, PT_BYTE
);
4311 GAP_SIZE
+= inserted
;
4312 ZV_BYTE
-= inserted
;
4316 decode_coding_gap (&coding
, inserted
, inserted
);
4317 inserted
= coding
.produced_char
;
4318 coding_system
= CODING_ID_NAME (coding
.id
);
4320 else if (inserted
> 0)
4321 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4324 /* Call after-change hooks for the inserted text, aside from the case
4325 of normal visiting (not with REPLACE), which is done in a new buffer
4326 "before" the buffer is changed. */
4327 if (inserted
> 0 && total
> 0
4328 && (NILP (visit
) || !NILP (replace
)))
4330 signal_after_change (PT
, 0, inserted
);
4331 update_compositions (PT
, PT
, CHECK_BORDER
);
4334 /* Now INSERTED is measured in characters. */
4340 if (empty_undo_list_p
)
4341 bset_undo_list (current_buffer
, Qnil
);
4345 current_buffer
->modtime
= mtime
;
4346 current_buffer
->modtime_size
= st
.st_size
;
4347 bset_filename (current_buffer
, orig_filename
);
4350 SAVE_MODIFF
= MODIFF
;
4351 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4352 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4353 #ifdef CLASH_DETECTION
4356 if (!NILP (BVAR (current_buffer
, file_truename
)))
4357 unlock_file (BVAR (current_buffer
, file_truename
));
4358 unlock_file (filename
);
4360 #endif /* CLASH_DETECTION */
4362 xsignal2 (Qfile_error
,
4363 build_string ("not a regular file"), orig_filename
);
4366 if (set_coding_system
)
4367 Vlast_coding_system_used
= coding_system
;
4369 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4371 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4373 if (! NILP (insval
))
4375 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4376 wrong_type_argument (intern ("inserted-chars"), insval
);
4377 inserted
= XFASTINT (insval
);
4381 /* Decode file format. */
4384 /* Don't run point motion or modification hooks when decoding. */
4385 ptrdiff_t count1
= SPECPDL_INDEX ();
4386 ptrdiff_t old_inserted
= inserted
;
4387 specbind (Qinhibit_point_motion_hooks
, Qt
);
4388 specbind (Qinhibit_modification_hooks
, Qt
);
4390 /* Save old undo list and don't record undo for decoding. */
4391 old_undo
= BVAR (current_buffer
, undo_list
);
4392 bset_undo_list (current_buffer
, Qt
);
4396 insval
= call3 (Qformat_decode
,
4397 Qnil
, make_number (inserted
), visit
);
4398 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4399 wrong_type_argument (intern ("inserted-chars"), insval
);
4400 inserted
= XFASTINT (insval
);
4404 /* If REPLACE is non-nil and we succeeded in not replacing the
4405 beginning or end of the buffer text with the file's contents,
4406 call format-decode with `point' positioned at the beginning
4407 of the buffer and `inserted' equaling the number of
4408 characters in the buffer. Otherwise, format-decode might
4409 fail to correctly analyze the beginning or end of the buffer.
4410 Hence we temporarily save `point' and `inserted' here and
4411 restore `point' iff format-decode did not insert or delete
4412 any text. Otherwise we leave `point' at point-min. */
4413 ptrdiff_t opoint
= PT
;
4414 ptrdiff_t opoint_byte
= PT_BYTE
;
4415 ptrdiff_t oinserted
= ZV
- BEGV
;
4416 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4418 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4419 insval
= call3 (Qformat_decode
,
4420 Qnil
, make_number (oinserted
), visit
);
4421 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4422 wrong_type_argument (intern ("inserted-chars"), insval
);
4423 if (ochars_modiff
== CHARS_MODIFF
)
4424 /* format_decode didn't modify buffer's characters => move
4425 point back to position before inserted text and leave
4426 value of inserted alone. */
4427 SET_PT_BOTH (opoint
, opoint_byte
);
4429 /* format_decode modified buffer's characters => consider
4430 entire buffer changed and leave point at point-min. */
4431 inserted
= XFASTINT (insval
);
4434 /* For consistency with format-decode call these now iff inserted > 0
4435 (martin 2007-06-28). */
4436 p
= Vafter_insert_file_functions
;
4441 insval
= call1 (XCAR (p
), make_number (inserted
));
4444 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4445 wrong_type_argument (intern ("inserted-chars"), insval
);
4446 inserted
= XFASTINT (insval
);
4451 /* For the rationale of this see the comment on
4452 format-decode above. */
4453 ptrdiff_t opoint
= PT
;
4454 ptrdiff_t opoint_byte
= PT_BYTE
;
4455 ptrdiff_t oinserted
= ZV
- BEGV
;
4456 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4458 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4459 insval
= call1 (XCAR (p
), make_number (oinserted
));
4462 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4463 wrong_type_argument (intern ("inserted-chars"), insval
);
4464 if (ochars_modiff
== CHARS_MODIFF
)
4465 /* after_insert_file_functions didn't modify
4466 buffer's characters => move point back to
4467 position before inserted text and leave value of
4469 SET_PT_BOTH (opoint
, opoint_byte
);
4471 /* after_insert_file_functions did modify buffer's
4472 characters => consider entire buffer changed and
4473 leave point at point-min. */
4474 inserted
= XFASTINT (insval
);
4482 if (!empty_undo_list_p
)
4484 bset_undo_list (current_buffer
, old_undo
);
4485 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4487 /* Adjust the last undo record for the size change during
4488 the format conversion. */
4489 Lisp_Object tem
= XCAR (old_undo
);
4490 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4491 && INTEGERP (XCDR (tem
))
4492 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4493 XSETCDR (tem
, make_number (PT
+ inserted
));
4497 /* If undo_list was Qt before, keep it that way.
4498 Otherwise start with an empty undo_list. */
4499 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4501 unbind_to (count1
, Qnil
);
4505 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4507 /* If visiting nonexistent file, return nil. */
4508 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4511 /* We made a lot of deletions and insertions above, so invalidate
4512 the newline cache for the entire region of the inserted
4514 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
));
4526 RETURN_UNGCPRO (unbind_to (count
, val
));
4529 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4532 build_annotations_unwind (Lisp_Object arg
)
4534 Vwrite_region_annotation_buffers
= arg
;
4537 /* Decide the coding-system to encode the data with. */
4539 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4540 Schoose_write_coding_system
, 3, 6, 0,
4541 doc
: /* Choose the coding system for writing a file.
4542 Arguments are as for `write-region'.
4543 This function is for internal use only. It may prompt the user. */ )
4544 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4545 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4548 Lisp_Object eol_parent
= Qnil
;
4550 /* Mimic write-region behavior. */
4553 XSETFASTINT (start
, BEGV
);
4554 XSETFASTINT (end
, ZV
);
4558 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4559 BVAR (current_buffer
, auto_save_file_name
))))
4564 else if (!NILP (Vcoding_system_for_write
))
4566 val
= Vcoding_system_for_write
;
4567 if (coding_system_require_warning
4568 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4569 /* Confirm that VAL can surely encode the current region. */
4570 val
= call5 (Vselect_safe_coding_system_function
,
4571 start
, end
, list2 (Qt
, val
),
4576 /* If the variable `buffer-file-coding-system' is set locally,
4577 it means that the file was read with some kind of code
4578 conversion or the variable is explicitly set by users. We
4579 had better write it out with the same coding system even if
4580 `enable-multibyte-characters' is nil.
4582 If it is not set locally, we anyway have to convert EOL
4583 format if the default value of `buffer-file-coding-system'
4584 tells that it is not Unix-like (LF only) format. */
4585 bool using_default_coding
= 0;
4586 bool force_raw_text
= 0;
4588 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4590 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4593 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4599 /* Check file-coding-system-alist. */
4600 Lisp_Object args
[7], coding_systems
;
4602 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4603 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4605 coding_systems
= Ffind_operation_coding_system (7, args
);
4606 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4607 val
= XCDR (coding_systems
);
4612 /* If we still have not decided a coding system, use the
4613 default value of buffer-file-coding-system. */
4614 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4615 using_default_coding
= 1;
4618 if (! NILP (val
) && ! force_raw_text
)
4620 Lisp_Object spec
, attrs
;
4622 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4623 attrs
= AREF (spec
, 0);
4624 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4629 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4630 /* Confirm that VAL can surely encode the current region. */
4631 val
= call5 (Vselect_safe_coding_system_function
,
4632 start
, end
, val
, Qnil
, filename
);
4634 /* If the decided coding-system doesn't specify end-of-line
4635 format, we use that of
4636 `default-buffer-file-coding-system'. */
4637 if (! using_default_coding
4638 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4639 val
= (coding_inherit_eol_type
4640 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4642 /* If we decide not to encode text, use `raw-text' or one of its
4645 val
= raw_text_coding_system (val
);
4648 val
= coding_inherit_eol_type (val
, eol_parent
);
4652 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4653 "r\nFWrite region to file: \ni\ni\ni\np",
4654 doc
: /* Write current region into specified file.
4655 When called from a program, requires three arguments:
4656 START, END and FILENAME. START and END are normally buffer positions
4657 specifying the part of the buffer to write.
4658 If START is nil, that means to use the entire buffer contents.
4659 If START is a string, then output that string to the file
4660 instead of any buffer contents; END is ignored.
4662 Optional fourth argument APPEND if non-nil means
4663 append to existing file contents (if any). If it is a number,
4664 seek to that offset in the file before writing.
4665 Optional fifth argument VISIT, if t or a string, means
4666 set the last-save-file-modtime of buffer to this file's modtime
4667 and mark buffer not modified.
4668 If VISIT is a string, it is a second file name;
4669 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4670 VISIT is also the file name to lock and unlock for clash detection.
4671 If VISIT is neither t nor nil nor a string,
4672 that means do not display the \"Wrote file\" message.
4673 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4674 use for locking and unlocking, overriding FILENAME and VISIT.
4675 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4676 for an existing file with the same name. If MUSTBENEW is `excl',
4677 that means to get an error if the file already exists; never overwrite.
4678 If MUSTBENEW is neither nil nor `excl', that means ask for
4679 confirmation before overwriting, but do go ahead and overwrite the file
4680 if the user confirms.
4682 This does code conversion according to the value of
4683 `coding-system-for-write', `buffer-file-coding-system', or
4684 `file-coding-system-alist', and sets the variable
4685 `last-coding-system-used' to the coding system actually used.
4687 This calls `write-region-annotate-functions' at the start, and
4688 `write-region-post-annotation-function' at the end. */)
4689 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4690 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4692 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4696 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4697 descriptor for FILENAME, so do not open or close FILENAME. */
4700 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4701 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4702 Lisp_Object mustbenew
, int desc
)
4706 off_t offset
IF_LINT (= 0);
4707 bool open_and_close_file
= desc
< 0;
4712 struct timespec modtime
;
4713 ptrdiff_t count
= SPECPDL_INDEX ();
4714 ptrdiff_t count1
IF_LINT (= 0);
4715 Lisp_Object handler
;
4716 Lisp_Object visit_file
;
4717 Lisp_Object annotations
;
4718 Lisp_Object encoded_filename
;
4719 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4720 bool quietly
= !NILP (visit
);
4721 bool file_locked
= 0;
4722 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4723 struct buffer
*given_buffer
;
4724 struct coding_system coding
;
4726 if (current_buffer
->base_buffer
&& visiting
)
4727 error ("Cannot do file visiting in an indirect buffer");
4729 if (!NILP (start
) && !STRINGP (start
))
4730 validate_region (&start
, &end
);
4733 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4735 filename
= Fexpand_file_name (filename
, Qnil
);
4737 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4738 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4740 if (STRINGP (visit
))
4741 visit_file
= Fexpand_file_name (visit
, Qnil
);
4743 visit_file
= filename
;
4745 if (NILP (lockname
))
4746 lockname
= visit_file
;
4750 /* If the file name has special constructs in it,
4751 call the corresponding file handler. */
4752 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4753 /* If FILENAME has no handler, see if VISIT has one. */
4754 if (NILP (handler
) && STRINGP (visit
))
4755 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4757 if (!NILP (handler
))
4760 val
= call6 (handler
, Qwrite_region
, start
, end
,
4761 filename
, append
, visit
);
4765 SAVE_MODIFF
= MODIFF
;
4766 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4767 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 #ifdef CLASH_DETECTION
4827 if (open_and_close_file
&& !auto_saving
)
4829 lock_file (lockname
);
4832 #endif /* CLASH_DETECTION */
4834 encoded_filename
= ENCODE_FILE (filename
);
4835 fn
= SSDATA (encoded_filename
);
4836 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4837 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4838 if (NUMBERP (append
))
4839 offset
= file_offset (append
);
4840 else if (!NILP (append
))
4841 open_flags
|= O_APPEND
;
4843 mode
= S_IREAD
| S_IWRITE
;
4845 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4848 if (open_and_close_file
)
4850 desc
= emacs_open (fn
, open_flags
, mode
);
4853 int open_errno
= errno
;
4854 #ifdef CLASH_DETECTION
4856 unlock_file (lockname
);
4857 #endif /* CLASH_DETECTION */
4859 report_file_errno ("Opening output file", filename
, open_errno
);
4862 count1
= SPECPDL_INDEX ();
4863 record_unwind_protect_int (close_file_unwind
, desc
);
4866 if (NUMBERP (append
))
4868 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4871 int lseek_errno
= errno
;
4872 #ifdef CLASH_DETECTION
4874 unlock_file (lockname
);
4875 #endif /* CLASH_DETECTION */
4877 report_file_errno ("Lseek error", filename
, lseek_errno
);
4885 if (STRINGP (start
))
4886 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4887 else if (XINT (start
) != XINT (end
))
4888 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4889 &annotations
, &coding
);
4892 /* If file was empty, still need to write the annotations. */
4893 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4894 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4898 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4899 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4901 /* We have to flush out a data. */
4902 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4903 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4909 /* fsync is not crucial for temporary files. Nor for auto-save
4910 files, since they might lose some work anyway. */
4911 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4913 /* Transfer data and metadata to disk, retrying if interrupted.
4914 fsync can report a write failure here, e.g., due to disk full
4915 under NFS. But ignore EINVAL, which means fsync is not
4916 supported on this file. */
4917 while (fsync (desc
) != 0)
4920 if (errno
!= EINVAL
)
4921 ok
= 0, save_errno
= errno
;
4926 modtime
= invalid_timespec ();
4929 if (fstat (desc
, &st
) == 0)
4930 modtime
= get_stat_mtime (&st
);
4932 ok
= 0, save_errno
= errno
;
4935 if (open_and_close_file
)
4937 /* NFS can report a write failure now. */
4938 if (emacs_close (desc
) < 0)
4939 ok
= 0, save_errno
= errno
;
4941 /* Discard the unwind protect for close_file_unwind. */
4942 specpdl_ptr
= specpdl
+ count1
;
4945 /* Some file systems have a bug where st_mtime is not updated
4946 properly after a write. For example, CIFS might not see the
4947 st_mtime change until after the file is opened again.
4949 Attempt to detect this file system bug, and update MODTIME to the
4950 newer st_mtime if the bug appears to be present. This introduces
4951 a race condition, so to avoid most instances of the race condition
4952 on non-buggy file systems, skip this check if the most recently
4953 encountered non-buggy file system was the current file system.
4955 A race condition can occur if some other process modifies the
4956 file between the fstat above and the fstat below, but the race is
4957 unlikely and a similar race between the last write and the fstat
4958 above cannot possibly be closed anyway. */
4960 if (timespec_valid_p (modtime
)
4961 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4963 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4967 if (fstat (desc1
, &st1
) == 0
4968 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4970 /* Use the heuristic if it appears to be valid. With neither
4971 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4972 file, the time stamp won't change. Also, some non-POSIX
4973 systems don't update an empty file's time stamp when
4974 truncating it. Finally, file systems with 100 ns or worse
4975 resolution sometimes seem to have bugs: on a system with ns
4976 resolution, checking ns % 100 incorrectly avoids the heuristic
4977 1% of the time, but the problem should be temporary as we will
4978 try again on the next time stamp. */
4980 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4982 && modtime
.tv_nsec
% 100 != 0);
4984 struct timespec modtime1
= get_stat_mtime (&st1
);
4986 && timespec_cmp (modtime
, modtime1
) == 0
4987 && st
.st_size
== st1
.st_size
)
4989 timestamp_file_system
= st
.st_dev
;
4990 valid_timestamp_file_system
= 1;
4994 st
.st_size
= st1
.st_size
;
4998 emacs_close (desc1
);
5002 /* Call write-region-post-annotation-function. */
5003 while (CONSP (Vwrite_region_annotation_buffers
))
5005 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5006 if (!NILP (Fbuffer_live_p (buf
)))
5009 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5010 call0 (Vwrite_region_post_annotation_function
);
5012 Vwrite_region_annotation_buffers
5013 = XCDR (Vwrite_region_annotation_buffers
);
5016 unbind_to (count
, Qnil
);
5018 #ifdef CLASH_DETECTION
5020 unlock_file (lockname
);
5021 #endif /* CLASH_DETECTION */
5023 /* Do this before reporting IO error
5024 to avoid a "file has changed on disk" warning on
5025 next attempt to save. */
5026 if (timespec_valid_p (modtime
))
5028 current_buffer
->modtime
= modtime
;
5029 current_buffer
->modtime_size
= st
.st_size
;
5033 report_file_errno ("Write error", filename
, save_errno
);
5037 SAVE_MODIFF
= MODIFF
;
5038 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5039 bset_filename (current_buffer
, visit_file
);
5040 update_mode_lines
= 14;
5045 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5046 BVAR (current_buffer
, auto_save_file_name
))))
5047 SAVE_MODIFF
= MODIFF
;
5053 message_with_string ((NUMBERP (append
)
5063 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5064 doc
: /* Return t if (car A) is numerically less than (car B). */)
5065 (Lisp_Object a
, Lisp_Object b
)
5067 Lisp_Object args
[2] = { Fcar (a
), Fcar (b
), };
5068 return Flss (2, args
);
5071 /* Build the complete list of annotations appropriate for writing out
5072 the text between START and END, by calling all the functions in
5073 write-region-annotate-functions and merging the lists they return.
5074 If one of these functions switches to a different buffer, we assume
5075 that buffer contains altered text. Therefore, the caller must
5076 make sure to restore the current buffer in all cases,
5077 as save-excursion would do. */
5080 build_annotations (Lisp_Object start
, Lisp_Object end
)
5082 Lisp_Object annotations
;
5084 struct gcpro gcpro1
, gcpro2
;
5085 Lisp_Object original_buffer
;
5087 bool used_global
= 0;
5089 XSETBUFFER (original_buffer
, current_buffer
);
5092 p
= Vwrite_region_annotate_functions
;
5093 GCPRO2 (annotations
, p
);
5096 struct buffer
*given_buffer
= current_buffer
;
5097 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5098 { /* Use the global value of the hook. */
5101 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5103 p
= Fappend (2, arg
);
5106 Vwrite_region_annotations_so_far
= annotations
;
5107 res
= call2 (XCAR (p
), start
, end
);
5108 /* If the function makes a different buffer current,
5109 assume that means this buffer contains altered text to be output.
5110 Reset START and END from the buffer bounds
5111 and discard all previous annotations because they should have
5112 been dealt with by this function. */
5113 if (current_buffer
!= given_buffer
)
5115 Vwrite_region_annotation_buffers
5116 = Fcons (Fcurrent_buffer (),
5117 Vwrite_region_annotation_buffers
);
5118 XSETFASTINT (start
, BEGV
);
5119 XSETFASTINT (end
, ZV
);
5122 Flength (res
); /* Check basic validity of return value */
5123 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5127 /* Now do the same for annotation functions implied by the file-format */
5128 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5129 p
= BVAR (current_buffer
, auto_save_file_format
);
5131 p
= BVAR (current_buffer
, file_format
);
5132 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5134 struct buffer
*given_buffer
= current_buffer
;
5136 Vwrite_region_annotations_so_far
= annotations
;
5138 /* Value is either a list of annotations or nil if the function
5139 has written annotations to a temporary buffer, which is now
5141 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5142 original_buffer
, make_number (i
));
5143 if (current_buffer
!= given_buffer
)
5145 XSETFASTINT (start
, BEGV
);
5146 XSETFASTINT (end
, ZV
);
5151 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5159 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5160 If STRING is nil, POS is the character position in the current buffer.
5161 Intersperse with them the annotations from *ANNOT
5162 which fall within the range of POS to POS + NCHARS,
5163 each at its appropriate position.
5165 We modify *ANNOT by discarding elements as we use them up.
5167 Return true if successful. */
5170 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5171 ptrdiff_t nchars
, Lisp_Object
*annot
,
5172 struct coding_system
*coding
)
5176 ptrdiff_t lastpos
= pos
+ nchars
;
5178 while (NILP (*annot
) || CONSP (*annot
))
5180 tem
= Fcar_safe (Fcar (*annot
));
5183 nextpos
= XFASTINT (tem
);
5185 /* If there are no more annotations in this range,
5186 output the rest of the range all at once. */
5187 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5188 return e_write (desc
, string
, pos
, lastpos
, coding
);
5190 /* Output buffer text up to the next annotation's position. */
5193 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5197 /* Output the annotation. */
5198 tem
= Fcdr (Fcar (*annot
));
5201 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5204 *annot
= Fcdr (*annot
);
5209 /* Maximum number of characters that the next
5210 function encodes per one loop iteration. */
5212 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5214 /* Write text in the range START and END into descriptor DESC,
5215 encoding them with coding system CODING. If STRING is nil, START
5216 and END are character positions of the current buffer, else they
5217 are indexes to the string STRING. Return true if successful. */
5220 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5221 struct coding_system
*coding
)
5223 if (STRINGP (string
))
5226 end
= SCHARS (string
);
5229 /* We used to have a code for handling selective display here. But,
5230 now it is handled within encode_coding. */
5234 if (STRINGP (string
))
5236 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5237 if (CODING_REQUIRE_ENCODING (coding
))
5239 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5241 /* Avoid creating huge Lisp string in encode_coding_object. */
5242 if (nchars
== E_WRITE_MAX
)
5243 coding
->raw_destination
= 1;
5245 encode_coding_object
5246 (coding
, string
, start
, string_char_to_byte (string
, start
),
5247 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5252 coding
->dst_object
= string
;
5253 coding
->consumed_char
= SCHARS (string
);
5254 coding
->produced
= SBYTES (string
);
5259 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5260 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5262 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5263 if (CODING_REQUIRE_ENCODING (coding
))
5265 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5268 if (nchars
== E_WRITE_MAX
)
5269 coding
->raw_destination
= 1;
5271 encode_coding_object
5272 (coding
, Fcurrent_buffer (), start
, start_byte
,
5273 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5277 coding
->dst_object
= Qnil
;
5278 coding
->dst_pos_byte
= start_byte
;
5279 if (start
>= GPT
|| end
<= GPT
)
5281 coding
->consumed_char
= end
- start
;
5282 coding
->produced
= end_byte
- start_byte
;
5286 coding
->consumed_char
= GPT
- start
;
5287 coding
->produced
= GPT_BYTE
- start_byte
;
5292 if (coding
->produced
> 0)
5294 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5295 : (STRINGP (coding
->dst_object
)
5296 ? SSDATA (coding
->dst_object
)
5297 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5298 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5300 if (coding
->raw_destination
)
5302 /* We're responsible for freeing this, see
5303 encode_coding_object to check why. */
5304 xfree (coding
->destination
);
5305 coding
->raw_destination
= 0;
5307 if (coding
->produced
)
5310 start
+= coding
->consumed_char
;
5316 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5317 Sverify_visited_file_modtime
, 0, 1, 0,
5318 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5319 This means that the file has not been changed since it was visited or saved.
5320 If BUF is omitted or nil, it defaults to the current buffer.
5321 See Info node `(elisp)Modification Time' for more details. */)
5326 Lisp_Object handler
;
5327 Lisp_Object filename
;
5328 struct timespec mtime
;
5338 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5339 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5341 /* If the file name has special constructs in it,
5342 call the corresponding file handler. */
5343 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5344 Qverify_visited_file_modtime
);
5345 if (!NILP (handler
))
5346 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5348 filename
= ENCODE_FILE (BVAR (b
, filename
));
5350 mtime
= (stat (SSDATA (filename
), &st
) == 0
5351 ? get_stat_mtime (&st
)
5352 : time_error_value (errno
));
5353 if (timespec_cmp (mtime
, b
->modtime
) == 0
5354 && (b
->modtime_size
< 0
5355 || st
.st_size
== b
->modtime_size
))
5360 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5361 Svisited_file_modtime
, 0, 0, 0,
5362 doc
: /* Return the current buffer's recorded visited file modification time.
5363 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5364 `file-attributes' returns. If the current buffer has no recorded file
5365 modification time, this function returns 0. If the visited file
5366 doesn't exist, return -1.
5367 See Info node `(elisp)Modification Time' for more details. */)
5370 int ns
= current_buffer
->modtime
.tv_nsec
;
5372 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5373 return make_lisp_time (current_buffer
->modtime
);
5376 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5377 Sset_visited_file_modtime
, 0, 1, 0,
5378 doc
: /* Update buffer's recorded modification time from the visited file's time.
5379 Useful if the buffer was not read from the file normally
5380 or if the file itself has been changed for some known benign reason.
5381 An argument specifies the modification time value to use
5382 \(instead of that of the visited file), in the form of a list
5383 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5384 `visited-file-modtime'. */)
5385 (Lisp_Object time_flag
)
5387 if (!NILP (time_flag
))
5389 struct timespec mtime
;
5390 if (INTEGERP (time_flag
))
5392 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5393 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5396 mtime
= lisp_time_argument (time_flag
);
5398 current_buffer
->modtime
= mtime
;
5399 current_buffer
->modtime_size
= -1;
5403 register Lisp_Object filename
;
5405 Lisp_Object handler
;
5407 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5409 /* If the file name has special constructs in it,
5410 call the corresponding file handler. */
5411 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5412 if (!NILP (handler
))
5413 /* The handler can find the file name the same way we did. */
5414 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5416 filename
= ENCODE_FILE (filename
);
5418 if (stat (SSDATA (filename
), &st
) >= 0)
5420 current_buffer
->modtime
= get_stat_mtime (&st
);
5421 current_buffer
->modtime_size
= st
.st_size
;
5429 auto_save_error (Lisp_Object error_val
)
5431 Lisp_Object args
[3], msg
;
5433 struct gcpro gcpro1
;
5435 auto_save_error_occurred
= 1;
5437 ring_bell (XFRAME (selected_frame
));
5439 args
[0] = build_string ("Auto-saving %s: %s");
5440 args
[1] = BVAR (current_buffer
, name
);
5441 args
[2] = Ferror_message_string (error_val
);
5442 msg
= Fformat (3, args
);
5445 for (i
= 0; i
< 3; ++i
)
5450 message3_nolog (msg
);
5451 Fsleep_for (make_number (1), Qnil
);
5464 auto_save_mode_bits
= 0666;
5466 /* Get visited file's mode to become the auto save file's mode. */
5467 if (! NILP (BVAR (current_buffer
, filename
)))
5469 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5470 /* But make sure we can overwrite it later! */
5471 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5472 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5474 /* Remote files don't cooperate with stat. */
5475 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5479 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5480 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5484 struct auto_save_unwind
5491 do_auto_save_unwind (void *arg
)
5493 struct auto_save_unwind
*p
= arg
;
5494 FILE *stream
= p
->stream
;
5495 minibuffer_auto_raise
= p
->auto_raise
;
5506 do_auto_save_make_dir (Lisp_Object dir
)
5510 auto_saving_dir_umask
= 077;
5511 result
= call2 (Qmake_directory
, dir
, Qt
);
5512 auto_saving_dir_umask
= 0;
5517 do_auto_save_eh (Lisp_Object ignore
)
5519 auto_saving_dir_umask
= 0;
5523 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5524 doc
: /* Auto-save all buffers that need it.
5525 This is all buffers that have auto-saving enabled
5526 and are changed since last auto-saved.
5527 Auto-saving writes the buffer into a file
5528 so that your editing is not lost if the system crashes.
5529 This file is not the file you visited; that changes only when you save.
5530 Normally we run the normal hook `auto-save-hook' before saving.
5532 A non-nil NO-MESSAGE argument means do not print any message if successful.
5533 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5534 (Lisp_Object no_message
, Lisp_Object current_only
)
5536 struct buffer
*old
= current_buffer
, *b
;
5537 Lisp_Object tail
, buf
, hook
;
5538 bool auto_saved
= 0;
5539 int do_handled_files
;
5541 FILE *stream
= NULL
;
5542 ptrdiff_t count
= SPECPDL_INDEX ();
5543 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5544 bool old_message_p
= 0;
5545 struct auto_save_unwind auto_save_unwind
;
5546 struct gcpro gcpro1
, gcpro2
;
5548 if (max_specpdl_size
< specpdl_size
+ 40)
5549 max_specpdl_size
= specpdl_size
+ 40;
5554 if (NILP (no_message
))
5556 old_message_p
= push_message ();
5557 record_unwind_protect_void (pop_message_unwind
);
5560 /* Ordinarily don't quit within this function,
5561 but don't make it impossible to quit (in case we get hung in I/O). */
5565 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5566 point to non-strings reached from Vbuffer_alist. */
5568 hook
= intern ("auto-save-hook");
5569 safe_run_hooks (hook
);
5571 if (STRINGP (Vauto_save_list_file_name
))
5573 Lisp_Object listfile
;
5575 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5577 /* Don't try to create the directory when shutting down Emacs,
5578 because creating the directory might signal an error, and
5579 that would leave Emacs in a strange state. */
5580 if (!NILP (Vrun_hooks
))
5584 GCPRO2 (dir
, listfile
);
5585 dir
= Ffile_name_directory (listfile
);
5586 if (NILP (Ffile_directory_p (dir
)))
5587 internal_condition_case_1 (do_auto_save_make_dir
,
5593 stream
= emacs_fopen (SSDATA (listfile
), "w");
5596 auto_save_unwind
.stream
= stream
;
5597 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5598 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5599 minibuffer_auto_raise
= 0;
5601 auto_save_error_occurred
= 0;
5603 /* On first pass, save all files that don't have handlers.
5604 On second pass, save all files that do have handlers.
5606 If Emacs is crashing, the handlers may tweak what is causing
5607 Emacs to crash in the first place, and it would be a shame if
5608 Emacs failed to autosave perfectly ordinary files because it
5609 couldn't handle some ange-ftp'd file. */
5611 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5612 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5616 /* Record all the buffers that have auto save mode
5617 in the special file that lists them. For each of these buffers,
5618 Record visited name (if any) and auto save name. */
5619 if (STRINGP (BVAR (b
, auto_save_file_name
))
5620 && stream
!= NULL
&& do_handled_files
== 0)
5623 if (!NILP (BVAR (b
, filename
)))
5625 fwrite (SDATA (BVAR (b
, filename
)), 1,
5626 SBYTES (BVAR (b
, filename
)), stream
);
5628 putc ('\n', stream
);
5629 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5630 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5631 putc ('\n', stream
);
5635 if (!NILP (current_only
)
5636 && b
!= current_buffer
)
5639 /* Don't auto-save indirect buffers.
5640 The base buffer takes care of it. */
5644 /* Check for auto save enabled
5645 and file changed since last auto save
5646 and file changed since last real save. */
5647 if (STRINGP (BVAR (b
, auto_save_file_name
))
5648 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5649 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5650 /* -1 means we've turned off autosaving for a while--see below. */
5651 && XINT (BVAR (b
, save_length
)) >= 0
5652 && (do_handled_files
5653 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5656 struct timespec before_time
= current_timespec ();
5657 struct timespec after_time
;
5659 /* If we had a failure, don't try again for 20 minutes. */
5660 if (b
->auto_save_failure_time
> 0
5661 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5664 set_buffer_internal (b
);
5665 if (NILP (Vauto_save_include_big_deletions
)
5666 && (XFASTINT (BVAR (b
, save_length
)) * 10
5667 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5668 /* A short file is likely to change a large fraction;
5669 spare the user annoying messages. */
5670 && XFASTINT (BVAR (b
, save_length
)) > 5000
5671 /* These messages are frequent and annoying for `*mail*'. */
5672 && !EQ (BVAR (b
, filename
), Qnil
)
5673 && NILP (no_message
))
5675 /* It has shrunk too much; turn off auto-saving here. */
5676 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5677 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5679 minibuffer_auto_raise
= 0;
5680 /* Turn off auto-saving until there's a real save,
5681 and prevent any more warnings. */
5682 XSETINT (BVAR (b
, save_length
), -1);
5683 Fsleep_for (make_number (1), Qnil
);
5686 if (!auto_saved
&& NILP (no_message
))
5687 message1 ("Auto-saving...");
5688 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5690 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5691 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5692 set_buffer_internal (old
);
5694 after_time
= current_timespec ();
5696 /* If auto-save took more than 60 seconds,
5697 assume it was an NFS failure that got a timeout. */
5698 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5699 b
->auto_save_failure_time
= after_time
.tv_sec
;
5703 /* Prevent another auto save till enough input events come in. */
5704 record_auto_save ();
5706 if (auto_saved
&& NILP (no_message
))
5710 /* If we are going to restore an old message,
5711 give time to read ours. */
5712 sit_for (make_number (1), 0, 0);
5715 else if (!auto_save_error_occurred
)
5716 /* Don't overwrite the error message if an error occurred.
5717 If we displayed a message and then restored a state
5718 with no message, leave a "done" message on the screen. */
5719 message1 ("Auto-saving...done");
5724 /* This restores the message-stack status. */
5725 unbind_to (count
, Qnil
);
5729 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5730 Sset_buffer_auto_saved
, 0, 0, 0,
5731 doc
: /* Mark current buffer as auto-saved with its current text.
5732 No auto-save file will be written until the buffer changes again. */)
5735 /* FIXME: This should not be called in indirect buffers, since
5736 they're not autosaved. */
5737 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5738 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5739 current_buffer
->auto_save_failure_time
= 0;
5743 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5744 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5745 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5748 current_buffer
->auto_save_failure_time
= 0;
5752 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5754 doc
: /* Return t if current buffer has been auto-saved recently.
5755 More precisely, if it has been auto-saved since last read from or saved
5756 in the visited file. If the buffer has no visited file,
5757 then any auto-save counts as "recent". */)
5760 /* FIXME: maybe we should return nil for indirect buffers since
5761 they're never autosaved. */
5762 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5765 /* Reading and completing file names */
5767 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5768 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5769 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5770 The return value is only relevant for a call to `read-file-name' that happens
5771 before any other event (mouse or keypress) is handled. */)
5774 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5775 || defined (HAVE_NS)
5776 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5779 && window_system_available (SELECTED_FRAME ()))
5786 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5788 struct gcpro gcpro1
;
5789 Lisp_Object args
[7];
5791 GCPRO1 (default_filename
);
5792 args
[0] = intern ("read-file-name");
5795 args
[3] = default_filename
;
5796 args
[4] = mustmatch
;
5798 args
[6] = predicate
;
5799 RETURN_UNGCPRO (Ffuncall (7, args
));
5806 valid_timestamp_file_system
= 0;
5808 /* fsync can be a significant performance hit. Often it doesn't
5809 suffice to make the file-save operation survive a crash. For
5810 batch scripts, which are typically part of larger shell commands
5811 that don't fsync other files, its effect on performance can be
5812 significant so its utility is particularly questionable.
5813 Hence, for now by default fsync is used only when interactive.
5815 For more on why fsync often fails to work on today's hardware, see:
5816 Zheng M et al. Understanding the robustness of SSDs under power fault.
5817 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5818 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5820 For more on why fsync does not suffice even if it works properly, see:
5821 Roche X. Necessary step(s) to synchronize filename operations on disk.
5822 Austin Group Defect 672, 2013-03-19
5823 http://austingroupbugs.net/view.php?id=672 */
5824 write_region_inhibit_fsync
= noninteractive
;
5828 syms_of_fileio (void)
5830 DEFSYM (Qoperations
, "operations");
5831 DEFSYM (Qexpand_file_name
, "expand-file-name");
5832 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5833 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5834 DEFSYM (Qfile_name_directory
, "file-name-directory");
5835 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5836 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5837 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5838 DEFSYM (Qcopy_file
, "copy-file");
5839 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5840 DEFSYM (Qmake_directory
, "make-directory");
5841 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5842 DEFSYM (Qdelete_file
, "delete-file");
5843 DEFSYM (Qrename_file
, "rename-file");
5844 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5845 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5846 DEFSYM (Qfile_exists_p
, "file-exists-p");
5847 DEFSYM (Qfile_executable_p
, "file-executable-p");
5848 DEFSYM (Qfile_readable_p
, "file-readable-p");
5849 DEFSYM (Qfile_writable_p
, "file-writable-p");
5850 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5851 DEFSYM (Qaccess_file
, "access-file");
5852 DEFSYM (Qfile_directory_p
, "file-directory-p");
5853 DEFSYM (Qfile_regular_p
, "file-regular-p");
5854 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5855 DEFSYM (Qfile_modes
, "file-modes");
5856 DEFSYM (Qset_file_modes
, "set-file-modes");
5857 DEFSYM (Qset_file_times
, "set-file-times");
5858 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5859 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5860 DEFSYM (Qfile_acl
, "file-acl");
5861 DEFSYM (Qset_file_acl
, "set-file-acl");
5862 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5863 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5864 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5865 DEFSYM (Qwrite_region
, "write-region");
5866 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5867 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5868 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5870 DEFSYM (Qfile_name_history
, "file-name-history");
5871 Fset (Qfile_name_history
, Qnil
);
5873 DEFSYM (Qfile_error
, "file-error");
5874 DEFSYM (Qfile_already_exists
, "file-already-exists");
5875 DEFSYM (Qfile_date_error
, "file-date-error");
5876 DEFSYM (Qfile_notify_error
, "file-notify-error");
5877 DEFSYM (Qexcl
, "excl");
5879 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5880 doc
: /* Coding system for encoding file names.
5881 If it is nil, `default-file-name-coding-system' (which see) is used.
5883 On MS-Windows, the value of this variable is largely ignored if
5884 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5885 behaves as if file names were encoded in `utf-8'. */);
5886 Vfile_name_coding_system
= Qnil
;
5888 DEFVAR_LISP ("default-file-name-coding-system",
5889 Vdefault_file_name_coding_system
,
5890 doc
: /* Default coding system for encoding file names.
5891 This variable is used only when `file-name-coding-system' is nil.
5893 This variable is set/changed by the command `set-language-environment'.
5894 User should not set this variable manually,
5895 instead use `file-name-coding-system' to get a constant encoding
5896 of file names regardless of the current language environment.
5898 On MS-Windows, the value of this variable is largely ignored if
5899 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5900 behaves as if file names were encoded in `utf-8'. */);
5901 Vdefault_file_name_coding_system
= Qnil
;
5903 DEFSYM (Qformat_decode
, "format-decode");
5904 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5905 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5906 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5908 Fput (Qfile_error
, Qerror_conditions
,
5909 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5910 Fput (Qfile_error
, Qerror_message
,
5911 build_pure_c_string ("File error"));
5913 Fput (Qfile_already_exists
, Qerror_conditions
,
5914 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5915 Fput (Qfile_already_exists
, Qerror_message
,
5916 build_pure_c_string ("File already exists"));
5918 Fput (Qfile_date_error
, Qerror_conditions
,
5919 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5920 Fput (Qfile_date_error
, Qerror_message
,
5921 build_pure_c_string ("Cannot set file date"));
5923 Fput (Qfile_notify_error
, Qerror_conditions
,
5924 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5925 Fput (Qfile_notify_error
, Qerror_message
,
5926 build_pure_c_string ("File notification error"));
5928 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5929 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5930 If a file name matches REGEXP, all I/O on that file is done by calling
5931 HANDLER. If a file name matches more than one handler, the handler
5932 whose match starts last in the file name gets precedence. The
5933 function `find-file-name-handler' checks this list for a handler for
5936 HANDLER should be a function. The first argument given to it is the
5937 name of the I/O primitive to be handled; the remaining arguments are
5938 the arguments that were passed to that primitive. For example, if you
5939 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5940 HANDLER is called like this:
5942 (funcall HANDLER 'file-exists-p FILENAME)
5944 Note that HANDLER must be able to handle all I/O primitives; if it has
5945 nothing special to do for a primitive, it should reinvoke the
5946 primitive to handle the operation \"the usual way\".
5947 See Info node `(elisp)Magic File Names' for more details. */);
5948 Vfile_name_handler_alist
= Qnil
;
5950 DEFVAR_LISP ("set-auto-coding-function",
5951 Vset_auto_coding_function
,
5952 doc
: /* If non-nil, a function to call to decide a coding system of file.
5953 Two arguments are passed to this function: the file name
5954 and the length of a file contents following the point.
5955 This function should return a coding system to decode the file contents.
5956 It should check the file name against `auto-coding-alist'.
5957 If no coding system is decided, it should check a coding system
5958 specified in the heading lines with the format:
5959 -*- ... coding: CODING-SYSTEM; ... -*-
5960 or local variable spec of the tailing lines with `coding:' tag. */);
5961 Vset_auto_coding_function
= Qnil
;
5963 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5964 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5965 Each is passed one argument, the number of characters inserted,
5966 with point at the start of the inserted text. Each function
5967 should leave point the same, and return the new character count.
5968 If `insert-file-contents' is intercepted by a handler from
5969 `file-name-handler-alist', that handler is responsible for calling the
5970 functions in `after-insert-file-functions' if appropriate. */);
5971 Vafter_insert_file_functions
= Qnil
;
5973 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5974 doc
: /* A list of functions to be called at the start of `write-region'.
5975 Each is passed two arguments, START and END as for `write-region'.
5976 These are usually two numbers but not always; see the documentation
5977 for `write-region'. The function should return a list of pairs
5978 of the form (POSITION . STRING), consisting of strings to be effectively
5979 inserted at the specified positions of the file being written (1 means to
5980 insert before the first byte written). The POSITIONs must be sorted into
5983 If there are several annotation functions, the lists returned by these
5984 functions are merged destructively. As each annotation function runs,
5985 the variable `write-region-annotations-so-far' contains a list of all
5986 annotations returned by previous annotation functions.
5988 An annotation function can return with a different buffer current.
5989 Doing so removes the annotations returned by previous functions, and
5990 resets START and END to `point-min' and `point-max' of the new buffer.
5992 After `write-region' completes, Emacs calls the function stored in
5993 `write-region-post-annotation-function', once for each buffer that was
5994 current when building the annotations (i.e., at least once), with that
5995 buffer current. */);
5996 Vwrite_region_annotate_functions
= Qnil
;
5997 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5999 DEFVAR_LISP ("write-region-post-annotation-function",
6000 Vwrite_region_post_annotation_function
,
6001 doc
: /* Function to call after `write-region' completes.
6002 The function is called with no arguments. If one or more of the
6003 annotation functions in `write-region-annotate-functions' changed the
6004 current buffer, the function stored in this variable is called for
6005 each of those additional buffers as well, in addition to the original
6006 buffer. The relevant buffer is current during each function call. */);
6007 Vwrite_region_post_annotation_function
= Qnil
;
6008 staticpro (&Vwrite_region_annotation_buffers
);
6010 DEFVAR_LISP ("write-region-annotations-so-far",
6011 Vwrite_region_annotations_so_far
,
6012 doc
: /* When an annotation function is called, this holds the previous annotations.
6013 These are the annotations made by other annotation functions
6014 that were already called. See also `write-region-annotate-functions'. */);
6015 Vwrite_region_annotations_so_far
= Qnil
;
6017 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6018 doc
: /* A list of file name handlers that temporarily should not be used.
6019 This applies only to the operation `inhibit-file-name-operation'. */);
6020 Vinhibit_file_name_handlers
= Qnil
;
6022 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6023 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6024 Vinhibit_file_name_operation
= Qnil
;
6026 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6027 doc
: /* File name in which we write a list of all auto save file names.
6028 This variable is initialized automatically from `auto-save-list-file-prefix'
6029 shortly after Emacs reads your init file, if you have not yet given it
6030 a non-nil value. */);
6031 Vauto_save_list_file_name
= Qnil
;
6033 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6034 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6035 Normally auto-save files are written under other names. */);
6036 Vauto_save_visited_file_name
= Qnil
;
6038 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6039 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6040 If nil, deleting a substantial portion of the text disables auto-save
6041 in the buffer; this is the default behavior, because the auto-save
6042 file is usually more useful if it contains the deleted text. */);
6043 Vauto_save_include_big_deletions
= Qnil
;
6045 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6046 doc
: /* Non-nil means don't call fsync in `write-region'.
6047 This variable affects calls to `write-region' as well as save commands.
6048 Setting this to nil may avoid data loss if the system loses power or
6049 the operating system crashes. */);
6050 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6052 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6053 doc
: /* Specifies whether to use the system's trash can.
6054 When non-nil, certain file deletion commands use the function
6055 `move-file-to-trash' instead of deleting files outright.
6056 This includes interactive calls to `delete-file' and
6057 `delete-directory' and the Dired deletion commands. */);
6058 delete_by_moving_to_trash
= 0;
6059 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6061 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6062 DEFSYM (Qcopy_directory
, "copy-directory");
6063 DEFSYM (Qdelete_directory
, "delete-directory");
6064 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");
6066 defsubr (&Sfind_file_name_handler
);
6067 defsubr (&Sfile_name_directory
);
6068 defsubr (&Sfile_name_nondirectory
);
6069 defsubr (&Sunhandled_file_name_directory
);
6070 defsubr (&Sfile_name_as_directory
);
6071 defsubr (&Sdirectory_file_name
);
6072 defsubr (&Smake_temp_name
);
6073 defsubr (&Sexpand_file_name
);
6074 defsubr (&Ssubstitute_in_file_name
);
6075 defsubr (&Scopy_file
);
6076 defsubr (&Smake_directory_internal
);
6077 defsubr (&Sdelete_directory_internal
);
6078 defsubr (&Sdelete_file
);
6079 defsubr (&Srename_file
);
6080 defsubr (&Sadd_name_to_file
);
6081 defsubr (&Smake_symbolic_link
);
6082 defsubr (&Sfile_name_absolute_p
);
6083 defsubr (&Sfile_exists_p
);
6084 defsubr (&Sfile_executable_p
);
6085 defsubr (&Sfile_readable_p
);
6086 defsubr (&Sfile_writable_p
);
6087 defsubr (&Saccess_file
);
6088 defsubr (&Sfile_symlink_p
);
6089 defsubr (&Sfile_directory_p
);
6090 defsubr (&Sfile_accessible_directory_p
);
6091 defsubr (&Sfile_regular_p
);
6092 defsubr (&Sfile_modes
);
6093 defsubr (&Sset_file_modes
);
6094 defsubr (&Sset_file_times
);
6095 defsubr (&Sfile_selinux_context
);
6096 defsubr (&Sfile_acl
);
6097 defsubr (&Sset_file_acl
);
6098 defsubr (&Sset_file_selinux_context
);
6099 defsubr (&Sset_default_file_modes
);
6100 defsubr (&Sdefault_file_modes
);
6101 defsubr (&Sfile_newer_than_file_p
);
6102 defsubr (&Sinsert_file_contents
);
6103 defsubr (&Schoose_write_coding_system
);
6104 defsubr (&Swrite_region
);
6105 defsubr (&Scar_less_than_car
);
6106 defsubr (&Sverify_visited_file_modtime
);
6107 defsubr (&Svisited_file_modtime
);
6108 defsubr (&Sset_visited_file_modtime
);
6109 defsubr (&Sdo_auto_save
);
6110 defsubr (&Sset_buffer_auto_saved
);
6111 defsubr (&Sclear_buffer_auto_save_failure
);
6112 defsubr (&Srecent_auto_save_p
);
6114 defsubr (&Snext_read_file_uses_dialog_p
);
6117 defsubr (&Sunix_sync
);