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 static Lisp_Object Qchoose_write_coding_system
;
327 Lisp_Object Qwrite_region
;
328 static Lisp_Object Qverify_visited_file_modtime
;
329 static Lisp_Object Qset_visited_file_modtime
;
331 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
332 Sfind_file_name_handler
, 2, 2, 0,
333 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
334 Otherwise, return nil.
335 A file name is handled if one of the regular expressions in
336 `file-name-handler-alist' matches it.
338 If OPERATION equals `inhibit-file-name-operation', then we ignore
339 any handlers that are members of `inhibit-file-name-handlers',
340 but we still do run any other handlers. This lets handlers
341 use the standard functions without calling themselves recursively. */)
342 (Lisp_Object filename
, Lisp_Object operation
)
344 /* This function must not munge the match data. */
345 Lisp_Object chain
, inhibited_handlers
, result
;
349 CHECK_STRING (filename
);
351 if (EQ (operation
, Vinhibit_file_name_operation
))
352 inhibited_handlers
= Vinhibit_file_name_handlers
;
354 inhibited_handlers
= Qnil
;
356 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
357 chain
= XCDR (chain
))
363 Lisp_Object string
= XCAR (elt
);
365 Lisp_Object handler
= XCDR (elt
);
366 Lisp_Object operations
= Qnil
;
368 if (SYMBOLP (handler
))
369 operations
= Fget (handler
, Qoperations
);
372 && (match_pos
= fast_string_match (string
, filename
)) > pos
373 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
377 handler
= XCDR (elt
);
378 tem
= Fmemq (handler
, inhibited_handlers
);
392 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
394 doc
: /* Return the directory component in file name FILENAME.
395 Return nil if FILENAME does not include a directory.
396 Otherwise return a directory name.
397 Given a Unix syntax file name, returns a string ending in slash. */)
398 (Lisp_Object filename
)
401 register const char *beg
;
406 register const char *p
;
409 CHECK_STRING (filename
);
411 /* If the file name has special constructs in it,
412 call the corresponding file handler. */
413 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
416 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
418 return STRINGP (handled_name
) ? handled_name
: Qnil
;
422 beg
= xlispstrdupa (filename
);
424 beg
= SSDATA (filename
);
426 p
= beg
+ SBYTES (filename
);
428 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
430 /* only recognize drive specifier at the beginning */
432 /* handle the "/:d:foo" and "/:foo" cases correctly */
433 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
434 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
441 /* Expansion of "c:" to drive and default directory. */
444 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
445 char *res
= alloca (MAXPATHLEN
+ 1);
448 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
450 memcpy (res
, beg
, 2);
455 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
457 size_t l
= strlen (res
);
459 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
462 p
= beg
+ strlen (beg
);
463 dostounix_filename (beg
);
464 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
465 STRING_MULTIBYTE (filename
));
468 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
469 STRING_MULTIBYTE (filename
));
471 else if (STRING_MULTIBYTE (filename
))
473 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
474 dostounix_filename (SSDATA (tem_fn
));
476 if (!NILP (Vw32_downcase_file_names
))
477 tem_fn
= Fdowncase (tem_fn
);
482 dostounix_filename (beg
);
483 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
487 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
491 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
492 Sfile_name_nondirectory
, 1, 1, 0,
493 doc
: /* Return file name FILENAME sans its directory.
494 For example, in a Unix-syntax file name,
495 this is everything after the last slash,
496 or the entire name if it contains no slash. */)
497 (Lisp_Object filename
)
499 register const char *beg
, *p
, *end
;
502 CHECK_STRING (filename
);
504 /* If the file name has special constructs in it,
505 call the corresponding file handler. */
506 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
509 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
511 if (STRINGP (handled_name
))
513 error ("Invalid handler in `file-name-handler-alist'");
516 beg
= SSDATA (filename
);
517 end
= p
= beg
+ SBYTES (filename
);
519 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
521 /* only recognize drive specifier at beginning */
523 /* handle the "/:d:foo" case correctly */
524 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
529 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
532 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
533 Sunhandled_file_name_directory
, 1, 1, 0,
534 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
535 A `directly usable' directory name is one that may be used without the
536 intervention of any file handler.
537 If FILENAME is a directly usable file itself, return
538 \(file-name-directory FILENAME).
539 If FILENAME refers to a file which is not accessible from a local process,
540 then this should return nil.
541 The `call-process' and `start-process' functions use this function to
542 get a current directory to run processes in. */)
543 (Lisp_Object filename
)
547 /* If the file name has special constructs in it,
548 call the corresponding file handler. */
549 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
552 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
554 return STRINGP (handled_name
) ? handled_name
: Qnil
;
557 return Ffile_name_directory (filename
);
560 /* Maximum number of bytes that DST will be longer than SRC
561 in file_name_as_directory. This occurs when SRCLEN == 0. */
562 enum { file_name_as_directory_slop
= 2 };
564 /* Convert from file name SRC of length SRCLEN to directory name in
565 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
566 string. On UNIX, just make sure there is a terminating /. Return
567 the length of DST in bytes. */
570 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
581 memcpy (dst
, src
, srclen
);
582 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
583 dst
[srclen
++] = DIRECTORY_SEP
;
586 dostounix_filename (dst
);
591 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
592 Sfile_name_as_directory
, 1, 1, 0,
593 doc
: /* Return a string representing the file name FILE interpreted as a directory.
594 This operation exists because a directory is also a file, but its name as
595 a directory is different from its name as a file.
596 The result can be used as the value of `default-directory'
597 or passed as second argument to `expand-file-name'.
598 For a Unix-syntax file name, just appends a slash. */)
603 Lisp_Object handler
, val
;
610 /* If the file name has special constructs in it,
611 call the corresponding file handler. */
612 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
615 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
617 if (STRINGP (handled_name
))
619 error ("Invalid handler in `file-name-handler-alist'");
623 if (!NILP (Vw32_downcase_file_names
))
624 file
= Fdowncase (file
);
626 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
627 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
628 STRING_MULTIBYTE (file
));
629 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
634 /* Convert from directory name SRC of length SRCLEN to file name in
635 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
636 string. On UNIX, just make sure there isn't a terminating /.
637 Return the length of DST in bytes. */
640 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
642 /* Process as Unix format: just remove any final slash.
643 But leave "/" and "//" unchanged. */
646 && !IS_ANY_SEP (src
[srclen
- 2])
648 && IS_DIRECTORY_SEP (src
[srclen
- 1])
649 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
652 memcpy (dst
, src
, srclen
);
655 dostounix_filename (dst
);
660 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
662 doc
: /* Returns the file name of the directory named DIRECTORY.
663 This is the name of the file that holds the data for the directory DIRECTORY.
664 This operation exists because a directory is also a file, but its name as
665 a directory is different from its name as a file.
666 In Unix-syntax, this function just removes the final slash. */)
667 (Lisp_Object directory
)
671 Lisp_Object handler
, val
;
674 CHECK_STRING (directory
);
676 if (NILP (directory
))
679 /* If the file name has special constructs in it,
680 call the corresponding file handler. */
681 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
684 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
686 if (STRINGP (handled_name
))
688 error ("Invalid handler in `file-name-handler-alist'");
692 if (!NILP (Vw32_downcase_file_names
))
693 directory
= Fdowncase (directory
);
695 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
696 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
697 STRING_MULTIBYTE (directory
));
698 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
703 static const char make_temp_name_tbl
[64] =
705 'A','B','C','D','E','F','G','H',
706 'I','J','K','L','M','N','O','P',
707 'Q','R','S','T','U','V','W','X',
708 'Y','Z','a','b','c','d','e','f',
709 'g','h','i','j','k','l','m','n',
710 'o','p','q','r','s','t','u','v',
711 'w','x','y','z','0','1','2','3',
712 '4','5','6','7','8','9','-','_'
715 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
717 /* Value is a temporary file name starting with PREFIX, a string.
719 The Emacs process number forms part of the result, so there is
720 no danger of generating a name being used by another process.
721 In addition, this function makes an attempt to choose a name
722 which has no existing file. To make this work, PREFIX should be
723 an absolute file name.
725 BASE64_P means add the pid as 3 characters in base64
726 encoding. In this case, 6 characters will be added to PREFIX to
727 form the file name. Otherwise, if Emacs is running on a system
728 with long file names, add the pid as a decimal number.
730 This function signals an error if no unique file name could be
734 make_temp_name (Lisp_Object prefix
, bool base64_p
)
736 Lisp_Object val
, encoded_prefix
;
740 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
743 CHECK_STRING (prefix
);
745 /* VAL is created by adding 6 characters to PREFIX. The first
746 three are the PID of this process, in base 64, and the second
747 three are incremented if the file already exists. This ensures
748 262144 unique file names per PID per PREFIX. */
754 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
755 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
756 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
761 #ifdef HAVE_LONG_FILE_NAMES
762 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
764 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
765 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
766 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
771 encoded_prefix
= ENCODE_FILE (prefix
);
772 len
= SBYTES (encoded_prefix
);
773 val
= make_uninit_string (len
+ 3 + pidlen
);
775 memcpy (data
, SSDATA (encoded_prefix
), len
);
778 memcpy (p
, pidbuf
, pidlen
);
781 /* Here we try to minimize useless stat'ing when this function is
782 invoked many times successively with the same PREFIX. We achieve
783 this by initializing count to a random value, and incrementing it
786 We don't want make-temp-name to be called while dumping,
787 because then make_temp_name_count_initialized_p would get set
788 and then make_temp_name_count would not be set when Emacs starts. */
790 if (!make_temp_name_count_initialized_p
)
792 make_temp_name_count
= time (NULL
);
793 make_temp_name_count_initialized_p
= 1;
798 unsigned num
= make_temp_name_count
;
800 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
801 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
802 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
804 /* Poor man's congruential RN generator. Replace with
805 ++make_temp_name_count for debugging. */
806 make_temp_name_count
+= 25229;
807 make_temp_name_count
%= 225307;
809 if (!check_existing (data
))
811 /* We want to return only if errno is ENOENT. */
813 return DECODE_FILE (val
);
815 /* The error here is dubious, but there is little else we
816 can do. The alternatives are to return nil, which is
817 as bad as (and in many cases worse than) throwing the
818 error, or to ignore the error, which will likely result
819 in looping through 225307 stat's, which is not only
820 dog-slow, but also useless since eventually nil would
821 have to be returned anyway. */
822 report_file_error ("Cannot create temporary name for prefix",
830 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
831 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
832 The Emacs process number forms part of the result,
833 so there is no danger of generating a name being used by another process.
835 In addition, this function makes an attempt to choose a name
836 which has no existing file. To make this work,
837 PREFIX should be an absolute file name.
839 There is a race condition between calling `make-temp-name' and creating the
840 file which opens all kinds of security holes. For that reason, you should
841 probably use `make-temp-file' instead, except in three circumstances:
843 * If you are creating the file in the user's home directory.
844 * If you are creating a directory rather than an ordinary file.
845 * If you are taking special precautions as `make-temp-file' does. */)
848 return make_temp_name (prefix
, 0);
853 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
854 doc
: /* Convert filename NAME to absolute, and canonicalize it.
855 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
856 \(does not start with slash or tilde); both the directory name and
857 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
858 missing, the current buffer's value of `default-directory' is used.
859 NAME should be a string that is a valid file name for the underlying
861 File name components that are `.' are removed, and
862 so are file name components followed by `..', along with the `..' itself;
863 note that these simplifications are done without checking the resulting
864 file names in the file system.
865 Multiple consecutive slashes are collapsed into a single slash,
866 except at the beginning of the file name when they are significant (e.g.,
867 UNC file names on MS-Windows.)
868 An initial `~/' expands to your home directory.
869 An initial `~USER/' expands to USER's home directory.
870 See also the function `substitute-in-file-name'.
872 For technical reasons, this function can return correct but
873 non-intuitive results for the root directory; for instance,
874 \(expand-file-name ".." "/") returns "/..". For this reason, use
875 \(directory-file-name (file-name-directory dirname)) to traverse a
876 filesystem tree, not (expand-file-name ".." dirname). */)
877 (Lisp_Object name
, Lisp_Object default_directory
)
879 /* These point to SDATA and need to be careful with string-relocation
880 during GC (via DECODE_FILE). */
883 /* This should only point to alloca'd data. */
890 bool collapse_newdir
= 1;
894 Lisp_Object handler
, result
, handled_name
;
901 /* If the file name has special constructs in it,
902 call the corresponding file handler. */
903 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
906 handled_name
= call3 (handler
, Qexpand_file_name
,
907 name
, default_directory
);
908 if (STRINGP (handled_name
))
910 error ("Invalid handler in `file-name-handler-alist'");
914 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
915 if (NILP (default_directory
))
916 default_directory
= BVAR (current_buffer
, directory
);
917 if (! STRINGP (default_directory
))
920 /* "/" is not considered a root directory on DOS_NT, so using "/"
921 here causes an infinite recursion in, e.g., the following:
923 (let (default-directory)
924 (expand-file-name "a"))
926 To avoid this, we set default_directory to the root of the
928 default_directory
= build_string (emacs_root_dir ());
930 default_directory
= build_string ("/");
934 if (!NILP (default_directory
))
936 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
939 handled_name
= call3 (handler
, Qexpand_file_name
,
940 name
, default_directory
);
941 if (STRINGP (handled_name
))
943 error ("Invalid handler in `file-name-handler-alist'");
948 char *o
= SSDATA (default_directory
);
950 /* Make sure DEFAULT_DIRECTORY is properly expanded.
951 It would be better to do this down below where we actually use
952 default_directory. Unfortunately, calling Fexpand_file_name recursively
953 could invoke GC, and the strings might be relocated. This would
954 be annoying because we have pointers into strings lying around
955 that would need adjusting, and people would add new pointers to
956 the code and forget to adjust them, resulting in intermittent bugs.
957 Putting this call here avoids all that crud.
959 The EQ test avoids infinite recursion. */
960 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
961 /* Save time in some common cases - as long as default_directory
962 is not relative, it can be canonicalized with name below (if it
963 is needed at all) without requiring it to be expanded now. */
965 /* Detect MSDOS file names with drive specifiers. */
966 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
967 && IS_DIRECTORY_SEP (o
[2]))
969 /* Detect Windows file names in UNC format. */
970 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
972 #else /* not DOS_NT */
973 /* Detect Unix absolute file names (/... alone is not absolute on
975 && ! (IS_DIRECTORY_SEP (o
[0]))
976 #endif /* not DOS_NT */
982 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
986 multibyte
= STRING_MULTIBYTE (name
);
987 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
991 unsigned char *p
= SDATA (name
);
993 while (*p
&& ASCII_BYTE_P (*p
))
997 /* NAME is a pure ASCII string, and DEFAULT_DIRECTORY is
998 unibyte. Do not convert DEFAULT_DIRECTORY to
999 multibyte; instead, convert NAME to a unibyte string,
1000 so that the result of this function is also a unibyte
1001 string. This is needed during bootstrapping and
1002 dumping, when Emacs cannot decode file names, because
1003 the locale environment is not set up. */
1004 name
= make_unibyte_string (SSDATA (name
), SBYTES (name
));
1008 default_directory
= string_to_multibyte (default_directory
);
1012 name
= string_to_multibyte (name
);
1018 if (!NILP (Vw32_downcase_file_names
))
1019 default_directory
= Fdowncase (default_directory
);
1022 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
1023 nm
= xlispstrdupa (name
);
1026 /* Note if special escape prefix is present, but remove for now. */
1027 if (nm
[0] == '/' && nm
[1] == ':')
1033 /* Find and remove drive specifier if present; this makes nm absolute
1034 even if the rest of the name appears to be relative. Only look for
1035 drive specifier at the beginning. */
1036 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1038 drive
= (unsigned char) nm
[0];
1043 /* If we see "c://somedir", we want to strip the first slash after the
1044 colon when stripping the drive letter. Otherwise, this expands to
1046 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1049 /* Discard any previous drive specifier if nm is now in UNC format. */
1050 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1051 && !IS_DIRECTORY_SEP (nm
[2]))
1053 #endif /* WINDOWSNT */
1056 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1057 none are found, we can probably return right away. We will avoid
1058 allocating a new string if name is already fully expanded. */
1060 IS_DIRECTORY_SEP (nm
[0])
1062 && drive
&& !is_escaped
1065 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1069 /* If it turns out that the filename we want to return is just a
1070 suffix of FILENAME, we don't need to go through and edit
1071 things; we just need to construct a new string using data
1072 starting at the middle of FILENAME. If we set LOSE, that
1073 means we've discovered that we can't do that cool trick. */
1079 /* Since we know the name is absolute, we can assume that each
1080 element starts with a "/". */
1082 /* "." and ".." are hairy. */
1083 if (IS_DIRECTORY_SEP (p
[0])
1085 && (IS_DIRECTORY_SEP (p
[2])
1087 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1090 /* Replace multiple slashes with a single one, except
1091 leave leading "//" alone. */
1092 else if (IS_DIRECTORY_SEP (p
[0])
1093 && IS_DIRECTORY_SEP (p
[1])
1094 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1101 /* Make sure directories are all separated with /, but
1102 avoid allocation of a new string when not required. */
1103 dostounix_filename (nm
);
1105 if (IS_DIRECTORY_SEP (nm
[1]))
1107 if (strcmp (nm
, SSDATA (name
)) != 0)
1108 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1112 /* Drive must be set, so this is okay. */
1113 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1117 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1118 temp
[0] = DRIVE_LETTER (drive
);
1119 name
= concat2 (build_string (temp
), name
);
1122 if (!NILP (Vw32_downcase_file_names
))
1123 name
= Fdowncase (name
);
1126 #else /* not DOS_NT */
1127 if (strcmp (nm
, SSDATA (name
)) == 0)
1129 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1130 #endif /* not DOS_NT */
1134 /* At this point, nm might or might not be an absolute file name. We
1135 need to expand ~ or ~user if present, otherwise prefix nm with
1136 default_directory if nm is not absolute, and finally collapse /./
1137 and /foo/../ sequences.
1139 We set newdir to be the appropriate prefix if one is needed:
1140 - the relevant user directory if nm starts with ~ or ~user
1141 - the specified drive's working dir (DOS/NT only) if nm does not
1143 - the value of default_directory.
1145 Note that these prefixes are not guaranteed to be absolute (except
1146 for the working dir of a drive). Therefore, to ensure we always
1147 return an absolute name, if the final prefix is not absolute we
1148 append it to the current working directory. */
1152 if (nm
[0] == '~') /* prefix ~ */
1154 if (IS_DIRECTORY_SEP (nm
[1])
1155 || nm
[1] == 0) /* ~ by itself */
1159 if (!(newdir
= egetenv ("HOME")))
1162 /* `egetenv' may return a unibyte string, which will bite us since
1163 we expect the directory to be multibyte. */
1167 char newdir_utf8
[MAX_UTF8_PATH
];
1169 filename_from_ansi (newdir
, newdir_utf8
);
1170 tem
= build_string (newdir_utf8
);
1174 tem
= build_string (newdir
);
1175 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1177 hdir
= DECODE_FILE (tem
);
1178 newdir
= SSDATA (hdir
);
1181 collapse_newdir
= 0;
1184 else /* ~user/filename */
1187 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1189 o
= SAFE_ALLOCA (p
- nm
+ 1);
1190 memcpy (o
, nm
, p
- nm
);
1194 pw
= getpwnam (o
+ 1);
1200 newdir
= pw
->pw_dir
;
1201 /* `getpwnam' may return a unibyte string, which will
1202 bite us since we expect the directory to be
1204 tem
= build_string (newdir
);
1205 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1207 hdir
= DECODE_FILE (tem
);
1208 newdir
= SSDATA (hdir
);
1212 collapse_newdir
= 0;
1216 /* If we don't find a user of that name, leave the name
1217 unchanged; don't move nm forward to p. */
1222 /* On DOS and Windows, nm is absolute if a drive name was specified;
1223 use the drive's current directory as the prefix if needed. */
1224 if (!newdir
&& drive
)
1226 /* Get default directory if needed to make nm absolute. */
1228 if (!IS_DIRECTORY_SEP (nm
[0]))
1230 adir
= alloca (MAXPATHLEN
+ 1);
1231 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1235 Lisp_Object tem
= build_string (adir
);
1237 tem
= DECODE_FILE (tem
);
1238 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1243 /* Either nm starts with /, or drive isn't mounted. */
1245 adir
[0] = DRIVE_LETTER (drive
);
1254 /* Finally, if no prefix has been specified and nm is not absolute,
1255 then it must be expanded relative to default_directory. */
1259 /* /... alone is not absolute on DOS and Windows. */
1260 && !IS_DIRECTORY_SEP (nm
[0])
1263 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1264 && !IS_DIRECTORY_SEP (nm
[2]))
1268 newdir
= SSDATA (default_directory
);
1270 /* Note if special escape prefix is present, but remove for now. */
1271 if (newdir
[0] == '/' && newdir
[1] == ':')
1282 /* First ensure newdir is an absolute name. */
1284 /* Detect MSDOS file names with drive specifiers. */
1285 ! (IS_DRIVE (newdir
[0])
1286 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1288 /* Detect Windows file names in UNC format. */
1289 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1290 && !IS_DIRECTORY_SEP (newdir
[2]))
1294 /* Effectively, let newdir be (expand-file-name newdir cwd).
1295 Because of the admonition against calling expand-file-name
1296 when we have pointers into lisp strings, we accomplish this
1297 indirectly by prepending newdir to nm if necessary, and using
1298 cwd (or the wd of newdir's drive) as the new newdir. */
1301 const int adir_size
= MAX_UTF8_PATH
;
1303 const int adir_size
= MAXPATHLEN
+ 1;
1306 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1308 drive
= (unsigned char) newdir
[0];
1311 if (!IS_DIRECTORY_SEP (nm
[0]))
1313 ptrdiff_t newlen
= strlen (newdir
);
1314 char *tmp
= alloca (newlen
+ file_name_as_directory_slop
1316 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1320 adir
= alloca (adir_size
);
1323 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1327 getcwd (adir
, adir_size
);
1330 Lisp_Object tem
= build_string (adir
);
1332 tem
= DECODE_FILE (tem
);
1333 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1338 /* Strip off drive name from prefix, if present. */
1339 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1345 /* Keep only a prefix from newdir if nm starts with slash
1346 (//server/share for UNC, nothing otherwise). */
1347 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1350 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1351 && !IS_DIRECTORY_SEP (newdir
[2]))
1353 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1355 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1357 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1370 /* Ignore any slash at the end of newdir, unless newdir is
1371 just "/" or "//". */
1372 length
= strlen (newdir
);
1373 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1374 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1380 /* Now concatenate the directory and name to new space in the stack frame. */
1381 tlen
= length
+ file_name_as_directory_slop
+ strlen (nm
) + 1;
1383 /* Reserve space for drive specifier and escape prefix, since either
1384 or both may need to be inserted. (The Microsoft x86 compiler
1385 produces incorrect code if the following two lines are combined.) */
1386 target
= alloca (tlen
+ 4);
1388 #else /* not DOS_NT */
1389 target
= SAFE_ALLOCA (tlen
);
1390 #endif /* not DOS_NT */
1395 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1398 /* If newdir is effectively "C:/", then the drive letter will have
1399 been stripped and newdir will be "/". Concatenating with an
1400 absolute directory in nm produces "//", which will then be
1401 incorrectly treated as a network share. Ignore newdir in
1402 this case (keeping the drive letter). */
1403 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1404 && newdir
[1] == '\0'))
1407 memcpy (target
, newdir
, length
);
1412 file_name_as_directory (target
, newdir
, length
, multibyte
);
1415 strcat (target
, nm
);
1417 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1425 if (!IS_DIRECTORY_SEP (*p
))
1429 else if (p
[1] == '.'
1430 && (IS_DIRECTORY_SEP (p
[2])
1433 /* If "/." is the entire filename, keep the "/". Otherwise,
1434 just delete the whole "/.". */
1435 if (o
== target
&& p
[2] == '\0')
1439 else if (p
[1] == '.' && p
[2] == '.'
1440 /* `/../' is the "superroot" on certain file systems.
1441 Turned off on DOS_NT systems because they have no
1442 "superroot" and because this causes us to produce
1443 file names like "d:/../foo" which fail file-related
1444 functions of the underlying OS. (To reproduce, try a
1445 long series of "../../" in default_directory, longer
1446 than the number of levels from the root.) */
1450 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1455 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1458 /* Don't go below server level in UNC filenames. */
1459 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1460 && IS_DIRECTORY_SEP (*target
))
1464 /* Keep initial / only if this is the whole name. */
1465 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1469 else if (IS_DIRECTORY_SEP (p
[1])
1470 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1471 /* Collapse multiple "/", except leave leading "//" alone. */
1480 /* At last, set drive name. */
1482 /* Except for network file name. */
1483 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1484 #endif /* WINDOWSNT */
1486 if (!drive
) emacs_abort ();
1488 target
[0] = DRIVE_LETTER (drive
);
1491 /* Reinsert the escape prefix if required. */
1498 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1499 dostounix_filename (SSDATA (result
));
1501 if (!NILP (Vw32_downcase_file_names
))
1502 result
= Fdowncase (result
);
1505 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1506 #endif /* !DOS_NT */
1509 /* Again look to see if the file name has special constructs in it
1510 and perhaps call the corresponding file handler. This is needed
1511 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1512 the ".." component gives us "/user@host:/bar/../baz" which needs
1513 to be expanded again. */
1514 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1515 if (!NILP (handler
))
1517 handled_name
= call3 (handler
, Qexpand_file_name
,
1518 result
, default_directory
);
1519 if (! STRINGP (handled_name
))
1520 error ("Invalid handler in `file-name-handler-alist'");
1521 result
= handled_name
;
1529 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1530 This is the old version of expand-file-name, before it was thoroughly
1531 rewritten for Emacs 10.31. We leave this version here commented-out,
1532 because the code is very complex and likely to have subtle bugs. If
1533 bugs _are_ found, it might be of interest to look at the old code and
1534 see what did it do in the relevant situation.
1536 Don't remove this code: it's true that it will be accessible
1537 from the repository, but a few years from deletion, people will
1538 forget it is there. */
1540 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1541 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1542 "Convert FILENAME to absolute, and canonicalize it.\n\
1543 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1544 \(does not start with slash); if DEFAULT is nil or missing,\n\
1545 the current buffer's value of default-directory is used.\n\
1546 Filenames containing `.' or `..' as components are simplified;\n\
1547 initial `~/' expands to your home directory.\n\
1548 See also the function `substitute-in-file-name'.")
1550 Lisp_Object name
, defalt
;
1554 register unsigned char *newdir
, *p
, *o
;
1556 unsigned char *target
;
1559 CHECK_STRING (name
);
1562 /* If nm is absolute, flush ...// and detect /./ and /../.
1563 If no /./ or /../ we can return right away. */
1570 if (p
[0] == '/' && p
[1] == '/')
1572 if (p
[0] == '/' && p
[1] == '~')
1573 nm
= p
+ 1, lose
= 1;
1574 if (p
[0] == '/' && p
[1] == '.'
1575 && (p
[2] == '/' || p
[2] == 0
1576 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1582 if (nm
== SDATA (name
))
1584 return build_string (nm
);
1588 /* Now determine directory to start with and put it in NEWDIR. */
1592 if (nm
[0] == '~') /* prefix ~ */
1593 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1595 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1596 newdir
= (unsigned char *) "";
1599 else /* ~user/filename */
1601 /* Get past ~ to user. */
1602 unsigned char *user
= nm
+ 1;
1603 /* Find end of name. */
1604 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1605 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1606 /* Copy the user name into temp storage. */
1607 o
= alloca (len
+ 1);
1608 memcpy (o
, user
, len
);
1611 /* Look up the user name. */
1613 pw
= (struct passwd
*) getpwnam (o
+ 1);
1616 error ("\"%s\" isn't a registered user", o
+ 1);
1618 newdir
= (unsigned char *) pw
->pw_dir
;
1620 /* Discard the user name from NM. */
1624 if (nm
[0] != '/' && !newdir
)
1627 defalt
= current_buffer
->directory
;
1628 CHECK_STRING (defalt
);
1629 newdir
= SDATA (defalt
);
1632 /* Now concatenate the directory and name to new space in the stack frame. */
1634 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1635 target
= alloca (tlen
);
1640 if (nm
[0] == 0 || nm
[0] == '/')
1641 strcpy (target
, newdir
);
1643 file_name_as_directory (target
, newdir
);
1646 strcat (target
, nm
);
1648 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1659 else if (!strncmp (p
, "//", 2)
1665 else if (p
[0] == '/' && p
[1] == '.'
1666 && (p
[2] == '/' || p
[2] == 0))
1668 else if (!strncmp (p
, "/..", 3)
1669 /* `/../' is the "superroot" on certain file systems. */
1671 && (p
[3] == '/' || p
[3] == 0))
1673 while (o
!= target
&& *--o
!= '/')
1675 if (o
== target
&& *o
== '/')
1685 return make_string (target
, o
- target
);
1689 /* If /~ or // appears, discard everything through first slash. */
1691 file_name_absolute_p (const char *filename
)
1694 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1696 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1697 && IS_DIRECTORY_SEP (filename
[2]))
1703 search_embedded_absfilename (char *nm
, char *endp
)
1707 for (p
= nm
+ 1; p
< endp
; p
++)
1709 if (IS_DIRECTORY_SEP (p
[-1])
1710 && file_name_absolute_p (p
)
1711 #if defined (WINDOWSNT) || defined (CYGWIN)
1712 /* // at start of file name is meaningful in Apollo,
1713 WindowsNT and Cygwin systems. */
1714 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1715 #endif /* not (WINDOWSNT || CYGWIN) */
1718 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1719 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1721 char *o
= alloca (s
- p
+ 1);
1723 memcpy (o
, p
, s
- p
);
1726 /* If we have ~user and `user' exists, discard
1727 everything up to ~. But if `user' does not exist, leave
1728 ~user alone, it might be a literal file name. */
1730 pw
= getpwnam (o
+ 1);
1742 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1743 Ssubstitute_in_file_name
, 1, 1, 0,
1744 doc
: /* Substitute environment variables referred to in FILENAME.
1745 `$FOO' where FOO is an environment variable name means to substitute
1746 the value of that variable. The variable name should be terminated
1747 with a character not a letter, digit or underscore; otherwise, enclose
1748 the entire variable name in braces.
1750 If `/~' appears, all of FILENAME through that `/' is discarded.
1751 If `//' appears, everything up to and including the first of
1752 those `/' is discarded. */)
1753 (Lisp_Object filename
)
1755 char *nm
, *p
, *x
, *endp
;
1756 bool substituted
= false;
1759 Lisp_Object handler
;
1761 CHECK_STRING (filename
);
1763 multibyte
= STRING_MULTIBYTE (filename
);
1765 /* If the file name has special constructs in it,
1766 call the corresponding file handler. */
1767 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1768 if (!NILP (handler
))
1770 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1772 if (STRINGP (handled_name
))
1773 return handled_name
;
1774 error ("Invalid handler in `file-name-handler-alist'");
1777 /* Always work on a copy of the string, in case GC happens during
1778 decode of environment variables, causing the original Lisp_String
1779 data to be relocated. */
1780 nm
= xlispstrdupa (filename
);
1783 dostounix_filename (nm
);
1784 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1786 endp
= nm
+ SBYTES (filename
);
1788 /* If /~ or // appears, discard everything through first slash. */
1789 p
= search_embedded_absfilename (nm
, endp
);
1791 /* Start over with the new string, so we check the file-name-handler
1792 again. Important with filenames like "/home/foo//:/hello///there"
1793 which would substitute to "/:/hello///there" rather than "/there". */
1794 return Fsubstitute_in_file_name
1795 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1797 /* See if any variables are substituted into the string. */
1799 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1802 = (!substituted
? filename
1803 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1804 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1806 if (!EQ (tmp
, name
))
1814 if (!NILP (Vw32_downcase_file_names
))
1815 filename
= Fdowncase (filename
);
1820 xnm
= SSDATA (filename
);
1821 x
= xnm
+ SBYTES (filename
);
1823 /* If /~ or // appears, discard everything through first slash. */
1824 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1825 /* This time we do not start over because we've already expanded envvars
1826 and replaced $$ with $. Maybe we should start over as well, but we'd
1827 need to quote some $ to $$ first. */
1831 if (!NILP (Vw32_downcase_file_names
))
1833 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1835 xname
= Fdowncase (xname
);
1840 return (xnm
== SSDATA (filename
)
1842 : make_specified_string (xnm
, -1, x
- xnm
, multibyte
));
1845 /* A slightly faster and more convenient way to get
1846 (directory-file-name (expand-file-name FOO)). */
1849 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1851 register Lisp_Object absname
;
1853 absname
= Fexpand_file_name (filename
, defdir
);
1855 /* Remove final slash, if any (unless this is the root dir).
1856 stat behaves differently depending! */
1857 if (SCHARS (absname
) > 1
1858 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1859 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1860 /* We cannot take shortcuts; they might be wrong for magic file names. */
1861 absname
= Fdirectory_file_name (absname
);
1865 /* Signal an error if the file ABSNAME already exists.
1866 If KNOWN_TO_EXIST, the file is known to exist.
1867 QUERYSTRING is a name for the action that is being considered
1869 If INTERACTIVE, ask the user whether to proceed,
1870 and bypass the error if the user says to go ahead.
1871 If QUICK, ask for y or n, not yes or no. */
1874 barf_or_query_if_file_exists (Lisp_Object absname
, bool known_to_exist
,
1875 const char *querystring
, bool interactive
,
1878 Lisp_Object tem
, encoded_filename
;
1879 struct stat statbuf
;
1880 struct gcpro gcpro1
;
1882 encoded_filename
= ENCODE_FILE (absname
);
1884 if (! known_to_exist
&& lstat (SSDATA (encoded_filename
), &statbuf
) == 0)
1886 if (S_ISDIR (statbuf
.st_mode
))
1887 xsignal2 (Qfile_error
,
1888 build_string ("File is a directory"), absname
);
1889 known_to_exist
= true;
1895 xsignal2 (Qfile_already_exists
,
1896 build_string ("File already exists"), absname
);
1898 tem
= format2 ("File %s already exists; %s anyway? ",
1899 absname
, build_string (querystring
));
1901 tem
= call1 (intern ("y-or-n-p"), tem
);
1903 tem
= do_yes_or_no_p (tem
);
1906 xsignal2 (Qfile_already_exists
,
1907 build_string ("File already exists"), absname
);
1911 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1912 "fCopy file: \nGCopy %s to file: \np\nP",
1913 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1914 If NEWNAME names a directory, copy FILE there.
1916 This function always sets the file modes of the output file to match
1919 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1920 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1921 signal a `file-already-exists' error without overwriting. If
1922 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1923 about overwriting; this is what happens in interactive use with M-x.
1924 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1927 Fourth arg KEEP-TIME non-nil means give the output file the same
1928 last-modified time as the old one. (This works on only some systems.)
1930 A prefix arg makes KEEP-TIME non-nil.
1932 If PRESERVE-UID-GID is non-nil, we try to transfer the
1933 uid and gid of FILE to NEWNAME.
1935 If PRESERVE-PERMISSIONS is non-nil, copy permissions of FILE to NEWNAME;
1936 this includes the file modes, along with ACL entries and SELinux
1937 context if present. Otherwise, if NEWNAME is created its file
1938 permission bits are those of FILE, masked by the default file
1940 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
,
1941 Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
,
1942 Lisp_Object preserve_permissions
)
1944 Lisp_Object handler
;
1945 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1946 ptrdiff_t count
= SPECPDL_INDEX ();
1947 Lisp_Object encoded_file
, encoded_newname
;
1949 security_context_t con
;
1955 bool already_exists
= false;
1959 char buf
[16 * 1024];
1963 encoded_file
= encoded_newname
= Qnil
;
1964 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1965 CHECK_STRING (file
);
1966 CHECK_STRING (newname
);
1968 if (!NILP (Ffile_directory_p (newname
)))
1969 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1971 newname
= Fexpand_file_name (newname
, Qnil
);
1973 file
= Fexpand_file_name (file
, Qnil
);
1975 /* If the input file name has special constructs in it,
1976 call the corresponding file handler. */
1977 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1978 /* Likewise for output file name. */
1980 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1981 if (!NILP (handler
))
1982 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1983 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1984 preserve_permissions
));
1986 encoded_file
= ENCODE_FILE (file
);
1987 encoded_newname
= ENCODE_FILE (newname
);
1990 if (NILP (ok_if_already_exists
)
1991 || INTEGERP (ok_if_already_exists
))
1992 barf_or_query_if_file_exists (newname
, false, "copy to it",
1993 INTEGERP (ok_if_already_exists
), false);
1995 result
= w32_copy_file (SSDATA (encoded_file
), SSDATA (encoded_newname
),
1996 !NILP (keep_time
), !NILP (preserve_uid_gid
),
1997 !NILP (preserve_permissions
));
2001 report_file_error ("Copying file", list2 (file
, newname
));
2003 report_file_error ("Copying permissions from", file
);
2005 xsignal2 (Qfile_date_error
,
2006 build_string ("Resetting file times"), newname
);
2008 report_file_error ("Copying permissions to", newname
);
2010 #else /* not WINDOWSNT */
2012 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2016 report_file_error ("Opening input file", file
);
2018 record_unwind_protect_int (close_file_unwind
, ifd
);
2020 if (fstat (ifd
, &st
) != 0)
2021 report_file_error ("Input file status", file
);
2023 if (!NILP (preserve_permissions
))
2026 if (is_selinux_enabled ())
2028 conlength
= fgetfilecon (ifd
, &con
);
2029 if (conlength
== -1)
2030 report_file_error ("Doing fgetfilecon", file
);
2035 /* We can copy only regular files. */
2036 if (!S_ISREG (st
.st_mode
))
2037 report_file_errno ("Non-regular file", file
,
2038 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
2041 new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0700 : 0777);
2043 new_mask
= S_IREAD
| S_IWRITE
;
2046 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
| O_CREAT
| O_EXCL
,
2048 if (ofd
< 0 && errno
== EEXIST
)
2050 if (NILP (ok_if_already_exists
) || INTEGERP (ok_if_already_exists
))
2051 barf_or_query_if_file_exists (newname
, true, "copy to it",
2052 INTEGERP (ok_if_already_exists
), false);
2053 already_exists
= true;
2054 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
, 0);
2057 report_file_error ("Opening output file", newname
);
2059 record_unwind_protect_int (close_file_unwind
, ofd
);
2064 if (fstat (ofd
, &out_st
) != 0)
2065 report_file_error ("Output file status", newname
);
2066 if (st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2067 report_file_errno ("Input and output files are the same",
2068 list2 (file
, newname
), 0);
2069 if (ftruncate (ofd
, 0) != 0)
2070 report_file_error ("Truncating output file", newname
);
2075 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2076 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2077 report_file_error ("Write error", newname
);
2081 /* Preserve the original file permissions, and if requested, also its
2084 mode_t preserved_permissions
= st
.st_mode
& 07777;
2085 mode_t default_permissions
= st
.st_mode
& 0777 & ~realmask
;
2086 if (!NILP (preserve_uid_gid
))
2088 /* Attempt to change owner and group. If that doesn't work
2089 attempt to change just the group, as that is sometimes allowed.
2090 Adjust the mode mask to eliminate setuid or setgid bits
2091 or group permissions bits that are inappropriate if the
2092 owner or group are wrong. */
2093 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2095 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2096 preserved_permissions
&= ~04000;
2099 preserved_permissions
&= ~06000;
2101 /* Copy the other bits to the group bits, since the
2103 preserved_permissions
&= ~070;
2104 preserved_permissions
|= (preserved_permissions
& 7) << 3;
2105 default_permissions
&= ~070;
2106 default_permissions
|= (default_permissions
& 7) << 3;
2111 switch (!NILP (preserve_permissions
)
2112 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2113 SSDATA (encoded_newname
), ofd
,
2114 preserved_permissions
)
2116 || (new_mask
& ~realmask
) == default_permissions
)
2118 : fchmod (ofd
, default_permissions
))
2120 case -2: report_file_error ("Copying permissions from", file
);
2121 case -1: report_file_error ("Copying permissions to", newname
);
2124 #endif /* not MSDOS */
2129 /* Set the modified context back to the file. */
2130 bool fail
= fsetfilecon (ofd
, con
) != 0;
2131 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2132 if (fail
&& errno
!= ENOTSUP
)
2133 report_file_error ("Doing fsetfilecon", newname
);
2139 if (!NILP (keep_time
))
2141 struct timespec atime
= get_stat_atime (&st
);
2142 struct timespec mtime
= get_stat_mtime (&st
);
2143 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
) != 0)
2144 xsignal2 (Qfile_date_error
,
2145 build_string ("Cannot set file date"), newname
);
2148 if (emacs_close (ofd
) < 0)
2149 report_file_error ("Write error", newname
);
2154 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2155 and if it can't, it tells so. Otherwise, under MSDOS we usually
2156 get only the READ bit, which will make the copied file read-only,
2157 so it's better not to chmod at all. */
2158 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2159 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2161 #endif /* not WINDOWSNT */
2163 /* Discard the unwind protects. */
2164 specpdl_ptr
= specpdl
+ count
;
2170 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2171 Smake_directory_internal
, 1, 1, 0,
2172 doc
: /* Create a new directory named DIRECTORY. */)
2173 (Lisp_Object directory
)
2176 Lisp_Object handler
;
2177 Lisp_Object encoded_dir
;
2179 CHECK_STRING (directory
);
2180 directory
= Fexpand_file_name (directory
, Qnil
);
2182 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2183 if (!NILP (handler
))
2184 return call2 (handler
, Qmake_directory_internal
, directory
);
2186 encoded_dir
= ENCODE_FILE (directory
);
2188 dir
= SSDATA (encoded_dir
);
2191 if (mkdir (dir
) != 0)
2193 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2195 report_file_error ("Creating directory", directory
);
2200 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2201 Sdelete_directory_internal
, 1, 1, 0,
2202 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2203 (Lisp_Object directory
)
2206 Lisp_Object encoded_dir
;
2208 CHECK_STRING (directory
);
2209 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2210 encoded_dir
= ENCODE_FILE (directory
);
2211 dir
= SSDATA (encoded_dir
);
2213 if (rmdir (dir
) != 0)
2214 report_file_error ("Removing directory", directory
);
2219 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2220 "(list (read-file-name \
2221 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2222 \"Move file to trash: \" \"Delete file: \") \
2223 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2224 (null current-prefix-arg))",
2225 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2226 If file has multiple names, it continues to exist with the other names.
2227 TRASH non-nil means to trash the file instead of deleting, provided
2228 `delete-by-moving-to-trash' is non-nil.
2230 When called interactively, TRASH is t if no prefix argument is given.
2231 With a prefix argument, TRASH is nil. */)
2232 (Lisp_Object filename
, Lisp_Object trash
)
2234 Lisp_Object handler
;
2235 Lisp_Object encoded_file
;
2236 struct gcpro gcpro1
;
2239 if (!NILP (Ffile_directory_p (filename
))
2240 && NILP (Ffile_symlink_p (filename
)))
2241 xsignal2 (Qfile_error
,
2242 build_string ("Removing old name: is a directory"),
2245 filename
= Fexpand_file_name (filename
, Qnil
);
2247 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2248 if (!NILP (handler
))
2249 return call3 (handler
, Qdelete_file
, filename
, trash
);
2251 if (delete_by_moving_to_trash
&& !NILP (trash
))
2252 return call1 (Qmove_file_to_trash
, filename
);
2254 encoded_file
= ENCODE_FILE (filename
);
2256 if (unlink (SSDATA (encoded_file
)) < 0)
2257 report_file_error ("Removing old name", filename
);
2262 internal_delete_file_1 (Lisp_Object ignore
)
2267 /* Delete file FILENAME, returning true if successful.
2268 This ignores `delete-by-moving-to-trash'. */
2271 internal_delete_file (Lisp_Object filename
)
2275 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2276 Qt
, internal_delete_file_1
);
2280 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2281 "fRename file: \nGRename %s to file: \np",
2282 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2283 If file has names other than FILE, it continues to have those names.
2284 Signals a `file-already-exists' error if a file NEWNAME already exists
2285 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2286 A number as third arg means request confirmation if NEWNAME already exists.
2287 This is what happens in interactive use with M-x. */)
2288 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2290 Lisp_Object handler
;
2291 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2292 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2294 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2295 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2296 CHECK_STRING (file
);
2297 CHECK_STRING (newname
);
2298 file
= Fexpand_file_name (file
, Qnil
);
2300 if ((!NILP (Ffile_directory_p (newname
)))
2302 /* If the file names are identical but for the case,
2303 don't attempt to move directory to itself. */
2304 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2308 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2309 ? file
: Fdirectory_file_name (file
));
2310 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2313 newname
= Fexpand_file_name (newname
, Qnil
);
2315 /* If the file name has special constructs in it,
2316 call the corresponding file handler. */
2317 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2319 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2320 if (!NILP (handler
))
2321 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2322 file
, newname
, ok_if_already_exists
));
2324 encoded_file
= ENCODE_FILE (file
);
2325 encoded_newname
= ENCODE_FILE (newname
);
2328 /* If the file names are identical but for the case, don't ask for
2329 confirmation: they simply want to change the letter-case of the
2331 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2333 if (NILP (ok_if_already_exists
)
2334 || INTEGERP (ok_if_already_exists
))
2335 barf_or_query_if_file_exists (newname
, false, "rename to it",
2336 INTEGERP (ok_if_already_exists
), false);
2337 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2339 int rename_errno
= errno
;
2340 if (rename_errno
== EXDEV
)
2343 symlink_target
= Ffile_symlink_p (file
);
2344 if (! NILP (symlink_target
))
2345 Fmake_symbolic_link (symlink_target
, newname
,
2346 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2347 else if (!NILP (Ffile_directory_p (file
)))
2348 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2350 /* We have already prompted if it was an integer, so don't
2351 have copy-file prompt again. */
2352 Fcopy_file (file
, newname
,
2353 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2356 count
= SPECPDL_INDEX ();
2357 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2359 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2360 call2 (Qdelete_directory
, file
, Qt
);
2362 Fdelete_file (file
, Qnil
);
2363 unbind_to (count
, Qnil
);
2366 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2372 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2373 "fAdd name to file: \nGName to add to %s: \np",
2374 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2375 Signals a `file-already-exists' error if a file NEWNAME already exists
2376 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2377 A number as third arg means request confirmation if NEWNAME already exists.
2378 This is what happens in interactive use with M-x. */)
2379 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2381 Lisp_Object handler
;
2382 Lisp_Object encoded_file
, encoded_newname
;
2383 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2385 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2386 encoded_file
= encoded_newname
= Qnil
;
2387 CHECK_STRING (file
);
2388 CHECK_STRING (newname
);
2389 file
= Fexpand_file_name (file
, Qnil
);
2391 if (!NILP (Ffile_directory_p (newname
)))
2392 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2394 newname
= Fexpand_file_name (newname
, Qnil
);
2396 /* If the file name has special constructs in it,
2397 call the corresponding file handler. */
2398 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2399 if (!NILP (handler
))
2400 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2401 newname
, ok_if_already_exists
));
2403 /* If the new name has special constructs in it,
2404 call the corresponding file handler. */
2405 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2406 if (!NILP (handler
))
2407 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2408 newname
, ok_if_already_exists
));
2410 encoded_file
= ENCODE_FILE (file
);
2411 encoded_newname
= ENCODE_FILE (newname
);
2413 if (NILP (ok_if_already_exists
)
2414 || INTEGERP (ok_if_already_exists
))
2415 barf_or_query_if_file_exists (newname
, false, "make it a new name",
2416 INTEGERP (ok_if_already_exists
), false);
2418 unlink (SSDATA (newname
));
2419 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2421 int link_errno
= errno
;
2422 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2429 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2430 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2431 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2432 Both args must be strings.
2433 Signals a `file-already-exists' error if a file LINKNAME already exists
2434 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2435 A number as third arg means request confirmation if LINKNAME already exists.
2436 This happens for interactive use with M-x. */)
2437 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2439 Lisp_Object handler
;
2440 Lisp_Object encoded_filename
, encoded_linkname
;
2441 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2443 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2444 encoded_filename
= encoded_linkname
= Qnil
;
2445 CHECK_STRING (filename
);
2446 CHECK_STRING (linkname
);
2447 /* If the link target has a ~, we must expand it to get
2448 a truly valid file name. Otherwise, do not expand;
2449 we want to permit links to relative file names. */
2450 if (SREF (filename
, 0) == '~')
2451 filename
= Fexpand_file_name (filename
, Qnil
);
2453 if (!NILP (Ffile_directory_p (linkname
)))
2454 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2456 linkname
= Fexpand_file_name (linkname
, Qnil
);
2458 /* If the file name has special constructs in it,
2459 call the corresponding file handler. */
2460 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2461 if (!NILP (handler
))
2462 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2463 linkname
, ok_if_already_exists
));
2465 /* If the new link name has special constructs in it,
2466 call the corresponding file handler. */
2467 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2468 if (!NILP (handler
))
2469 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2470 linkname
, ok_if_already_exists
));
2472 encoded_filename
= ENCODE_FILE (filename
);
2473 encoded_linkname
= ENCODE_FILE (linkname
);
2475 if (NILP (ok_if_already_exists
)
2476 || INTEGERP (ok_if_already_exists
))
2477 barf_or_query_if_file_exists (linkname
, false, "make it a link",
2478 INTEGERP (ok_if_already_exists
), false);
2479 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2481 /* If we didn't complain already, silently delete existing file. */
2483 if (errno
== EEXIST
)
2485 unlink (SSDATA (encoded_linkname
));
2486 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2493 if (errno
== ENOSYS
)
2496 xsignal1 (Qfile_error
,
2497 build_string ("Symbolic links are not supported"));
2500 symlink_errno
= errno
;
2501 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2509 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2511 doc
: /* Return t if file FILENAME specifies an absolute file name.
2512 On Unix, this is a name starting with a `/' or a `~'. */)
2513 (Lisp_Object filename
)
2515 CHECK_STRING (filename
);
2516 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2519 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2520 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2521 See also `file-readable-p' and `file-attributes'.
2522 This returns nil for a symlink to a nonexistent file.
2523 Use `file-symlink-p' to test for such links. */)
2524 (Lisp_Object filename
)
2526 Lisp_Object absname
;
2527 Lisp_Object handler
;
2529 CHECK_STRING (filename
);
2530 absname
= Fexpand_file_name (filename
, Qnil
);
2532 /* If the file name has special constructs in it,
2533 call the corresponding file handler. */
2534 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2535 if (!NILP (handler
))
2537 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2542 absname
= ENCODE_FILE (absname
);
2544 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2547 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2548 doc
: /* Return t if FILENAME can be executed by you.
2549 For a directory, this means you can access files in that directory. */)
2550 (Lisp_Object filename
)
2552 Lisp_Object absname
;
2553 Lisp_Object handler
;
2555 CHECK_STRING (filename
);
2556 absname
= Fexpand_file_name (filename
, Qnil
);
2558 /* If the file name has special constructs in it,
2559 call the corresponding file handler. */
2560 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2561 if (!NILP (handler
))
2562 return call2 (handler
, Qfile_executable_p
, absname
);
2564 absname
= ENCODE_FILE (absname
);
2566 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2569 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2570 doc
: /* Return t if file FILENAME exists and you can read it.
2571 See also `file-exists-p' and `file-attributes'. */)
2572 (Lisp_Object filename
)
2574 Lisp_Object absname
;
2575 Lisp_Object handler
;
2577 CHECK_STRING (filename
);
2578 absname
= Fexpand_file_name (filename
, Qnil
);
2580 /* If the file name has special constructs in it,
2581 call the corresponding file handler. */
2582 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2583 if (!NILP (handler
))
2584 return call2 (handler
, Qfile_readable_p
, absname
);
2586 absname
= ENCODE_FILE (absname
);
2587 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2591 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2592 doc
: /* Return t if file FILENAME can be written or created by you. */)
2593 (Lisp_Object filename
)
2595 Lisp_Object absname
, dir
, encoded
;
2596 Lisp_Object handler
;
2598 CHECK_STRING (filename
);
2599 absname
= Fexpand_file_name (filename
, Qnil
);
2601 /* If the file name has special constructs in it,
2602 call the corresponding file handler. */
2603 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2604 if (!NILP (handler
))
2605 return call2 (handler
, Qfile_writable_p
, absname
);
2607 encoded
= ENCODE_FILE (absname
);
2608 if (check_writable (SSDATA (encoded
), W_OK
))
2610 if (errno
!= ENOENT
)
2613 dir
= Ffile_name_directory (absname
);
2614 eassert (!NILP (dir
));
2616 dir
= Fdirectory_file_name (dir
);
2619 dir
= ENCODE_FILE (dir
);
2621 /* The read-only attribute of the parent directory doesn't affect
2622 whether a file or directory can be created within it. Some day we
2623 should check ACLs though, which do affect this. */
2624 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2626 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2630 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2631 doc
: /* Access file FILENAME, and get an error if that does not work.
2632 The second argument STRING is used in the error message.
2633 If there is no error, returns nil. */)
2634 (Lisp_Object filename
, Lisp_Object string
)
2636 Lisp_Object handler
, encoded_filename
, absname
;
2638 CHECK_STRING (filename
);
2639 absname
= Fexpand_file_name (filename
, Qnil
);
2641 CHECK_STRING (string
);
2643 /* If the file name has special constructs in it,
2644 call the corresponding file handler. */
2645 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2646 if (!NILP (handler
))
2647 return call3 (handler
, Qaccess_file
, absname
, string
);
2649 encoded_filename
= ENCODE_FILE (absname
);
2651 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2652 report_file_error (SSDATA (string
), filename
);
2657 /* Relative to directory FD, return the symbolic link value of FILENAME.
2658 On failure, return nil. */
2660 emacs_readlinkat (int fd
, char const *filename
)
2662 static struct allocator
const emacs_norealloc_allocator
=
2663 { xmalloc
, NULL
, xfree
, memory_full
};
2665 char readlink_buf
[1024];
2666 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2667 &emacs_norealloc_allocator
, readlinkat
);
2671 val
= build_unibyte_string (buf
);
2672 if (buf
[0] == '/' && strchr (buf
, ':'))
2673 val
= concat2 (build_unibyte_string ("/:"), val
);
2674 if (buf
!= readlink_buf
)
2676 val
= DECODE_FILE (val
);
2680 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2681 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2682 The value is the link target, as a string.
2683 Otherwise it returns nil.
2685 This function returns t when given the name of a symlink that
2686 points to a nonexistent file. */)
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
;
3017 absname
= expand_and_dir_to_file (filename
,
3018 BVAR (current_buffer
, directory
));
3020 /* If the file name has special constructs in it,
3021 call the corresponding file handler. */
3022 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3023 if (!NILP (handler
))
3024 return call2 (handler
, Qfile_acl
, absname
);
3026 #ifdef HAVE_ACL_SET_FILE
3027 absname
= ENCODE_FILE (absname
);
3029 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3033 str
= acl_to_text (acl
, NULL
);
3040 acl_string
= build_string (str
);
3050 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3052 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3053 ACL-STRING should contain the textual representation of the ACL
3054 entries in a format suitable for the platform.
3056 Value is t if setting of ACL was successful, nil otherwise.
3058 Setting ACL for local files requires Emacs to be built with ACL
3060 (Lisp_Object filename
, Lisp_Object acl_string
)
3062 Lisp_Object absname
;
3063 Lisp_Object handler
;
3064 #ifdef HAVE_ACL_SET_FILE
3065 Lisp_Object encoded_absname
;
3070 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3072 /* If the file name has special constructs in it,
3073 call the corresponding file handler. */
3074 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3075 if (!NILP (handler
))
3076 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3078 #ifdef HAVE_ACL_SET_FILE
3079 if (STRINGP (acl_string
))
3081 acl
= acl_from_text (SSDATA (acl_string
));
3084 report_file_error ("Converting ACL", absname
);
3088 encoded_absname
= ENCODE_FILE (absname
);
3090 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3093 if (fail
&& acl_errno_valid (errno
))
3094 report_file_error ("Setting ACL", absname
);
3097 return fail
? Qnil
: Qt
;
3104 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3105 doc
: /* Return mode bits of file named FILENAME, as an integer.
3106 Return nil, if file does not exist or is not accessible. */)
3107 (Lisp_Object filename
)
3109 Lisp_Object absname
;
3111 Lisp_Object handler
;
3113 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3115 /* If the file name has special constructs in it,
3116 call the corresponding file handler. */
3117 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3118 if (!NILP (handler
))
3119 return call2 (handler
, Qfile_modes
, absname
);
3121 absname
= ENCODE_FILE (absname
);
3123 if (stat (SSDATA (absname
), &st
) < 0)
3126 return make_number (st
.st_mode
& 07777);
3129 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3130 "(let ((file (read-file-name \"File: \"))) \
3131 (list file (read-file-modes nil file)))",
3132 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3133 Only the 12 low bits of MODE are used.
3135 Interactively, mode bits are read by `read-file-modes', which accepts
3136 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3137 (Lisp_Object filename
, Lisp_Object mode
)
3139 Lisp_Object absname
, encoded_absname
;
3140 Lisp_Object handler
;
3142 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3143 CHECK_NUMBER (mode
);
3145 /* If the file name has special constructs in it,
3146 call the corresponding file handler. */
3147 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3148 if (!NILP (handler
))
3149 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3151 encoded_absname
= ENCODE_FILE (absname
);
3153 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3154 report_file_error ("Doing chmod", absname
);
3159 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3160 doc
: /* Set the file permission bits for newly created files.
3161 The argument MODE should be an integer; only the low 9 bits are used.
3162 This setting is inherited by subprocesses. */)
3165 mode_t oldrealmask
, oldumask
, newumask
;
3166 CHECK_NUMBER (mode
);
3167 oldrealmask
= realmask
;
3168 newumask
= ~ XINT (mode
) & 0777;
3171 realmask
= newumask
;
3172 oldumask
= umask (newumask
);
3175 eassert (oldumask
== oldrealmask
);
3179 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3180 doc
: /* Return the default file protection for created files.
3181 The value is an integer. */)
3185 XSETINT (value
, (~ realmask
) & 0777);
3190 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3191 doc
: /* Set times of file FILENAME to TIMESTAMP.
3192 Set both access and modification times.
3193 Return t on success, else nil.
3194 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3196 (Lisp_Object filename
, Lisp_Object timestamp
)
3198 Lisp_Object absname
, encoded_absname
;
3199 Lisp_Object handler
;
3200 struct timespec t
= lisp_time_argument (timestamp
);
3202 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3204 /* If the file name has special constructs in it,
3205 call the corresponding file handler. */
3206 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3207 if (!NILP (handler
))
3208 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3210 encoded_absname
= ENCODE_FILE (absname
);
3213 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
) != 0)
3216 /* Setting times on a directory always fails. */
3217 if (file_directory_p (SSDATA (encoded_absname
)))
3220 report_file_error ("Setting file times", absname
);
3228 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3229 doc
: /* Tell Unix to finish all pending disk updates. */)
3236 #endif /* HAVE_SYNC */
3238 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3239 doc
: /* Return t if file FILE1 is newer than file FILE2.
3240 If FILE1 does not exist, the answer is nil;
3241 otherwise, if FILE2 does not exist, the answer is t. */)
3242 (Lisp_Object file1
, Lisp_Object file2
)
3244 Lisp_Object absname1
, absname2
;
3245 struct stat st1
, st2
;
3246 Lisp_Object handler
;
3247 struct gcpro gcpro1
, gcpro2
;
3249 CHECK_STRING (file1
);
3250 CHECK_STRING (file2
);
3253 GCPRO2 (absname1
, file2
);
3254 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3255 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3258 /* If the file name has special constructs in it,
3259 call the corresponding file handler. */
3260 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3262 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3263 if (!NILP (handler
))
3264 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3266 GCPRO2 (absname1
, absname2
);
3267 absname1
= ENCODE_FILE (absname1
);
3268 absname2
= ENCODE_FILE (absname2
);
3271 if (stat (SSDATA (absname1
), &st1
) < 0)
3274 if (stat (SSDATA (absname2
), &st2
) < 0)
3277 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3281 #ifndef READ_BUF_SIZE
3282 #define READ_BUF_SIZE (64 << 10)
3284 /* Some buffer offsets are stored in 'int' variables. */
3285 verify (READ_BUF_SIZE
<= INT_MAX
);
3287 /* This function is called after Lisp functions to decide a coding
3288 system are called, or when they cause an error. Before they are
3289 called, the current buffer is set unibyte and it contains only a
3290 newly inserted text (thus the buffer was empty before the
3293 The functions may set markers, overlays, text properties, or even
3294 alter the buffer contents, change the current buffer.
3296 Here, we reset all those changes by:
3297 o set back the current buffer.
3298 o move all markers and overlays to BEG.
3299 o remove all text properties.
3300 o set back the buffer multibyteness. */
3303 decide_coding_unwind (Lisp_Object unwind_data
)
3305 Lisp_Object multibyte
, undo_list
, buffer
;
3307 multibyte
= XCAR (unwind_data
);
3308 unwind_data
= XCDR (unwind_data
);
3309 undo_list
= XCAR (unwind_data
);
3310 buffer
= XCDR (unwind_data
);
3312 set_buffer_internal (XBUFFER (buffer
));
3313 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3314 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3315 set_buffer_intervals (current_buffer
, NULL
);
3316 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3318 /* Now we are safe to change the buffer's multibyteness directly. */
3319 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3320 bset_undo_list (current_buffer
, undo_list
);
3323 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3324 object where slot 0 is the file descriptor, slot 1 specifies
3325 an offset to put the read bytes, and slot 2 is the maximum
3326 amount of bytes to read. Value is the number of bytes read. */
3329 read_non_regular (Lisp_Object state
)
3335 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3336 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3337 + XSAVE_INTEGER (state
, 1)),
3338 XSAVE_INTEGER (state
, 2));
3340 /* Fast recycle this object for the likely next call. */
3342 return make_number (nbytes
);
3346 /* Condition-case handler used when reading from non-regular files
3347 in insert-file-contents. */
3350 read_non_regular_quit (Lisp_Object ignore
)
3355 /* Return the file offset that VAL represents, checking for type
3356 errors and overflow. */
3358 file_offset (Lisp_Object val
)
3360 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3365 double v
= XFLOAT_DATA (val
);
3367 && (sizeof (off_t
) < sizeof v
3368 ? v
<= TYPE_MAXIMUM (off_t
)
3369 : v
< TYPE_MAXIMUM (off_t
)))
3373 wrong_type_argument (intern ("file-offset"), val
);
3376 /* Return a special time value indicating the error number ERRNUM. */
3377 static struct timespec
3378 time_error_value (int errnum
)
3380 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3381 ? NONEXISTENT_MODTIME_NSECS
3382 : UNKNOWN_MODTIME_NSECS
);
3383 return make_timespec (0, ns
);
3386 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3388 doc
: /* Insert contents of file FILENAME after point.
3389 Returns list of absolute file name and number of characters inserted.
3390 If second argument VISIT is non-nil, the buffer's visited filename and
3391 last save file modtime are set, and it is marked unmodified. If
3392 visiting and the file does not exist, visiting is completed before the
3395 The optional third and fourth arguments BEG and END specify what portion
3396 of the file to insert. These arguments count bytes in the file, not
3397 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3399 If optional fifth argument REPLACE is non-nil, replace the current
3400 buffer contents (in the accessible portion) with the file contents.
3401 This is better than simply deleting and inserting the whole thing
3402 because (1) it preserves some marker positions and (2) it puts less data
3403 in the undo list. When REPLACE is non-nil, the second return value is
3404 the number of characters that replace previous buffer contents.
3406 This function does code conversion according to the value of
3407 `coding-system-for-read' or `file-coding-system-alist', and sets the
3408 variable `last-coding-system-used' to the coding system actually used.
3410 In addition, this function decodes the inserted text from known formats
3411 by calling `format-decode', which see. */)
3412 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3415 struct timespec mtime
;
3417 ptrdiff_t inserted
= 0;
3419 off_t beg_offset
, end_offset
;
3421 ptrdiff_t count
= SPECPDL_INDEX ();
3422 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3423 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3425 ptrdiff_t total
= 0;
3426 bool not_regular
= 0;
3428 char read_buf
[READ_BUF_SIZE
];
3429 struct coding_system coding
;
3430 bool replace_handled
= 0;
3431 bool set_coding_system
= 0;
3432 Lisp_Object coding_system
;
3434 /* If the undo log only contains the insertion, there's no point
3435 keeping it. It's typically when we first fill a file-buffer. */
3436 bool empty_undo_list_p
3437 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3439 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3440 bool we_locked_file
= 0;
3443 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3444 error ("Cannot do file visiting in an indirect buffer");
3446 if (!NILP (BVAR (current_buffer
, read_only
)))
3447 Fbarf_if_buffer_read_only ();
3451 orig_filename
= Qnil
;
3454 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3456 CHECK_STRING (filename
);
3457 filename
= Fexpand_file_name (filename
, Qnil
);
3459 /* The value Qnil means that the coding system is not yet
3461 coding_system
= Qnil
;
3463 /* If the file name has special constructs in it,
3464 call the corresponding file handler. */
3465 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3466 if (!NILP (handler
))
3468 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3469 visit
, beg
, end
, replace
);
3470 if (CONSP (val
) && CONSP (XCDR (val
))
3471 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3472 inserted
= XINT (XCAR (XCDR (val
)));
3476 orig_filename
= filename
;
3477 filename
= ENCODE_FILE (filename
);
3479 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3484 report_file_error ("Opening input file", orig_filename
);
3485 mtime
= time_error_value (save_errno
);
3487 if (!NILP (Vcoding_system_for_read
))
3488 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3492 fd_index
= SPECPDL_INDEX ();
3493 record_unwind_protect_int (close_file_unwind
, fd
);
3495 /* Replacement should preserve point as it preserves markers. */
3496 if (!NILP (replace
))
3497 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3499 if (fstat (fd
, &st
) != 0)
3500 report_file_error ("Input file status", orig_filename
);
3501 mtime
= get_stat_mtime (&st
);
3503 /* This code will need to be changed in order to work on named
3504 pipes, and it's probably just not worth it. So we should at
3505 least signal an error. */
3506 if (!S_ISREG (st
.st_mode
))
3513 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3514 xsignal2 (Qfile_error
,
3515 build_string ("not a regular file"), orig_filename
);
3520 if (!NILP (beg
) || !NILP (end
))
3521 error ("Attempt to visit less than an entire file");
3522 if (BEG
< Z
&& NILP (replace
))
3523 error ("Cannot do file visiting in a non-empty buffer");
3527 beg_offset
= file_offset (beg
);
3532 end_offset
= file_offset (end
);
3536 end_offset
= TYPE_MAXIMUM (off_t
);
3539 end_offset
= st
.st_size
;
3541 /* A negative size can happen on a platform that allows file
3542 sizes greater than the maximum off_t value. */
3546 /* The file size returned from stat may be zero, but data
3547 may be readable nonetheless, for example when this is a
3548 file in the /proc filesystem. */
3549 if (end_offset
== 0)
3550 end_offset
= READ_BUF_SIZE
;
3554 /* Check now whether the buffer will become too large,
3555 in the likely case where the file's length is not changing.
3556 This saves a lot of needless work before a buffer overflow. */
3559 /* The likely offset where we will stop reading. We could read
3560 more (or less), if the file grows (or shrinks) as we read it. */
3561 off_t likely_end
= min (end_offset
, st
.st_size
);
3563 if (beg_offset
< likely_end
)
3566 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3567 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3568 off_t likely_growth
= likely_end
- beg_offset
;
3569 if (buf_growth_max
< likely_growth
)
3574 /* Prevent redisplay optimizations. */
3575 current_buffer
->clip_changed
= 1;
3577 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3579 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3580 setup_coding_system (coding_system
, &coding
);
3581 /* Ensure we set Vlast_coding_system_used. */
3582 set_coding_system
= 1;
3586 /* Decide the coding system to use for reading the file now
3587 because we can't use an optimized method for handling
3588 `coding:' tag if the current buffer is not empty. */
3589 if (!NILP (Vcoding_system_for_read
))
3590 coding_system
= Vcoding_system_for_read
;
3593 /* Don't try looking inside a file for a coding system
3594 specification if it is not seekable. */
3595 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3597 /* Find a coding system specified in the heading two
3598 lines or in the tailing several lines of the file.
3599 We assume that the 1K-byte and 3K-byte for heading
3600 and tailing respectively are sufficient for this
3604 if (st
.st_size
<= (1024 * 4))
3605 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3608 nread
= emacs_read (fd
, read_buf
, 1024);
3612 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3613 report_file_error ("Setting file position",
3615 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3616 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3621 report_file_error ("Read error", orig_filename
);
3624 struct buffer
*prev
= current_buffer
;
3625 Lisp_Object workbuf
;
3628 record_unwind_current_buffer ();
3630 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3631 buf
= XBUFFER (workbuf
);
3633 delete_all_overlays (buf
);
3634 bset_directory (buf
, BVAR (current_buffer
, directory
));
3635 bset_read_only (buf
, Qnil
);
3636 bset_filename (buf
, Qnil
);
3637 bset_undo_list (buf
, Qt
);
3638 eassert (buf
->overlays_before
== NULL
);
3639 eassert (buf
->overlays_after
== NULL
);
3641 set_buffer_internal (buf
);
3643 bset_enable_multibyte_characters (buf
, Qnil
);
3645 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3646 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3647 coding_system
= call2 (Vset_auto_coding_function
,
3648 filename
, make_number (nread
));
3649 set_buffer_internal (prev
);
3651 /* Discard the unwind protect for recovering the
3655 /* Rewind the file for the actual read done later. */
3656 if (lseek (fd
, 0, SEEK_SET
) < 0)
3657 report_file_error ("Setting file position", orig_filename
);
3661 if (NILP (coding_system
))
3663 /* If we have not yet decided a coding system, check
3664 file-coding-system-alist. */
3665 Lisp_Object args
[6];
3667 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3668 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3669 coding_system
= Ffind_operation_coding_system (6, args
);
3670 if (CONSP (coding_system
))
3671 coding_system
= XCAR (coding_system
);
3675 if (NILP (coding_system
))
3676 coding_system
= Qundecided
;
3678 CHECK_CODING_SYSTEM (coding_system
);
3680 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3681 /* We must suppress all character code conversion except for
3682 end-of-line conversion. */
3683 coding_system
= raw_text_coding_system (coding_system
);
3685 setup_coding_system (coding_system
, &coding
);
3686 /* Ensure we set Vlast_coding_system_used. */
3687 set_coding_system
= 1;
3690 /* If requested, replace the accessible part of the buffer
3691 with the file contents. Avoid replacing text at the
3692 beginning or end of the buffer that matches the file contents;
3693 that preserves markers pointing to the unchanged parts.
3695 Here we implement this feature in an optimized way
3696 for the case where code conversion is NOT needed.
3697 The following if-statement handles the case of conversion
3698 in a less optimal way.
3700 If the code conversion is "automatic" then we try using this
3701 method and hope for the best.
3702 But if we discover the need for conversion, we give up on this method
3703 and let the following if-statement handle the replace job. */
3706 && (NILP (coding_system
)
3707 || ! CODING_REQUIRE_DECODING (&coding
)))
3709 /* same_at_start and same_at_end count bytes,
3710 because file access counts bytes
3711 and BEG and END count bytes. */
3712 ptrdiff_t same_at_start
= BEGV_BYTE
;
3713 ptrdiff_t same_at_end
= ZV_BYTE
;
3715 /* There is still a possibility we will find the need to do code
3716 conversion. If that happens, set this variable to
3717 give up on handling REPLACE in the optimized way. */
3718 bool giveup_match_end
= 0;
3720 if (beg_offset
!= 0)
3722 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3723 report_file_error ("Setting file position", orig_filename
);
3728 /* Count how many chars at the start of the file
3729 match the text at the beginning of the buffer. */
3734 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3736 report_file_error ("Read error", orig_filename
);
3737 else if (nread
== 0)
3740 if (CODING_REQUIRE_DETECTION (&coding
))
3742 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3745 setup_coding_system (coding_system
, &coding
);
3748 if (CODING_REQUIRE_DECODING (&coding
))
3749 /* We found that the file should be decoded somehow.
3750 Let's give up here. */
3752 giveup_match_end
= 1;
3757 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3758 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3759 same_at_start
++, bufpos
++;
3760 /* If we found a discrepancy, stop the scan.
3761 Otherwise loop around and scan the next bufferful. */
3762 if (bufpos
!= nread
)
3766 /* If the file matches the buffer completely,
3767 there's no need to replace anything. */
3768 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3771 clear_unwind_protect (fd_index
);
3773 /* Truncate the buffer to the size of the file. */
3774 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3779 /* Count how many chars at the end of the file
3780 match the text at the end of the buffer. But, if we have
3781 already found that decoding is necessary, don't waste time. */
3782 while (!giveup_match_end
)
3784 int total_read
, nread
, bufpos
, trial
;
3787 /* At what file position are we now scanning? */
3788 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3789 /* If the entire file matches the buffer tail, stop the scan. */
3792 /* How much can we scan in the next step? */
3793 trial
= min (curpos
, sizeof read_buf
);
3794 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3795 report_file_error ("Setting file position", orig_filename
);
3797 total_read
= nread
= 0;
3798 while (total_read
< trial
)
3800 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3802 report_file_error ("Read error", orig_filename
);
3803 else if (nread
== 0)
3805 total_read
+= nread
;
3808 /* Scan this bufferful from the end, comparing with
3809 the Emacs buffer. */
3810 bufpos
= total_read
;
3812 /* Compare with same_at_start to avoid counting some buffer text
3813 as matching both at the file's beginning and at the end. */
3814 while (bufpos
> 0 && same_at_end
> same_at_start
3815 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3816 same_at_end
--, bufpos
--;
3818 /* If we found a discrepancy, stop the scan.
3819 Otherwise loop around and scan the preceding bufferful. */
3822 /* If this discrepancy is because of code conversion,
3823 we cannot use this method; giveup and try the other. */
3824 if (same_at_end
> same_at_start
3825 && FETCH_BYTE (same_at_end
- 1) >= 0200
3826 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3827 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3828 giveup_match_end
= 1;
3837 if (! giveup_match_end
)
3841 /* We win! We can handle REPLACE the optimized way. */
3843 /* Extend the start of non-matching text area to multibyte
3844 character boundary. */
3845 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3846 while (same_at_start
> BEGV_BYTE
3847 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3850 /* Extend the end of non-matching text area to multibyte
3851 character boundary. */
3852 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3853 while (same_at_end
< ZV_BYTE
3854 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3857 /* Don't try to reuse the same piece of text twice. */
3858 overlap
= (same_at_start
- BEGV_BYTE
3860 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3862 same_at_end
+= overlap
;
3864 /* Arrange to read only the nonmatching middle part of the file. */
3865 beg_offset
+= same_at_start
- BEGV_BYTE
;
3866 end_offset
-= ZV_BYTE
- same_at_end
;
3868 invalidate_buffer_caches (current_buffer
,
3869 BYTE_TO_CHAR (same_at_start
),
3870 BYTE_TO_CHAR (same_at_end
));
3871 del_range_byte (same_at_start
, same_at_end
, 0);
3872 /* Insert from the file at the proper position. */
3873 temp
= BYTE_TO_CHAR (same_at_start
);
3874 SET_PT_BOTH (temp
, same_at_start
);
3876 /* If display currently starts at beginning of line,
3877 keep it that way. */
3878 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3879 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3881 replace_handled
= 1;
3885 /* If requested, replace the accessible part of the buffer
3886 with the file contents. Avoid replacing text at the
3887 beginning or end of the buffer that matches the file contents;
3888 that preserves markers pointing to the unchanged parts.
3890 Here we implement this feature for the case where code conversion
3891 is needed, in a simple way that needs a lot of memory.
3892 The preceding if-statement handles the case of no conversion
3893 in a more optimized way. */
3894 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3896 ptrdiff_t same_at_start
= BEGV_BYTE
;
3897 ptrdiff_t same_at_end
= ZV_BYTE
;
3898 ptrdiff_t same_at_start_charpos
;
3899 ptrdiff_t inserted_chars
;
3902 unsigned char *decoded
;
3905 ptrdiff_t this_count
= SPECPDL_INDEX ();
3907 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3908 Lisp_Object conversion_buffer
;
3909 struct gcpro gcpro1
;
3911 conversion_buffer
= code_conversion_save (1, multibyte
);
3913 /* First read the whole file, performing code conversion into
3914 CONVERSION_BUFFER. */
3916 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3917 report_file_error ("Setting file position", orig_filename
);
3919 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3920 unprocessed
= 0; /* Bytes not processed in previous loop. */
3922 GCPRO1 (conversion_buffer
);
3925 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3926 quitting while reading a huge file. */
3928 /* Allow quitting out of the actual I/O. */
3931 this = emacs_read (fd
, read_buf
+ unprocessed
,
3932 READ_BUF_SIZE
- unprocessed
);
3938 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3939 BUF_Z (XBUFFER (conversion_buffer
)));
3940 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3941 unprocessed
+ this, conversion_buffer
);
3942 unprocessed
= coding
.carryover_bytes
;
3943 if (coding
.carryover_bytes
> 0)
3944 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3948 report_file_error ("Read error", orig_filename
);
3950 clear_unwind_protect (fd_index
);
3952 if (unprocessed
> 0)
3954 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3955 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3956 unprocessed
, conversion_buffer
);
3957 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3960 coding_system
= CODING_ID_NAME (coding
.id
);
3961 set_coding_system
= 1;
3962 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3963 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3964 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3966 /* Compare the beginning of the converted string with the buffer
3970 while (bufpos
< inserted
&& same_at_start
< same_at_end
3971 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3972 same_at_start
++, bufpos
++;
3974 /* If the file matches the head of buffer completely,
3975 there's no need to replace anything. */
3977 if (bufpos
== inserted
)
3979 /* Truncate the buffer to the size of the file. */
3980 if (same_at_start
!= same_at_end
)
3982 invalidate_buffer_caches (current_buffer
,
3983 BYTE_TO_CHAR (same_at_start
),
3984 BYTE_TO_CHAR (same_at_end
));
3985 del_range_byte (same_at_start
, same_at_end
, 0);
3989 unbind_to (this_count
, Qnil
);
3993 /* Extend the start of non-matching text area to the previous
3994 multibyte character boundary. */
3995 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3996 while (same_at_start
> BEGV_BYTE
3997 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4000 /* Scan this bufferful from the end, comparing with
4001 the Emacs buffer. */
4004 /* Compare with same_at_start to avoid counting some buffer text
4005 as matching both at the file's beginning and at the end. */
4006 while (bufpos
> 0 && same_at_end
> same_at_start
4007 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4008 same_at_end
--, bufpos
--;
4010 /* Extend the end of non-matching text area to the next
4011 multibyte character boundary. */
4012 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4013 while (same_at_end
< ZV_BYTE
4014 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4017 /* Don't try to reuse the same piece of text twice. */
4018 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4020 same_at_end
+= overlap
;
4022 /* If display currently starts at beginning of line,
4023 keep it that way. */
4024 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4025 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4027 /* Replace the chars that we need to replace,
4028 and update INSERTED to equal the number of bytes
4029 we are taking from the decoded string. */
4030 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4032 if (same_at_end
!= same_at_start
)
4034 invalidate_buffer_caches (current_buffer
,
4035 BYTE_TO_CHAR (same_at_start
),
4036 BYTE_TO_CHAR (same_at_end
));
4037 del_range_byte (same_at_start
, same_at_end
, 0);
4039 eassert (same_at_start
== GPT_BYTE
);
4040 same_at_start
= GPT_BYTE
;
4044 temp
= BYTE_TO_CHAR (same_at_start
);
4046 /* Insert from the file at the proper position. */
4047 SET_PT_BOTH (temp
, same_at_start
);
4048 same_at_start_charpos
4049 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4050 same_at_start
- BEGV_BYTE
4051 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4052 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4054 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4055 same_at_start
+ inserted
- BEGV_BYTE
4056 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4057 - same_at_start_charpos
);
4058 /* This binding is to avoid ask-user-about-supersession-threat
4059 being called in insert_from_buffer (via in
4060 prepare_to_modify_buffer). */
4061 specbind (intern ("buffer-file-name"), Qnil
);
4062 insert_from_buffer (XBUFFER (conversion_buffer
),
4063 same_at_start_charpos
, inserted_chars
, 0);
4064 /* Set `inserted' to the number of inserted characters. */
4065 inserted
= PT
- temp
;
4066 /* Set point before the inserted characters. */
4067 SET_PT_BOTH (temp
, same_at_start
);
4069 unbind_to (this_count
, Qnil
);
4075 total
= end_offset
- beg_offset
;
4077 /* For a special file, all we can do is guess. */
4078 total
= READ_BUF_SIZE
;
4080 if (NILP (visit
) && total
> 0)
4082 #ifdef CLASH_DETECTION
4083 if (!NILP (BVAR (current_buffer
, file_truename
))
4084 /* Make binding buffer-file-name to nil effective. */
4085 && !NILP (BVAR (current_buffer
, filename
))
4086 && SAVE_MODIFF
>= MODIFF
)
4088 #endif /* CLASH_DETECTION */
4089 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4092 move_gap_both (PT
, PT_BYTE
);
4093 if (GAP_SIZE
< total
)
4094 make_gap (total
- GAP_SIZE
);
4096 if (beg_offset
!= 0 || !NILP (replace
))
4098 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4099 report_file_error ("Setting file position", orig_filename
);
4102 /* In the following loop, HOW_MUCH contains the total bytes read so
4103 far for a regular file, and not changed for a special file. But,
4104 before exiting the loop, it is set to a negative value if I/O
4108 /* Total bytes inserted. */
4111 /* Here, we don't do code conversion in the loop. It is done by
4112 decode_coding_gap after all data are read into the buffer. */
4114 ptrdiff_t gap_size
= GAP_SIZE
;
4116 while (how_much
< total
)
4118 /* try is reserved in some compilers (Microsoft C) */
4119 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4126 /* Maybe make more room. */
4127 if (gap_size
< trytry
)
4129 make_gap (trytry
- gap_size
);
4130 gap_size
= GAP_SIZE
- inserted
;
4133 /* Read from the file, capturing `quit'. When an
4134 error occurs, end the loop, and arrange for a quit
4135 to be signaled after decoding the text we read. */
4136 nbytes
= internal_condition_case_1
4138 make_save_int_int_int (fd
, inserted
, trytry
),
4139 Qerror
, read_non_regular_quit
);
4147 this = XINT (nbytes
);
4151 /* Allow quitting out of the actual I/O. We don't make text
4152 part of the buffer until all the reading is done, so a C-g
4153 here doesn't do any harm. */
4156 this = emacs_read (fd
,
4157 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4171 /* For a regular file, where TOTAL is the real size,
4172 count HOW_MUCH to compare with it.
4173 For a special file, where TOTAL is just a buffer size,
4174 so don't bother counting in HOW_MUCH.
4175 (INSERTED is where we count the number of characters inserted.) */
4182 /* Now we have either read all the file data into the gap,
4183 or stop reading on I/O error or quit. If nothing was
4184 read, undo marking the buffer modified. */
4188 #ifdef CLASH_DETECTION
4190 unlock_file (BVAR (current_buffer
, file_truename
));
4192 Vdeactivate_mark
= old_Vdeactivate_mark
;
4195 Vdeactivate_mark
= Qt
;
4198 clear_unwind_protect (fd_index
);
4201 report_file_error ("Read error", orig_filename
);
4203 /* Make the text read part of the buffer. */
4204 GAP_SIZE
-= inserted
;
4206 GPT_BYTE
+= inserted
;
4208 ZV_BYTE
+= inserted
;
4213 /* Put an anchor to ensure multi-byte form ends at gap. */
4218 if (NILP (coding_system
))
4220 /* The coding system is not yet decided. Decide it by an
4221 optimized method for handling `coding:' tag.
4223 Note that we can get here only if the buffer was empty
4224 before the insertion. */
4226 if (!NILP (Vcoding_system_for_read
))
4227 coding_system
= Vcoding_system_for_read
;
4230 /* Since we are sure that the current buffer was empty
4231 before the insertion, we can toggle
4232 enable-multibyte-characters directly here without taking
4233 care of marker adjustment. By this way, we can run Lisp
4234 program safely before decoding the inserted text. */
4235 Lisp_Object unwind_data
;
4236 ptrdiff_t count1
= SPECPDL_INDEX ();
4238 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4239 Fcons (BVAR (current_buffer
, undo_list
),
4240 Fcurrent_buffer ()));
4241 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4242 bset_undo_list (current_buffer
, Qt
);
4243 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4245 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4247 coding_system
= call2 (Vset_auto_coding_function
,
4248 filename
, make_number (inserted
));
4251 if (NILP (coding_system
))
4253 /* If the coding system is not yet decided, check
4254 file-coding-system-alist. */
4255 Lisp_Object args
[6];
4257 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4258 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4259 coding_system
= Ffind_operation_coding_system (6, args
);
4260 if (CONSP (coding_system
))
4261 coding_system
= XCAR (coding_system
);
4263 unbind_to (count1
, Qnil
);
4264 inserted
= Z_BYTE
- BEG_BYTE
;
4267 if (NILP (coding_system
))
4268 coding_system
= Qundecided
;
4270 CHECK_CODING_SYSTEM (coding_system
);
4272 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4273 /* We must suppress all character code conversion except for
4274 end-of-line conversion. */
4275 coding_system
= raw_text_coding_system (coding_system
);
4276 setup_coding_system (coding_system
, &coding
);
4277 /* Ensure we set Vlast_coding_system_used. */
4278 set_coding_system
= 1;
4283 /* When we visit a file by raw-text, we change the buffer to
4285 if (CODING_FOR_UNIBYTE (&coding
)
4286 /* Can't do this if part of the buffer might be preserved. */
4288 /* Visiting a file with these coding system makes the buffer
4290 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4293 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4294 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4295 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4297 move_gap_both (PT
, PT_BYTE
);
4298 GAP_SIZE
+= inserted
;
4299 ZV_BYTE
-= inserted
;
4303 decode_coding_gap (&coding
, inserted
, inserted
);
4304 inserted
= coding
.produced_char
;
4305 coding_system
= CODING_ID_NAME (coding
.id
);
4307 else if (inserted
> 0)
4308 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4311 /* Call after-change hooks for the inserted text, aside from the case
4312 of normal visiting (not with REPLACE), which is done in a new buffer
4313 "before" the buffer is changed. */
4314 if (inserted
> 0 && total
> 0
4315 && (NILP (visit
) || !NILP (replace
)))
4317 signal_after_change (PT
, 0, inserted
);
4318 update_compositions (PT
, PT
, CHECK_BORDER
);
4321 /* Now INSERTED is measured in characters. */
4327 if (empty_undo_list_p
)
4328 bset_undo_list (current_buffer
, Qnil
);
4332 current_buffer
->modtime
= mtime
;
4333 current_buffer
->modtime_size
= st
.st_size
;
4334 bset_filename (current_buffer
, orig_filename
);
4337 SAVE_MODIFF
= MODIFF
;
4338 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4339 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4340 #ifdef CLASH_DETECTION
4343 if (!NILP (BVAR (current_buffer
, file_truename
)))
4344 unlock_file (BVAR (current_buffer
, file_truename
));
4345 unlock_file (filename
);
4347 #endif /* CLASH_DETECTION */
4349 xsignal2 (Qfile_error
,
4350 build_string ("not a regular file"), orig_filename
);
4353 if (set_coding_system
)
4354 Vlast_coding_system_used
= coding_system
;
4356 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4358 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4360 if (! NILP (insval
))
4362 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4363 wrong_type_argument (intern ("inserted-chars"), insval
);
4364 inserted
= XFASTINT (insval
);
4368 /* Decode file format. */
4371 /* Don't run point motion or modification hooks when decoding. */
4372 ptrdiff_t count1
= SPECPDL_INDEX ();
4373 ptrdiff_t old_inserted
= inserted
;
4374 specbind (Qinhibit_point_motion_hooks
, Qt
);
4375 specbind (Qinhibit_modification_hooks
, Qt
);
4377 /* Save old undo list and don't record undo for decoding. */
4378 old_undo
= BVAR (current_buffer
, undo_list
);
4379 bset_undo_list (current_buffer
, Qt
);
4383 insval
= call3 (Qformat_decode
,
4384 Qnil
, make_number (inserted
), visit
);
4385 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4386 wrong_type_argument (intern ("inserted-chars"), insval
);
4387 inserted
= XFASTINT (insval
);
4391 /* If REPLACE is non-nil and we succeeded in not replacing the
4392 beginning or end of the buffer text with the file's contents,
4393 call format-decode with `point' positioned at the beginning
4394 of the buffer and `inserted' equaling the number of
4395 characters in the buffer. Otherwise, format-decode might
4396 fail to correctly analyze the beginning or end of the buffer.
4397 Hence we temporarily save `point' and `inserted' here and
4398 restore `point' iff format-decode did not insert or delete
4399 any text. Otherwise we leave `point' at point-min. */
4400 ptrdiff_t opoint
= PT
;
4401 ptrdiff_t opoint_byte
= PT_BYTE
;
4402 ptrdiff_t oinserted
= ZV
- BEGV
;
4403 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4405 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4406 insval
= call3 (Qformat_decode
,
4407 Qnil
, make_number (oinserted
), visit
);
4408 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4409 wrong_type_argument (intern ("inserted-chars"), insval
);
4410 if (ochars_modiff
== CHARS_MODIFF
)
4411 /* format_decode didn't modify buffer's characters => move
4412 point back to position before inserted text and leave
4413 value of inserted alone. */
4414 SET_PT_BOTH (opoint
, opoint_byte
);
4416 /* format_decode modified buffer's characters => consider
4417 entire buffer changed and leave point at point-min. */
4418 inserted
= XFASTINT (insval
);
4421 /* For consistency with format-decode call these now iff inserted > 0
4422 (martin 2007-06-28). */
4423 p
= Vafter_insert_file_functions
;
4428 insval
= call1 (XCAR (p
), make_number (inserted
));
4431 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4432 wrong_type_argument (intern ("inserted-chars"), insval
);
4433 inserted
= XFASTINT (insval
);
4438 /* For the rationale of this see the comment on
4439 format-decode above. */
4440 ptrdiff_t opoint
= PT
;
4441 ptrdiff_t opoint_byte
= PT_BYTE
;
4442 ptrdiff_t oinserted
= ZV
- BEGV
;
4443 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4445 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4446 insval
= call1 (XCAR (p
), make_number (oinserted
));
4449 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4450 wrong_type_argument (intern ("inserted-chars"), insval
);
4451 if (ochars_modiff
== CHARS_MODIFF
)
4452 /* after_insert_file_functions didn't modify
4453 buffer's characters => move point back to
4454 position before inserted text and leave value of
4456 SET_PT_BOTH (opoint
, opoint_byte
);
4458 /* after_insert_file_functions did modify buffer's
4459 characters => consider entire buffer changed and
4460 leave point at point-min. */
4461 inserted
= XFASTINT (insval
);
4469 if (!empty_undo_list_p
)
4471 bset_undo_list (current_buffer
, old_undo
);
4472 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4474 /* Adjust the last undo record for the size change during
4475 the format conversion. */
4476 Lisp_Object tem
= XCAR (old_undo
);
4477 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4478 && INTEGERP (XCDR (tem
))
4479 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4480 XSETCDR (tem
, make_number (PT
+ inserted
));
4484 /* If undo_list was Qt before, keep it that way.
4485 Otherwise start with an empty undo_list. */
4486 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4488 unbind_to (count1
, Qnil
);
4492 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4494 /* If visiting nonexistent file, return nil. */
4495 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4498 /* We made a lot of deletions and insertions above, so invalidate
4499 the newline cache for the entire region of the inserted
4501 if (current_buffer
->base_buffer
&& current_buffer
->base_buffer
->newline_cache
)
4502 invalidate_region_cache (current_buffer
->base_buffer
,
4503 current_buffer
->base_buffer
->newline_cache
,
4504 PT
- BEG
, Z
- PT
- inserted
);
4505 else if (current_buffer
->newline_cache
)
4506 invalidate_region_cache (current_buffer
,
4507 current_buffer
->newline_cache
,
4508 PT
- BEG
, Z
- PT
- inserted
);
4511 Fsignal (Qquit
, Qnil
);
4513 /* Retval needs to be dealt with in all cases consistently. */
4515 val
= list2 (orig_filename
, make_number (inserted
));
4517 RETURN_UNGCPRO (unbind_to (count
, val
));
4520 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4523 build_annotations_unwind (Lisp_Object arg
)
4525 Vwrite_region_annotation_buffers
= arg
;
4528 /* Decide the coding-system to encode the data with. */
4530 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4531 Schoose_write_coding_system
, 3, 6, 0,
4532 doc
: /* Choose the coding system for writing a file.
4533 Arguments are as for `write-region'.
4534 This function is for internal use only. It may prompt the user. */ )
4535 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4536 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4539 Lisp_Object eol_parent
= Qnil
;
4541 /* Mimic write-region behavior. */
4544 XSETFASTINT (start
, BEGV
);
4545 XSETFASTINT (end
, ZV
);
4549 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4550 BVAR (current_buffer
, auto_save_file_name
))))
4555 else if (!NILP (Vcoding_system_for_write
))
4557 val
= Vcoding_system_for_write
;
4558 if (coding_system_require_warning
4559 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4560 /* Confirm that VAL can surely encode the current region. */
4561 val
= call5 (Vselect_safe_coding_system_function
,
4562 start
, end
, list2 (Qt
, val
),
4567 /* If the variable `buffer-file-coding-system' is set locally,
4568 it means that the file was read with some kind of code
4569 conversion or the variable is explicitly set by users. We
4570 had better write it out with the same coding system even if
4571 `enable-multibyte-characters' is nil.
4573 If it is not set locally, we anyway have to convert EOL
4574 format if the default value of `buffer-file-coding-system'
4575 tells that it is not Unix-like (LF only) format. */
4576 bool using_default_coding
= 0;
4577 bool force_raw_text
= 0;
4579 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4581 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4584 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4590 /* Check file-coding-system-alist. */
4591 Lisp_Object args
[7], coding_systems
;
4593 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4594 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4596 coding_systems
= Ffind_operation_coding_system (7, args
);
4597 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4598 val
= XCDR (coding_systems
);
4603 /* If we still have not decided a coding system, use the
4604 default value of buffer-file-coding-system. */
4605 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4606 using_default_coding
= 1;
4609 if (! NILP (val
) && ! force_raw_text
)
4611 Lisp_Object spec
, attrs
;
4613 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4614 attrs
= AREF (spec
, 0);
4615 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4620 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4621 /* Confirm that VAL can surely encode the current region. */
4622 val
= call5 (Vselect_safe_coding_system_function
,
4623 start
, end
, val
, Qnil
, filename
);
4625 /* If the decided coding-system doesn't specify end-of-line
4626 format, we use that of
4627 `default-buffer-file-coding-system'. */
4628 if (! using_default_coding
4629 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4630 val
= (coding_inherit_eol_type
4631 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4633 /* If we decide not to encode text, use `raw-text' or one of its
4636 val
= raw_text_coding_system (val
);
4639 val
= coding_inherit_eol_type (val
, eol_parent
);
4643 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4644 "r\nFWrite region to file: \ni\ni\ni\np",
4645 doc
: /* Write current region into specified file.
4646 When called from a program, requires three arguments:
4647 START, END and FILENAME. START and END are normally buffer positions
4648 specifying the part of the buffer to write.
4649 If START is nil, that means to use the entire buffer contents.
4650 If START is a string, then output that string to the file
4651 instead of any buffer contents; END is ignored.
4653 Optional fourth argument APPEND if non-nil means
4654 append to existing file contents (if any). If it is a number,
4655 seek to that offset in the file before writing.
4656 Optional fifth argument VISIT, if t or a string, means
4657 set the last-save-file-modtime of buffer to this file's modtime
4658 and mark buffer not modified.
4659 If VISIT is a string, it is a second file name;
4660 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4661 VISIT is also the file name to lock and unlock for clash detection.
4662 If VISIT is neither t nor nil nor a string,
4663 that means do not display the \"Wrote file\" message.
4664 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4665 use for locking and unlocking, overriding FILENAME and VISIT.
4666 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4667 for an existing file with the same name. If MUSTBENEW is `excl',
4668 that means to get an error if the file already exists; never overwrite.
4669 If MUSTBENEW is neither nil nor `excl', that means ask for
4670 confirmation before overwriting, but do go ahead and overwrite the file
4671 if the user confirms.
4673 This does code conversion according to the value of
4674 `coding-system-for-write', `buffer-file-coding-system', or
4675 `file-coding-system-alist', and sets the variable
4676 `last-coding-system-used' to the coding system actually used.
4678 This calls `write-region-annotate-functions' at the start, and
4679 `write-region-post-annotation-function' at the end. */)
4680 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4681 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4683 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4687 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4688 descriptor for FILENAME, so do not open or close FILENAME. */
4691 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4692 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4693 Lisp_Object mustbenew
, int desc
)
4697 off_t offset
IF_LINT (= 0);
4698 bool open_and_close_file
= desc
< 0;
4703 struct timespec modtime
;
4704 ptrdiff_t count
= SPECPDL_INDEX ();
4705 ptrdiff_t count1
IF_LINT (= 0);
4706 Lisp_Object handler
;
4707 Lisp_Object visit_file
;
4708 Lisp_Object annotations
;
4709 Lisp_Object encoded_filename
;
4710 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4711 bool quietly
= !NILP (visit
);
4712 bool file_locked
= 0;
4713 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4714 struct buffer
*given_buffer
;
4715 struct coding_system coding
;
4717 if (current_buffer
->base_buffer
&& visiting
)
4718 error ("Cannot do file visiting in an indirect buffer");
4720 if (!NILP (start
) && !STRINGP (start
))
4721 validate_region (&start
, &end
);
4724 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4726 filename
= Fexpand_file_name (filename
, Qnil
);
4728 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4729 barf_or_query_if_file_exists (filename
, false, "overwrite", true, true);
4731 if (STRINGP (visit
))
4732 visit_file
= Fexpand_file_name (visit
, Qnil
);
4734 visit_file
= filename
;
4736 if (NILP (lockname
))
4737 lockname
= visit_file
;
4741 /* If the file name has special constructs in it,
4742 call the corresponding file handler. */
4743 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4744 /* If FILENAME has no handler, see if VISIT has one. */
4745 if (NILP (handler
) && STRINGP (visit
))
4746 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4748 if (!NILP (handler
))
4751 val
= call6 (handler
, Qwrite_region
, start
, end
,
4752 filename
, append
, visit
);
4756 SAVE_MODIFF
= MODIFF
;
4757 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4758 bset_filename (current_buffer
, visit_file
);
4764 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4766 /* Special kludge to simplify auto-saving. */
4769 /* Do it later, so write-region-annotate-function can work differently
4770 if we save "the buffer" vs "a region".
4771 This is useful in tar-mode. --Stef
4772 XSETFASTINT (start, BEG);
4773 XSETFASTINT (end, Z); */
4777 record_unwind_protect (build_annotations_unwind
,
4778 Vwrite_region_annotation_buffers
);
4779 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4781 given_buffer
= current_buffer
;
4783 if (!STRINGP (start
))
4785 annotations
= build_annotations (start
, end
);
4787 if (current_buffer
!= given_buffer
)
4789 XSETFASTINT (start
, BEGV
);
4790 XSETFASTINT (end
, ZV
);
4796 XSETFASTINT (start
, BEGV
);
4797 XSETFASTINT (end
, ZV
);
4802 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4804 /* Decide the coding-system to encode the data with.
4805 We used to make this choice before calling build_annotations, but that
4806 leads to problems when a write-annotate-function takes care of
4807 unsavable chars (as was the case with X-Symbol). */
4808 Vlast_coding_system_used
=
4809 Fchoose_write_coding_system (start
, end
, filename
,
4810 append
, visit
, lockname
);
4812 setup_coding_system (Vlast_coding_system_used
, &coding
);
4814 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4815 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4817 #ifdef CLASH_DETECTION
4818 if (open_and_close_file
&& !auto_saving
)
4820 lock_file (lockname
);
4823 #endif /* CLASH_DETECTION */
4825 encoded_filename
= ENCODE_FILE (filename
);
4826 fn
= SSDATA (encoded_filename
);
4827 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4828 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4829 if (NUMBERP (append
))
4830 offset
= file_offset (append
);
4831 else if (!NILP (append
))
4832 open_flags
|= O_APPEND
;
4834 mode
= S_IREAD
| S_IWRITE
;
4836 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4839 if (open_and_close_file
)
4841 desc
= emacs_open (fn
, open_flags
, mode
);
4844 int open_errno
= errno
;
4845 #ifdef CLASH_DETECTION
4847 unlock_file (lockname
);
4848 #endif /* CLASH_DETECTION */
4850 report_file_errno ("Opening output file", filename
, open_errno
);
4853 count1
= SPECPDL_INDEX ();
4854 record_unwind_protect_int (close_file_unwind
, desc
);
4857 if (NUMBERP (append
))
4859 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4862 int lseek_errno
= errno
;
4863 #ifdef CLASH_DETECTION
4865 unlock_file (lockname
);
4866 #endif /* CLASH_DETECTION */
4868 report_file_errno ("Lseek error", filename
, lseek_errno
);
4876 if (STRINGP (start
))
4877 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4878 else if (XINT (start
) != XINT (end
))
4879 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4880 &annotations
, &coding
);
4883 /* If file was empty, still need to write the annotations. */
4884 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4885 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4889 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4890 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4892 /* We have to flush out a data. */
4893 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4894 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4900 /* fsync is not crucial for temporary files. Nor for auto-save
4901 files, since they might lose some work anyway. */
4902 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4904 /* Transfer data and metadata to disk, retrying if interrupted.
4905 fsync can report a write failure here, e.g., due to disk full
4906 under NFS. But ignore EINVAL, which means fsync is not
4907 supported on this file. */
4908 while (fsync (desc
) != 0)
4911 if (errno
!= EINVAL
)
4912 ok
= 0, save_errno
= errno
;
4917 modtime
= invalid_timespec ();
4920 if (fstat (desc
, &st
) == 0)
4921 modtime
= get_stat_mtime (&st
);
4923 ok
= 0, save_errno
= errno
;
4926 if (open_and_close_file
)
4928 /* NFS can report a write failure now. */
4929 if (emacs_close (desc
) < 0)
4930 ok
= 0, save_errno
= errno
;
4932 /* Discard the unwind protect for close_file_unwind. */
4933 specpdl_ptr
= specpdl
+ count1
;
4936 /* Some file systems have a bug where st_mtime is not updated
4937 properly after a write. For example, CIFS might not see the
4938 st_mtime change until after the file is opened again.
4940 Attempt to detect this file system bug, and update MODTIME to the
4941 newer st_mtime if the bug appears to be present. This introduces
4942 a race condition, so to avoid most instances of the race condition
4943 on non-buggy file systems, skip this check if the most recently
4944 encountered non-buggy file system was the current file system.
4946 A race condition can occur if some other process modifies the
4947 file between the fstat above and the fstat below, but the race is
4948 unlikely and a similar race between the last write and the fstat
4949 above cannot possibly be closed anyway. */
4951 if (timespec_valid_p (modtime
)
4952 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4954 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4958 if (fstat (desc1
, &st1
) == 0
4959 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4961 /* Use the heuristic if it appears to be valid. With neither
4962 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4963 file, the time stamp won't change. Also, some non-POSIX
4964 systems don't update an empty file's time stamp when
4965 truncating it. Finally, file systems with 100 ns or worse
4966 resolution sometimes seem to have bugs: on a system with ns
4967 resolution, checking ns % 100 incorrectly avoids the heuristic
4968 1% of the time, but the problem should be temporary as we will
4969 try again on the next time stamp. */
4971 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4973 && modtime
.tv_nsec
% 100 != 0);
4975 struct timespec modtime1
= get_stat_mtime (&st1
);
4977 && timespec_cmp (modtime
, modtime1
) == 0
4978 && st
.st_size
== st1
.st_size
)
4980 timestamp_file_system
= st
.st_dev
;
4981 valid_timestamp_file_system
= 1;
4985 st
.st_size
= st1
.st_size
;
4989 emacs_close (desc1
);
4993 /* Call write-region-post-annotation-function. */
4994 while (CONSP (Vwrite_region_annotation_buffers
))
4996 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4997 if (!NILP (Fbuffer_live_p (buf
)))
5000 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5001 call0 (Vwrite_region_post_annotation_function
);
5003 Vwrite_region_annotation_buffers
5004 = XCDR (Vwrite_region_annotation_buffers
);
5007 unbind_to (count
, Qnil
);
5009 #ifdef CLASH_DETECTION
5011 unlock_file (lockname
);
5012 #endif /* CLASH_DETECTION */
5014 /* Do this before reporting IO error
5015 to avoid a "file has changed on disk" warning on
5016 next attempt to save. */
5017 if (timespec_valid_p (modtime
))
5019 current_buffer
->modtime
= modtime
;
5020 current_buffer
->modtime_size
= st
.st_size
;
5024 report_file_errno ("Write error", filename
, save_errno
);
5028 SAVE_MODIFF
= MODIFF
;
5029 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5030 bset_filename (current_buffer
, visit_file
);
5031 update_mode_lines
= 14;
5036 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5037 BVAR (current_buffer
, auto_save_file_name
))))
5038 SAVE_MODIFF
= MODIFF
;
5044 message_with_string ((NUMBERP (append
)
5054 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5055 doc
: /* Return t if (car A) is numerically less than (car B). */)
5056 (Lisp_Object a
, Lisp_Object b
)
5058 Lisp_Object args
[2];
5061 return Flss (2, args
);
5064 /* Build the complete list of annotations appropriate for writing out
5065 the text between START and END, by calling all the functions in
5066 write-region-annotate-functions and merging the lists they return.
5067 If one of these functions switches to a different buffer, we assume
5068 that buffer contains altered text. Therefore, the caller must
5069 make sure to restore the current buffer in all cases,
5070 as save-excursion would do. */
5073 build_annotations (Lisp_Object start
, Lisp_Object end
)
5075 Lisp_Object annotations
;
5077 struct gcpro gcpro1
, gcpro2
;
5078 Lisp_Object original_buffer
;
5080 bool used_global
= 0;
5082 XSETBUFFER (original_buffer
, current_buffer
);
5085 p
= Vwrite_region_annotate_functions
;
5086 GCPRO2 (annotations
, p
);
5089 struct buffer
*given_buffer
= current_buffer
;
5090 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5091 { /* Use the global value of the hook. */
5094 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5096 p
= Fappend (2, arg
);
5099 Vwrite_region_annotations_so_far
= annotations
;
5100 res
= call2 (XCAR (p
), start
, end
);
5101 /* If the function makes a different buffer current,
5102 assume that means this buffer contains altered text to be output.
5103 Reset START and END from the buffer bounds
5104 and discard all previous annotations because they should have
5105 been dealt with by this function. */
5106 if (current_buffer
!= given_buffer
)
5108 Vwrite_region_annotation_buffers
5109 = Fcons (Fcurrent_buffer (),
5110 Vwrite_region_annotation_buffers
);
5111 XSETFASTINT (start
, BEGV
);
5112 XSETFASTINT (end
, ZV
);
5115 Flength (res
); /* Check basic validity of return value */
5116 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5120 /* Now do the same for annotation functions implied by the file-format */
5121 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5122 p
= BVAR (current_buffer
, auto_save_file_format
);
5124 p
= BVAR (current_buffer
, file_format
);
5125 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5127 struct buffer
*given_buffer
= current_buffer
;
5129 Vwrite_region_annotations_so_far
= annotations
;
5131 /* Value is either a list of annotations or nil if the function
5132 has written annotations to a temporary buffer, which is now
5134 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5135 original_buffer
, make_number (i
));
5136 if (current_buffer
!= given_buffer
)
5138 XSETFASTINT (start
, BEGV
);
5139 XSETFASTINT (end
, ZV
);
5144 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5152 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5153 If STRING is nil, POS is the character position in the current buffer.
5154 Intersperse with them the annotations from *ANNOT
5155 which fall within the range of POS to POS + NCHARS,
5156 each at its appropriate position.
5158 We modify *ANNOT by discarding elements as we use them up.
5160 Return true if successful. */
5163 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5164 ptrdiff_t nchars
, Lisp_Object
*annot
,
5165 struct coding_system
*coding
)
5169 ptrdiff_t lastpos
= pos
+ nchars
;
5171 while (NILP (*annot
) || CONSP (*annot
))
5173 tem
= Fcar_safe (Fcar (*annot
));
5176 nextpos
= XFASTINT (tem
);
5178 /* If there are no more annotations in this range,
5179 output the rest of the range all at once. */
5180 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5181 return e_write (desc
, string
, pos
, lastpos
, coding
);
5183 /* Output buffer text up to the next annotation's position. */
5186 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5190 /* Output the annotation. */
5191 tem
= Fcdr (Fcar (*annot
));
5194 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5197 *annot
= Fcdr (*annot
);
5202 /* Maximum number of characters that the next
5203 function encodes per one loop iteration. */
5205 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5207 /* Write text in the range START and END into descriptor DESC,
5208 encoding them with coding system CODING. If STRING is nil, START
5209 and END are character positions of the current buffer, else they
5210 are indexes to the string STRING. Return true if successful. */
5213 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5214 struct coding_system
*coding
)
5216 if (STRINGP (string
))
5219 end
= SCHARS (string
);
5222 /* We used to have a code for handling selective display here. But,
5223 now it is handled within encode_coding. */
5227 if (STRINGP (string
))
5229 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5230 if (CODING_REQUIRE_ENCODING (coding
))
5232 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5234 /* Avoid creating huge Lisp string in encode_coding_object. */
5235 if (nchars
== E_WRITE_MAX
)
5236 coding
->raw_destination
= 1;
5238 encode_coding_object
5239 (coding
, string
, start
, string_char_to_byte (string
, start
),
5240 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5245 coding
->dst_object
= string
;
5246 coding
->consumed_char
= SCHARS (string
);
5247 coding
->produced
= SBYTES (string
);
5252 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5253 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5255 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5256 if (CODING_REQUIRE_ENCODING (coding
))
5258 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5261 if (nchars
== E_WRITE_MAX
)
5262 coding
->raw_destination
= 1;
5264 encode_coding_object
5265 (coding
, Fcurrent_buffer (), start
, start_byte
,
5266 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5270 coding
->dst_object
= Qnil
;
5271 coding
->dst_pos_byte
= start_byte
;
5272 if (start
>= GPT
|| end
<= GPT
)
5274 coding
->consumed_char
= end
- start
;
5275 coding
->produced
= end_byte
- start_byte
;
5279 coding
->consumed_char
= GPT
- start
;
5280 coding
->produced
= GPT_BYTE
- start_byte
;
5285 if (coding
->produced
> 0)
5287 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5288 : (STRINGP (coding
->dst_object
)
5289 ? SSDATA (coding
->dst_object
)
5290 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5291 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5293 if (coding
->raw_destination
)
5295 /* We're responsible for freeing this, see
5296 encode_coding_object to check why. */
5297 xfree (coding
->destination
);
5298 coding
->raw_destination
= 0;
5300 if (coding
->produced
)
5303 start
+= coding
->consumed_char
;
5309 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5310 Sverify_visited_file_modtime
, 0, 1, 0,
5311 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5312 This means that the file has not been changed since it was visited or saved.
5313 If BUF is omitted or nil, it defaults to the current buffer.
5314 See Info node `(elisp)Modification Time' for more details. */)
5319 Lisp_Object handler
;
5320 Lisp_Object filename
;
5321 struct timespec mtime
;
5331 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5332 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5334 /* If the file name has special constructs in it,
5335 call the corresponding file handler. */
5336 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5337 Qverify_visited_file_modtime
);
5338 if (!NILP (handler
))
5339 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5341 filename
= ENCODE_FILE (BVAR (b
, filename
));
5343 mtime
= (stat (SSDATA (filename
), &st
) == 0
5344 ? get_stat_mtime (&st
)
5345 : time_error_value (errno
));
5346 if (timespec_cmp (mtime
, b
->modtime
) == 0
5347 && (b
->modtime_size
< 0
5348 || st
.st_size
== b
->modtime_size
))
5353 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5354 Svisited_file_modtime
, 0, 0, 0,
5355 doc
: /* Return the current buffer's recorded visited file modification time.
5356 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5357 `file-attributes' returns. If the current buffer has no recorded file
5358 modification time, this function returns 0. If the visited file
5359 doesn't exist, return -1.
5360 See Info node `(elisp)Modification Time' for more details. */)
5363 int ns
= current_buffer
->modtime
.tv_nsec
;
5365 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5366 return make_lisp_time (current_buffer
->modtime
);
5369 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5370 Sset_visited_file_modtime
, 0, 1, 0,
5371 doc
: /* Update buffer's recorded modification time from the visited file's time.
5372 Useful if the buffer was not read from the file normally
5373 or if the file itself has been changed for some known benign reason.
5374 An argument specifies the modification time value to use
5375 \(instead of that of the visited file), in the form of a list
5376 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5377 `visited-file-modtime'. */)
5378 (Lisp_Object time_flag
)
5380 if (!NILP (time_flag
))
5382 struct timespec mtime
;
5383 if (INTEGERP (time_flag
))
5385 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5386 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5389 mtime
= lisp_time_argument (time_flag
);
5391 current_buffer
->modtime
= mtime
;
5392 current_buffer
->modtime_size
= -1;
5396 register Lisp_Object filename
;
5398 Lisp_Object handler
;
5400 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5402 /* If the file name has special constructs in it,
5403 call the corresponding file handler. */
5404 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5405 if (!NILP (handler
))
5406 /* The handler can find the file name the same way we did. */
5407 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5409 filename
= ENCODE_FILE (filename
);
5411 if (stat (SSDATA (filename
), &st
) >= 0)
5413 current_buffer
->modtime
= get_stat_mtime (&st
);
5414 current_buffer
->modtime_size
= st
.st_size
;
5422 auto_save_error (Lisp_Object error_val
)
5424 Lisp_Object args
[3], msg
;
5426 struct gcpro gcpro1
;
5428 auto_save_error_occurred
= 1;
5430 ring_bell (XFRAME (selected_frame
));
5432 args
[0] = build_string ("Auto-saving %s: %s");
5433 args
[1] = BVAR (current_buffer
, name
);
5434 args
[2] = Ferror_message_string (error_val
);
5435 msg
= Fformat (3, args
);
5438 for (i
= 0; i
< 3; ++i
)
5443 message3_nolog (msg
);
5444 Fsleep_for (make_number (1), Qnil
);
5457 auto_save_mode_bits
= 0666;
5459 /* Get visited file's mode to become the auto save file's mode. */
5460 if (! NILP (BVAR (current_buffer
, filename
)))
5462 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5463 /* But make sure we can overwrite it later! */
5464 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5465 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5467 /* Remote files don't cooperate with stat. */
5468 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5472 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5473 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5477 struct auto_save_unwind
5484 do_auto_save_unwind (void *arg
)
5486 struct auto_save_unwind
*p
= arg
;
5487 FILE *stream
= p
->stream
;
5488 minibuffer_auto_raise
= p
->auto_raise
;
5499 do_auto_save_make_dir (Lisp_Object dir
)
5503 auto_saving_dir_umask
= 077;
5504 result
= call2 (Qmake_directory
, dir
, Qt
);
5505 auto_saving_dir_umask
= 0;
5510 do_auto_save_eh (Lisp_Object ignore
)
5512 auto_saving_dir_umask
= 0;
5516 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5517 doc
: /* Auto-save all buffers that need it.
5518 This is all buffers that have auto-saving enabled
5519 and are changed since last auto-saved.
5520 Auto-saving writes the buffer into a file
5521 so that your editing is not lost if the system crashes.
5522 This file is not the file you visited; that changes only when you save.
5523 Normally we run the normal hook `auto-save-hook' before saving.
5525 A non-nil NO-MESSAGE argument means do not print any message if successful.
5526 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5527 (Lisp_Object no_message
, Lisp_Object current_only
)
5529 struct buffer
*old
= current_buffer
, *b
;
5530 Lisp_Object tail
, buf
, hook
;
5531 bool auto_saved
= 0;
5532 int do_handled_files
;
5534 FILE *stream
= NULL
;
5535 ptrdiff_t count
= SPECPDL_INDEX ();
5536 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5537 bool old_message_p
= 0;
5538 struct auto_save_unwind auto_save_unwind
;
5539 struct gcpro gcpro1
, gcpro2
;
5541 if (max_specpdl_size
< specpdl_size
+ 40)
5542 max_specpdl_size
= specpdl_size
+ 40;
5547 if (NILP (no_message
))
5549 old_message_p
= push_message ();
5550 record_unwind_protect_void (pop_message_unwind
);
5553 /* Ordinarily don't quit within this function,
5554 but don't make it impossible to quit (in case we get hung in I/O). */
5558 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5559 point to non-strings reached from Vbuffer_alist. */
5561 hook
= intern ("auto-save-hook");
5562 safe_run_hooks (hook
);
5564 if (STRINGP (Vauto_save_list_file_name
))
5566 Lisp_Object listfile
;
5568 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5570 /* Don't try to create the directory when shutting down Emacs,
5571 because creating the directory might signal an error, and
5572 that would leave Emacs in a strange state. */
5573 if (!NILP (Vrun_hooks
))
5577 GCPRO2 (dir
, listfile
);
5578 dir
= Ffile_name_directory (listfile
);
5579 if (NILP (Ffile_directory_p (dir
)))
5580 internal_condition_case_1 (do_auto_save_make_dir
,
5586 stream
= emacs_fopen (SSDATA (listfile
), "w");
5589 auto_save_unwind
.stream
= stream
;
5590 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5591 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5592 minibuffer_auto_raise
= 0;
5594 auto_save_error_occurred
= 0;
5596 /* On first pass, save all files that don't have handlers.
5597 On second pass, save all files that do have handlers.
5599 If Emacs is crashing, the handlers may tweak what is causing
5600 Emacs to crash in the first place, and it would be a shame if
5601 Emacs failed to autosave perfectly ordinary files because it
5602 couldn't handle some ange-ftp'd file. */
5604 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5605 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5609 /* Record all the buffers that have auto save mode
5610 in the special file that lists them. For each of these buffers,
5611 Record visited name (if any) and auto save name. */
5612 if (STRINGP (BVAR (b
, auto_save_file_name
))
5613 && stream
!= NULL
&& do_handled_files
== 0)
5616 if (!NILP (BVAR (b
, filename
)))
5618 fwrite (SDATA (BVAR (b
, filename
)), 1,
5619 SBYTES (BVAR (b
, filename
)), stream
);
5621 putc ('\n', stream
);
5622 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5623 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5624 putc ('\n', stream
);
5628 if (!NILP (current_only
)
5629 && b
!= current_buffer
)
5632 /* Don't auto-save indirect buffers.
5633 The base buffer takes care of it. */
5637 /* Check for auto save enabled
5638 and file changed since last auto save
5639 and file changed since last real save. */
5640 if (STRINGP (BVAR (b
, auto_save_file_name
))
5641 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5642 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5643 /* -1 means we've turned off autosaving for a while--see below. */
5644 && XINT (BVAR (b
, save_length
)) >= 0
5645 && (do_handled_files
5646 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5649 struct timespec before_time
= current_timespec ();
5650 struct timespec after_time
;
5652 /* If we had a failure, don't try again for 20 minutes. */
5653 if (b
->auto_save_failure_time
> 0
5654 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5657 set_buffer_internal (b
);
5658 if (NILP (Vauto_save_include_big_deletions
)
5659 && (XFASTINT (BVAR (b
, save_length
)) * 10
5660 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5661 /* A short file is likely to change a large fraction;
5662 spare the user annoying messages. */
5663 && XFASTINT (BVAR (b
, save_length
)) > 5000
5664 /* These messages are frequent and annoying for `*mail*'. */
5665 && !EQ (BVAR (b
, filename
), Qnil
)
5666 && NILP (no_message
))
5668 /* It has shrunk too much; turn off auto-saving here. */
5669 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5670 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5672 minibuffer_auto_raise
= 0;
5673 /* Turn off auto-saving until there's a real save,
5674 and prevent any more warnings. */
5675 XSETINT (BVAR (b
, save_length
), -1);
5676 Fsleep_for (make_number (1), Qnil
);
5679 if (!auto_saved
&& NILP (no_message
))
5680 message1 ("Auto-saving...");
5681 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5683 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5684 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5685 set_buffer_internal (old
);
5687 after_time
= current_timespec ();
5689 /* If auto-save took more than 60 seconds,
5690 assume it was an NFS failure that got a timeout. */
5691 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5692 b
->auto_save_failure_time
= after_time
.tv_sec
;
5696 /* Prevent another auto save till enough input events come in. */
5697 record_auto_save ();
5699 if (auto_saved
&& NILP (no_message
))
5703 /* If we are going to restore an old message,
5704 give time to read ours. */
5705 sit_for (make_number (1), 0, 0);
5708 else if (!auto_save_error_occurred
)
5709 /* Don't overwrite the error message if an error occurred.
5710 If we displayed a message and then restored a state
5711 with no message, leave a "done" message on the screen. */
5712 message1 ("Auto-saving...done");
5717 /* This restores the message-stack status. */
5718 unbind_to (count
, Qnil
);
5722 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5723 Sset_buffer_auto_saved
, 0, 0, 0,
5724 doc
: /* Mark current buffer as auto-saved with its current text.
5725 No auto-save file will be written until the buffer changes again. */)
5728 /* FIXME: This should not be called in indirect buffers, since
5729 they're not autosaved. */
5730 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5731 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5732 current_buffer
->auto_save_failure_time
= 0;
5736 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5737 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5738 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5741 current_buffer
->auto_save_failure_time
= 0;
5745 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5747 doc
: /* Return t if current buffer has been auto-saved recently.
5748 More precisely, if it has been auto-saved since last read from or saved
5749 in the visited file. If the buffer has no visited file,
5750 then any auto-save counts as "recent". */)
5753 /* FIXME: maybe we should return nil for indirect buffers since
5754 they're never autosaved. */
5755 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5758 /* Reading and completing file names */
5760 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5761 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5762 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5763 The return value is only relevant for a call to `read-file-name' that happens
5764 before any other event (mouse or keypress) is handled. */)
5767 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5768 || defined (HAVE_NS)
5769 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5772 && window_system_available (SELECTED_FRAME ()))
5779 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5781 struct gcpro gcpro1
;
5782 Lisp_Object args
[7];
5784 GCPRO1 (default_filename
);
5785 args
[0] = intern ("read-file-name");
5788 args
[3] = default_filename
;
5789 args
[4] = mustmatch
;
5791 args
[6] = predicate
;
5792 RETURN_UNGCPRO (Ffuncall (7, args
));
5799 realmask
= umask (0);
5802 valid_timestamp_file_system
= 0;
5804 /* fsync can be a significant performance hit. Often it doesn't
5805 suffice to make the file-save operation survive a crash. For
5806 batch scripts, which are typically part of larger shell commands
5807 that don't fsync other files, its effect on performance can be
5808 significant so its utility is particularly questionable.
5809 Hence, for now by default fsync is used only when interactive.
5811 For more on why fsync often fails to work on today's hardware, see:
5812 Zheng M et al. Understanding the robustness of SSDs under power fault.
5813 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5814 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5816 For more on why fsync does not suffice even if it works properly, see:
5817 Roche X. Necessary step(s) to synchronize filename operations on disk.
5818 Austin Group Defect 672, 2013-03-19
5819 http://austingroupbugs.net/view.php?id=672 */
5820 write_region_inhibit_fsync
= noninteractive
;
5824 syms_of_fileio (void)
5826 DEFSYM (Qoperations
, "operations");
5827 DEFSYM (Qexpand_file_name
, "expand-file-name");
5828 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5829 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5830 DEFSYM (Qfile_name_directory
, "file-name-directory");
5831 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5832 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5833 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5834 DEFSYM (Qcopy_file
, "copy-file");
5835 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5836 DEFSYM (Qmake_directory
, "make-directory");
5837 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5838 DEFSYM (Qdelete_file
, "delete-file");
5839 DEFSYM (Qrename_file
, "rename-file");
5840 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5841 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5842 DEFSYM (Qfile_exists_p
, "file-exists-p");
5843 DEFSYM (Qfile_executable_p
, "file-executable-p");
5844 DEFSYM (Qfile_readable_p
, "file-readable-p");
5845 DEFSYM (Qfile_writable_p
, "file-writable-p");
5846 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5847 DEFSYM (Qaccess_file
, "access-file");
5848 DEFSYM (Qfile_directory_p
, "file-directory-p");
5849 DEFSYM (Qfile_regular_p
, "file-regular-p");
5850 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5851 DEFSYM (Qfile_modes
, "file-modes");
5852 DEFSYM (Qset_file_modes
, "set-file-modes");
5853 DEFSYM (Qset_file_times
, "set-file-times");
5854 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5855 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5856 DEFSYM (Qfile_acl
, "file-acl");
5857 DEFSYM (Qset_file_acl
, "set-file-acl");
5858 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5859 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5860 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5861 DEFSYM (Qwrite_region
, "write-region");
5862 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5863 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5864 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5866 DEFSYM (Qfile_name_history
, "file-name-history");
5867 Fset (Qfile_name_history
, Qnil
);
5869 DEFSYM (Qfile_error
, "file-error");
5870 DEFSYM (Qfile_already_exists
, "file-already-exists");
5871 DEFSYM (Qfile_date_error
, "file-date-error");
5872 DEFSYM (Qfile_notify_error
, "file-notify-error");
5873 DEFSYM (Qexcl
, "excl");
5875 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5876 doc
: /* Coding system for encoding file names.
5877 If it is nil, `default-file-name-coding-system' (which see) is used.
5879 On MS-Windows, the value of this variable is largely ignored if
5880 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5881 behaves as if file names were encoded in `utf-8'. */);
5882 Vfile_name_coding_system
= Qnil
;
5884 DEFVAR_LISP ("default-file-name-coding-system",
5885 Vdefault_file_name_coding_system
,
5886 doc
: /* Default coding system for encoding file names.
5887 This variable is used only when `file-name-coding-system' is nil.
5889 This variable is set/changed by the command `set-language-environment'.
5890 User should not set this variable manually,
5891 instead use `file-name-coding-system' to get a constant encoding
5892 of file names regardless of the current language environment.
5894 On MS-Windows, the value of this variable is largely ignored if
5895 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5896 behaves as if file names were encoded in `utf-8'. */);
5897 Vdefault_file_name_coding_system
= Qnil
;
5899 DEFSYM (Qformat_decode
, "format-decode");
5900 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5901 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5902 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5904 Fput (Qfile_error
, Qerror_conditions
,
5905 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5906 Fput (Qfile_error
, Qerror_message
,
5907 build_pure_c_string ("File error"));
5909 Fput (Qfile_already_exists
, Qerror_conditions
,
5910 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5911 Fput (Qfile_already_exists
, Qerror_message
,
5912 build_pure_c_string ("File already exists"));
5914 Fput (Qfile_date_error
, Qerror_conditions
,
5915 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5916 Fput (Qfile_date_error
, Qerror_message
,
5917 build_pure_c_string ("Cannot set file date"));
5919 Fput (Qfile_notify_error
, Qerror_conditions
,
5920 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5921 Fput (Qfile_notify_error
, Qerror_message
,
5922 build_pure_c_string ("File notification error"));
5924 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5925 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5926 If a file name matches REGEXP, all I/O on that file is done by calling
5927 HANDLER. If a file name matches more than one handler, the handler
5928 whose match starts last in the file name gets precedence. The
5929 function `find-file-name-handler' checks this list for a handler for
5932 HANDLER should be a function. The first argument given to it is the
5933 name of the I/O primitive to be handled; the remaining arguments are
5934 the arguments that were passed to that primitive. For example, if you
5935 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5936 HANDLER is called like this:
5938 (funcall HANDLER 'file-exists-p FILENAME)
5940 Note that HANDLER must be able to handle all I/O primitives; if it has
5941 nothing special to do for a primitive, it should reinvoke the
5942 primitive to handle the operation \"the usual way\".
5943 See Info node `(elisp)Magic File Names' for more details. */);
5944 Vfile_name_handler_alist
= Qnil
;
5946 DEFVAR_LISP ("set-auto-coding-function",
5947 Vset_auto_coding_function
,
5948 doc
: /* If non-nil, a function to call to decide a coding system of file.
5949 Two arguments are passed to this function: the file name
5950 and the length of a file contents following the point.
5951 This function should return a coding system to decode the file contents.
5952 It should check the file name against `auto-coding-alist'.
5953 If no coding system is decided, it should check a coding system
5954 specified in the heading lines with the format:
5955 -*- ... coding: CODING-SYSTEM; ... -*-
5956 or local variable spec of the tailing lines with `coding:' tag. */);
5957 Vset_auto_coding_function
= Qnil
;
5959 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5960 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5961 Each is passed one argument, the number of characters inserted,
5962 with point at the start of the inserted text. Each function
5963 should leave point the same, and return the new character count.
5964 If `insert-file-contents' is intercepted by a handler from
5965 `file-name-handler-alist', that handler is responsible for calling the
5966 functions in `after-insert-file-functions' if appropriate. */);
5967 Vafter_insert_file_functions
= Qnil
;
5969 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5970 doc
: /* A list of functions to be called at the start of `write-region'.
5971 Each is passed two arguments, START and END as for `write-region'.
5972 These are usually two numbers but not always; see the documentation
5973 for `write-region'. The function should return a list of pairs
5974 of the form (POSITION . STRING), consisting of strings to be effectively
5975 inserted at the specified positions of the file being written (1 means to
5976 insert before the first byte written). The POSITIONs must be sorted into
5979 If there are several annotation functions, the lists returned by these
5980 functions are merged destructively. As each annotation function runs,
5981 the variable `write-region-annotations-so-far' contains a list of all
5982 annotations returned by previous annotation functions.
5984 An annotation function can return with a different buffer current.
5985 Doing so removes the annotations returned by previous functions, and
5986 resets START and END to `point-min' and `point-max' of the new buffer.
5988 After `write-region' completes, Emacs calls the function stored in
5989 `write-region-post-annotation-function', once for each buffer that was
5990 current when building the annotations (i.e., at least once), with that
5991 buffer current. */);
5992 Vwrite_region_annotate_functions
= Qnil
;
5993 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5995 DEFVAR_LISP ("write-region-post-annotation-function",
5996 Vwrite_region_post_annotation_function
,
5997 doc
: /* Function to call after `write-region' completes.
5998 The function is called with no arguments. If one or more of the
5999 annotation functions in `write-region-annotate-functions' changed the
6000 current buffer, the function stored in this variable is called for
6001 each of those additional buffers as well, in addition to the original
6002 buffer. The relevant buffer is current during each function call. */);
6003 Vwrite_region_post_annotation_function
= Qnil
;
6004 staticpro (&Vwrite_region_annotation_buffers
);
6006 DEFVAR_LISP ("write-region-annotations-so-far",
6007 Vwrite_region_annotations_so_far
,
6008 doc
: /* When an annotation function is called, this holds the previous annotations.
6009 These are the annotations made by other annotation functions
6010 that were already called. See also `write-region-annotate-functions'. */);
6011 Vwrite_region_annotations_so_far
= Qnil
;
6013 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6014 doc
: /* A list of file name handlers that temporarily should not be used.
6015 This applies only to the operation `inhibit-file-name-operation'. */);
6016 Vinhibit_file_name_handlers
= Qnil
;
6018 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6019 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6020 Vinhibit_file_name_operation
= Qnil
;
6022 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6023 doc
: /* File name in which we write a list of all auto save file names.
6024 This variable is initialized automatically from `auto-save-list-file-prefix'
6025 shortly after Emacs reads your init file, if you have not yet given it
6026 a non-nil value. */);
6027 Vauto_save_list_file_name
= Qnil
;
6029 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6030 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6031 Normally auto-save files are written under other names. */);
6032 Vauto_save_visited_file_name
= Qnil
;
6034 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6035 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6036 If nil, deleting a substantial portion of the text disables auto-save
6037 in the buffer; this is the default behavior, because the auto-save
6038 file is usually more useful if it contains the deleted text. */);
6039 Vauto_save_include_big_deletions
= Qnil
;
6041 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6042 doc
: /* Non-nil means don't call fsync in `write-region'.
6043 This variable affects calls to `write-region' as well as save commands.
6044 Setting this to nil may avoid data loss if the system loses power or
6045 the operating system crashes. */);
6046 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6048 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6049 doc
: /* Specifies whether to use the system's trash can.
6050 When non-nil, certain file deletion commands use the function
6051 `move-file-to-trash' instead of deleting files outright.
6052 This includes interactive calls to `delete-file' and
6053 `delete-directory' and the Dired deletion commands. */);
6054 delete_by_moving_to_trash
= 0;
6055 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6057 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6058 DEFSYM (Qcopy_directory
, "copy-directory");
6059 DEFSYM (Qdelete_directory
, "delete-directory");
6060 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");
6062 defsubr (&Sfind_file_name_handler
);
6063 defsubr (&Sfile_name_directory
);
6064 defsubr (&Sfile_name_nondirectory
);
6065 defsubr (&Sunhandled_file_name_directory
);
6066 defsubr (&Sfile_name_as_directory
);
6067 defsubr (&Sdirectory_file_name
);
6068 defsubr (&Smake_temp_name
);
6069 defsubr (&Sexpand_file_name
);
6070 defsubr (&Ssubstitute_in_file_name
);
6071 defsubr (&Scopy_file
);
6072 defsubr (&Smake_directory_internal
);
6073 defsubr (&Sdelete_directory_internal
);
6074 defsubr (&Sdelete_file
);
6075 defsubr (&Srename_file
);
6076 defsubr (&Sadd_name_to_file
);
6077 defsubr (&Smake_symbolic_link
);
6078 defsubr (&Sfile_name_absolute_p
);
6079 defsubr (&Sfile_exists_p
);
6080 defsubr (&Sfile_executable_p
);
6081 defsubr (&Sfile_readable_p
);
6082 defsubr (&Sfile_writable_p
);
6083 defsubr (&Saccess_file
);
6084 defsubr (&Sfile_symlink_p
);
6085 defsubr (&Sfile_directory_p
);
6086 defsubr (&Sfile_accessible_directory_p
);
6087 defsubr (&Sfile_regular_p
);
6088 defsubr (&Sfile_modes
);
6089 defsubr (&Sset_file_modes
);
6090 defsubr (&Sset_file_times
);
6091 defsubr (&Sfile_selinux_context
);
6092 defsubr (&Sfile_acl
);
6093 defsubr (&Sset_file_acl
);
6094 defsubr (&Sset_file_selinux_context
);
6095 defsubr (&Sset_default_file_modes
);
6096 defsubr (&Sdefault_file_modes
);
6097 defsubr (&Sfile_newer_than_file_p
);
6098 defsubr (&Sinsert_file_contents
);
6099 defsubr (&Schoose_write_coding_system
);
6100 defsubr (&Swrite_region
);
6101 defsubr (&Scar_less_than_car
);
6102 defsubr (&Sverify_visited_file_modtime
);
6103 defsubr (&Svisited_file_modtime
);
6104 defsubr (&Sset_visited_file_modtime
);
6105 defsubr (&Sdo_auto_save
);
6106 defsubr (&Sset_buffer_auto_saved
);
6107 defsubr (&Sclear_buffer_auto_save_failure
);
6108 defsubr (&Srecent_auto_save_p
);
6110 defsubr (&Snext_read_file_uses_dialog_p
);
6113 defsubr (&Sunix_sync
);