1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
39 #ifdef HAVE_ACL_SET_FILE
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
52 #include "region-cache.h"
54 #include "dispextern.h"
61 #endif /* not WINDOWSNT */
65 #include <sys/param.h>
69 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
70 redirector allows the six letters between 'Z' and 'a' as well. */
72 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
75 #define IS_DRIVE(x) c_isalpha (x)
77 /* Need to lower-case the drive letter, or else expanded
78 filenames will sometimes compare unequal, because
79 `expand-file-name' doesn't always down-case the drive letter. */
80 #define DRIVE_LETTER(x) c_tolower (x)
85 #include <allocator.h>
86 #include <careadlinkat.h>
87 #include <stat-time.h>
95 /* True during writing of auto-save files. */
96 static bool auto_saving
;
98 /* Emacs's real umask. */
99 static mode_t realmask
;
101 /* Nonzero umask during creation of auto-save directories. */
102 static mode_t auto_saving_dir_umask
;
104 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
105 a new file with the same mode as the original. */
106 static mode_t auto_save_mode_bits
;
108 /* Set by auto_save_1 if an error occurred during the last auto-save. */
109 static bool auto_save_error_occurred
;
111 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
112 number of a file system where time stamps were observed to to work. */
113 static bool valid_timestamp_file_system
;
114 static dev_t timestamp_file_system
;
116 /* The symbol bound to coding-system-for-read when
117 insert-file-contents is called for recovering a file. This is not
118 an actual coding system name, but just an indicator to tell
119 insert-file-contents to use `emacs-mule' with a special flag for
120 auto saving and recovering a file. */
121 static Lisp_Object Qauto_save_coding
;
123 /* Property name of a file name handler,
124 which gives a list of operations it handles.. */
125 static Lisp_Object Qoperations
;
127 /* Lisp functions for translating file formats. */
128 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
130 /* Lisp function for setting buffer-file-coding-system and the
131 multibyteness of the current buffer after inserting a file. */
132 static Lisp_Object Qafter_insert_file_set_coding
;
134 static Lisp_Object Qwrite_region_annotate_functions
;
135 /* Each time an annotation function changes the buffer, the new buffer
137 static Lisp_Object Vwrite_region_annotation_buffers
;
139 static Lisp_Object Qdelete_by_moving_to_trash
;
141 /* Lisp function for moving files to trash. */
142 static Lisp_Object Qmove_file_to_trash
;
144 /* Lisp function for recursively copying directories. */
145 static Lisp_Object Qcopy_directory
;
147 /* Lisp function for recursively deleting directories. */
148 static Lisp_Object Qdelete_directory
;
150 static Lisp_Object Qsubstitute_env_in_file_name
;
152 Lisp_Object Qfile_error
, Qfile_notify_error
;
153 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
154 static Lisp_Object Qexcl
;
155 Lisp_Object Qfile_name_history
;
157 static Lisp_Object Qcar_less_than_car
;
159 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
160 Lisp_Object
*, struct coding_system
*);
161 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
162 struct coding_system
*);
165 /* Return true if FILENAME exists. */
168 check_existing (const char *filename
)
170 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
173 /* Return true if file FILENAME exists and can be executed. */
176 check_executable (char *filename
)
178 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
181 /* Return true if file FILENAME exists and can be accessed
182 according to AMODE, which should include W_OK.
183 On failure, return false and set errno. */
186 check_writable (const char *filename
, int amode
)
189 /* FIXME: an faccessat implementation should be added to the
190 DOS/Windows ports and this #ifdef branch should be removed. */
192 if (stat (filename
, &st
) < 0)
195 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
196 #else /* not MSDOS */
197 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
199 /* faccessat may have returned failure because Cygwin couldn't
200 determine the file's UID or GID; if so, we return success. */
203 int faccessat_errno
= errno
;
205 if (stat (filename
, &st
) < 0)
207 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
208 errno
= faccessat_errno
;
212 #endif /* not MSDOS */
215 /* Signal a file-access failure. STRING describes the failure,
216 NAME the file involved, and ERRORNO the errno value.
218 If NAME is neither null nor a pair, package it up as a singleton
219 list before reporting it; this saves report_file_errno's caller the
220 trouble of preserving errno before calling list1. */
223 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
225 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
226 Lisp_Object errstring
;
229 synchronize_system_messages_locale ();
230 str
= strerror (errorno
);
231 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
232 Vlocale_coding_system
, 0);
238 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
241 /* System error messages are capitalized. Downcase the initial
242 unless it is followed by a slash. (The slash case caters to
243 error messages that begin with "I/O" or, in German, "E/A".) */
244 if (STRING_MULTIBYTE (errstring
)
245 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
249 str
= SSDATA (errstring
);
250 c
= STRING_CHAR ((unsigned char *) str
);
251 Faset (errstring
, make_number (0), make_number (downcase (c
)));
254 xsignal (Qfile_error
,
255 Fcons (build_string (string
), Fcons (errstring
, data
)));
259 /* Signal a file-access failure that set errno. STRING describes the
260 failure, NAME the file involved. When invoking this function, take
261 care to not use arguments such as build_string ("foo") that involve
262 side effects that may set errno. */
265 report_file_error (char const *string
, Lisp_Object name
)
267 report_file_errno (string
, name
, errno
);
271 close_file_unwind (int fd
)
277 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 Lisp_Object Qwrite_region
;
327 static Lisp_Object Qverify_visited_file_modtime
;
328 static Lisp_Object Qset_visited_file_modtime
;
330 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
331 Sfind_file_name_handler
, 2, 2, 0,
332 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
333 Otherwise, return nil.
334 A file name is handled if one of the regular expressions in
335 `file-name-handler-alist' matches it.
337 If OPERATION equals `inhibit-file-name-operation', then we ignore
338 any handlers that are members of `inhibit-file-name-handlers',
339 but we still do run any other handlers. This lets handlers
340 use the standard functions without calling themselves recursively. */)
341 (Lisp_Object filename
, Lisp_Object operation
)
343 /* This function must not munge the match data. */
344 Lisp_Object chain
, inhibited_handlers
, result
;
348 CHECK_STRING (filename
);
350 if (EQ (operation
, Vinhibit_file_name_operation
))
351 inhibited_handlers
= Vinhibit_file_name_handlers
;
353 inhibited_handlers
= Qnil
;
355 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
356 chain
= XCDR (chain
))
362 Lisp_Object string
= XCAR (elt
);
364 Lisp_Object handler
= XCDR (elt
);
365 Lisp_Object operations
= Qnil
;
367 if (SYMBOLP (handler
))
368 operations
= Fget (handler
, Qoperations
);
371 && (match_pos
= fast_string_match (string
, filename
)) > pos
372 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
376 handler
= XCDR (elt
);
377 tem
= Fmemq (handler
, inhibited_handlers
);
391 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
393 doc
: /* Return the directory component in file name FILENAME.
394 Return nil if FILENAME does not include a directory.
395 Otherwise return a directory name.
396 Given a Unix syntax file name, returns a string ending in slash. */)
397 (Lisp_Object filename
)
400 register const char *beg
;
405 register const char *p
;
408 CHECK_STRING (filename
);
410 /* If the file name has special constructs in it,
411 call the corresponding file handler. */
412 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
415 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
417 return STRINGP (handled_name
) ? handled_name
: Qnil
;
421 beg
= xlispstrdupa (filename
);
423 beg
= SSDATA (filename
);
425 p
= beg
+ SBYTES (filename
);
427 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
429 /* only recognize drive specifier at the beginning */
431 /* handle the "/:d:foo" and "/:foo" cases correctly */
432 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
433 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
440 /* Expansion of "c:" to drive and default directory. */
443 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
444 char *res
= alloca (MAXPATHLEN
+ 1);
447 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
449 memcpy (res
, beg
, 2);
454 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
456 size_t l
= strlen (res
);
458 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
461 p
= beg
+ strlen (beg
);
462 dostounix_filename (beg
);
463 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
464 STRING_MULTIBYTE (filename
));
467 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
468 STRING_MULTIBYTE (filename
));
470 else if (STRING_MULTIBYTE (filename
))
472 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
473 dostounix_filename (SSDATA (tem_fn
));
475 if (!NILP (Vw32_downcase_file_names
))
476 tem_fn
= Fdowncase (tem_fn
);
481 dostounix_filename (beg
);
482 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
486 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
490 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
491 Sfile_name_nondirectory
, 1, 1, 0,
492 doc
: /* Return file name FILENAME sans its directory.
493 For example, in a Unix-syntax file name,
494 this is everything after the last slash,
495 or the entire name if it contains no slash. */)
496 (Lisp_Object filename
)
498 register const char *beg
, *p
, *end
;
501 CHECK_STRING (filename
);
503 /* If the file name has special constructs in it,
504 call the corresponding file handler. */
505 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
508 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
510 if (STRINGP (handled_name
))
512 error ("Invalid handler in `file-name-handler-alist'");
515 beg
= SSDATA (filename
);
516 end
= p
= beg
+ SBYTES (filename
);
518 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
520 /* only recognize drive specifier at beginning */
522 /* handle the "/:d:foo" case correctly */
523 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
528 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
531 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
532 Sunhandled_file_name_directory
, 1, 1, 0,
533 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
534 A `directly usable' directory name is one that may be used without the
535 intervention of any file handler.
536 If FILENAME is a directly usable file itself, return
537 \(file-name-directory FILENAME).
538 If FILENAME refers to a file which is not accessible from a local process,
539 then this should return nil.
540 The `call-process' and `start-process' functions use this function to
541 get a current directory to run processes in. */)
542 (Lisp_Object filename
)
546 /* If the file name has special constructs in it,
547 call the corresponding file handler. */
548 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
551 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
553 return STRINGP (handled_name
) ? handled_name
: Qnil
;
556 return Ffile_name_directory (filename
);
559 /* Maximum number of bytes that DST will be longer than SRC
560 in file_name_as_directory. This occurs when SRCLEN == 0. */
561 enum { file_name_as_directory_slop
= 2 };
563 /* Convert from file name SRC of length SRCLEN to directory name in
564 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
565 string. On UNIX, just make sure there is a terminating /. Return
566 the length of DST in bytes. */
569 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
580 memcpy (dst
, src
, srclen
);
581 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
582 dst
[srclen
++] = DIRECTORY_SEP
;
585 dostounix_filename (dst
);
590 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
591 Sfile_name_as_directory
, 1, 1, 0,
592 doc
: /* Return a string representing the file name FILE interpreted as a directory.
593 This operation exists because a directory is also a file, but its name as
594 a directory is different from its name as a file.
595 The result can be used as the value of `default-directory'
596 or passed as second argument to `expand-file-name'.
597 For a Unix-syntax file name, just appends a slash. */)
602 Lisp_Object handler
, val
;
609 /* If the file name has special constructs in it,
610 call the corresponding file handler. */
611 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
614 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
616 if (STRINGP (handled_name
))
618 error ("Invalid handler in `file-name-handler-alist'");
622 if (!NILP (Vw32_downcase_file_names
))
623 file
= Fdowncase (file
);
625 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
626 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
627 STRING_MULTIBYTE (file
));
628 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
633 /* Convert from directory name SRC of length SRCLEN to file name in
634 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
635 string. On UNIX, just make sure there isn't a terminating /.
636 Return the length of DST in bytes. */
639 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
641 /* Process as Unix format: just remove any final slash.
642 But leave "/" and "//" unchanged. */
645 && !IS_ANY_SEP (src
[srclen
- 2])
647 && IS_DIRECTORY_SEP (src
[srclen
- 1])
648 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
651 memcpy (dst
, src
, srclen
);
654 dostounix_filename (dst
);
659 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
661 doc
: /* Returns the file name of the directory named DIRECTORY.
662 This is the name of the file that holds the data for the directory DIRECTORY.
663 This operation exists because a directory is also a file, but its name as
664 a directory is different from its name as a file.
665 In Unix-syntax, this function just removes the final slash. */)
666 (Lisp_Object directory
)
670 Lisp_Object handler
, val
;
673 CHECK_STRING (directory
);
675 if (NILP (directory
))
678 /* If the file name has special constructs in it,
679 call the corresponding file handler. */
680 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
683 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
685 if (STRINGP (handled_name
))
687 error ("Invalid handler in `file-name-handler-alist'");
691 if (!NILP (Vw32_downcase_file_names
))
692 directory
= Fdowncase (directory
);
694 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
695 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
696 STRING_MULTIBYTE (directory
));
697 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
702 static const char make_temp_name_tbl
[64] =
704 'A','B','C','D','E','F','G','H',
705 'I','J','K','L','M','N','O','P',
706 'Q','R','S','T','U','V','W','X',
707 'Y','Z','a','b','c','d','e','f',
708 'g','h','i','j','k','l','m','n',
709 'o','p','q','r','s','t','u','v',
710 'w','x','y','z','0','1','2','3',
711 '4','5','6','7','8','9','-','_'
714 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
716 /* Value is a temporary file name starting with PREFIX, a string.
718 The Emacs process number forms part of the result, so there is
719 no danger of generating a name being used by another process.
720 In addition, this function makes an attempt to choose a name
721 which has no existing file. To make this work, PREFIX should be
722 an absolute file name.
724 BASE64_P means add the pid as 3 characters in base64
725 encoding. In this case, 6 characters will be added to PREFIX to
726 form the file name. Otherwise, if Emacs is running on a system
727 with long file names, add the pid as a decimal number.
729 This function signals an error if no unique file name could be
733 make_temp_name (Lisp_Object prefix
, bool base64_p
)
735 Lisp_Object val
, encoded_prefix
;
739 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
742 CHECK_STRING (prefix
);
744 /* VAL is created by adding 6 characters to PREFIX. The first
745 three are the PID of this process, in base 64, and the second
746 three are incremented if the file already exists. This ensures
747 262144 unique file names per PID per PREFIX. */
753 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
754 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
755 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
760 #ifdef HAVE_LONG_FILE_NAMES
761 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
763 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
764 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
765 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
770 encoded_prefix
= ENCODE_FILE (prefix
);
771 len
= SBYTES (encoded_prefix
);
772 val
= make_uninit_string (len
+ 3 + pidlen
);
774 memcpy (data
, SSDATA (encoded_prefix
), len
);
777 memcpy (p
, pidbuf
, pidlen
);
780 /* Here we try to minimize useless stat'ing when this function is
781 invoked many times successively with the same PREFIX. We achieve
782 this by initializing count to a random value, and incrementing it
785 We don't want make-temp-name to be called while dumping,
786 because then make_temp_name_count_initialized_p would get set
787 and then make_temp_name_count would not be set when Emacs starts. */
789 if (!make_temp_name_count_initialized_p
)
791 make_temp_name_count
= time (NULL
);
792 make_temp_name_count_initialized_p
= 1;
797 unsigned num
= make_temp_name_count
;
799 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
800 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
801 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
803 /* Poor man's congruential RN generator. Replace with
804 ++make_temp_name_count for debugging. */
805 make_temp_name_count
+= 25229;
806 make_temp_name_count
%= 225307;
808 if (!check_existing (data
))
810 /* We want to return only if errno is ENOENT. */
812 return DECODE_FILE (val
);
814 /* The error here is dubious, but there is little else we
815 can do. The alternatives are to return nil, which is
816 as bad as (and in many cases worse than) throwing the
817 error, or to ignore the error, which will likely result
818 in looping through 225307 stat's, which is not only
819 dog-slow, but also useless since eventually nil would
820 have to be returned anyway. */
821 report_file_error ("Cannot create temporary name for prefix",
829 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
830 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
831 The Emacs process number forms part of the result,
832 so there is no danger of generating a name being used by another process.
834 In addition, this function makes an attempt to choose a name
835 which has no existing file. To make this work,
836 PREFIX should be an absolute file name.
838 There is a race condition between calling `make-temp-name' and creating the
839 file which opens all kinds of security holes. For that reason, you should
840 probably use `make-temp-file' instead, except in three circumstances:
842 * If you are creating the file in the user's home directory.
843 * If you are creating a directory rather than an ordinary file.
844 * If you are taking special precautions as `make-temp-file' does. */)
847 return make_temp_name (prefix
, 0);
852 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
853 doc
: /* Convert filename NAME to absolute, and canonicalize it.
854 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
855 \(does not start with slash or tilde); both the directory name and
856 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
857 missing, the current buffer's value of `default-directory' is used.
858 NAME should be a string that is a valid file name for the underlying
860 File name components that are `.' are removed, and
861 so are file name components followed by `..', along with the `..' itself;
862 note that these simplifications are done without checking the resulting
863 file names in the file system.
864 Multiple consecutive slashes are collapsed into a single slash,
865 except at the beginning of the file name when they are significant (e.g.,
866 UNC file names on MS-Windows.)
867 An initial `~/' expands to your home directory.
868 An initial `~USER/' expands to USER's home directory.
869 See also the function `substitute-in-file-name'.
871 For technical reasons, this function can return correct but
872 non-intuitive results for the root directory; for instance,
873 \(expand-file-name ".." "/") returns "/..". For this reason, use
874 \(directory-file-name (file-name-directory dirname)) to traverse a
875 filesystem tree, not (expand-file-name ".." dirname). */)
876 (Lisp_Object name
, Lisp_Object default_directory
)
878 /* These point to SDATA and need to be careful with string-relocation
879 during GC (via DECODE_FILE). */
882 /* This should only point to alloca'd data. */
889 bool collapse_newdir
= 1;
893 Lisp_Object handler
, result
, handled_name
;
900 /* If the file name has special constructs in it,
901 call the corresponding file handler. */
902 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
905 handled_name
= call3 (handler
, Qexpand_file_name
,
906 name
, default_directory
);
907 if (STRINGP (handled_name
))
909 error ("Invalid handler in `file-name-handler-alist'");
913 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
914 if (NILP (default_directory
))
915 default_directory
= BVAR (current_buffer
, directory
);
916 if (! STRINGP (default_directory
))
919 /* "/" is not considered a root directory on DOS_NT, so using "/"
920 here causes an infinite recursion in, e.g., the following:
922 (let (default-directory)
923 (expand-file-name "a"))
925 To avoid this, we set default_directory to the root of the
927 default_directory
= build_string (emacs_root_dir ());
929 default_directory
= build_string ("/");
933 if (!NILP (default_directory
))
935 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
938 handled_name
= call3 (handler
, Qexpand_file_name
,
939 name
, default_directory
);
940 if (STRINGP (handled_name
))
942 error ("Invalid handler in `file-name-handler-alist'");
947 char *o
= SSDATA (default_directory
);
949 /* Make sure DEFAULT_DIRECTORY is properly expanded.
950 It would be better to do this down below where we actually use
951 default_directory. Unfortunately, calling Fexpand_file_name recursively
952 could invoke GC, and the strings might be relocated. This would
953 be annoying because we have pointers into strings lying around
954 that would need adjusting, and people would add new pointers to
955 the code and forget to adjust them, resulting in intermittent bugs.
956 Putting this call here avoids all that crud.
958 The EQ test avoids infinite recursion. */
959 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
960 /* Save time in some common cases - as long as default_directory
961 is not relative, it can be canonicalized with name below (if it
962 is needed at all) without requiring it to be expanded now. */
964 /* Detect MSDOS file names with drive specifiers. */
965 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
966 && IS_DIRECTORY_SEP (o
[2]))
968 /* Detect Windows file names in UNC format. */
969 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
971 #else /* not DOS_NT */
972 /* Detect Unix absolute file names (/... alone is not absolute on
974 && ! (IS_DIRECTORY_SEP (o
[0]))
975 #endif /* not DOS_NT */
981 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
985 multibyte
= STRING_MULTIBYTE (name
);
986 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
990 unsigned char *p
= SDATA (name
);
992 while (*p
&& ASCII_BYTE_P (*p
))
996 /* NAME is a pure ASCII string, and DEFAULT_DIRECTORY is
997 unibyte. Do not convert DEFAULT_DIRECTORY to
998 multibyte; instead, convert NAME to a unibyte string,
999 so that the result of this function is also a unibyte
1000 string. This is needed during bootstrapping and
1001 dumping, when Emacs cannot decode file names, because
1002 the locale environment is not set up. */
1003 name
= make_unibyte_string (SSDATA (name
), SBYTES (name
));
1007 default_directory
= string_to_multibyte (default_directory
);
1011 name
= string_to_multibyte (name
);
1017 if (!NILP (Vw32_downcase_file_names
))
1018 default_directory
= Fdowncase (default_directory
);
1021 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
1022 nm
= xlispstrdupa (name
);
1025 /* Note if special escape prefix is present, but remove for now. */
1026 if (nm
[0] == '/' && nm
[1] == ':')
1032 /* Find and remove drive specifier if present; this makes nm absolute
1033 even if the rest of the name appears to be relative. Only look for
1034 drive specifier at the beginning. */
1035 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1037 drive
= (unsigned char) nm
[0];
1042 /* If we see "c://somedir", we want to strip the first slash after the
1043 colon when stripping the drive letter. Otherwise, this expands to
1045 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1048 /* Discard any previous drive specifier if nm is now in UNC format. */
1049 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1050 && !IS_DIRECTORY_SEP (nm
[2]))
1052 #endif /* WINDOWSNT */
1055 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1056 none are found, we can probably return right away. We will avoid
1057 allocating a new string if name is already fully expanded. */
1059 IS_DIRECTORY_SEP (nm
[0])
1061 && drive
&& !is_escaped
1064 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1068 /* If it turns out that the filename we want to return is just a
1069 suffix of FILENAME, we don't need to go through and edit
1070 things; we just need to construct a new string using data
1071 starting at the middle of FILENAME. If we set LOSE, that
1072 means we've discovered that we can't do that cool trick. */
1078 /* Since we know the name is absolute, we can assume that each
1079 element starts with a "/". */
1081 /* "." and ".." are hairy. */
1082 if (IS_DIRECTORY_SEP (p
[0])
1084 && (IS_DIRECTORY_SEP (p
[2])
1086 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1089 /* Replace multiple slashes with a single one, except
1090 leave leading "//" alone. */
1091 else if (IS_DIRECTORY_SEP (p
[0])
1092 && IS_DIRECTORY_SEP (p
[1])
1093 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1100 /* Make sure directories are all separated with /, but
1101 avoid allocation of a new string when not required. */
1102 dostounix_filename (nm
);
1104 if (IS_DIRECTORY_SEP (nm
[1]))
1106 if (strcmp (nm
, SSDATA (name
)) != 0)
1107 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1111 /* Drive must be set, so this is okay. */
1112 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1116 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1117 temp
[0] = DRIVE_LETTER (drive
);
1118 name
= concat2 (build_string (temp
), name
);
1121 if (!NILP (Vw32_downcase_file_names
))
1122 name
= Fdowncase (name
);
1125 #else /* not DOS_NT */
1126 if (strcmp (nm
, SSDATA (name
)) == 0)
1128 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1129 #endif /* not DOS_NT */
1133 /* At this point, nm might or might not be an absolute file name. We
1134 need to expand ~ or ~user if present, otherwise prefix nm with
1135 default_directory if nm is not absolute, and finally collapse /./
1136 and /foo/../ sequences.
1138 We set newdir to be the appropriate prefix if one is needed:
1139 - the relevant user directory if nm starts with ~ or ~user
1140 - the specified drive's working dir (DOS/NT only) if nm does not
1142 - the value of default_directory.
1144 Note that these prefixes are not guaranteed to be absolute (except
1145 for the working dir of a drive). Therefore, to ensure we always
1146 return an absolute name, if the final prefix is not absolute we
1147 append it to the current working directory. */
1151 if (nm
[0] == '~') /* prefix ~ */
1153 if (IS_DIRECTORY_SEP (nm
[1])
1154 || nm
[1] == 0) /* ~ by itself */
1158 if (!(newdir
= egetenv ("HOME")))
1161 /* `egetenv' may return a unibyte string, which will bite us since
1162 we expect the directory to be multibyte. */
1166 char newdir_utf8
[MAX_UTF8_PATH
];
1168 filename_from_ansi (newdir
, newdir_utf8
);
1169 tem
= make_unibyte_string (newdir_utf8
, strlen (newdir_utf8
));
1173 tem
= build_string (newdir
);
1174 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1176 hdir
= DECODE_FILE (tem
);
1177 newdir
= SSDATA (hdir
);
1180 collapse_newdir
= 0;
1183 else /* ~user/filename */
1186 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1188 o
= SAFE_ALLOCA (p
- nm
+ 1);
1189 memcpy (o
, nm
, p
- nm
);
1193 pw
= getpwnam (o
+ 1);
1199 newdir
= pw
->pw_dir
;
1200 /* `getpwnam' may return a unibyte string, which will
1201 bite us since we expect the directory to be
1203 tem
= make_unibyte_string (newdir
, strlen (newdir
));
1204 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1206 hdir
= DECODE_FILE (tem
);
1207 newdir
= SSDATA (hdir
);
1211 collapse_newdir
= 0;
1215 /* If we don't find a user of that name, leave the name
1216 unchanged; don't move nm forward to p. */
1221 /* On DOS and Windows, nm is absolute if a drive name was specified;
1222 use the drive's current directory as the prefix if needed. */
1223 if (!newdir
&& drive
)
1225 /* Get default directory if needed to make nm absolute. */
1227 if (!IS_DIRECTORY_SEP (nm
[0]))
1229 adir
= alloca (MAXPATHLEN
+ 1);
1230 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1234 Lisp_Object tem
= build_string (adir
);
1236 tem
= DECODE_FILE (tem
);
1237 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1242 /* Either nm starts with /, or drive isn't mounted. */
1244 adir
[0] = DRIVE_LETTER (drive
);
1253 /* Finally, if no prefix has been specified and nm is not absolute,
1254 then it must be expanded relative to default_directory. */
1258 /* /... alone is not absolute on DOS and Windows. */
1259 && !IS_DIRECTORY_SEP (nm
[0])
1262 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1263 && !IS_DIRECTORY_SEP (nm
[2]))
1267 newdir
= SSDATA (default_directory
);
1269 /* Note if special escape prefix is present, but remove for now. */
1270 if (newdir
[0] == '/' && newdir
[1] == ':')
1281 /* First ensure newdir is an absolute name. */
1283 /* Detect MSDOS file names with drive specifiers. */
1284 ! (IS_DRIVE (newdir
[0])
1285 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1287 /* Detect Windows file names in UNC format. */
1288 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1289 && !IS_DIRECTORY_SEP (newdir
[2]))
1293 /* Effectively, let newdir be (expand-file-name newdir cwd).
1294 Because of the admonition against calling expand-file-name
1295 when we have pointers into lisp strings, we accomplish this
1296 indirectly by prepending newdir to nm if necessary, and using
1297 cwd (or the wd of newdir's drive) as the new newdir. */
1300 const int adir_size
= MAX_UTF8_PATH
;
1302 const int adir_size
= MAXPATHLEN
+ 1;
1305 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1307 drive
= (unsigned char) newdir
[0];
1310 if (!IS_DIRECTORY_SEP (nm
[0]))
1312 ptrdiff_t newlen
= strlen (newdir
);
1313 char *tmp
= alloca (newlen
+ file_name_as_directory_slop
1315 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1319 adir
= alloca (adir_size
);
1322 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1326 getcwd (adir
, adir_size
);
1329 Lisp_Object tem
= build_string (adir
);
1331 tem
= DECODE_FILE (tem
);
1332 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1337 /* Strip off drive name from prefix, if present. */
1338 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1344 /* Keep only a prefix from newdir if nm starts with slash
1345 (//server/share for UNC, nothing otherwise). */
1346 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1349 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1350 && !IS_DIRECTORY_SEP (newdir
[2]))
1352 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1354 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1356 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1369 /* Ignore any slash at the end of newdir, unless newdir is
1370 just "/" or "//". */
1371 length
= strlen (newdir
);
1372 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1373 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1379 /* Now concatenate the directory and name to new space in the stack frame. */
1380 tlen
= length
+ file_name_as_directory_slop
+ strlen (nm
) + 1;
1382 /* Reserve space for drive specifier and escape prefix, since either
1383 or both may need to be inserted. (The Microsoft x86 compiler
1384 produces incorrect code if the following two lines are combined.) */
1385 target
= alloca (tlen
+ 4);
1387 #else /* not DOS_NT */
1388 target
= SAFE_ALLOCA (tlen
);
1389 #endif /* not DOS_NT */
1394 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1397 /* If newdir is effectively "C:/", then the drive letter will have
1398 been stripped and newdir will be "/". Concatenating with an
1399 absolute directory in nm produces "//", which will then be
1400 incorrectly treated as a network share. Ignore newdir in
1401 this case (keeping the drive letter). */
1402 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1403 && newdir
[1] == '\0'))
1406 memcpy (target
, newdir
, length
);
1411 file_name_as_directory (target
, newdir
, length
, multibyte
);
1414 strcat (target
, nm
);
1416 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1424 if (!IS_DIRECTORY_SEP (*p
))
1428 else if (p
[1] == '.'
1429 && (IS_DIRECTORY_SEP (p
[2])
1432 /* If "/." is the entire filename, keep the "/". Otherwise,
1433 just delete the whole "/.". */
1434 if (o
== target
&& p
[2] == '\0')
1438 else if (p
[1] == '.' && p
[2] == '.'
1439 /* `/../' is the "superroot" on certain file systems.
1440 Turned off on DOS_NT systems because they have no
1441 "superroot" and because this causes us to produce
1442 file names like "d:/../foo" which fail file-related
1443 functions of the underlying OS. (To reproduce, try a
1444 long series of "../../" in default_directory, longer
1445 than the number of levels from the root.) */
1449 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1454 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1457 /* Don't go below server level in UNC filenames. */
1458 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1459 && IS_DIRECTORY_SEP (*target
))
1463 /* Keep initial / only if this is the whole name. */
1464 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1468 else if (IS_DIRECTORY_SEP (p
[1])
1469 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1470 /* Collapse multiple "/", except leave leading "//" alone. */
1479 /* At last, set drive name. */
1481 /* Except for network file name. */
1482 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1483 #endif /* WINDOWSNT */
1485 if (!drive
) emacs_abort ();
1487 target
[0] = DRIVE_LETTER (drive
);
1490 /* Reinsert the escape prefix if required. */
1497 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1498 dostounix_filename (SSDATA (result
));
1500 if (!NILP (Vw32_downcase_file_names
))
1501 result
= Fdowncase (result
);
1504 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1505 #endif /* !DOS_NT */
1508 /* Again look to see if the file name has special constructs in it
1509 and perhaps call the corresponding file handler. This is needed
1510 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1511 the ".." component gives us "/user@host:/bar/../baz" which needs
1512 to be expanded again. */
1513 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1514 if (!NILP (handler
))
1516 handled_name
= call3 (handler
, Qexpand_file_name
,
1517 result
, default_directory
);
1518 if (! STRINGP (handled_name
))
1519 error ("Invalid handler in `file-name-handler-alist'");
1520 result
= handled_name
;
1528 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1529 This is the old version of expand-file-name, before it was thoroughly
1530 rewritten for Emacs 10.31. We leave this version here commented-out,
1531 because the code is very complex and likely to have subtle bugs. If
1532 bugs _are_ found, it might be of interest to look at the old code and
1533 see what did it do in the relevant situation.
1535 Don't remove this code: it's true that it will be accessible
1536 from the repository, but a few years from deletion, people will
1537 forget it is there. */
1539 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1540 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1541 "Convert FILENAME to absolute, and canonicalize it.\n\
1542 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1543 \(does not start with slash); if DEFAULT is nil or missing,\n\
1544 the current buffer's value of default-directory is used.\n\
1545 Filenames containing `.' or `..' as components are simplified;\n\
1546 initial `~/' expands to your home directory.\n\
1547 See also the function `substitute-in-file-name'.")
1549 Lisp_Object name
, defalt
;
1553 register unsigned char *newdir
, *p
, *o
;
1555 unsigned char *target
;
1558 CHECK_STRING (name
);
1561 /* If nm is absolute, flush ...// and detect /./ and /../.
1562 If no /./ or /../ we can return right away. */
1569 if (p
[0] == '/' && p
[1] == '/')
1571 if (p
[0] == '/' && p
[1] == '~')
1572 nm
= p
+ 1, lose
= 1;
1573 if (p
[0] == '/' && p
[1] == '.'
1574 && (p
[2] == '/' || p
[2] == 0
1575 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1581 if (nm
== SDATA (name
))
1583 return build_string (nm
);
1587 /* Now determine directory to start with and put it in NEWDIR. */
1591 if (nm
[0] == '~') /* prefix ~ */
1592 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1594 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1595 newdir
= (unsigned char *) "";
1598 else /* ~user/filename */
1600 /* Get past ~ to user. */
1601 unsigned char *user
= nm
+ 1;
1602 /* Find end of name. */
1603 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1604 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1605 /* Copy the user name into temp storage. */
1606 o
= alloca (len
+ 1);
1607 memcpy (o
, user
, len
);
1610 /* Look up the user name. */
1612 pw
= (struct passwd
*) getpwnam (o
+ 1);
1615 error ("\"%s\" isn't a registered user", o
+ 1);
1617 newdir
= (unsigned char *) pw
->pw_dir
;
1619 /* Discard the user name from NM. */
1623 if (nm
[0] != '/' && !newdir
)
1626 defalt
= current_buffer
->directory
;
1627 CHECK_STRING (defalt
);
1628 newdir
= SDATA (defalt
);
1631 /* Now concatenate the directory and name to new space in the stack frame. */
1633 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1634 target
= alloca (tlen
);
1639 if (nm
[0] == 0 || nm
[0] == '/')
1640 strcpy (target
, newdir
);
1642 file_name_as_directory (target
, newdir
);
1645 strcat (target
, nm
);
1647 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1658 else if (!strncmp (p
, "//", 2)
1664 else if (p
[0] == '/' && p
[1] == '.'
1665 && (p
[2] == '/' || p
[2] == 0))
1667 else if (!strncmp (p
, "/..", 3)
1668 /* `/../' is the "superroot" on certain file systems. */
1670 && (p
[3] == '/' || p
[3] == 0))
1672 while (o
!= target
&& *--o
!= '/')
1674 if (o
== target
&& *o
== '/')
1684 return make_string (target
, o
- target
);
1688 /* If /~ or // appears, discard everything through first slash. */
1690 file_name_absolute_p (const char *filename
)
1693 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1695 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1696 && IS_DIRECTORY_SEP (filename
[2]))
1702 search_embedded_absfilename (char *nm
, char *endp
)
1706 for (p
= nm
+ 1; p
< endp
; p
++)
1708 if (IS_DIRECTORY_SEP (p
[-1])
1709 && file_name_absolute_p (p
)
1710 #if defined (WINDOWSNT) || defined (CYGWIN)
1711 /* // at start of file name is meaningful in Apollo,
1712 WindowsNT and Cygwin systems. */
1713 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1714 #endif /* not (WINDOWSNT || CYGWIN) */
1717 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1718 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1720 char *o
= alloca (s
- p
+ 1);
1722 memcpy (o
, p
, s
- p
);
1725 /* If we have ~user and `user' exists, discard
1726 everything up to ~. But if `user' does not exist, leave
1727 ~user alone, it might be a literal file name. */
1729 pw
= getpwnam (o
+ 1);
1741 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1742 Ssubstitute_in_file_name
, 1, 1, 0,
1743 doc
: /* Substitute environment variables referred to in FILENAME.
1744 `$FOO' where FOO is an environment variable name means to substitute
1745 the value of that variable. The variable name should be terminated
1746 with a character not a letter, digit or underscore; otherwise, enclose
1747 the entire variable name in braces.
1749 If `/~' appears, all of FILENAME through that `/' is discarded.
1750 If `//' appears, everything up to and including the first of
1751 those `/' is discarded. */)
1752 (Lisp_Object filename
)
1754 char *nm
, *p
, *x
, *endp
;
1755 bool substituted
= false;
1758 Lisp_Object handler
;
1760 CHECK_STRING (filename
);
1762 multibyte
= STRING_MULTIBYTE (filename
);
1764 /* If the file name has special constructs in it,
1765 call the corresponding file handler. */
1766 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1767 if (!NILP (handler
))
1769 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1771 if (STRINGP (handled_name
))
1772 return handled_name
;
1773 error ("Invalid handler in `file-name-handler-alist'");
1776 /* Always work on a copy of the string, in case GC happens during
1777 decode of environment variables, causing the original Lisp_String
1778 data to be relocated. */
1779 nm
= xlispstrdupa (filename
);
1782 dostounix_filename (nm
);
1783 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1785 endp
= nm
+ SBYTES (filename
);
1787 /* If /~ or // appears, discard everything through first slash. */
1788 p
= search_embedded_absfilename (nm
, endp
);
1790 /* Start over with the new string, so we check the file-name-handler
1791 again. Important with filenames like "/home/foo//:/hello///there"
1792 which would substitute to "/:/hello///there" rather than "/there". */
1793 return Fsubstitute_in_file_name
1794 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1796 /* See if any variables are substituted into the string. */
1798 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1801 = (!substituted
? filename
1802 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1803 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1805 if (!EQ (tmp
, name
))
1813 if (!NILP (Vw32_downcase_file_names
))
1814 filename
= Fdowncase (filename
);
1819 xnm
= SSDATA (filename
);
1820 x
= xnm
+ SBYTES (filename
);
1822 /* If /~ or // appears, discard everything through first slash. */
1823 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1824 /* This time we do not start over because we've already expanded envvars
1825 and replaced $$ with $. Maybe we should start over as well, but we'd
1826 need to quote some $ to $$ first. */
1830 if (!NILP (Vw32_downcase_file_names
))
1832 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1834 xname
= Fdowncase (xname
);
1839 return (xnm
== SSDATA (filename
)
1841 : make_specified_string (xnm
, -1, x
- xnm
, multibyte
));
1844 /* A slightly faster and more convenient way to get
1845 (directory-file-name (expand-file-name FOO)). */
1848 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1850 register Lisp_Object absname
;
1852 absname
= Fexpand_file_name (filename
, defdir
);
1854 /* Remove final slash, if any (unless this is the root dir).
1855 stat behaves differently depending! */
1856 if (SCHARS (absname
) > 1
1857 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1858 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1859 /* We cannot take shortcuts; they might be wrong for magic file names. */
1860 absname
= Fdirectory_file_name (absname
);
1864 /* Signal an error if the file ABSNAME already exists.
1865 If KNOWN_TO_EXIST, the file is known to exist.
1866 QUERYSTRING is a name for the action that is being considered
1868 If INTERACTIVE, ask the user whether to proceed,
1869 and bypass the error if the user says to go ahead.
1870 If QUICK, ask for y or n, not yes or no. */
1873 barf_or_query_if_file_exists (Lisp_Object absname
, bool known_to_exist
,
1874 const char *querystring
, bool interactive
,
1877 Lisp_Object tem
, encoded_filename
;
1878 struct stat statbuf
;
1879 struct gcpro gcpro1
;
1881 encoded_filename
= ENCODE_FILE (absname
);
1883 if (! known_to_exist
&& lstat (SSDATA (encoded_filename
), &statbuf
) == 0)
1885 if (S_ISDIR (statbuf
.st_mode
))
1886 xsignal2 (Qfile_error
,
1887 build_string ("File is a directory"), absname
);
1888 known_to_exist
= true;
1894 xsignal2 (Qfile_already_exists
,
1895 build_string ("File already exists"), absname
);
1897 tem
= format2 ("File %s already exists; %s anyway? ",
1898 absname
, build_string (querystring
));
1900 tem
= call1 (intern ("y-or-n-p"), tem
);
1902 tem
= do_yes_or_no_p (tem
);
1905 xsignal2 (Qfile_already_exists
,
1906 build_string ("File already exists"), absname
);
1910 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1911 "fCopy file: \nGCopy %s to file: \np\nP",
1912 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1913 If NEWNAME names a directory, copy FILE there.
1915 This function always sets the file modes of the output file to match
1918 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1919 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1920 signal a `file-already-exists' error without overwriting. If
1921 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1922 about overwriting; this is what happens in interactive use with M-x.
1923 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1926 Fourth arg KEEP-TIME non-nil means give the output file the same
1927 last-modified time as the old one. (This works on only some systems.)
1929 A prefix arg makes KEEP-TIME non-nil.
1931 If PRESERVE-UID-GID is non-nil, we try to transfer the
1932 uid and gid of FILE to NEWNAME.
1934 If PRESERVE-PERMISSIONS is non-nil, copy permissions of FILE to NEWNAME;
1935 this includes the file modes, along with ACL entries and SELinux
1936 context if present. Otherwise, if NEWNAME is created its file
1937 permission bits are those of FILE, masked by the default file
1939 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
,
1940 Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
,
1941 Lisp_Object preserve_permissions
)
1943 Lisp_Object handler
;
1944 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1945 ptrdiff_t count
= SPECPDL_INDEX ();
1946 Lisp_Object encoded_file
, encoded_newname
;
1948 security_context_t con
;
1954 bool already_exists
= false;
1958 char buf
[16 * 1024];
1962 encoded_file
= encoded_newname
= Qnil
;
1963 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1964 CHECK_STRING (file
);
1965 CHECK_STRING (newname
);
1967 if (!NILP (Ffile_directory_p (newname
)))
1968 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1970 newname
= Fexpand_file_name (newname
, Qnil
);
1972 file
= Fexpand_file_name (file
, Qnil
);
1974 /* If the input file name has special constructs in it,
1975 call the corresponding file handler. */
1976 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1977 /* Likewise for output file name. */
1979 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1980 if (!NILP (handler
))
1981 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1982 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1983 preserve_permissions
));
1985 encoded_file
= ENCODE_FILE (file
);
1986 encoded_newname
= ENCODE_FILE (newname
);
1989 if (NILP (ok_if_already_exists
)
1990 || INTEGERP (ok_if_already_exists
))
1991 barf_or_query_if_file_exists (newname
, false, "copy to it",
1992 INTEGERP (ok_if_already_exists
), false);
1994 result
= w32_copy_file (SSDATA (encoded_file
), SSDATA (encoded_newname
),
1995 !NILP (keep_time
), !NILP (preserve_uid_gid
),
1996 !NILP (preserve_permissions
));
2000 report_file_error ("Copying file", list2 (file
, newname
));
2002 report_file_error ("Copying permissions from", file
);
2004 xsignal2 (Qfile_date_error
,
2005 build_string ("Resetting file times"), newname
);
2007 report_file_error ("Copying permissions to", newname
);
2009 #else /* not WINDOWSNT */
2011 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2015 report_file_error ("Opening input file", file
);
2017 record_unwind_protect_int (close_file_unwind
, ifd
);
2019 if (fstat (ifd
, &st
) != 0)
2020 report_file_error ("Input file status", file
);
2022 if (!NILP (preserve_permissions
))
2025 if (is_selinux_enabled ())
2027 conlength
= fgetfilecon (ifd
, &con
);
2028 if (conlength
== -1)
2029 report_file_error ("Doing fgetfilecon", file
);
2034 /* We can copy only regular files. */
2035 if (!S_ISREG (st
.st_mode
))
2036 report_file_errno ("Non-regular file", file
,
2037 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
2040 new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0700 : 0777);
2042 new_mask
= S_IREAD
| S_IWRITE
;
2045 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
| O_CREAT
| O_EXCL
,
2047 if (ofd
< 0 && errno
== EEXIST
)
2049 if (NILP (ok_if_already_exists
) || INTEGERP (ok_if_already_exists
))
2050 barf_or_query_if_file_exists (newname
, true, "copy to it",
2051 INTEGERP (ok_if_already_exists
), false);
2052 already_exists
= true;
2053 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
, 0);
2056 report_file_error ("Opening output file", newname
);
2058 record_unwind_protect_int (close_file_unwind
, ofd
);
2063 if (fstat (ofd
, &out_st
) != 0)
2064 report_file_error ("Output file status", newname
);
2065 if (st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2066 report_file_errno ("Input and output files are the same",
2067 list2 (file
, newname
), 0);
2068 if (ftruncate (ofd
, 0) != 0)
2069 report_file_error ("Truncating output file", newname
);
2074 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2075 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2076 report_file_error ("Write error", newname
);
2080 /* Preserve the original file permissions, and if requested, also its
2083 mode_t preserved_permissions
= st
.st_mode
& 07777;
2084 mode_t default_permissions
= st
.st_mode
& 0777 & ~realmask
;
2085 if (!NILP (preserve_uid_gid
))
2087 /* Attempt to change owner and group. If that doesn't work
2088 attempt to change just the group, as that is sometimes allowed.
2089 Adjust the mode mask to eliminate setuid or setgid bits
2090 or group permissions bits that are inappropriate if the
2091 owner or group are wrong. */
2092 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2094 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2095 preserved_permissions
&= ~04000;
2098 preserved_permissions
&= ~06000;
2100 /* Copy the other bits to the group bits, since the
2102 preserved_permissions
&= ~070;
2103 preserved_permissions
|= (preserved_permissions
& 7) << 3;
2104 default_permissions
&= ~070;
2105 default_permissions
|= (default_permissions
& 7) << 3;
2110 switch (!NILP (preserve_permissions
)
2111 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2112 SSDATA (encoded_newname
), ofd
,
2113 preserved_permissions
)
2115 || (new_mask
& ~realmask
) == default_permissions
)
2117 : fchmod (ofd
, default_permissions
))
2119 case -2: report_file_error ("Copying permissions from", file
);
2120 case -1: report_file_error ("Copying permissions to", newname
);
2123 #endif /* not MSDOS */
2128 /* Set the modified context back to the file. */
2129 bool fail
= fsetfilecon (ofd
, con
) != 0;
2130 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2131 if (fail
&& errno
!= ENOTSUP
)
2132 report_file_error ("Doing fsetfilecon", newname
);
2138 if (!NILP (keep_time
))
2140 struct timespec atime
= get_stat_atime (&st
);
2141 struct timespec mtime
= get_stat_mtime (&st
);
2142 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
) != 0)
2143 xsignal2 (Qfile_date_error
,
2144 build_string ("Cannot set file date"), newname
);
2147 if (emacs_close (ofd
) < 0)
2148 report_file_error ("Write error", newname
);
2153 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2154 and if it can't, it tells so. Otherwise, under MSDOS we usually
2155 get only the READ bit, which will make the copied file read-only,
2156 so it's better not to chmod at all. */
2157 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2158 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2160 #endif /* not WINDOWSNT */
2162 /* Discard the unwind protects. */
2163 specpdl_ptr
= specpdl
+ count
;
2169 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2170 Smake_directory_internal
, 1, 1, 0,
2171 doc
: /* Create a new directory named DIRECTORY. */)
2172 (Lisp_Object directory
)
2175 Lisp_Object handler
;
2176 Lisp_Object encoded_dir
;
2178 CHECK_STRING (directory
);
2179 directory
= Fexpand_file_name (directory
, Qnil
);
2181 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2182 if (!NILP (handler
))
2183 return call2 (handler
, Qmake_directory_internal
, directory
);
2185 encoded_dir
= ENCODE_FILE (directory
);
2187 dir
= SSDATA (encoded_dir
);
2190 if (mkdir (dir
) != 0)
2192 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2194 report_file_error ("Creating directory", directory
);
2199 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2200 Sdelete_directory_internal
, 1, 1, 0,
2201 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2202 (Lisp_Object directory
)
2205 Lisp_Object encoded_dir
;
2207 CHECK_STRING (directory
);
2208 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2209 encoded_dir
= ENCODE_FILE (directory
);
2210 dir
= SSDATA (encoded_dir
);
2212 if (rmdir (dir
) != 0)
2213 report_file_error ("Removing directory", directory
);
2218 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2219 "(list (read-file-name \
2220 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2221 \"Move file to trash: \" \"Delete file: \") \
2222 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2223 (null current-prefix-arg))",
2224 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2225 If file has multiple names, it continues to exist with the other names.
2226 TRASH non-nil means to trash the file instead of deleting, provided
2227 `delete-by-moving-to-trash' is non-nil.
2229 When called interactively, TRASH is t if no prefix argument is given.
2230 With a prefix argument, TRASH is nil. */)
2231 (Lisp_Object filename
, Lisp_Object trash
)
2233 Lisp_Object handler
;
2234 Lisp_Object encoded_file
;
2235 struct gcpro gcpro1
;
2238 if (!NILP (Ffile_directory_p (filename
))
2239 && NILP (Ffile_symlink_p (filename
)))
2240 xsignal2 (Qfile_error
,
2241 build_string ("Removing old name: is a directory"),
2244 filename
= Fexpand_file_name (filename
, Qnil
);
2246 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2247 if (!NILP (handler
))
2248 return call3 (handler
, Qdelete_file
, filename
, trash
);
2250 if (delete_by_moving_to_trash
&& !NILP (trash
))
2251 return call1 (Qmove_file_to_trash
, filename
);
2253 encoded_file
= ENCODE_FILE (filename
);
2255 if (unlink (SSDATA (encoded_file
)) < 0)
2256 report_file_error ("Removing old name", filename
);
2261 internal_delete_file_1 (Lisp_Object ignore
)
2266 /* Delete file FILENAME, returning true if successful.
2267 This ignores `delete-by-moving-to-trash'. */
2270 internal_delete_file (Lisp_Object filename
)
2274 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2275 Qt
, internal_delete_file_1
);
2279 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2280 "fRename file: \nGRename %s to file: \np",
2281 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2282 If file has names other than FILE, it continues to have those names.
2283 Signals a `file-already-exists' error if a file NEWNAME already exists
2284 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2285 A number as third arg means request confirmation if NEWNAME already exists.
2286 This is what happens in interactive use with M-x. */)
2287 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2289 Lisp_Object handler
;
2290 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2291 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2293 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2294 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2295 CHECK_STRING (file
);
2296 CHECK_STRING (newname
);
2297 file
= Fexpand_file_name (file
, Qnil
);
2299 if ((!NILP (Ffile_directory_p (newname
)))
2301 /* If the file names are identical but for the case,
2302 don't attempt to move directory to itself. */
2303 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2307 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2308 ? file
: Fdirectory_file_name (file
));
2309 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2312 newname
= Fexpand_file_name (newname
, Qnil
);
2314 /* If the file name has special constructs in it,
2315 call the corresponding file handler. */
2316 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2318 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2319 if (!NILP (handler
))
2320 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2321 file
, newname
, ok_if_already_exists
));
2323 encoded_file
= ENCODE_FILE (file
);
2324 encoded_newname
= ENCODE_FILE (newname
);
2327 /* If the file names are identical but for the case, don't ask for
2328 confirmation: they simply want to change the letter-case of the
2330 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2332 if (NILP (ok_if_already_exists
)
2333 || INTEGERP (ok_if_already_exists
))
2334 barf_or_query_if_file_exists (newname
, false, "rename to it",
2335 INTEGERP (ok_if_already_exists
), false);
2336 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2338 int rename_errno
= errno
;
2339 if (rename_errno
== EXDEV
)
2342 symlink_target
= Ffile_symlink_p (file
);
2343 if (! NILP (symlink_target
))
2344 Fmake_symbolic_link (symlink_target
, newname
,
2345 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2346 else if (!NILP (Ffile_directory_p (file
)))
2347 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2349 /* We have already prompted if it was an integer, so don't
2350 have copy-file prompt again. */
2351 Fcopy_file (file
, newname
,
2352 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2355 count
= SPECPDL_INDEX ();
2356 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2358 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2359 call2 (Qdelete_directory
, file
, Qt
);
2361 Fdelete_file (file
, Qnil
);
2362 unbind_to (count
, Qnil
);
2365 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2371 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2372 "fAdd name to file: \nGName to add to %s: \np",
2373 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2374 Signals a `file-already-exists' error if a file NEWNAME already exists
2375 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2376 A number as third arg means request confirmation if NEWNAME already exists.
2377 This is what happens in interactive use with M-x. */)
2378 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2380 Lisp_Object handler
;
2381 Lisp_Object encoded_file
, encoded_newname
;
2382 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2384 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2385 encoded_file
= encoded_newname
= Qnil
;
2386 CHECK_STRING (file
);
2387 CHECK_STRING (newname
);
2388 file
= Fexpand_file_name (file
, Qnil
);
2390 if (!NILP (Ffile_directory_p (newname
)))
2391 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2393 newname
= Fexpand_file_name (newname
, Qnil
);
2395 /* If the file name has special constructs in it,
2396 call the corresponding file handler. */
2397 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2398 if (!NILP (handler
))
2399 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2400 newname
, ok_if_already_exists
));
2402 /* If the new name has special constructs in it,
2403 call the corresponding file handler. */
2404 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2405 if (!NILP (handler
))
2406 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2407 newname
, ok_if_already_exists
));
2409 encoded_file
= ENCODE_FILE (file
);
2410 encoded_newname
= ENCODE_FILE (newname
);
2412 if (NILP (ok_if_already_exists
)
2413 || INTEGERP (ok_if_already_exists
))
2414 barf_or_query_if_file_exists (newname
, false, "make it a new name",
2415 INTEGERP (ok_if_already_exists
), false);
2417 unlink (SSDATA (newname
));
2418 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2420 int link_errno
= errno
;
2421 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2428 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2429 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2430 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2431 Both args must be strings.
2432 Signals a `file-already-exists' error if a file LINKNAME already exists
2433 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2434 A number as third arg means request confirmation if LINKNAME already exists.
2435 This happens for interactive use with M-x. */)
2436 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2438 Lisp_Object handler
;
2439 Lisp_Object encoded_filename
, encoded_linkname
;
2440 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2442 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2443 encoded_filename
= encoded_linkname
= Qnil
;
2444 CHECK_STRING (filename
);
2445 CHECK_STRING (linkname
);
2446 /* If the link target has a ~, we must expand it to get
2447 a truly valid file name. Otherwise, do not expand;
2448 we want to permit links to relative file names. */
2449 if (SREF (filename
, 0) == '~')
2450 filename
= Fexpand_file_name (filename
, Qnil
);
2452 if (!NILP (Ffile_directory_p (linkname
)))
2453 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2455 linkname
= Fexpand_file_name (linkname
, Qnil
);
2457 /* If the file name has special constructs in it,
2458 call the corresponding file handler. */
2459 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2460 if (!NILP (handler
))
2461 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2462 linkname
, ok_if_already_exists
));
2464 /* If the new link name has special constructs in it,
2465 call the corresponding file handler. */
2466 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2467 if (!NILP (handler
))
2468 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2469 linkname
, ok_if_already_exists
));
2471 encoded_filename
= ENCODE_FILE (filename
);
2472 encoded_linkname
= ENCODE_FILE (linkname
);
2474 if (NILP (ok_if_already_exists
)
2475 || INTEGERP (ok_if_already_exists
))
2476 barf_or_query_if_file_exists (linkname
, false, "make it a link",
2477 INTEGERP (ok_if_already_exists
), false);
2478 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2480 /* If we didn't complain already, silently delete existing file. */
2482 if (errno
== EEXIST
)
2484 unlink (SSDATA (encoded_linkname
));
2485 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2492 if (errno
== ENOSYS
)
2495 xsignal1 (Qfile_error
,
2496 build_string ("Symbolic links are not supported"));
2499 symlink_errno
= errno
;
2500 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2508 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2510 doc
: /* Return t if file FILENAME specifies an absolute file name.
2511 On Unix, this is a name starting with a `/' or a `~'. */)
2512 (Lisp_Object filename
)
2514 CHECK_STRING (filename
);
2515 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2518 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2519 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2520 See also `file-readable-p' and `file-attributes'.
2521 This returns nil for a symlink to a nonexistent file.
2522 Use `file-symlink-p' to test for such links. */)
2523 (Lisp_Object filename
)
2525 Lisp_Object absname
;
2526 Lisp_Object handler
;
2528 CHECK_STRING (filename
);
2529 absname
= Fexpand_file_name (filename
, Qnil
);
2531 /* If the file name has special constructs in it,
2532 call the corresponding file handler. */
2533 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2534 if (!NILP (handler
))
2536 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2541 absname
= ENCODE_FILE (absname
);
2543 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2546 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2547 doc
: /* Return t if FILENAME can be executed by you.
2548 For a directory, this means you can access files in that directory.
2549 \(It is generally better to use `file-accessible-directory-p' for that
2550 purpose, though.) */)
2551 (Lisp_Object filename
)
2553 Lisp_Object absname
;
2554 Lisp_Object handler
;
2556 CHECK_STRING (filename
);
2557 absname
= Fexpand_file_name (filename
, Qnil
);
2559 /* If the file name has special constructs in it,
2560 call the corresponding file handler. */
2561 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2562 if (!NILP (handler
))
2563 return call2 (handler
, Qfile_executable_p
, absname
);
2565 absname
= ENCODE_FILE (absname
);
2567 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2570 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2571 doc
: /* Return t if file FILENAME exists and you can read it.
2572 See also `file-exists-p' and `file-attributes'. */)
2573 (Lisp_Object filename
)
2575 Lisp_Object absname
;
2576 Lisp_Object handler
;
2578 CHECK_STRING (filename
);
2579 absname
= Fexpand_file_name (filename
, Qnil
);
2581 /* If the file name has special constructs in it,
2582 call the corresponding file handler. */
2583 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2584 if (!NILP (handler
))
2585 return call2 (handler
, Qfile_readable_p
, absname
);
2587 absname
= ENCODE_FILE (absname
);
2588 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2592 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2593 doc
: /* Return t if file FILENAME can be written or created by you. */)
2594 (Lisp_Object filename
)
2596 Lisp_Object absname
, dir
, encoded
;
2597 Lisp_Object handler
;
2599 CHECK_STRING (filename
);
2600 absname
= Fexpand_file_name (filename
, Qnil
);
2602 /* If the file name has special constructs in it,
2603 call the corresponding file handler. */
2604 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2605 if (!NILP (handler
))
2606 return call2 (handler
, Qfile_writable_p
, absname
);
2608 encoded
= ENCODE_FILE (absname
);
2609 if (check_writable (SSDATA (encoded
), W_OK
))
2611 if (errno
!= ENOENT
)
2614 dir
= Ffile_name_directory (absname
);
2615 eassert (!NILP (dir
));
2617 dir
= Fdirectory_file_name (dir
);
2620 dir
= ENCODE_FILE (dir
);
2622 /* The read-only attribute of the parent directory doesn't affect
2623 whether a file or directory can be created within it. Some day we
2624 should check ACLs though, which do affect this. */
2625 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2627 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2631 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2632 doc
: /* Access file FILENAME, and get an error if that does not work.
2633 The second argument STRING is used in the error message.
2634 If there is no error, returns nil. */)
2635 (Lisp_Object filename
, Lisp_Object string
)
2637 Lisp_Object handler
, encoded_filename
, absname
;
2639 CHECK_STRING (filename
);
2640 absname
= Fexpand_file_name (filename
, Qnil
);
2642 CHECK_STRING (string
);
2644 /* If the file name has special constructs in it,
2645 call the corresponding file handler. */
2646 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2647 if (!NILP (handler
))
2648 return call3 (handler
, Qaccess_file
, absname
, string
);
2650 encoded_filename
= ENCODE_FILE (absname
);
2652 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2653 report_file_error (SSDATA (string
), filename
);
2658 /* Relative to directory FD, return the symbolic link value of FILENAME.
2659 On failure, return nil. */
2661 emacs_readlinkat (int fd
, char const *filename
)
2663 static struct allocator
const emacs_norealloc_allocator
=
2664 { xmalloc
, NULL
, xfree
, memory_full
};
2666 char readlink_buf
[1024];
2667 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2668 &emacs_norealloc_allocator
, readlinkat
);
2672 val
= build_unibyte_string (buf
);
2673 if (buf
[0] == '/' && strchr (buf
, ':'))
2674 val
= concat2 (build_unibyte_string ("/:"), val
);
2675 if (buf
!= readlink_buf
)
2677 val
= DECODE_FILE (val
);
2681 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2682 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2683 The value is the link target, as a string.
2684 Otherwise it returns nil.
2686 This function does not check whether the link target exists. */)
2687 (Lisp_Object filename
)
2689 Lisp_Object handler
;
2691 CHECK_STRING (filename
);
2692 filename
= Fexpand_file_name (filename
, Qnil
);
2694 /* If the file name has special constructs in it,
2695 call the corresponding file handler. */
2696 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2697 if (!NILP (handler
))
2698 return call2 (handler
, Qfile_symlink_p
, filename
);
2700 filename
= ENCODE_FILE (filename
);
2702 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2705 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2706 doc
: /* Return t if FILENAME names an existing directory.
2707 Symbolic links to directories count as directories.
2708 See `file-symlink-p' to distinguish symlinks. */)
2709 (Lisp_Object filename
)
2711 Lisp_Object absname
;
2712 Lisp_Object handler
;
2714 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2716 /* If the file name has special constructs in it,
2717 call the corresponding file handler. */
2718 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2719 if (!NILP (handler
))
2720 return call2 (handler
, Qfile_directory_p
, absname
);
2722 absname
= ENCODE_FILE (absname
);
2724 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2727 /* Return true if FILE is a directory or a symlink to a directory. */
2729 file_directory_p (char const *file
)
2732 /* This is cheaper than 'stat'. */
2733 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2736 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2740 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2741 Sfile_accessible_directory_p
, 1, 1, 0,
2742 doc
: /* Return t if file FILENAME names a directory you can open.
2743 For the value to be t, FILENAME must specify the name of a directory as a file,
2744 and the directory must allow you to open files in it. In order to use a
2745 directory as a buffer's current directory, this predicate must return true.
2746 A directory name spec may be given instead; then the value is t
2747 if the directory so specified exists and really is a readable and
2748 searchable directory. */)
2749 (Lisp_Object filename
)
2751 Lisp_Object absname
;
2752 Lisp_Object handler
;
2754 CHECK_STRING (filename
);
2755 absname
= Fexpand_file_name (filename
, Qnil
);
2757 /* If the file name has special constructs in it,
2758 call the corresponding file handler. */
2759 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2760 if (!NILP (handler
))
2762 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2767 absname
= ENCODE_FILE (absname
);
2768 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2771 /* If FILE is a searchable directory or a symlink to a
2772 searchable directory, return true. Otherwise return
2773 false and set errno to an error number. */
2775 file_accessible_directory_p (char const *file
)
2778 /* There's no need to test whether FILE is searchable, as the
2779 searchable/executable bit is invented on DOS_NT platforms. */
2780 return file_directory_p (file
);
2782 /* On POSIXish platforms, use just one system call; this avoids a
2783 race and is typically faster. */
2784 ptrdiff_t len
= strlen (file
);
2790 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2791 There are three exceptions: "", "/", and "//". Leave "" alone,
2792 as it's invalid. Append only "." to the other two exceptions as
2793 "/" and "//" are distinct on some platforms, whereas "/", "///",
2794 "////", etc. are all equivalent. */
2799 /* Just check for trailing '/' when deciding whether to append '/'.
2800 That's simpler than testing the two special cases "/" and "//",
2801 and it's a safe optimization here. */
2802 char *buf
= SAFE_ALLOCA (len
+ 3);
2803 memcpy (buf
, file
, len
);
2804 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2808 ok
= check_existing (dir
);
2809 saved_errno
= errno
;
2811 errno
= saved_errno
;
2816 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2817 doc
: /* Return t if FILENAME names a regular file.
2818 This is the sort of file that holds an ordinary stream of data bytes.
2819 Symbolic links to regular files count as regular files.
2820 See `file-symlink-p' to distinguish symlinks. */)
2821 (Lisp_Object filename
)
2823 register Lisp_Object absname
;
2825 Lisp_Object handler
;
2827 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2829 /* If the file name has special constructs in it,
2830 call the corresponding file handler. */
2831 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2832 if (!NILP (handler
))
2833 return call2 (handler
, Qfile_regular_p
, absname
);
2835 absname
= ENCODE_FILE (absname
);
2840 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2842 /* Tell stat to use expensive method to get accurate info. */
2843 Vw32_get_true_file_attributes
= Qt
;
2844 result
= stat (SDATA (absname
), &st
);
2845 Vw32_get_true_file_attributes
= tem
;
2849 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2852 if (stat (SSDATA (absname
), &st
) < 0)
2854 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2858 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2859 Sfile_selinux_context
, 1, 1, 0,
2860 doc
: /* Return SELinux context of file named FILENAME.
2861 The return value is a list (USER ROLE TYPE RANGE), where the list
2862 elements are strings naming the user, role, type, and range of the
2863 file's SELinux security context.
2865 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2866 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2867 (Lisp_Object filename
)
2869 Lisp_Object absname
;
2870 Lisp_Object values
[4];
2871 Lisp_Object handler
;
2873 security_context_t con
;
2878 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2880 /* If the file name has special constructs in it,
2881 call the corresponding file handler. */
2882 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2883 if (!NILP (handler
))
2884 return call2 (handler
, Qfile_selinux_context
, absname
);
2886 absname
= ENCODE_FILE (absname
);
2893 if (is_selinux_enabled ())
2895 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2898 context
= context_new (con
);
2899 if (context_user_get (context
))
2900 values
[0] = build_string (context_user_get (context
));
2901 if (context_role_get (context
))
2902 values
[1] = build_string (context_role_get (context
));
2903 if (context_type_get (context
))
2904 values
[2] = build_string (context_type_get (context
));
2905 if (context_range_get (context
))
2906 values
[3] = build_string (context_range_get (context
));
2907 context_free (context
);
2913 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2916 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2917 Sset_file_selinux_context
, 2, 2, 0,
2918 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2919 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2920 elements are strings naming the components of a SELinux context.
2922 Value is t if setting of SELinux context was successful, nil otherwise.
2924 This function does nothing and returns nil if SELinux is disabled,
2925 or if Emacs was not compiled with SELinux support. */)
2926 (Lisp_Object filename
, Lisp_Object context
)
2928 Lisp_Object absname
;
2929 Lisp_Object handler
;
2931 Lisp_Object encoded_absname
;
2932 Lisp_Object user
= CAR_SAFE (context
);
2933 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2934 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2935 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2936 security_context_t con
;
2939 context_t parsed_con
;
2942 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2944 /* If the file name has special constructs in it,
2945 call the corresponding file handler. */
2946 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2947 if (!NILP (handler
))
2948 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2951 if (is_selinux_enabled ())
2953 /* Get current file context. */
2954 encoded_absname
= ENCODE_FILE (absname
);
2955 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2958 parsed_con
= context_new (con
);
2959 /* Change the parts defined in the parameter.*/
2962 if (context_user_set (parsed_con
, SSDATA (user
)))
2963 error ("Doing context_user_set");
2967 if (context_role_set (parsed_con
, SSDATA (role
)))
2968 error ("Doing context_role_set");
2972 if (context_type_set (parsed_con
, SSDATA (type
)))
2973 error ("Doing context_type_set");
2975 if (STRINGP (range
))
2977 if (context_range_set (parsed_con
, SSDATA (range
)))
2978 error ("Doing context_range_set");
2981 /* Set the modified context back to the file. */
2982 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2983 context_str (parsed_con
))
2985 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2986 if (fail
&& errno
!= ENOTSUP
)
2987 report_file_error ("Doing lsetfilecon", absname
);
2989 context_free (parsed_con
);
2991 return fail
? Qnil
: Qt
;
2994 report_file_error ("Doing lgetfilecon", absname
);
3001 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3002 doc
: /* Return ACL entries of file named FILENAME.
3003 The entries are returned in a format suitable for use in `set-file-acl'
3004 but is otherwise undocumented and subject to change.
3005 Return nil if file does not exist or is not accessible, or if Emacs
3006 was unable to determine the ACL entries. */)
3007 (Lisp_Object filename
)
3009 Lisp_Object absname
;
3010 Lisp_Object handler
;
3011 #ifdef HAVE_ACL_SET_FILE
3013 Lisp_Object acl_string
;
3015 # ifndef HAVE_ACL_TYPE_EXTENDED
3016 acl_type_t ACL_TYPE_EXTENDED
= ACL_TYPE_ACCESS
;
3020 absname
= expand_and_dir_to_file (filename
,
3021 BVAR (current_buffer
, directory
));
3023 /* If the file name has special constructs in it,
3024 call the corresponding file handler. */
3025 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3026 if (!NILP (handler
))
3027 return call2 (handler
, Qfile_acl
, absname
);
3029 #ifdef HAVE_ACL_SET_FILE
3030 absname
= ENCODE_FILE (absname
);
3032 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_EXTENDED
);
3036 str
= acl_to_text (acl
, NULL
);
3043 acl_string
= build_string (str
);
3053 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3055 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3056 ACL-STRING should contain the textual representation of the ACL
3057 entries in a format suitable for the platform.
3059 Value is t if setting of ACL was successful, nil otherwise.
3061 Setting ACL for local files requires Emacs to be built with ACL
3063 (Lisp_Object filename
, Lisp_Object acl_string
)
3065 Lisp_Object absname
;
3066 Lisp_Object handler
;
3067 #ifdef HAVE_ACL_SET_FILE
3068 Lisp_Object encoded_absname
;
3073 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3075 /* If the file name has special constructs in it,
3076 call the corresponding file handler. */
3077 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3078 if (!NILP (handler
))
3079 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3081 #ifdef HAVE_ACL_SET_FILE
3082 if (STRINGP (acl_string
))
3084 acl
= acl_from_text (SSDATA (acl_string
));
3087 report_file_error ("Converting ACL", absname
);
3091 encoded_absname
= ENCODE_FILE (absname
);
3093 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3096 if (fail
&& acl_errno_valid (errno
))
3097 report_file_error ("Setting ACL", absname
);
3100 return fail
? Qnil
: Qt
;
3107 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3108 doc
: /* Return mode bits of file named FILENAME, as an integer.
3109 Return nil, if file does not exist or is not accessible. */)
3110 (Lisp_Object filename
)
3112 Lisp_Object absname
;
3114 Lisp_Object handler
;
3116 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3118 /* If the file name has special constructs in it,
3119 call the corresponding file handler. */
3120 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3121 if (!NILP (handler
))
3122 return call2 (handler
, Qfile_modes
, absname
);
3124 absname
= ENCODE_FILE (absname
);
3126 if (stat (SSDATA (absname
), &st
) < 0)
3129 return make_number (st
.st_mode
& 07777);
3132 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3133 "(let ((file (read-file-name \"File: \"))) \
3134 (list file (read-file-modes nil file)))",
3135 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3136 Only the 12 low bits of MODE are used.
3138 Interactively, mode bits are read by `read-file-modes', which accepts
3139 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3140 (Lisp_Object filename
, Lisp_Object mode
)
3142 Lisp_Object absname
, encoded_absname
;
3143 Lisp_Object handler
;
3145 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3146 CHECK_NUMBER (mode
);
3148 /* If the file name has special constructs in it,
3149 call the corresponding file handler. */
3150 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3151 if (!NILP (handler
))
3152 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3154 encoded_absname
= ENCODE_FILE (absname
);
3156 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3157 report_file_error ("Doing chmod", absname
);
3162 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3163 doc
: /* Set the file permission bits for newly created files.
3164 The argument MODE should be an integer; only the low 9 bits are used.
3165 This setting is inherited by subprocesses. */)
3168 mode_t oldrealmask
, oldumask
, newumask
;
3169 CHECK_NUMBER (mode
);
3170 oldrealmask
= realmask
;
3171 newumask
= ~ XINT (mode
) & 0777;
3174 realmask
= newumask
;
3175 oldumask
= umask (newumask
);
3178 eassert (oldumask
== oldrealmask
);
3182 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3183 doc
: /* Return the default file protection for created files.
3184 The value is an integer. */)
3188 XSETINT (value
, (~ realmask
) & 0777);
3193 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3194 doc
: /* Set times of file FILENAME to TIMESTAMP.
3195 Set both access and modification times.
3196 Return t on success, else nil.
3197 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3199 (Lisp_Object filename
, Lisp_Object timestamp
)
3201 Lisp_Object absname
, encoded_absname
;
3202 Lisp_Object handler
;
3203 struct timespec t
= lisp_time_argument (timestamp
);
3205 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3207 /* If the file name has special constructs in it,
3208 call the corresponding file handler. */
3209 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3210 if (!NILP (handler
))
3211 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3213 encoded_absname
= ENCODE_FILE (absname
);
3216 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
) != 0)
3219 /* Setting times on a directory always fails. */
3220 if (file_directory_p (SSDATA (encoded_absname
)))
3223 report_file_error ("Setting file times", absname
);
3231 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3232 doc
: /* Tell Unix to finish all pending disk updates. */)
3239 #endif /* HAVE_SYNC */
3241 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3242 doc
: /* Return t if file FILE1 is newer than file FILE2.
3243 If FILE1 does not exist, the answer is nil;
3244 otherwise, if FILE2 does not exist, the answer is t. */)
3245 (Lisp_Object file1
, Lisp_Object file2
)
3247 Lisp_Object absname1
, absname2
;
3248 struct stat st1
, st2
;
3249 Lisp_Object handler
;
3250 struct gcpro gcpro1
, gcpro2
;
3252 CHECK_STRING (file1
);
3253 CHECK_STRING (file2
);
3256 GCPRO2 (absname1
, file2
);
3257 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3258 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3261 /* If the file name has special constructs in it,
3262 call the corresponding file handler. */
3263 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3265 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3266 if (!NILP (handler
))
3267 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3269 GCPRO2 (absname1
, absname2
);
3270 absname1
= ENCODE_FILE (absname1
);
3271 absname2
= ENCODE_FILE (absname2
);
3274 if (stat (SSDATA (absname1
), &st1
) < 0)
3277 if (stat (SSDATA (absname2
), &st2
) < 0)
3280 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3284 #ifndef READ_BUF_SIZE
3285 #define READ_BUF_SIZE (64 << 10)
3287 /* Some buffer offsets are stored in 'int' variables. */
3288 verify (READ_BUF_SIZE
<= INT_MAX
);
3290 /* This function is called after Lisp functions to decide a coding
3291 system are called, or when they cause an error. Before they are
3292 called, the current buffer is set unibyte and it contains only a
3293 newly inserted text (thus the buffer was empty before the
3296 The functions may set markers, overlays, text properties, or even
3297 alter the buffer contents, change the current buffer.
3299 Here, we reset all those changes by:
3300 o set back the current buffer.
3301 o move all markers and overlays to BEG.
3302 o remove all text properties.
3303 o set back the buffer multibyteness. */
3306 decide_coding_unwind (Lisp_Object unwind_data
)
3308 Lisp_Object multibyte
, undo_list
, buffer
;
3310 multibyte
= XCAR (unwind_data
);
3311 unwind_data
= XCDR (unwind_data
);
3312 undo_list
= XCAR (unwind_data
);
3313 buffer
= XCDR (unwind_data
);
3315 set_buffer_internal (XBUFFER (buffer
));
3316 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3317 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3318 set_buffer_intervals (current_buffer
, NULL
);
3319 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3321 /* Now we are safe to change the buffer's multibyteness directly. */
3322 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3323 bset_undo_list (current_buffer
, undo_list
);
3326 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3327 object where slot 0 is the file descriptor, slot 1 specifies
3328 an offset to put the read bytes, and slot 2 is the maximum
3329 amount of bytes to read. Value is the number of bytes read. */
3332 read_non_regular (Lisp_Object state
)
3338 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3339 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3340 + XSAVE_INTEGER (state
, 1)),
3341 XSAVE_INTEGER (state
, 2));
3343 /* Fast recycle this object for the likely next call. */
3345 return make_number (nbytes
);
3349 /* Condition-case handler used when reading from non-regular files
3350 in insert-file-contents. */
3353 read_non_regular_quit (Lisp_Object ignore
)
3358 /* Return the file offset that VAL represents, checking for type
3359 errors and overflow. */
3361 file_offset (Lisp_Object val
)
3363 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3368 double v
= XFLOAT_DATA (val
);
3370 && (sizeof (off_t
) < sizeof v
3371 ? v
<= TYPE_MAXIMUM (off_t
)
3372 : v
< TYPE_MAXIMUM (off_t
)))
3376 wrong_type_argument (intern ("file-offset"), val
);
3379 /* Return a special time value indicating the error number ERRNUM. */
3380 static struct timespec
3381 time_error_value (int errnum
)
3383 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3384 ? NONEXISTENT_MODTIME_NSECS
3385 : UNKNOWN_MODTIME_NSECS
);
3386 return make_timespec (0, ns
);
3389 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3391 doc
: /* Insert contents of file FILENAME after point.
3392 Returns list of absolute file name and number of characters inserted.
3393 If second argument VISIT is non-nil, the buffer's visited filename and
3394 last save file modtime are set, and it is marked unmodified. If
3395 visiting and the file does not exist, visiting is completed before the
3398 The optional third and fourth arguments BEG and END specify what portion
3399 of the file to insert. These arguments count bytes in the file, not
3400 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3402 If optional fifth argument REPLACE is non-nil, replace the current
3403 buffer contents (in the accessible portion) with the file contents.
3404 This is better than simply deleting and inserting the whole thing
3405 because (1) it preserves some marker positions and (2) it puts less data
3406 in the undo list. When REPLACE is non-nil, the second return value is
3407 the number of characters that replace previous buffer contents.
3409 This function does code conversion according to the value of
3410 `coding-system-for-read' or `file-coding-system-alist', and sets the
3411 variable `last-coding-system-used' to the coding system actually used.
3413 In addition, this function decodes the inserted text from known formats
3414 by calling `format-decode', which see. */)
3415 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3418 struct timespec mtime
;
3420 ptrdiff_t inserted
= 0;
3422 off_t beg_offset
, end_offset
;
3424 ptrdiff_t count
= SPECPDL_INDEX ();
3425 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3426 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3428 ptrdiff_t total
= 0;
3429 bool not_regular
= 0;
3431 char read_buf
[READ_BUF_SIZE
];
3432 struct coding_system coding
;
3433 bool replace_handled
= 0;
3434 bool set_coding_system
= 0;
3435 Lisp_Object coding_system
;
3437 /* If the undo log only contains the insertion, there's no point
3438 keeping it. It's typically when we first fill a file-buffer. */
3439 bool empty_undo_list_p
3440 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3442 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3443 bool we_locked_file
= 0;
3446 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3447 error ("Cannot do file visiting in an indirect buffer");
3449 if (!NILP (BVAR (current_buffer
, read_only
)))
3450 Fbarf_if_buffer_read_only ();
3454 orig_filename
= Qnil
;
3457 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3459 CHECK_STRING (filename
);
3460 filename
= Fexpand_file_name (filename
, Qnil
);
3462 /* The value Qnil means that the coding system is not yet
3464 coding_system
= Qnil
;
3466 /* If the file name has special constructs in it,
3467 call the corresponding file handler. */
3468 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3469 if (!NILP (handler
))
3471 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3472 visit
, beg
, end
, replace
);
3473 if (CONSP (val
) && CONSP (XCDR (val
))
3474 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3475 inserted
= XINT (XCAR (XCDR (val
)));
3479 orig_filename
= filename
;
3480 filename
= ENCODE_FILE (filename
);
3482 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3487 report_file_error ("Opening input file", orig_filename
);
3488 mtime
= time_error_value (save_errno
);
3490 if (!NILP (Vcoding_system_for_read
))
3491 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3495 fd_index
= SPECPDL_INDEX ();
3496 record_unwind_protect_int (close_file_unwind
, fd
);
3498 /* Replacement should preserve point as it preserves markers. */
3499 if (!NILP (replace
))
3500 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3502 if (fstat (fd
, &st
) != 0)
3503 report_file_error ("Input file status", orig_filename
);
3504 mtime
= get_stat_mtime (&st
);
3506 /* This code will need to be changed in order to work on named
3507 pipes, and it's probably just not worth it. So we should at
3508 least signal an error. */
3509 if (!S_ISREG (st
.st_mode
))
3516 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3517 xsignal2 (Qfile_error
,
3518 build_string ("not a regular file"), orig_filename
);
3523 if (!NILP (beg
) || !NILP (end
))
3524 error ("Attempt to visit less than an entire file");
3525 if (BEG
< Z
&& NILP (replace
))
3526 error ("Cannot do file visiting in a non-empty buffer");
3530 beg_offset
= file_offset (beg
);
3535 end_offset
= file_offset (end
);
3539 end_offset
= TYPE_MAXIMUM (off_t
);
3542 end_offset
= st
.st_size
;
3544 /* A negative size can happen on a platform that allows file
3545 sizes greater than the maximum off_t value. */
3549 /* The file size returned from stat may be zero, but data
3550 may be readable nonetheless, for example when this is a
3551 file in the /proc filesystem. */
3552 if (end_offset
== 0)
3553 end_offset
= READ_BUF_SIZE
;
3557 /* Check now whether the buffer will become too large,
3558 in the likely case where the file's length is not changing.
3559 This saves a lot of needless work before a buffer overflow. */
3562 /* The likely offset where we will stop reading. We could read
3563 more (or less), if the file grows (or shrinks) as we read it. */
3564 off_t likely_end
= min (end_offset
, st
.st_size
);
3566 if (beg_offset
< likely_end
)
3569 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3570 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3571 off_t likely_growth
= likely_end
- beg_offset
;
3572 if (buf_growth_max
< likely_growth
)
3577 /* Prevent redisplay optimizations. */
3578 current_buffer
->clip_changed
= 1;
3580 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3582 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3583 setup_coding_system (coding_system
, &coding
);
3584 /* Ensure we set Vlast_coding_system_used. */
3585 set_coding_system
= 1;
3589 /* Decide the coding system to use for reading the file now
3590 because we can't use an optimized method for handling
3591 `coding:' tag if the current buffer is not empty. */
3592 if (!NILP (Vcoding_system_for_read
))
3593 coding_system
= Vcoding_system_for_read
;
3596 /* Don't try looking inside a file for a coding system
3597 specification if it is not seekable. */
3598 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3600 /* Find a coding system specified in the heading two
3601 lines or in the tailing several lines of the file.
3602 We assume that the 1K-byte and 3K-byte for heading
3603 and tailing respectively are sufficient for this
3607 if (st
.st_size
<= (1024 * 4))
3608 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3611 nread
= emacs_read (fd
, read_buf
, 1024);
3615 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3616 report_file_error ("Setting file position",
3618 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3619 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3624 report_file_error ("Read error", orig_filename
);
3627 struct buffer
*prev
= current_buffer
;
3628 Lisp_Object workbuf
;
3631 record_unwind_current_buffer ();
3633 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3634 buf
= XBUFFER (workbuf
);
3636 delete_all_overlays (buf
);
3637 bset_directory (buf
, BVAR (current_buffer
, directory
));
3638 bset_read_only (buf
, Qnil
);
3639 bset_filename (buf
, Qnil
);
3640 bset_undo_list (buf
, Qt
);
3641 eassert (buf
->overlays_before
== NULL
);
3642 eassert (buf
->overlays_after
== NULL
);
3644 set_buffer_internal (buf
);
3646 bset_enable_multibyte_characters (buf
, Qnil
);
3648 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3649 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3650 coding_system
= call2 (Vset_auto_coding_function
,
3651 filename
, make_number (nread
));
3652 set_buffer_internal (prev
);
3654 /* Discard the unwind protect for recovering the
3658 /* Rewind the file for the actual read done later. */
3659 if (lseek (fd
, 0, SEEK_SET
) < 0)
3660 report_file_error ("Setting file position", orig_filename
);
3664 if (NILP (coding_system
))
3666 /* If we have not yet decided a coding system, check
3667 file-coding-system-alist. */
3668 Lisp_Object args
[6];
3670 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3671 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3672 coding_system
= Ffind_operation_coding_system (6, args
);
3673 if (CONSP (coding_system
))
3674 coding_system
= XCAR (coding_system
);
3678 if (NILP (coding_system
))
3679 coding_system
= Qundecided
;
3681 CHECK_CODING_SYSTEM (coding_system
);
3683 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3684 /* We must suppress all character code conversion except for
3685 end-of-line conversion. */
3686 coding_system
= raw_text_coding_system (coding_system
);
3688 setup_coding_system (coding_system
, &coding
);
3689 /* Ensure we set Vlast_coding_system_used. */
3690 set_coding_system
= 1;
3693 /* If requested, replace the accessible part of the buffer
3694 with the file contents. Avoid replacing text at the
3695 beginning or end of the buffer that matches the file contents;
3696 that preserves markers pointing to the unchanged parts.
3698 Here we implement this feature in an optimized way
3699 for the case where code conversion is NOT needed.
3700 The following if-statement handles the case of conversion
3701 in a less optimal way.
3703 If the code conversion is "automatic" then we try using this
3704 method and hope for the best.
3705 But if we discover the need for conversion, we give up on this method
3706 and let the following if-statement handle the replace job. */
3709 && (NILP (coding_system
)
3710 || ! CODING_REQUIRE_DECODING (&coding
)))
3712 /* same_at_start and same_at_end count bytes,
3713 because file access counts bytes
3714 and BEG and END count bytes. */
3715 ptrdiff_t same_at_start
= BEGV_BYTE
;
3716 ptrdiff_t same_at_end
= ZV_BYTE
;
3718 /* There is still a possibility we will find the need to do code
3719 conversion. If that happens, set this variable to
3720 give up on handling REPLACE in the optimized way. */
3721 bool giveup_match_end
= 0;
3723 if (beg_offset
!= 0)
3725 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3726 report_file_error ("Setting file position", orig_filename
);
3731 /* Count how many chars at the start of the file
3732 match the text at the beginning of the buffer. */
3737 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3739 report_file_error ("Read error", orig_filename
);
3740 else if (nread
== 0)
3743 if (CODING_REQUIRE_DETECTION (&coding
))
3745 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3748 setup_coding_system (coding_system
, &coding
);
3751 if (CODING_REQUIRE_DECODING (&coding
))
3752 /* We found that the file should be decoded somehow.
3753 Let's give up here. */
3755 giveup_match_end
= 1;
3760 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3761 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3762 same_at_start
++, bufpos
++;
3763 /* If we found a discrepancy, stop the scan.
3764 Otherwise loop around and scan the next bufferful. */
3765 if (bufpos
!= nread
)
3769 /* If the file matches the buffer completely,
3770 there's no need to replace anything. */
3771 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3774 clear_unwind_protect (fd_index
);
3776 /* Truncate the buffer to the size of the file. */
3777 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3782 /* Count how many chars at the end of the file
3783 match the text at the end of the buffer. But, if we have
3784 already found that decoding is necessary, don't waste time. */
3785 while (!giveup_match_end
)
3787 int total_read
, nread
, bufpos
, trial
;
3790 /* At what file position are we now scanning? */
3791 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3792 /* If the entire file matches the buffer tail, stop the scan. */
3795 /* How much can we scan in the next step? */
3796 trial
= min (curpos
, sizeof read_buf
);
3797 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3798 report_file_error ("Setting file position", orig_filename
);
3800 total_read
= nread
= 0;
3801 while (total_read
< trial
)
3803 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3805 report_file_error ("Read error", orig_filename
);
3806 else if (nread
== 0)
3808 total_read
+= nread
;
3811 /* Scan this bufferful from the end, comparing with
3812 the Emacs buffer. */
3813 bufpos
= total_read
;
3815 /* Compare with same_at_start to avoid counting some buffer text
3816 as matching both at the file's beginning and at the end. */
3817 while (bufpos
> 0 && same_at_end
> same_at_start
3818 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3819 same_at_end
--, bufpos
--;
3821 /* If we found a discrepancy, stop the scan.
3822 Otherwise loop around and scan the preceding bufferful. */
3825 /* If this discrepancy is because of code conversion,
3826 we cannot use this method; giveup and try the other. */
3827 if (same_at_end
> same_at_start
3828 && FETCH_BYTE (same_at_end
- 1) >= 0200
3829 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3830 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3831 giveup_match_end
= 1;
3840 if (! giveup_match_end
)
3844 /* We win! We can handle REPLACE the optimized way. */
3846 /* Extend the start of non-matching text area to multibyte
3847 character boundary. */
3848 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3849 while (same_at_start
> BEGV_BYTE
3850 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3853 /* Extend the end of non-matching text area to multibyte
3854 character boundary. */
3855 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3856 while (same_at_end
< ZV_BYTE
3857 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3860 /* Don't try to reuse the same piece of text twice. */
3861 overlap
= (same_at_start
- BEGV_BYTE
3863 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3865 same_at_end
+= overlap
;
3867 /* Arrange to read only the nonmatching middle part of the file. */
3868 beg_offset
+= same_at_start
- BEGV_BYTE
;
3869 end_offset
-= ZV_BYTE
- same_at_end
;
3871 invalidate_buffer_caches (current_buffer
,
3872 BYTE_TO_CHAR (same_at_start
),
3873 BYTE_TO_CHAR (same_at_end
));
3874 del_range_byte (same_at_start
, same_at_end
, 0);
3875 /* Insert from the file at the proper position. */
3876 temp
= BYTE_TO_CHAR (same_at_start
);
3877 SET_PT_BOTH (temp
, same_at_start
);
3879 /* If display currently starts at beginning of line,
3880 keep it that way. */
3881 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3882 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3884 replace_handled
= 1;
3888 /* If requested, replace the accessible part of the buffer
3889 with the file contents. Avoid replacing text at the
3890 beginning or end of the buffer that matches the file contents;
3891 that preserves markers pointing to the unchanged parts.
3893 Here we implement this feature for the case where code conversion
3894 is needed, in a simple way that needs a lot of memory.
3895 The preceding if-statement handles the case of no conversion
3896 in a more optimized way. */
3897 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3899 ptrdiff_t same_at_start
= BEGV_BYTE
;
3900 ptrdiff_t same_at_end
= ZV_BYTE
;
3901 ptrdiff_t same_at_start_charpos
;
3902 ptrdiff_t inserted_chars
;
3905 unsigned char *decoded
;
3908 ptrdiff_t this_count
= SPECPDL_INDEX ();
3910 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3911 Lisp_Object conversion_buffer
;
3912 struct gcpro gcpro1
;
3914 conversion_buffer
= code_conversion_save (1, multibyte
);
3916 /* First read the whole file, performing code conversion into
3917 CONVERSION_BUFFER. */
3919 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3920 report_file_error ("Setting file position", orig_filename
);
3922 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3923 unprocessed
= 0; /* Bytes not processed in previous loop. */
3925 GCPRO1 (conversion_buffer
);
3928 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3929 quitting while reading a huge file. */
3931 /* Allow quitting out of the actual I/O. */
3934 this = emacs_read (fd
, read_buf
+ unprocessed
,
3935 READ_BUF_SIZE
- unprocessed
);
3941 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3942 BUF_Z (XBUFFER (conversion_buffer
)));
3943 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3944 unprocessed
+ this, conversion_buffer
);
3945 unprocessed
= coding
.carryover_bytes
;
3946 if (coding
.carryover_bytes
> 0)
3947 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3951 report_file_error ("Read error", orig_filename
);
3953 clear_unwind_protect (fd_index
);
3955 if (unprocessed
> 0)
3957 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3958 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3959 unprocessed
, conversion_buffer
);
3960 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3963 coding_system
= CODING_ID_NAME (coding
.id
);
3964 set_coding_system
= 1;
3965 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3966 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3967 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3969 /* Compare the beginning of the converted string with the buffer
3973 while (bufpos
< inserted
&& same_at_start
< same_at_end
3974 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3975 same_at_start
++, bufpos
++;
3977 /* If the file matches the head of buffer completely,
3978 there's no need to replace anything. */
3980 if (bufpos
== inserted
)
3982 /* Truncate the buffer to the size of the file. */
3983 if (same_at_start
!= same_at_end
)
3985 invalidate_buffer_caches (current_buffer
,
3986 BYTE_TO_CHAR (same_at_start
),
3987 BYTE_TO_CHAR (same_at_end
));
3988 del_range_byte (same_at_start
, same_at_end
, 0);
3992 unbind_to (this_count
, Qnil
);
3996 /* Extend the start of non-matching text area to the previous
3997 multibyte character boundary. */
3998 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3999 while (same_at_start
> BEGV_BYTE
4000 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4003 /* Scan this bufferful from the end, comparing with
4004 the Emacs buffer. */
4007 /* Compare with same_at_start to avoid counting some buffer text
4008 as matching both at the file's beginning and at the end. */
4009 while (bufpos
> 0 && same_at_end
> same_at_start
4010 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4011 same_at_end
--, bufpos
--;
4013 /* Extend the end of non-matching text area to the next
4014 multibyte character boundary. */
4015 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4016 while (same_at_end
< ZV_BYTE
4017 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4020 /* Don't try to reuse the same piece of text twice. */
4021 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4023 same_at_end
+= overlap
;
4025 /* If display currently starts at beginning of line,
4026 keep it that way. */
4027 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4028 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4030 /* Replace the chars that we need to replace,
4031 and update INSERTED to equal the number of bytes
4032 we are taking from the decoded string. */
4033 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4035 if (same_at_end
!= same_at_start
)
4037 invalidate_buffer_caches (current_buffer
,
4038 BYTE_TO_CHAR (same_at_start
),
4039 BYTE_TO_CHAR (same_at_end
));
4040 del_range_byte (same_at_start
, same_at_end
, 0);
4042 eassert (same_at_start
== GPT_BYTE
);
4043 same_at_start
= GPT_BYTE
;
4047 temp
= BYTE_TO_CHAR (same_at_start
);
4049 /* Insert from the file at the proper position. */
4050 SET_PT_BOTH (temp
, same_at_start
);
4051 same_at_start_charpos
4052 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4053 same_at_start
- BEGV_BYTE
4054 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4055 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4057 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4058 same_at_start
+ inserted
- BEGV_BYTE
4059 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4060 - same_at_start_charpos
);
4061 /* This binding is to avoid ask-user-about-supersession-threat
4062 being called in insert_from_buffer (via in
4063 prepare_to_modify_buffer). */
4064 specbind (intern ("buffer-file-name"), Qnil
);
4065 insert_from_buffer (XBUFFER (conversion_buffer
),
4066 same_at_start_charpos
, inserted_chars
, 0);
4067 /* Set `inserted' to the number of inserted characters. */
4068 inserted
= PT
- temp
;
4069 /* Set point before the inserted characters. */
4070 SET_PT_BOTH (temp
, same_at_start
);
4072 unbind_to (this_count
, Qnil
);
4078 total
= end_offset
- beg_offset
;
4080 /* For a special file, all we can do is guess. */
4081 total
= READ_BUF_SIZE
;
4083 if (NILP (visit
) && total
> 0)
4085 #ifdef CLASH_DETECTION
4086 if (!NILP (BVAR (current_buffer
, file_truename
))
4087 /* Make binding buffer-file-name to nil effective. */
4088 && !NILP (BVAR (current_buffer
, filename
))
4089 && SAVE_MODIFF
>= MODIFF
)
4091 #endif /* CLASH_DETECTION */
4092 prepare_to_modify_buffer (PT
, PT
, NULL
);
4095 move_gap_both (PT
, PT_BYTE
);
4096 if (GAP_SIZE
< total
)
4097 make_gap (total
- GAP_SIZE
);
4099 if (beg_offset
!= 0 || !NILP (replace
))
4101 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4102 report_file_error ("Setting file position", orig_filename
);
4105 /* In the following loop, HOW_MUCH contains the total bytes read so
4106 far for a regular file, and not changed for a special file. But,
4107 before exiting the loop, it is set to a negative value if I/O
4111 /* Total bytes inserted. */
4114 /* Here, we don't do code conversion in the loop. It is done by
4115 decode_coding_gap after all data are read into the buffer. */
4117 ptrdiff_t gap_size
= GAP_SIZE
;
4119 while (how_much
< total
)
4121 /* try is reserved in some compilers (Microsoft C) */
4122 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4129 /* Maybe make more room. */
4130 if (gap_size
< trytry
)
4132 make_gap (trytry
- gap_size
);
4133 gap_size
= GAP_SIZE
- inserted
;
4136 /* Read from the file, capturing `quit'. When an
4137 error occurs, end the loop, and arrange for a quit
4138 to be signaled after decoding the text we read. */
4139 nbytes
= internal_condition_case_1
4141 make_save_int_int_int (fd
, inserted
, trytry
),
4142 Qerror
, read_non_regular_quit
);
4150 this = XINT (nbytes
);
4154 /* Allow quitting out of the actual I/O. We don't make text
4155 part of the buffer until all the reading is done, so a C-g
4156 here doesn't do any harm. */
4159 this = emacs_read (fd
,
4160 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4174 /* For a regular file, where TOTAL is the real size,
4175 count HOW_MUCH to compare with it.
4176 For a special file, where TOTAL is just a buffer size,
4177 so don't bother counting in HOW_MUCH.
4178 (INSERTED is where we count the number of characters inserted.) */
4185 /* Now we have either read all the file data into the gap,
4186 or stop reading on I/O error or quit. If nothing was
4187 read, undo marking the buffer modified. */
4191 #ifdef CLASH_DETECTION
4193 unlock_file (BVAR (current_buffer
, file_truename
));
4195 Vdeactivate_mark
= old_Vdeactivate_mark
;
4198 Vdeactivate_mark
= Qt
;
4201 clear_unwind_protect (fd_index
);
4204 report_file_error ("Read error", orig_filename
);
4206 /* Make the text read part of the buffer. */
4207 GAP_SIZE
-= inserted
;
4209 GPT_BYTE
+= inserted
;
4211 ZV_BYTE
+= inserted
;
4216 /* Put an anchor to ensure multi-byte form ends at gap. */
4221 if (NILP (coding_system
))
4223 /* The coding system is not yet decided. Decide it by an
4224 optimized method for handling `coding:' tag.
4226 Note that we can get here only if the buffer was empty
4227 before the insertion. */
4229 if (!NILP (Vcoding_system_for_read
))
4230 coding_system
= Vcoding_system_for_read
;
4233 /* Since we are sure that the current buffer was empty
4234 before the insertion, we can toggle
4235 enable-multibyte-characters directly here without taking
4236 care of marker adjustment. By this way, we can run Lisp
4237 program safely before decoding the inserted text. */
4238 Lisp_Object unwind_data
;
4239 ptrdiff_t count1
= SPECPDL_INDEX ();
4241 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4242 Fcons (BVAR (current_buffer
, undo_list
),
4243 Fcurrent_buffer ()));
4244 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4245 bset_undo_list (current_buffer
, Qt
);
4246 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4248 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4250 coding_system
= call2 (Vset_auto_coding_function
,
4251 filename
, make_number (inserted
));
4254 if (NILP (coding_system
))
4256 /* If the coding system is not yet decided, check
4257 file-coding-system-alist. */
4258 Lisp_Object args
[6];
4260 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4261 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4262 coding_system
= Ffind_operation_coding_system (6, args
);
4263 if (CONSP (coding_system
))
4264 coding_system
= XCAR (coding_system
);
4266 unbind_to (count1
, Qnil
);
4267 inserted
= Z_BYTE
- BEG_BYTE
;
4270 if (NILP (coding_system
))
4271 coding_system
= Qundecided
;
4273 CHECK_CODING_SYSTEM (coding_system
);
4275 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4276 /* We must suppress all character code conversion except for
4277 end-of-line conversion. */
4278 coding_system
= raw_text_coding_system (coding_system
);
4279 setup_coding_system (coding_system
, &coding
);
4280 /* Ensure we set Vlast_coding_system_used. */
4281 set_coding_system
= 1;
4286 /* When we visit a file by raw-text, we change the buffer to
4288 if (CODING_FOR_UNIBYTE (&coding
)
4289 /* Can't do this if part of the buffer might be preserved. */
4291 /* Visiting a file with these coding system makes the buffer
4293 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4296 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4297 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4298 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4300 move_gap_both (PT
, PT_BYTE
);
4301 GAP_SIZE
+= inserted
;
4302 ZV_BYTE
-= inserted
;
4306 decode_coding_gap (&coding
, inserted
, inserted
);
4307 inserted
= coding
.produced_char
;
4308 coding_system
= CODING_ID_NAME (coding
.id
);
4310 else if (inserted
> 0)
4311 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4314 /* Call after-change hooks for the inserted text, aside from the case
4315 of normal visiting (not with REPLACE), which is done in a new buffer
4316 "before" the buffer is changed. */
4317 if (inserted
> 0 && total
> 0
4318 && (NILP (visit
) || !NILP (replace
)))
4320 signal_after_change (PT
, 0, inserted
);
4321 update_compositions (PT
, PT
, CHECK_BORDER
);
4324 /* Now INSERTED is measured in characters. */
4330 if (empty_undo_list_p
)
4331 bset_undo_list (current_buffer
, Qnil
);
4335 current_buffer
->modtime
= mtime
;
4336 current_buffer
->modtime_size
= st
.st_size
;
4337 bset_filename (current_buffer
, orig_filename
);
4340 SAVE_MODIFF
= MODIFF
;
4341 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4342 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4343 #ifdef CLASH_DETECTION
4346 if (!NILP (BVAR (current_buffer
, file_truename
)))
4347 unlock_file (BVAR (current_buffer
, file_truename
));
4348 unlock_file (filename
);
4350 #endif /* CLASH_DETECTION */
4352 xsignal2 (Qfile_error
,
4353 build_string ("not a regular file"), orig_filename
);
4356 if (set_coding_system
)
4357 Vlast_coding_system_used
= coding_system
;
4359 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4361 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4363 if (! NILP (insval
))
4365 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4366 wrong_type_argument (intern ("inserted-chars"), insval
);
4367 inserted
= XFASTINT (insval
);
4371 /* Decode file format. */
4374 /* Don't run point motion or modification hooks when decoding. */
4375 ptrdiff_t count1
= SPECPDL_INDEX ();
4376 ptrdiff_t old_inserted
= inserted
;
4377 specbind (Qinhibit_point_motion_hooks
, Qt
);
4378 specbind (Qinhibit_modification_hooks
, Qt
);
4380 /* Save old undo list and don't record undo for decoding. */
4381 old_undo
= BVAR (current_buffer
, undo_list
);
4382 bset_undo_list (current_buffer
, Qt
);
4386 insval
= call3 (Qformat_decode
,
4387 Qnil
, make_number (inserted
), visit
);
4388 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4389 wrong_type_argument (intern ("inserted-chars"), insval
);
4390 inserted
= XFASTINT (insval
);
4394 /* If REPLACE is non-nil and we succeeded in not replacing the
4395 beginning or end of the buffer text with the file's contents,
4396 call format-decode with `point' positioned at the beginning
4397 of the buffer and `inserted' equaling the number of
4398 characters in the buffer. Otherwise, format-decode might
4399 fail to correctly analyze the beginning or end of the buffer.
4400 Hence we temporarily save `point' and `inserted' here and
4401 restore `point' iff format-decode did not insert or delete
4402 any text. Otherwise we leave `point' at point-min. */
4403 ptrdiff_t opoint
= PT
;
4404 ptrdiff_t opoint_byte
= PT_BYTE
;
4405 ptrdiff_t oinserted
= ZV
- BEGV
;
4406 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4408 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4409 insval
= call3 (Qformat_decode
,
4410 Qnil
, make_number (oinserted
), visit
);
4411 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4412 wrong_type_argument (intern ("inserted-chars"), insval
);
4413 if (ochars_modiff
== CHARS_MODIFF
)
4414 /* format_decode didn't modify buffer's characters => move
4415 point back to position before inserted text and leave
4416 value of inserted alone. */
4417 SET_PT_BOTH (opoint
, opoint_byte
);
4419 /* format_decode modified buffer's characters => consider
4420 entire buffer changed and leave point at point-min. */
4421 inserted
= XFASTINT (insval
);
4424 /* For consistency with format-decode call these now iff inserted > 0
4425 (martin 2007-06-28). */
4426 p
= Vafter_insert_file_functions
;
4431 insval
= call1 (XCAR (p
), make_number (inserted
));
4434 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4435 wrong_type_argument (intern ("inserted-chars"), insval
);
4436 inserted
= XFASTINT (insval
);
4441 /* For the rationale of this see the comment on
4442 format-decode above. */
4443 ptrdiff_t opoint
= PT
;
4444 ptrdiff_t opoint_byte
= PT_BYTE
;
4445 ptrdiff_t oinserted
= ZV
- BEGV
;
4446 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4448 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4449 insval
= call1 (XCAR (p
), make_number (oinserted
));
4452 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4453 wrong_type_argument (intern ("inserted-chars"), insval
);
4454 if (ochars_modiff
== CHARS_MODIFF
)
4455 /* after_insert_file_functions didn't modify
4456 buffer's characters => move point back to
4457 position before inserted text and leave value of
4459 SET_PT_BOTH (opoint
, opoint_byte
);
4461 /* after_insert_file_functions did modify buffer's
4462 characters => consider entire buffer changed and
4463 leave point at point-min. */
4464 inserted
= XFASTINT (insval
);
4472 if (!empty_undo_list_p
)
4474 bset_undo_list (current_buffer
, old_undo
);
4475 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4477 /* Adjust the last undo record for the size change during
4478 the format conversion. */
4479 Lisp_Object tem
= XCAR (old_undo
);
4480 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4481 && INTEGERP (XCDR (tem
))
4482 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4483 XSETCDR (tem
, make_number (PT
+ inserted
));
4487 /* If undo_list was Qt before, keep it that way.
4488 Otherwise start with an empty undo_list. */
4489 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4491 unbind_to (count1
, Qnil
);
4495 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4497 /* If visiting nonexistent file, return nil. */
4498 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4501 /* We made a lot of deletions and insertions above, so invalidate
4502 the newline cache for the entire region of the inserted
4504 if (current_buffer
->base_buffer
&& current_buffer
->base_buffer
->newline_cache
)
4505 invalidate_region_cache (current_buffer
->base_buffer
,
4506 current_buffer
->base_buffer
->newline_cache
,
4507 PT
- BEG
, Z
- PT
- inserted
);
4508 else if (current_buffer
->newline_cache
)
4509 invalidate_region_cache (current_buffer
,
4510 current_buffer
->newline_cache
,
4511 PT
- BEG
, Z
- PT
- inserted
);
4514 Fsignal (Qquit
, Qnil
);
4516 /* Retval needs to be dealt with in all cases consistently. */
4518 val
= list2 (orig_filename
, make_number (inserted
));
4520 RETURN_UNGCPRO (unbind_to (count
, val
));
4523 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4526 build_annotations_unwind (Lisp_Object arg
)
4528 Vwrite_region_annotation_buffers
= arg
;
4531 /* Decide the coding-system to encode the data with. */
4534 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4535 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4536 struct coding_system
*coding
)
4539 Lisp_Object eol_parent
= Qnil
;
4542 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4543 BVAR (current_buffer
, auto_save_file_name
))))
4548 else if (!NILP (Vcoding_system_for_write
))
4550 val
= Vcoding_system_for_write
;
4551 if (coding_system_require_warning
4552 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4553 /* Confirm that VAL can surely encode the current region. */
4554 val
= call5 (Vselect_safe_coding_system_function
,
4555 start
, end
, list2 (Qt
, val
),
4560 /* If the variable `buffer-file-coding-system' is set locally,
4561 it means that the file was read with some kind of code
4562 conversion or the variable is explicitly set by users. We
4563 had better write it out with the same coding system even if
4564 `enable-multibyte-characters' is nil.
4566 If it is not set locally, we anyway have to convert EOL
4567 format if the default value of `buffer-file-coding-system'
4568 tells that it is not Unix-like (LF only) format. */
4569 bool using_default_coding
= 0;
4570 bool force_raw_text
= 0;
4572 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4574 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4577 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4583 /* Check file-coding-system-alist. */
4584 Lisp_Object args
[7], coding_systems
;
4586 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4587 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4589 coding_systems
= Ffind_operation_coding_system (7, args
);
4590 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4591 val
= XCDR (coding_systems
);
4596 /* If we still have not decided a coding system, use the
4597 default value of buffer-file-coding-system. */
4598 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4599 using_default_coding
= 1;
4602 if (! NILP (val
) && ! force_raw_text
)
4604 Lisp_Object spec
, attrs
;
4606 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4607 attrs
= AREF (spec
, 0);
4608 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4613 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4614 /* Confirm that VAL can surely encode the current region. */
4615 val
= call5 (Vselect_safe_coding_system_function
,
4616 start
, end
, val
, Qnil
, filename
);
4618 /* If the decided coding-system doesn't specify end-of-line
4619 format, we use that of
4620 `default-buffer-file-coding-system'. */
4621 if (! using_default_coding
4622 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4623 val
= (coding_inherit_eol_type
4624 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4626 /* If we decide not to encode text, use `raw-text' or one of its
4629 val
= raw_text_coding_system (val
);
4632 val
= coding_inherit_eol_type (val
, eol_parent
);
4633 setup_coding_system (val
, coding
);
4635 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4636 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4640 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4641 "r\nFWrite region to file: \ni\ni\ni\np",
4642 doc
: /* Write current region into specified file.
4643 When called from a program, requires three arguments:
4644 START, END and FILENAME. START and END are normally buffer positions
4645 specifying the part of the buffer to write.
4646 If START is nil, that means to use the entire buffer contents.
4647 If START is a string, then output that string to the file
4648 instead of any buffer contents; END is ignored.
4650 Optional fourth argument APPEND if non-nil means
4651 append to existing file contents (if any). If it is a number,
4652 seek to that offset in the file before writing.
4653 Optional fifth argument VISIT, if t or a string, means
4654 set the last-save-file-modtime of buffer to this file's modtime
4655 and mark buffer not modified.
4656 If VISIT is a string, it is a second file name;
4657 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4658 VISIT is also the file name to lock and unlock for clash detection.
4659 If VISIT is neither t nor nil nor a string,
4660 that means do not display the \"Wrote file\" message.
4661 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4662 use for locking and unlocking, overriding FILENAME and VISIT.
4663 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4664 for an existing file with the same name. If MUSTBENEW is `excl',
4665 that means to get an error if the file already exists; never overwrite.
4666 If MUSTBENEW is neither nil nor `excl', that means ask for
4667 confirmation before overwriting, but do go ahead and overwrite the file
4668 if the user confirms.
4670 This does code conversion according to the value of
4671 `coding-system-for-write', `buffer-file-coding-system', or
4672 `file-coding-system-alist', and sets the variable
4673 `last-coding-system-used' to the coding system actually used.
4675 This calls `write-region-annotate-functions' at the start, and
4676 `write-region-post-annotation-function' at the end. */)
4677 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4678 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4680 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4684 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4685 descriptor for FILENAME, so do not open or close FILENAME. */
4688 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4689 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4690 Lisp_Object mustbenew
, int desc
)
4694 off_t offset
IF_LINT (= 0);
4695 bool open_and_close_file
= desc
< 0;
4700 struct timespec modtime
;
4701 ptrdiff_t count
= SPECPDL_INDEX ();
4702 ptrdiff_t count1
IF_LINT (= 0);
4703 Lisp_Object handler
;
4704 Lisp_Object visit_file
;
4705 Lisp_Object annotations
;
4706 Lisp_Object encoded_filename
;
4707 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4708 bool quietly
= !NILP (visit
);
4709 bool file_locked
= 0;
4710 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4711 struct buffer
*given_buffer
;
4712 struct coding_system coding
;
4714 if (current_buffer
->base_buffer
&& visiting
)
4715 error ("Cannot do file visiting in an indirect buffer");
4717 if (!NILP (start
) && !STRINGP (start
))
4718 validate_region (&start
, &end
);
4721 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4723 filename
= Fexpand_file_name (filename
, Qnil
);
4725 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4726 barf_or_query_if_file_exists (filename
, false, "overwrite", true, true);
4728 if (STRINGP (visit
))
4729 visit_file
= Fexpand_file_name (visit
, Qnil
);
4731 visit_file
= filename
;
4733 if (NILP (lockname
))
4734 lockname
= visit_file
;
4738 /* If the file name has special constructs in it,
4739 call the corresponding file handler. */
4740 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4741 /* If FILENAME has no handler, see if VISIT has one. */
4742 if (NILP (handler
) && STRINGP (visit
))
4743 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4745 if (!NILP (handler
))
4748 val
= call6 (handler
, Qwrite_region
, start
, end
,
4749 filename
, append
, visit
);
4753 SAVE_MODIFF
= MODIFF
;
4754 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4755 bset_filename (current_buffer
, visit_file
);
4761 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4763 /* Special kludge to simplify auto-saving. */
4766 /* Do it later, so write-region-annotate-function can work differently
4767 if we save "the buffer" vs "a region".
4768 This is useful in tar-mode. --Stef
4769 XSETFASTINT (start, BEG);
4770 XSETFASTINT (end, Z); */
4774 record_unwind_protect (build_annotations_unwind
,
4775 Vwrite_region_annotation_buffers
);
4776 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4778 given_buffer
= current_buffer
;
4780 if (!STRINGP (start
))
4782 annotations
= build_annotations (start
, end
);
4784 if (current_buffer
!= given_buffer
)
4786 XSETFASTINT (start
, BEGV
);
4787 XSETFASTINT (end
, ZV
);
4793 XSETFASTINT (start
, BEGV
);
4794 XSETFASTINT (end
, ZV
);
4799 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4801 /* Decide the coding-system to encode the data with.
4802 We used to make this choice before calling build_annotations, but that
4803 leads to problems when a write-annotate-function takes care of
4804 unsavable chars (as was the case with X-Symbol). */
4805 Vlast_coding_system_used
4806 = choose_write_coding_system (start
, end
, filename
,
4807 append
, visit
, lockname
, &coding
);
4809 #ifdef CLASH_DETECTION
4810 if (open_and_close_file
&& !auto_saving
)
4812 lock_file (lockname
);
4815 #endif /* CLASH_DETECTION */
4817 encoded_filename
= ENCODE_FILE (filename
);
4818 fn
= SSDATA (encoded_filename
);
4819 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4820 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4821 if (NUMBERP (append
))
4822 offset
= file_offset (append
);
4823 else if (!NILP (append
))
4824 open_flags
|= O_APPEND
;
4826 mode
= S_IREAD
| S_IWRITE
;
4828 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4831 if (open_and_close_file
)
4833 desc
= emacs_open (fn
, open_flags
, mode
);
4836 int open_errno
= errno
;
4837 #ifdef CLASH_DETECTION
4839 unlock_file (lockname
);
4840 #endif /* CLASH_DETECTION */
4842 report_file_errno ("Opening output file", filename
, open_errno
);
4845 count1
= SPECPDL_INDEX ();
4846 record_unwind_protect_int (close_file_unwind
, desc
);
4849 if (NUMBERP (append
))
4851 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4854 int lseek_errno
= errno
;
4855 #ifdef CLASH_DETECTION
4857 unlock_file (lockname
);
4858 #endif /* CLASH_DETECTION */
4860 report_file_errno ("Lseek error", filename
, lseek_errno
);
4868 if (STRINGP (start
))
4869 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4870 else if (XINT (start
) != XINT (end
))
4871 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4872 &annotations
, &coding
);
4875 /* If file was empty, still need to write the annotations. */
4876 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4877 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4881 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4882 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4884 /* We have to flush out a data. */
4885 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4886 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4892 /* fsync is not crucial for temporary files. Nor for auto-save
4893 files, since they might lose some work anyway. */
4894 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4896 /* Transfer data and metadata to disk, retrying if interrupted.
4897 fsync can report a write failure here, e.g., due to disk full
4898 under NFS. But ignore EINVAL, which means fsync is not
4899 supported on this file. */
4900 while (fsync (desc
) != 0)
4903 if (errno
!= EINVAL
)
4904 ok
= 0, save_errno
= errno
;
4909 modtime
= invalid_timespec ();
4912 if (fstat (desc
, &st
) == 0)
4913 modtime
= get_stat_mtime (&st
);
4915 ok
= 0, save_errno
= errno
;
4918 if (open_and_close_file
)
4920 /* NFS can report a write failure now. */
4921 if (emacs_close (desc
) < 0)
4922 ok
= 0, save_errno
= errno
;
4924 /* Discard the unwind protect for close_file_unwind. */
4925 specpdl_ptr
= specpdl
+ count1
;
4928 /* Some file systems have a bug where st_mtime is not updated
4929 properly after a write. For example, CIFS might not see the
4930 st_mtime change until after the file is opened again.
4932 Attempt to detect this file system bug, and update MODTIME to the
4933 newer st_mtime if the bug appears to be present. This introduces
4934 a race condition, so to avoid most instances of the race condition
4935 on non-buggy file systems, skip this check if the most recently
4936 encountered non-buggy file system was the current file system.
4938 A race condition can occur if some other process modifies the
4939 file between the fstat above and the fstat below, but the race is
4940 unlikely and a similar race between the last write and the fstat
4941 above cannot possibly be closed anyway. */
4943 if (timespec_valid_p (modtime
)
4944 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4946 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4950 if (fstat (desc1
, &st1
) == 0
4951 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4953 /* Use the heuristic if it appears to be valid. With neither
4954 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4955 file, the time stamp won't change. Also, some non-POSIX
4956 systems don't update an empty file's time stamp when
4957 truncating it. Finally, file systems with 100 ns or worse
4958 resolution sometimes seem to have bugs: on a system with ns
4959 resolution, checking ns % 100 incorrectly avoids the heuristic
4960 1% of the time, but the problem should be temporary as we will
4961 try again on the next time stamp. */
4963 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4965 && modtime
.tv_nsec
% 100 != 0);
4967 struct timespec modtime1
= get_stat_mtime (&st1
);
4969 && timespec_cmp (modtime
, modtime1
) == 0
4970 && st
.st_size
== st1
.st_size
)
4972 timestamp_file_system
= st
.st_dev
;
4973 valid_timestamp_file_system
= 1;
4977 st
.st_size
= st1
.st_size
;
4981 emacs_close (desc1
);
4985 /* Call write-region-post-annotation-function. */
4986 while (CONSP (Vwrite_region_annotation_buffers
))
4988 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4989 if (!NILP (Fbuffer_live_p (buf
)))
4992 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4993 call0 (Vwrite_region_post_annotation_function
);
4995 Vwrite_region_annotation_buffers
4996 = XCDR (Vwrite_region_annotation_buffers
);
4999 unbind_to (count
, Qnil
);
5001 #ifdef CLASH_DETECTION
5003 unlock_file (lockname
);
5004 #endif /* CLASH_DETECTION */
5006 /* Do this before reporting IO error
5007 to avoid a "file has changed on disk" warning on
5008 next attempt to save. */
5009 if (timespec_valid_p (modtime
))
5011 current_buffer
->modtime
= modtime
;
5012 current_buffer
->modtime_size
= st
.st_size
;
5016 report_file_errno ("Write error", filename
, save_errno
);
5020 SAVE_MODIFF
= MODIFF
;
5021 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5022 bset_filename (current_buffer
, visit_file
);
5023 update_mode_lines
= 14;
5028 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5029 BVAR (current_buffer
, auto_save_file_name
))))
5030 SAVE_MODIFF
= MODIFF
;
5036 message_with_string ((NUMBERP (append
)
5046 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5047 doc
: /* Return t if (car A) is numerically less than (car B). */)
5048 (Lisp_Object a
, Lisp_Object b
)
5050 Lisp_Object args
[2];
5053 return Flss (2, args
);
5056 /* Build the complete list of annotations appropriate for writing out
5057 the text between START and END, by calling all the functions in
5058 write-region-annotate-functions and merging the lists they return.
5059 If one of these functions switches to a different buffer, we assume
5060 that buffer contains altered text. Therefore, the caller must
5061 make sure to restore the current buffer in all cases,
5062 as save-excursion would do. */
5065 build_annotations (Lisp_Object start
, Lisp_Object end
)
5067 Lisp_Object annotations
;
5069 struct gcpro gcpro1
, gcpro2
;
5070 Lisp_Object original_buffer
;
5072 bool used_global
= 0;
5074 XSETBUFFER (original_buffer
, current_buffer
);
5077 p
= Vwrite_region_annotate_functions
;
5078 GCPRO2 (annotations
, p
);
5081 struct buffer
*given_buffer
= current_buffer
;
5082 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5083 { /* Use the global value of the hook. */
5086 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5088 p
= Fappend (2, arg
);
5091 Vwrite_region_annotations_so_far
= annotations
;
5092 res
= call2 (XCAR (p
), start
, end
);
5093 /* If the function makes a different buffer current,
5094 assume that means this buffer contains altered text to be output.
5095 Reset START and END from the buffer bounds
5096 and discard all previous annotations because they should have
5097 been dealt with by this function. */
5098 if (current_buffer
!= given_buffer
)
5100 Vwrite_region_annotation_buffers
5101 = Fcons (Fcurrent_buffer (),
5102 Vwrite_region_annotation_buffers
);
5103 XSETFASTINT (start
, BEGV
);
5104 XSETFASTINT (end
, ZV
);
5107 Flength (res
); /* Check basic validity of return value */
5108 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5112 /* Now do the same for annotation functions implied by the file-format */
5113 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5114 p
= BVAR (current_buffer
, auto_save_file_format
);
5116 p
= BVAR (current_buffer
, file_format
);
5117 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5119 struct buffer
*given_buffer
= current_buffer
;
5121 Vwrite_region_annotations_so_far
= annotations
;
5123 /* Value is either a list of annotations or nil if the function
5124 has written annotations to a temporary buffer, which is now
5126 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5127 original_buffer
, make_number (i
));
5128 if (current_buffer
!= given_buffer
)
5130 XSETFASTINT (start
, BEGV
);
5131 XSETFASTINT (end
, ZV
);
5136 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5144 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5145 If STRING is nil, POS is the character position in the current buffer.
5146 Intersperse with them the annotations from *ANNOT
5147 which fall within the range of POS to POS + NCHARS,
5148 each at its appropriate position.
5150 We modify *ANNOT by discarding elements as we use them up.
5152 Return true if successful. */
5155 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5156 ptrdiff_t nchars
, Lisp_Object
*annot
,
5157 struct coding_system
*coding
)
5161 ptrdiff_t lastpos
= pos
+ nchars
;
5163 while (NILP (*annot
) || CONSP (*annot
))
5165 tem
= Fcar_safe (Fcar (*annot
));
5168 nextpos
= XFASTINT (tem
);
5170 /* If there are no more annotations in this range,
5171 output the rest of the range all at once. */
5172 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5173 return e_write (desc
, string
, pos
, lastpos
, coding
);
5175 /* Output buffer text up to the next annotation's position. */
5178 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5182 /* Output the annotation. */
5183 tem
= Fcdr (Fcar (*annot
));
5186 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5189 *annot
= Fcdr (*annot
);
5194 /* Maximum number of characters that the next
5195 function encodes per one loop iteration. */
5197 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5199 /* Write text in the range START and END into descriptor DESC,
5200 encoding them with coding system CODING. If STRING is nil, START
5201 and END are character positions of the current buffer, else they
5202 are indexes to the string STRING. Return true if successful. */
5205 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5206 struct coding_system
*coding
)
5208 if (STRINGP (string
))
5211 end
= SCHARS (string
);
5214 /* We used to have a code for handling selective display here. But,
5215 now it is handled within encode_coding. */
5219 if (STRINGP (string
))
5221 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5222 if (CODING_REQUIRE_ENCODING (coding
))
5224 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5226 /* Avoid creating huge Lisp string in encode_coding_object. */
5227 if (nchars
== E_WRITE_MAX
)
5228 coding
->raw_destination
= 1;
5230 encode_coding_object
5231 (coding
, string
, start
, string_char_to_byte (string
, start
),
5232 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5237 coding
->dst_object
= string
;
5238 coding
->consumed_char
= SCHARS (string
);
5239 coding
->produced
= SBYTES (string
);
5244 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5245 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5247 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5248 if (CODING_REQUIRE_ENCODING (coding
))
5250 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5253 if (nchars
== E_WRITE_MAX
)
5254 coding
->raw_destination
= 1;
5256 encode_coding_object
5257 (coding
, Fcurrent_buffer (), start
, start_byte
,
5258 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5262 coding
->dst_object
= Qnil
;
5263 coding
->dst_pos_byte
= start_byte
;
5264 if (start
>= GPT
|| end
<= GPT
)
5266 coding
->consumed_char
= end
- start
;
5267 coding
->produced
= end_byte
- start_byte
;
5271 coding
->consumed_char
= GPT
- start
;
5272 coding
->produced
= GPT_BYTE
- start_byte
;
5277 if (coding
->produced
> 0)
5279 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5280 : (STRINGP (coding
->dst_object
)
5281 ? SSDATA (coding
->dst_object
)
5282 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5283 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5285 if (coding
->raw_destination
)
5287 /* We're responsible for freeing this, see
5288 encode_coding_object to check why. */
5289 xfree (coding
->destination
);
5290 coding
->raw_destination
= 0;
5292 if (coding
->produced
)
5295 start
+= coding
->consumed_char
;
5301 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5302 Sverify_visited_file_modtime
, 0, 1, 0,
5303 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5304 This means that the file has not been changed since it was visited or saved.
5305 If BUF is omitted or nil, it defaults to the current buffer.
5306 See Info node `(elisp)Modification Time' for more details. */)
5311 Lisp_Object handler
;
5312 Lisp_Object filename
;
5313 struct timespec mtime
;
5323 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5324 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5326 /* If the file name has special constructs in it,
5327 call the corresponding file handler. */
5328 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5329 Qverify_visited_file_modtime
);
5330 if (!NILP (handler
))
5331 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5333 filename
= ENCODE_FILE (BVAR (b
, filename
));
5335 mtime
= (stat (SSDATA (filename
), &st
) == 0
5336 ? get_stat_mtime (&st
)
5337 : time_error_value (errno
));
5338 if (timespec_cmp (mtime
, b
->modtime
) == 0
5339 && (b
->modtime_size
< 0
5340 || st
.st_size
== b
->modtime_size
))
5345 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5346 Svisited_file_modtime
, 0, 0, 0,
5347 doc
: /* Return the current buffer's recorded visited file modification time.
5348 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5349 `file-attributes' returns. If the current buffer has no recorded file
5350 modification time, this function returns 0. If the visited file
5351 doesn't exist, return -1.
5352 See Info node `(elisp)Modification Time' for more details. */)
5355 int ns
= current_buffer
->modtime
.tv_nsec
;
5357 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5358 return make_lisp_time (current_buffer
->modtime
);
5361 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5362 Sset_visited_file_modtime
, 0, 1, 0,
5363 doc
: /* Update buffer's recorded modification time from the visited file's time.
5364 Useful if the buffer was not read from the file normally
5365 or if the file itself has been changed for some known benign reason.
5366 An argument specifies the modification time value to use
5367 \(instead of that of the visited file), in the form of a list
5368 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5369 `visited-file-modtime'. */)
5370 (Lisp_Object time_flag
)
5372 if (!NILP (time_flag
))
5374 struct timespec mtime
;
5375 if (INTEGERP (time_flag
))
5377 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5378 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5381 mtime
= lisp_time_argument (time_flag
);
5383 current_buffer
->modtime
= mtime
;
5384 current_buffer
->modtime_size
= -1;
5388 register Lisp_Object filename
;
5390 Lisp_Object handler
;
5392 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5394 /* If the file name has special constructs in it,
5395 call the corresponding file handler. */
5396 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5397 if (!NILP (handler
))
5398 /* The handler can find the file name the same way we did. */
5399 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5401 filename
= ENCODE_FILE (filename
);
5403 if (stat (SSDATA (filename
), &st
) >= 0)
5405 current_buffer
->modtime
= get_stat_mtime (&st
);
5406 current_buffer
->modtime_size
= st
.st_size
;
5414 auto_save_error (Lisp_Object error_val
)
5416 Lisp_Object args
[3], msg
;
5418 struct gcpro gcpro1
;
5420 auto_save_error_occurred
= 1;
5422 ring_bell (XFRAME (selected_frame
));
5424 args
[0] = build_string ("Auto-saving %s: %s");
5425 args
[1] = BVAR (current_buffer
, name
);
5426 args
[2] = Ferror_message_string (error_val
);
5427 msg
= Fformat (3, args
);
5430 for (i
= 0; i
< 3; ++i
)
5435 message3_nolog (msg
);
5436 Fsleep_for (make_number (1), Qnil
);
5449 auto_save_mode_bits
= 0666;
5451 /* Get visited file's mode to become the auto save file's mode. */
5452 if (! NILP (BVAR (current_buffer
, filename
)))
5454 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5455 /* But make sure we can overwrite it later! */
5456 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5457 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5459 /* Remote files don't cooperate with stat. */
5460 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5464 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5465 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5469 struct auto_save_unwind
5476 do_auto_save_unwind (void *arg
)
5478 struct auto_save_unwind
*p
= arg
;
5479 FILE *stream
= p
->stream
;
5480 minibuffer_auto_raise
= p
->auto_raise
;
5491 do_auto_save_make_dir (Lisp_Object dir
)
5495 auto_saving_dir_umask
= 077;
5496 result
= call2 (Qmake_directory
, dir
, Qt
);
5497 auto_saving_dir_umask
= 0;
5502 do_auto_save_eh (Lisp_Object ignore
)
5504 auto_saving_dir_umask
= 0;
5508 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5509 doc
: /* Auto-save all buffers that need it.
5510 This is all buffers that have auto-saving enabled
5511 and are changed since last auto-saved.
5512 Auto-saving writes the buffer into a file
5513 so that your editing is not lost if the system crashes.
5514 This file is not the file you visited; that changes only when you save.
5515 Normally we run the normal hook `auto-save-hook' before saving.
5517 A non-nil NO-MESSAGE argument means do not print any message if successful.
5518 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5519 (Lisp_Object no_message
, Lisp_Object current_only
)
5521 struct buffer
*old
= current_buffer
, *b
;
5522 Lisp_Object tail
, buf
, hook
;
5523 bool auto_saved
= 0;
5524 int do_handled_files
;
5526 FILE *stream
= NULL
;
5527 ptrdiff_t count
= SPECPDL_INDEX ();
5528 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5529 bool old_message_p
= 0;
5530 struct auto_save_unwind auto_save_unwind
;
5531 struct gcpro gcpro1
, gcpro2
;
5533 if (max_specpdl_size
< specpdl_size
+ 40)
5534 max_specpdl_size
= specpdl_size
+ 40;
5539 if (NILP (no_message
))
5541 old_message_p
= push_message ();
5542 record_unwind_protect_void (pop_message_unwind
);
5545 /* Ordinarily don't quit within this function,
5546 but don't make it impossible to quit (in case we get hung in I/O). */
5550 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5551 point to non-strings reached from Vbuffer_alist. */
5553 hook
= intern ("auto-save-hook");
5554 safe_run_hooks (hook
);
5556 if (STRINGP (Vauto_save_list_file_name
))
5558 Lisp_Object listfile
;
5560 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5562 /* Don't try to create the directory when shutting down Emacs,
5563 because creating the directory might signal an error, and
5564 that would leave Emacs in a strange state. */
5565 if (!NILP (Vrun_hooks
))
5569 GCPRO2 (dir
, listfile
);
5570 dir
= Ffile_name_directory (listfile
);
5571 if (NILP (Ffile_directory_p (dir
)))
5572 internal_condition_case_1 (do_auto_save_make_dir
,
5578 stream
= emacs_fopen (SSDATA (listfile
), "w");
5581 auto_save_unwind
.stream
= stream
;
5582 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5583 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5584 minibuffer_auto_raise
= 0;
5586 auto_save_error_occurred
= 0;
5588 /* On first pass, save all files that don't have handlers.
5589 On second pass, save all files that do have handlers.
5591 If Emacs is crashing, the handlers may tweak what is causing
5592 Emacs to crash in the first place, and it would be a shame if
5593 Emacs failed to autosave perfectly ordinary files because it
5594 couldn't handle some ange-ftp'd file. */
5596 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5597 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5601 /* Record all the buffers that have auto save mode
5602 in the special file that lists them. For each of these buffers,
5603 Record visited name (if any) and auto save name. */
5604 if (STRINGP (BVAR (b
, auto_save_file_name
))
5605 && stream
!= NULL
&& do_handled_files
== 0)
5608 if (!NILP (BVAR (b
, filename
)))
5610 fwrite (SDATA (BVAR (b
, filename
)), 1,
5611 SBYTES (BVAR (b
, filename
)), stream
);
5613 putc ('\n', stream
);
5614 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5615 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5616 putc ('\n', stream
);
5620 if (!NILP (current_only
)
5621 && b
!= current_buffer
)
5624 /* Don't auto-save indirect buffers.
5625 The base buffer takes care of it. */
5629 /* Check for auto save enabled
5630 and file changed since last auto save
5631 and file changed since last real save. */
5632 if (STRINGP (BVAR (b
, auto_save_file_name
))
5633 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5634 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5635 /* -1 means we've turned off autosaving for a while--see below. */
5636 && XINT (BVAR (b
, save_length
)) >= 0
5637 && (do_handled_files
5638 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5641 struct timespec before_time
= current_timespec ();
5642 struct timespec after_time
;
5644 /* If we had a failure, don't try again for 20 minutes. */
5645 if (b
->auto_save_failure_time
> 0
5646 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5649 set_buffer_internal (b
);
5650 if (NILP (Vauto_save_include_big_deletions
)
5651 && (XFASTINT (BVAR (b
, save_length
)) * 10
5652 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5653 /* A short file is likely to change a large fraction;
5654 spare the user annoying messages. */
5655 && XFASTINT (BVAR (b
, save_length
)) > 5000
5656 /* These messages are frequent and annoying for `*mail*'. */
5657 && !EQ (BVAR (b
, filename
), Qnil
)
5658 && NILP (no_message
))
5660 /* It has shrunk too much; turn off auto-saving here. */
5661 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5662 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5664 minibuffer_auto_raise
= 0;
5665 /* Turn off auto-saving until there's a real save,
5666 and prevent any more warnings. */
5667 XSETINT (BVAR (b
, save_length
), -1);
5668 Fsleep_for (make_number (1), Qnil
);
5671 if (!auto_saved
&& NILP (no_message
))
5672 message1 ("Auto-saving...");
5673 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5675 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5676 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5677 set_buffer_internal (old
);
5679 after_time
= current_timespec ();
5681 /* If auto-save took more than 60 seconds,
5682 assume it was an NFS failure that got a timeout. */
5683 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5684 b
->auto_save_failure_time
= after_time
.tv_sec
;
5688 /* Prevent another auto save till enough input events come in. */
5689 record_auto_save ();
5691 if (auto_saved
&& NILP (no_message
))
5695 /* If we are going to restore an old message,
5696 give time to read ours. */
5697 sit_for (make_number (1), 0, 0);
5700 else if (!auto_save_error_occurred
)
5701 /* Don't overwrite the error message if an error occurred.
5702 If we displayed a message and then restored a state
5703 with no message, leave a "done" message on the screen. */
5704 message1 ("Auto-saving...done");
5709 /* This restores the message-stack status. */
5710 unbind_to (count
, Qnil
);
5714 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5715 Sset_buffer_auto_saved
, 0, 0, 0,
5716 doc
: /* Mark current buffer as auto-saved with its current text.
5717 No auto-save file will be written until the buffer changes again. */)
5720 /* FIXME: This should not be called in indirect buffers, since
5721 they're not autosaved. */
5722 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5723 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5724 current_buffer
->auto_save_failure_time
= 0;
5728 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5729 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5730 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5733 current_buffer
->auto_save_failure_time
= 0;
5737 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5739 doc
: /* Return t if current buffer has been auto-saved recently.
5740 More precisely, if it has been auto-saved since last read from or saved
5741 in the visited file. If the buffer has no visited file,
5742 then any auto-save counts as "recent". */)
5745 /* FIXME: maybe we should return nil for indirect buffers since
5746 they're never autosaved. */
5747 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5750 /* Reading and completing file names */
5752 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5753 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5754 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5755 The return value is only relevant for a call to `read-file-name' that happens
5756 before any other event (mouse or keypress) is handled. */)
5759 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5760 || defined (HAVE_NS)
5761 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5764 && window_system_available (SELECTED_FRAME ()))
5771 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5773 struct gcpro gcpro1
;
5774 Lisp_Object args
[7];
5776 GCPRO1 (default_filename
);
5777 args
[0] = intern ("read-file-name");
5780 args
[3] = default_filename
;
5781 args
[4] = mustmatch
;
5783 args
[6] = predicate
;
5784 RETURN_UNGCPRO (Ffuncall (7, args
));
5791 realmask
= umask (0);
5794 valid_timestamp_file_system
= 0;
5796 /* fsync can be a significant performance hit. Often it doesn't
5797 suffice to make the file-save operation survive a crash. For
5798 batch scripts, which are typically part of larger shell commands
5799 that don't fsync other files, its effect on performance can be
5800 significant so its utility is particularly questionable.
5801 Hence, for now by default fsync is used only when interactive.
5803 For more on why fsync often fails to work on today's hardware, see:
5804 Zheng M et al. Understanding the robustness of SSDs under power fault.
5805 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5806 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5808 For more on why fsync does not suffice even if it works properly, see:
5809 Roche X. Necessary step(s) to synchronize filename operations on disk.
5810 Austin Group Defect 672, 2013-03-19
5811 http://austingroupbugs.net/view.php?id=672 */
5812 write_region_inhibit_fsync
= noninteractive
;
5816 syms_of_fileio (void)
5818 DEFSYM (Qoperations
, "operations");
5819 DEFSYM (Qexpand_file_name
, "expand-file-name");
5820 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5821 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5822 DEFSYM (Qfile_name_directory
, "file-name-directory");
5823 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5824 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5825 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5826 DEFSYM (Qcopy_file
, "copy-file");
5827 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5828 DEFSYM (Qmake_directory
, "make-directory");
5829 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5830 DEFSYM (Qdelete_file
, "delete-file");
5831 DEFSYM (Qrename_file
, "rename-file");
5832 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5833 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5834 DEFSYM (Qfile_exists_p
, "file-exists-p");
5835 DEFSYM (Qfile_executable_p
, "file-executable-p");
5836 DEFSYM (Qfile_readable_p
, "file-readable-p");
5837 DEFSYM (Qfile_writable_p
, "file-writable-p");
5838 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5839 DEFSYM (Qaccess_file
, "access-file");
5840 DEFSYM (Qfile_directory_p
, "file-directory-p");
5841 DEFSYM (Qfile_regular_p
, "file-regular-p");
5842 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5843 DEFSYM (Qfile_modes
, "file-modes");
5844 DEFSYM (Qset_file_modes
, "set-file-modes");
5845 DEFSYM (Qset_file_times
, "set-file-times");
5846 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5847 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5848 DEFSYM (Qfile_acl
, "file-acl");
5849 DEFSYM (Qset_file_acl
, "set-file-acl");
5850 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5851 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5852 DEFSYM (Qwrite_region
, "write-region");
5853 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5854 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5855 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5857 DEFSYM (Qfile_name_history
, "file-name-history");
5858 Fset (Qfile_name_history
, Qnil
);
5860 DEFSYM (Qfile_error
, "file-error");
5861 DEFSYM (Qfile_already_exists
, "file-already-exists");
5862 DEFSYM (Qfile_date_error
, "file-date-error");
5863 DEFSYM (Qfile_notify_error
, "file-notify-error");
5864 DEFSYM (Qexcl
, "excl");
5866 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5867 doc
: /* Coding system for encoding file names.
5868 If it is nil, `default-file-name-coding-system' (which see) is used.
5870 On MS-Windows, the value of this variable is largely ignored if
5871 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5872 behaves as if file names were encoded in `utf-8'. */);
5873 Vfile_name_coding_system
= Qnil
;
5875 DEFVAR_LISP ("default-file-name-coding-system",
5876 Vdefault_file_name_coding_system
,
5877 doc
: /* Default coding system for encoding file names.
5878 This variable is used only when `file-name-coding-system' is nil.
5880 This variable is set/changed by the command `set-language-environment'.
5881 User should not set this variable manually,
5882 instead use `file-name-coding-system' to get a constant encoding
5883 of file names regardless of the current language environment.
5885 On MS-Windows, the value of this variable is largely ignored if
5886 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5887 behaves as if file names were encoded in `utf-8'. */);
5888 Vdefault_file_name_coding_system
= Qnil
;
5890 DEFSYM (Qformat_decode
, "format-decode");
5891 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5892 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5893 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5895 Fput (Qfile_error
, Qerror_conditions
,
5896 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5897 Fput (Qfile_error
, Qerror_message
,
5898 build_pure_c_string ("File error"));
5900 Fput (Qfile_already_exists
, Qerror_conditions
,
5901 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5902 Fput (Qfile_already_exists
, Qerror_message
,
5903 build_pure_c_string ("File already exists"));
5905 Fput (Qfile_date_error
, Qerror_conditions
,
5906 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5907 Fput (Qfile_date_error
, Qerror_message
,
5908 build_pure_c_string ("Cannot set file date"));
5910 Fput (Qfile_notify_error
, Qerror_conditions
,
5911 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5912 Fput (Qfile_notify_error
, Qerror_message
,
5913 build_pure_c_string ("File notification error"));
5915 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5916 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5917 If a file name matches REGEXP, all I/O on that file is done by calling
5918 HANDLER. If a file name matches more than one handler, the handler
5919 whose match starts last in the file name gets precedence. The
5920 function `find-file-name-handler' checks this list for a handler for
5923 HANDLER should be a function. The first argument given to it is the
5924 name of the I/O primitive to be handled; the remaining arguments are
5925 the arguments that were passed to that primitive. For example, if you
5926 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5927 HANDLER is called like this:
5929 (funcall HANDLER 'file-exists-p FILENAME)
5931 Note that HANDLER must be able to handle all I/O primitives; if it has
5932 nothing special to do for a primitive, it should reinvoke the
5933 primitive to handle the operation \"the usual way\".
5934 See Info node `(elisp)Magic File Names' for more details. */);
5935 Vfile_name_handler_alist
= Qnil
;
5937 DEFVAR_LISP ("set-auto-coding-function",
5938 Vset_auto_coding_function
,
5939 doc
: /* If non-nil, a function to call to decide a coding system of file.
5940 Two arguments are passed to this function: the file name
5941 and the length of a file contents following the point.
5942 This function should return a coding system to decode the file contents.
5943 It should check the file name against `auto-coding-alist'.
5944 If no coding system is decided, it should check a coding system
5945 specified in the heading lines with the format:
5946 -*- ... coding: CODING-SYSTEM; ... -*-
5947 or local variable spec of the tailing lines with `coding:' tag. */);
5948 Vset_auto_coding_function
= Qnil
;
5950 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5951 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5952 Each is passed one argument, the number of characters inserted,
5953 with point at the start of the inserted text. Each function
5954 should leave point the same, and return the new character count.
5955 If `insert-file-contents' is intercepted by a handler from
5956 `file-name-handler-alist', that handler is responsible for calling the
5957 functions in `after-insert-file-functions' if appropriate. */);
5958 Vafter_insert_file_functions
= Qnil
;
5960 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5961 doc
: /* A list of functions to be called at the start of `write-region'.
5962 Each is passed two arguments, START and END as for `write-region'.
5963 These are usually two numbers but not always; see the documentation
5964 for `write-region'. The function should return a list of pairs
5965 of the form (POSITION . STRING), consisting of strings to be effectively
5966 inserted at the specified positions of the file being written (1 means to
5967 insert before the first byte written). The POSITIONs must be sorted into
5970 If there are several annotation functions, the lists returned by these
5971 functions are merged destructively. As each annotation function runs,
5972 the variable `write-region-annotations-so-far' contains a list of all
5973 annotations returned by previous annotation functions.
5975 An annotation function can return with a different buffer current.
5976 Doing so removes the annotations returned by previous functions, and
5977 resets START and END to `point-min' and `point-max' of the new buffer.
5979 After `write-region' completes, Emacs calls the function stored in
5980 `write-region-post-annotation-function', once for each buffer that was
5981 current when building the annotations (i.e., at least once), with that
5982 buffer current. */);
5983 Vwrite_region_annotate_functions
= Qnil
;
5984 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5986 DEFVAR_LISP ("write-region-post-annotation-function",
5987 Vwrite_region_post_annotation_function
,
5988 doc
: /* Function to call after `write-region' completes.
5989 The function is called with no arguments. If one or more of the
5990 annotation functions in `write-region-annotate-functions' changed the
5991 current buffer, the function stored in this variable is called for
5992 each of those additional buffers as well, in addition to the original
5993 buffer. The relevant buffer is current during each function call. */);
5994 Vwrite_region_post_annotation_function
= Qnil
;
5995 staticpro (&Vwrite_region_annotation_buffers
);
5997 DEFVAR_LISP ("write-region-annotations-so-far",
5998 Vwrite_region_annotations_so_far
,
5999 doc
: /* When an annotation function is called, this holds the previous annotations.
6000 These are the annotations made by other annotation functions
6001 that were already called. See also `write-region-annotate-functions'. */);
6002 Vwrite_region_annotations_so_far
= Qnil
;
6004 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6005 doc
: /* A list of file name handlers that temporarily should not be used.
6006 This applies only to the operation `inhibit-file-name-operation'. */);
6007 Vinhibit_file_name_handlers
= Qnil
;
6009 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6010 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6011 Vinhibit_file_name_operation
= Qnil
;
6013 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6014 doc
: /* File name in which we write a list of all auto save file names.
6015 This variable is initialized automatically from `auto-save-list-file-prefix'
6016 shortly after Emacs reads your init file, if you have not yet given it
6017 a non-nil value. */);
6018 Vauto_save_list_file_name
= Qnil
;
6020 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6021 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6022 Normally auto-save files are written under other names. */);
6023 Vauto_save_visited_file_name
= Qnil
;
6025 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6026 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6027 If nil, deleting a substantial portion of the text disables auto-save
6028 in the buffer; this is the default behavior, because the auto-save
6029 file is usually more useful if it contains the deleted text. */);
6030 Vauto_save_include_big_deletions
= Qnil
;
6032 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6033 doc
: /* Non-nil means don't call fsync in `write-region'.
6034 This variable affects calls to `write-region' as well as save commands.
6035 Setting this to nil may avoid data loss if the system loses power or
6036 the operating system crashes. By default, it is non-nil in batch mode. */);
6037 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6039 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6040 doc
: /* Specifies whether to use the system's trash can.
6041 When non-nil, certain file deletion commands use the function
6042 `move-file-to-trash' instead of deleting files outright.
6043 This includes interactive calls to `delete-file' and
6044 `delete-directory' and the Dired deletion commands. */);
6045 delete_by_moving_to_trash
= 0;
6046 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6048 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6049 DEFSYM (Qcopy_directory
, "copy-directory");
6050 DEFSYM (Qdelete_directory
, "delete-directory");
6051 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");
6053 defsubr (&Sfind_file_name_handler
);
6054 defsubr (&Sfile_name_directory
);
6055 defsubr (&Sfile_name_nondirectory
);
6056 defsubr (&Sunhandled_file_name_directory
);
6057 defsubr (&Sfile_name_as_directory
);
6058 defsubr (&Sdirectory_file_name
);
6059 defsubr (&Smake_temp_name
);
6060 defsubr (&Sexpand_file_name
);
6061 defsubr (&Ssubstitute_in_file_name
);
6062 defsubr (&Scopy_file
);
6063 defsubr (&Smake_directory_internal
);
6064 defsubr (&Sdelete_directory_internal
);
6065 defsubr (&Sdelete_file
);
6066 defsubr (&Srename_file
);
6067 defsubr (&Sadd_name_to_file
);
6068 defsubr (&Smake_symbolic_link
);
6069 defsubr (&Sfile_name_absolute_p
);
6070 defsubr (&Sfile_exists_p
);
6071 defsubr (&Sfile_executable_p
);
6072 defsubr (&Sfile_readable_p
);
6073 defsubr (&Sfile_writable_p
);
6074 defsubr (&Saccess_file
);
6075 defsubr (&Sfile_symlink_p
);
6076 defsubr (&Sfile_directory_p
);
6077 defsubr (&Sfile_accessible_directory_p
);
6078 defsubr (&Sfile_regular_p
);
6079 defsubr (&Sfile_modes
);
6080 defsubr (&Sset_file_modes
);
6081 defsubr (&Sset_file_times
);
6082 defsubr (&Sfile_selinux_context
);
6083 defsubr (&Sfile_acl
);
6084 defsubr (&Sset_file_acl
);
6085 defsubr (&Sset_file_selinux_context
);
6086 defsubr (&Sset_default_file_modes
);
6087 defsubr (&Sdefault_file_modes
);
6088 defsubr (&Sfile_newer_than_file_p
);
6089 defsubr (&Sinsert_file_contents
);
6090 defsubr (&Swrite_region
);
6091 defsubr (&Scar_less_than_car
);
6092 defsubr (&Sverify_visited_file_modtime
);
6093 defsubr (&Svisited_file_modtime
);
6094 defsubr (&Sset_visited_file_modtime
);
6095 defsubr (&Sdo_auto_save
);
6096 defsubr (&Sset_buffer_auto_saved
);
6097 defsubr (&Sclear_buffer_auto_save_failure
);
6098 defsubr (&Srecent_auto_save_p
);
6100 defsubr (&Snext_read_file_uses_dialog_p
);
6103 defsubr (&Sunix_sync
);