1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
39 #ifdef HAVE_ACL_SET_FILE
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
52 #include "region-cache.h"
54 #include "dispextern.h"
61 #endif /* not WINDOWSNT */
65 #include <sys/param.h>
69 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
70 redirector allows the six letters between 'Z' and 'a' as well. */
72 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
75 #define IS_DRIVE(x) c_isalpha (x)
77 /* Need to lower-case the drive letter, or else expanded
78 filenames will sometimes compare unequal, because
79 `expand-file-name' doesn't always down-case the drive letter. */
80 #define DRIVE_LETTER(x) c_tolower (x)
85 #include <allocator.h>
86 #include <careadlinkat.h>
87 #include <stat-time.h>
95 /* True during writing of auto-save files. */
96 static bool auto_saving
;
98 /* Nonzero umask during creation of auto-save directories. */
99 static mode_t auto_saving_dir_umask
;
101 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
102 a new file with the same mode as the original. */
103 static mode_t auto_save_mode_bits
;
105 /* Set by auto_save_1 if an error occurred during the last auto-save. */
106 static bool auto_save_error_occurred
;
108 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
109 number of a file system where time stamps were observed to to work. */
110 static bool valid_timestamp_file_system
;
111 static dev_t timestamp_file_system
;
113 /* The symbol bound to coding-system-for-read when
114 insert-file-contents is called for recovering a file. This is not
115 an actual coding system name, but just an indicator to tell
116 insert-file-contents to use `emacs-mule' with a special flag for
117 auto saving and recovering a file. */
118 static Lisp_Object Qauto_save_coding
;
120 /* Property name of a file name handler,
121 which gives a list of operations it handles.. */
122 static Lisp_Object Qoperations
;
124 /* Lisp functions for translating file formats. */
125 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
127 /* Lisp function for setting buffer-file-coding-system and the
128 multibyteness of the current buffer after inserting a file. */
129 static Lisp_Object Qafter_insert_file_set_coding
;
131 static Lisp_Object Qwrite_region_annotate_functions
;
132 /* Each time an annotation function changes the buffer, the new buffer
134 static Lisp_Object Vwrite_region_annotation_buffers
;
136 static Lisp_Object Qdelete_by_moving_to_trash
;
138 /* Lisp function for moving files to trash. */
139 static Lisp_Object Qmove_file_to_trash
;
141 /* Lisp function for recursively copying directories. */
142 static Lisp_Object Qcopy_directory
;
144 /* Lisp function for recursively deleting directories. */
145 static Lisp_Object Qdelete_directory
;
147 static Lisp_Object Qsubstitute_env_in_file_name
;
152 Lisp_Object Qfile_error
, Qfile_notify_error
;
153 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
154 static Lisp_Object Qexcl
;
155 Lisp_Object Qfile_name_history
;
157 static Lisp_Object Qcar_less_than_car
;
159 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
160 Lisp_Object
*, struct coding_system
*);
161 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
162 struct coding_system
*);
165 /* Return true if FILENAME exists. */
168 check_existing (const char *filename
)
170 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
173 /* Return true if file FILENAME exists and can be executed. */
176 check_executable (char *filename
)
178 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
181 /* Return true if file FILENAME exists and can be accessed
182 according to AMODE, which should include W_OK.
183 On failure, return false and set errno. */
186 check_writable (const char *filename
, int amode
)
189 /* FIXME: an faccessat implementation should be added to the
190 DOS/Windows ports and this #ifdef branch should be removed. */
192 if (stat (filename
, &st
) < 0)
195 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
196 #else /* not MSDOS */
197 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
199 /* faccessat may have returned failure because Cygwin couldn't
200 determine the file's UID or GID; if so, we return success. */
203 int faccessat_errno
= errno
;
205 if (stat (filename
, &st
) < 0)
207 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
208 errno
= faccessat_errno
;
212 #endif /* not MSDOS */
215 /* Signal a file-access failure. STRING describes the failure,
216 NAME the file involved, and ERRORNO the errno value.
218 If NAME is neither null nor a pair, package it up as a singleton
219 list before reporting it; this saves report_file_errno's caller the
220 trouble of preserving errno before calling list1. */
223 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
225 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
226 Lisp_Object errstring
;
229 synchronize_system_messages_locale ();
230 str
= strerror (errorno
);
231 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
232 Vlocale_coding_system
, 0);
238 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
241 /* System error messages are capitalized. Downcase the initial
242 unless it is followed by a slash. (The slash case caters to
243 error messages that begin with "I/O" or, in German, "E/A".) */
244 if (STRING_MULTIBYTE (errstring
)
245 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
249 str
= SSDATA (errstring
);
250 c
= STRING_CHAR ((unsigned char *) str
);
251 Faset (errstring
, make_number (0), make_number (downcase (c
)));
254 xsignal (Qfile_error
,
255 Fcons (build_string (string
), Fcons (errstring
, data
)));
259 /* Signal a file-access failure that set errno. STRING describes the
260 failure, NAME the file involved. When invoking this function, take
261 care to not use arguments such as build_string ("foo") that involve
262 side effects that may set errno. */
265 report_file_error (char const *string
, Lisp_Object name
)
267 report_file_errno (string
, name
, errno
);
271 close_file_unwind (int fd
)
277 fclose_unwind (void *arg
)
283 /* Restore point, having saved it as a marker. */
286 restore_point_unwind (Lisp_Object location
)
288 Fgoto_char (location
);
289 unchain_marker (XMARKER (location
));
293 static Lisp_Object Qexpand_file_name
;
294 static Lisp_Object Qsubstitute_in_file_name
;
295 static Lisp_Object Qdirectory_file_name
;
296 static Lisp_Object Qfile_name_directory
;
297 static Lisp_Object Qfile_name_nondirectory
;
298 static Lisp_Object Qunhandled_file_name_directory
;
299 static Lisp_Object Qfile_name_as_directory
;
300 static Lisp_Object Qcopy_file
;
301 static Lisp_Object Qmake_directory_internal
;
302 static Lisp_Object Qmake_directory
;
303 static Lisp_Object Qdelete_directory_internal
;
304 Lisp_Object Qdelete_file
;
305 static Lisp_Object Qrename_file
;
306 static Lisp_Object Qadd_name_to_file
;
307 static Lisp_Object Qmake_symbolic_link
;
308 Lisp_Object Qfile_exists_p
;
309 static Lisp_Object Qfile_executable_p
;
310 static Lisp_Object Qfile_readable_p
;
311 static Lisp_Object Qfile_writable_p
;
312 static Lisp_Object Qfile_symlink_p
;
313 static Lisp_Object Qaccess_file
;
314 Lisp_Object Qfile_directory_p
;
315 static Lisp_Object Qfile_regular_p
;
316 static Lisp_Object Qfile_accessible_directory_p
;
317 static Lisp_Object Qfile_modes
;
318 static Lisp_Object Qset_file_modes
;
319 static Lisp_Object Qset_file_times
;
320 static Lisp_Object Qfile_selinux_context
;
321 static Lisp_Object Qset_file_selinux_context
;
322 static Lisp_Object Qfile_acl
;
323 static Lisp_Object Qset_file_acl
;
324 static Lisp_Object Qfile_newer_than_file_p
;
325 Lisp_Object Qinsert_file_contents
;
326 static Lisp_Object Qchoose_write_coding_system
;
327 Lisp_Object Qwrite_region
;
328 static Lisp_Object Qverify_visited_file_modtime
;
329 static Lisp_Object Qset_visited_file_modtime
;
331 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
332 Sfind_file_name_handler
, 2, 2, 0,
333 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
334 Otherwise, return nil.
335 A file name is handled if one of the regular expressions in
336 `file-name-handler-alist' matches it.
338 If OPERATION equals `inhibit-file-name-operation', then we ignore
339 any handlers that are members of `inhibit-file-name-handlers',
340 but we still do run any other handlers. This lets handlers
341 use the standard functions without calling themselves recursively. */)
342 (Lisp_Object filename
, Lisp_Object operation
)
344 /* This function must not munge the match data. */
345 Lisp_Object chain
, inhibited_handlers
, result
;
349 CHECK_STRING (filename
);
351 if (EQ (operation
, Vinhibit_file_name_operation
))
352 inhibited_handlers
= Vinhibit_file_name_handlers
;
354 inhibited_handlers
= Qnil
;
356 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
357 chain
= XCDR (chain
))
363 Lisp_Object string
= XCAR (elt
);
365 Lisp_Object handler
= XCDR (elt
);
366 Lisp_Object operations
= Qnil
;
368 if (SYMBOLP (handler
))
369 operations
= Fget (handler
, Qoperations
);
372 && (match_pos
= fast_string_match (string
, filename
)) > pos
373 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
377 handler
= XCDR (elt
);
378 tem
= Fmemq (handler
, inhibited_handlers
);
392 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
394 doc
: /* Return the directory component in file name FILENAME.
395 Return nil if FILENAME does not include a directory.
396 Otherwise return a directory name.
397 Given a Unix syntax file name, returns a string ending in slash. */)
398 (Lisp_Object filename
)
401 register const char *beg
;
406 register const char *p
;
409 CHECK_STRING (filename
);
411 /* If the file name has special constructs in it,
412 call the corresponding file handler. */
413 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
416 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
418 return STRINGP (handled_name
) ? handled_name
: Qnil
;
422 beg
= xlispstrdupa (filename
);
424 beg
= SSDATA (filename
);
426 p
= beg
+ SBYTES (filename
);
428 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
430 /* only recognize drive specifier at the beginning */
432 /* handle the "/:d:foo" and "/:foo" cases correctly */
433 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
434 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
441 /* Expansion of "c:" to drive and default directory. */
444 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
445 char *res
= alloca (MAXPATHLEN
+ 1);
448 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
450 memcpy (res
, beg
, 2);
455 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
457 size_t l
= strlen (res
);
459 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
462 p
= beg
+ strlen (beg
);
463 dostounix_filename (beg
);
464 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]))
1054 #endif /* WINDOWSNT */
1057 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1058 none are found, we can probably return right away. We will avoid
1059 allocating a new string if name is already fully expanded. */
1061 IS_DIRECTORY_SEP (nm
[0])
1063 && drive
&& !is_escaped
1066 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1070 /* If it turns out that the filename we want to return is just a
1071 suffix of FILENAME, we don't need to go through and edit
1072 things; we just need to construct a new string using data
1073 starting at the middle of FILENAME. If we set LOSE, that
1074 means we've discovered that we can't do that cool trick. */
1080 /* Since we know the name is absolute, we can assume that each
1081 element starts with a "/". */
1083 /* "." and ".." are hairy. */
1084 if (IS_DIRECTORY_SEP (p
[0])
1086 && (IS_DIRECTORY_SEP (p
[2])
1088 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1091 /* Replace multiple slashes with a single one, except
1092 leave leading "//" alone. */
1093 else if (IS_DIRECTORY_SEP (p
[0])
1094 && IS_DIRECTORY_SEP (p
[1])
1095 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1102 /* Make sure directories are all separated with /, but
1103 avoid allocation of a new string when not required. */
1104 dostounix_filename (nm
);
1106 if (IS_DIRECTORY_SEP (nm
[1]))
1108 if (strcmp (nm
, SSDATA (name
)) != 0)
1109 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1113 /* Drive must be set, so this is okay. */
1114 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1118 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1119 temp
[0] = DRIVE_LETTER (drive
);
1120 name
= concat2 (build_string (temp
), name
);
1123 if (!NILP (Vw32_downcase_file_names
))
1124 name
= Fdowncase (name
);
1127 #else /* not DOS_NT */
1128 if (strcmp (nm
, SSDATA (name
)) == 0)
1130 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1131 #endif /* not DOS_NT */
1135 /* At this point, nm might or might not be an absolute file name. We
1136 need to expand ~ or ~user if present, otherwise prefix nm with
1137 default_directory if nm is not absolute, and finally collapse /./
1138 and /foo/../ sequences.
1140 We set newdir to be the appropriate prefix if one is needed:
1141 - the relevant user directory if nm starts with ~ or ~user
1142 - the specified drive's working dir (DOS/NT only) if nm does not
1144 - the value of default_directory.
1146 Note that these prefixes are not guaranteed to be absolute (except
1147 for the working dir of a drive). Therefore, to ensure we always
1148 return an absolute name, if the final prefix is not absolute we
1149 append it to the current working directory. */
1153 if (nm
[0] == '~') /* prefix ~ */
1155 if (IS_DIRECTORY_SEP (nm
[1])
1156 || nm
[1] == 0) /* ~ by itself */
1160 if (!(newdir
= egetenv ("HOME")))
1163 /* `egetenv' may return a unibyte string, which will bite us since
1164 we expect the directory to be multibyte. */
1168 char newdir_utf8
[MAX_UTF8_PATH
];
1170 filename_from_ansi (newdir
, newdir_utf8
);
1171 tem
= build_string (newdir_utf8
);
1175 tem
= build_string (newdir
);
1177 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1179 hdir
= DECODE_FILE (tem
);
1180 newdir
= SSDATA (hdir
);
1183 collapse_newdir
= 0;
1186 else /* ~user/filename */
1189 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1191 o
= SAFE_ALLOCA (p
- nm
+ 1);
1192 memcpy (o
, nm
, p
- nm
);
1196 pw
= getpwnam (o
+ 1);
1202 newdir
= pw
->pw_dir
;
1203 /* `getpwnam' may return a unibyte string, which will
1204 bite us since we expect the directory to be
1206 tem
= build_string (newdir
);
1207 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1209 hdir
= DECODE_FILE (tem
);
1210 newdir
= SSDATA (hdir
);
1214 collapse_newdir
= 0;
1218 /* If we don't find a user of that name, leave the name
1219 unchanged; don't move nm forward to p. */
1224 /* On DOS and Windows, nm is absolute if a drive name was specified;
1225 use the drive's current directory as the prefix if needed. */
1226 if (!newdir
&& drive
)
1228 /* Get default directory if needed to make nm absolute. */
1230 if (!IS_DIRECTORY_SEP (nm
[0]))
1232 adir
= alloca (MAXPATHLEN
+ 1);
1233 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1237 Lisp_Object tem
= build_string (adir
);
1239 tem
= DECODE_FILE (tem
);
1240 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1245 /* Either nm starts with /, or drive isn't mounted. */
1247 adir
[0] = DRIVE_LETTER (drive
);
1256 /* Finally, if no prefix has been specified and nm is not absolute,
1257 then it must be expanded relative to default_directory. */
1261 /* /... alone is not absolute on DOS and Windows. */
1262 && !IS_DIRECTORY_SEP (nm
[0])
1265 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1269 newdir
= SSDATA (default_directory
);
1271 /* Note if special escape prefix is present, but remove for now. */
1272 if (newdir
[0] == '/' && newdir
[1] == ':')
1283 /* First ensure newdir is an absolute name. */
1285 /* Detect MSDOS file names with drive specifiers. */
1286 ! (IS_DRIVE (newdir
[0])
1287 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1289 /* Detect Windows file names in UNC format. */
1290 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
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]))
1352 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1354 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1356 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1369 /* Ignore any slash at the end of newdir, unless newdir is
1370 just "/" or "//". */
1371 length
= strlen (newdir
);
1372 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1373 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1379 /* Now concatenate the directory and name to new space in the stack frame. */
1380 tlen
= length
+ file_name_as_directory_slop
+ strlen (nm
) + 1;
1382 /* Reserve space for drive specifier and escape prefix, since either
1383 or both may need to be inserted. (The Microsoft x86 compiler
1384 produces incorrect code if the following two lines are combined.) */
1385 target
= alloca (tlen
+ 4);
1387 #else /* not DOS_NT */
1388 target
= SAFE_ALLOCA (tlen
);
1389 #endif /* not DOS_NT */
1394 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1397 /* If newdir is effectively "C:/", then the drive letter will have
1398 been stripped and newdir will be "/". Concatenating with an
1399 absolute directory in nm produces "//", which will then be
1400 incorrectly treated as a network share. Ignore newdir in
1401 this case (keeping the drive letter). */
1402 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1403 && newdir
[1] == '\0'))
1406 memcpy (target
, newdir
, length
);
1411 file_name_as_directory (target
, newdir
, length
, multibyte
);
1414 strcat (target
, nm
);
1416 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1424 if (!IS_DIRECTORY_SEP (*p
))
1428 else if (p
[1] == '.'
1429 && (IS_DIRECTORY_SEP (p
[2])
1432 /* If "/." is the entire filename, keep the "/". Otherwise,
1433 just delete the whole "/.". */
1434 if (o
== target
&& p
[2] == '\0')
1438 else if (p
[1] == '.' && p
[2] == '.'
1439 /* `/../' is the "superroot" on certain file systems.
1440 Turned off on DOS_NT systems because they have no
1441 "superroot" and because this causes us to produce
1442 file names like "d:/../foo" which fail file-related
1443 functions of the underlying OS. (To reproduce, try a
1444 long series of "../../" in default_directory, longer
1445 than the number of levels from the root.) */
1449 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1454 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1457 /* Don't go below server level in UNC filenames. */
1458 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1459 && IS_DIRECTORY_SEP (*target
))
1463 /* Keep initial / only if this is the whole name. */
1464 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1468 else if (IS_DIRECTORY_SEP (p
[1])
1469 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1470 /* Collapse multiple "/", except leave leading "//" alone. */
1479 /* At last, set drive name. */
1481 /* Except for network file name. */
1482 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1483 #endif /* WINDOWSNT */
1485 if (!drive
) emacs_abort ();
1487 target
[0] = DRIVE_LETTER (drive
);
1490 /* Reinsert the escape prefix if required. */
1497 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1498 dostounix_filename (SSDATA (result
));
1500 if (!NILP (Vw32_downcase_file_names
))
1501 result
= Fdowncase (result
);
1504 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1505 #endif /* !DOS_NT */
1508 /* Again look to see if the file name has special constructs in it
1509 and perhaps call the corresponding file handler. This is needed
1510 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1511 the ".." component gives us "/user@host:/bar/../baz" which needs
1512 to be expanded again. */
1513 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1514 if (!NILP (handler
))
1516 handled_name
= call3 (handler
, Qexpand_file_name
,
1517 result
, default_directory
);
1518 if (! STRINGP (handled_name
))
1519 error ("Invalid handler in `file-name-handler-alist'");
1520 result
= handled_name
;
1528 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1529 This is the old version of expand-file-name, before it was thoroughly
1530 rewritten for Emacs 10.31. We leave this version here commented-out,
1531 because the code is very complex and likely to have subtle bugs. If
1532 bugs _are_ found, it might be of interest to look at the old code and
1533 see what did it do in the relevant situation.
1535 Don't remove this code: it's true that it will be accessible
1536 from the repository, but a few years from deletion, people will
1537 forget it is there. */
1539 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1540 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1541 "Convert FILENAME to absolute, and canonicalize it.\n\
1542 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1543 \(does not start with slash); if DEFAULT is nil or missing,\n\
1544 the current buffer's value of default-directory is used.\n\
1545 Filenames containing `.' or `..' as components are simplified;\n\
1546 initial `~/' expands to your home directory.\n\
1547 See also the function `substitute-in-file-name'.")
1549 Lisp_Object name
, defalt
;
1553 register unsigned char *newdir
, *p
, *o
;
1555 unsigned char *target
;
1558 CHECK_STRING (name
);
1561 /* If nm is absolute, flush ...// and detect /./ and /../.
1562 If no /./ or /../ we can return right away. */
1569 if (p
[0] == '/' && p
[1] == '/')
1571 if (p
[0] == '/' && p
[1] == '~')
1572 nm
= p
+ 1, lose
= 1;
1573 if (p
[0] == '/' && p
[1] == '.'
1574 && (p
[2] == '/' || p
[2] == 0
1575 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1581 if (nm
== SDATA (name
))
1583 return build_string (nm
);
1587 /* Now determine directory to start with and put it in NEWDIR. */
1591 if (nm
[0] == '~') /* prefix ~ */
1592 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1594 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1595 newdir
= (unsigned char *) "";
1598 else /* ~user/filename */
1600 /* Get past ~ to user. */
1601 unsigned char *user
= nm
+ 1;
1602 /* Find end of name. */
1603 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1604 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1605 /* Copy the user name into temp storage. */
1606 o
= alloca (len
+ 1);
1607 memcpy (o
, user
, len
);
1610 /* Look up the user name. */
1612 pw
= (struct passwd
*) getpwnam (o
+ 1);
1615 error ("\"%s\" isn't a registered user", o
+ 1);
1617 newdir
= (unsigned char *) pw
->pw_dir
;
1619 /* Discard the user name from NM. */
1623 if (nm
[0] != '/' && !newdir
)
1626 defalt
= current_buffer
->directory
;
1627 CHECK_STRING (defalt
);
1628 newdir
= SDATA (defalt
);
1631 /* Now concatenate the directory and name to new space in the stack frame. */
1633 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1634 target
= alloca (tlen
);
1639 if (nm
[0] == 0 || nm
[0] == '/')
1640 strcpy (target
, newdir
);
1642 file_name_as_directory (target
, newdir
);
1645 strcat (target
, nm
);
1647 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1658 else if (!strncmp (p
, "//", 2)
1664 else if (p
[0] == '/' && p
[1] == '.'
1665 && (p
[2] == '/' || p
[2] == 0))
1667 else if (!strncmp (p
, "/..", 3)
1668 /* `/../' is the "superroot" on certain file systems. */
1670 && (p
[3] == '/' || p
[3] == 0))
1672 while (o
!= target
&& *--o
!= '/')
1674 if (o
== target
&& *o
== '/')
1684 return make_string (target
, o
- target
);
1688 /* If /~ or // appears, discard everything through first slash. */
1690 file_name_absolute_p (const char *filename
)
1693 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1695 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1696 && IS_DIRECTORY_SEP (filename
[2]))
1702 search_embedded_absfilename (char *nm
, char *endp
)
1706 for (p
= nm
+ 1; p
< endp
; p
++)
1708 if (IS_DIRECTORY_SEP (p
[-1])
1709 && file_name_absolute_p (p
)
1710 #if defined (WINDOWSNT) || defined (CYGWIN)
1711 /* // at start of file name is meaningful in Apollo,
1712 WindowsNT and Cygwin systems. */
1713 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1714 #endif /* not (WINDOWSNT || CYGWIN) */
1717 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1718 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1720 char *o
= alloca (s
- p
+ 1);
1722 memcpy (o
, p
, s
- p
);
1725 /* If we have ~user and `user' exists, discard
1726 everything up to ~. But if `user' does not exist, leave
1727 ~user alone, it might be a literal file name. */
1729 pw
= getpwnam (o
+ 1);
1741 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1742 Ssubstitute_in_file_name
, 1, 1, 0,
1743 doc
: /* Substitute environment variables referred to in FILENAME.
1744 `$FOO' where FOO is an environment variable name means to substitute
1745 the value of that variable. The variable name should be terminated
1746 with a character not a letter, digit or underscore; otherwise, enclose
1747 the entire variable name in braces.
1749 If `/~' appears, all of FILENAME through that `/' is discarded.
1750 If `//' appears, everything up to and including the first of
1751 those `/' is discarded. */)
1752 (Lisp_Object filename
)
1754 char *nm
, *p
, *x
, *endp
;
1755 bool substituted
= false;
1758 Lisp_Object handler
;
1760 CHECK_STRING (filename
);
1762 multibyte
= STRING_MULTIBYTE (filename
);
1764 /* If the file name has special constructs in it,
1765 call the corresponding file handler. */
1766 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1767 if (!NILP (handler
))
1769 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1771 if (STRINGP (handled_name
))
1772 return handled_name
;
1773 error ("Invalid handler in `file-name-handler-alist'");
1776 /* Always work on a copy of the string, in case GC happens during
1777 decode of environment variables, causing the original Lisp_String
1778 data to be relocated. */
1779 nm
= xlispstrdupa (filename
);
1782 dostounix_filename (nm
);
1783 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1785 endp
= nm
+ SBYTES (filename
);
1787 /* If /~ or // appears, discard everything through first slash. */
1788 p
= search_embedded_absfilename (nm
, endp
);
1790 /* Start over with the new string, so we check the file-name-handler
1791 again. Important with filenames like "/home/foo//:/hello///there"
1792 which would substitute to "/:/hello///there" rather than "/there". */
1793 return Fsubstitute_in_file_name
1794 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1796 /* See if any variables are substituted into the string. */
1798 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1801 = (!substituted
? filename
1802 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1803 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1805 if (!EQ (tmp
, name
))
1813 if (!NILP (Vw32_downcase_file_names
))
1814 filename
= Fdowncase (filename
);
1819 xnm
= SSDATA (filename
);
1820 x
= xnm
+ SBYTES (filename
);
1822 /* If /~ or // appears, discard everything through first slash. */
1823 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1824 /* This time we do not start over because we've already expanded envvars
1825 and replaced $$ with $. Maybe we should start over as well, but we'd
1826 need to quote some $ to $$ first. */
1830 if (!NILP (Vw32_downcase_file_names
))
1832 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1834 xname
= Fdowncase (xname
);
1839 return (xnm
== SSDATA (filename
)
1841 : make_specified_string (xnm
, -1, x
- xnm
, multibyte
));
1844 /* A slightly faster and more convenient way to get
1845 (directory-file-name (expand-file-name FOO)). */
1848 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1850 register Lisp_Object absname
;
1852 absname
= Fexpand_file_name (filename
, defdir
);
1854 /* Remove final slash, if any (unless this is the root dir).
1855 stat behaves differently depending! */
1856 if (SCHARS (absname
) > 1
1857 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1858 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1859 /* We cannot take shortcuts; they might be wrong for magic file names. */
1860 absname
= Fdirectory_file_name (absname
);
1864 /* Signal an error if the file ABSNAME already exists.
1865 If INTERACTIVE, ask the user whether to proceed,
1866 and bypass the error if the user says to go ahead.
1867 QUERYSTRING is a name for the action that is being considered
1870 *STATPTR is used to store the stat information if the file exists.
1871 If the file does not exist, STATPTR->st_mode is set to 0.
1872 If STATPTR is null, we don't store into it.
1874 If QUICK, ask for y or n, not yes or no. */
1877 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1878 bool interactive
, struct stat
*statptr
,
1881 Lisp_Object tem
, encoded_filename
;
1882 struct stat statbuf
;
1883 struct gcpro gcpro1
;
1885 encoded_filename
= ENCODE_FILE (absname
);
1887 /* `stat' is a good way to tell whether the file exists,
1888 regardless of what access permissions it has. */
1889 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1891 if (S_ISDIR (statbuf
.st_mode
))
1892 xsignal2 (Qfile_error
,
1893 build_string ("File is a directory"), absname
);
1896 xsignal2 (Qfile_already_exists
,
1897 build_string ("File already exists"), absname
);
1899 tem
= format2 ("File %s already exists; %s anyway? ",
1900 absname
, build_string (querystring
));
1902 tem
= call1 (intern ("y-or-n-p"), tem
);
1904 tem
= do_yes_or_no_p (tem
);
1907 xsignal2 (Qfile_already_exists
,
1908 build_string ("File already exists"), absname
);
1915 statptr
->st_mode
= 0;
1920 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1921 "fCopy file: \nGCopy %s to file: \np\nP",
1922 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1923 If NEWNAME names a directory, copy FILE there.
1925 This function always sets the file modes of the output file to match
1928 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1929 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1930 signal a `file-already-exists' error without overwriting. If
1931 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1932 about overwriting; this is what happens in interactive use with M-x.
1933 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1936 Fourth arg KEEP-TIME non-nil means give the output file the same
1937 last-modified time as the old one. (This works on only some systems.)
1939 A prefix arg makes KEEP-TIME non-nil.
1941 If PRESERVE-UID-GID is non-nil, we try to transfer the
1942 uid and gid of FILE to NEWNAME.
1944 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1945 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1946 entries (depending on how Emacs was built). */)
1947 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
, Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
, Lisp_Object preserve_extended_attributes
)
1951 char buf
[16 * 1024];
1952 struct stat st
, out_st
;
1953 Lisp_Object handler
;
1954 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1955 ptrdiff_t count
= SPECPDL_INDEX ();
1956 Lisp_Object encoded_file
, encoded_newname
;
1958 security_context_t con
;
1965 encoded_file
= encoded_newname
= Qnil
;
1966 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1967 CHECK_STRING (file
);
1968 CHECK_STRING (newname
);
1970 if (!NILP (Ffile_directory_p (newname
)))
1971 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1973 newname
= Fexpand_file_name (newname
, Qnil
);
1975 file
= Fexpand_file_name (file
, Qnil
);
1977 /* If the input file name has special constructs in it,
1978 call the corresponding file handler. */
1979 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1980 /* Likewise for output file name. */
1982 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1983 if (!NILP (handler
))
1984 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1985 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1986 preserve_extended_attributes
));
1988 encoded_file
= ENCODE_FILE (file
);
1989 encoded_newname
= ENCODE_FILE (newname
);
1991 if (NILP (ok_if_already_exists
)
1992 || INTEGERP (ok_if_already_exists
))
1993 barf_or_query_if_file_exists (newname
, "copy to it",
1994 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1995 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1999 result
= w32_copy_file (SSDATA (encoded_file
), SSDATA (encoded_newname
),
2000 !NILP (keep_time
), !NILP (preserve_uid_gid
),
2001 !NILP (preserve_extended_attributes
));
2005 report_file_error ("Copying file", list2 (file
, newname
));
2007 report_file_error ("Copying permissions from", file
);
2009 xsignal2 (Qfile_date_error
,
2010 build_string ("Resetting file times"), newname
);
2012 report_file_error ("Copying permissions to", newname
);
2014 #else /* not WINDOWSNT */
2016 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2020 report_file_error ("Opening input file", file
);
2022 record_unwind_protect_int (close_file_unwind
, ifd
);
2024 if (fstat (ifd
, &st
) != 0)
2025 report_file_error ("Input file status", file
);
2027 if (!NILP (preserve_extended_attributes
))
2030 if (is_selinux_enabled ())
2032 conlength
= fgetfilecon (ifd
, &con
);
2033 if (conlength
== -1)
2034 report_file_error ("Doing fgetfilecon", file
);
2039 if (out_st
.st_mode
!= 0
2040 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2041 report_file_errno ("Input and output files are the same",
2042 list2 (file
, newname
), 0);
2044 /* We can copy only regular files. */
2045 if (!S_ISREG (st
.st_mode
))
2046 report_file_errno ("Non-regular file", file
,
2047 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
2051 int new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0600 : 0666);
2053 int new_mask
= S_IREAD
| S_IWRITE
;
2055 ofd
= emacs_open (SSDATA (encoded_newname
),
2056 (O_WRONLY
| O_TRUNC
| O_CREAT
2057 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2061 report_file_error ("Opening output file", newname
);
2063 record_unwind_protect_int (close_file_unwind
, ofd
);
2067 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2068 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2069 report_file_error ("Write error", newname
);
2073 /* Preserve the original file permissions, and if requested, also its
2076 mode_t mode_mask
= 07777;
2077 if (!NILP (preserve_uid_gid
))
2079 /* Attempt to change owner and group. If that doesn't work
2080 attempt to change just the group, as that is sometimes allowed.
2081 Adjust the mode mask to eliminate setuid or setgid bits
2082 that are inappropriate if the owner and group are wrong. */
2083 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2085 mode_mask
&= ~06000;
2086 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2091 switch (!NILP (preserve_extended_attributes
)
2092 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2093 SSDATA (encoded_newname
), ofd
,
2094 st
.st_mode
& mode_mask
)
2095 : fchmod (ofd
, st
.st_mode
& mode_mask
))
2097 case -2: report_file_error ("Copying permissions from", file
);
2098 case -1: report_file_error ("Copying permissions to", newname
);
2101 #endif /* not MSDOS */
2106 /* Set the modified context back to the file. */
2107 bool fail
= fsetfilecon (ofd
, con
) != 0;
2108 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2109 if (fail
&& errno
!= ENOTSUP
)
2110 report_file_error ("Doing fsetfilecon", newname
);
2116 if (!NILP (keep_time
))
2118 struct timespec atime
= get_stat_atime (&st
);
2119 struct timespec mtime
= get_stat_mtime (&st
);
2120 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2121 xsignal2 (Qfile_date_error
,
2122 build_string ("Cannot set file date"), newname
);
2125 if (emacs_close (ofd
) < 0)
2126 report_file_error ("Write error", newname
);
2131 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2132 and if it can't, it tells so. Otherwise, under MSDOS we usually
2133 get only the READ bit, which will make the copied file read-only,
2134 so it's better not to chmod at all. */
2135 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2136 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2138 #endif /* not WINDOWSNT */
2140 /* Discard the unwind protects. */
2141 specpdl_ptr
= specpdl
+ count
;
2147 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2148 Smake_directory_internal
, 1, 1, 0,
2149 doc
: /* Create a new directory named DIRECTORY. */)
2150 (Lisp_Object directory
)
2153 Lisp_Object handler
;
2154 Lisp_Object encoded_dir
;
2156 CHECK_STRING (directory
);
2157 directory
= Fexpand_file_name (directory
, Qnil
);
2159 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2160 if (!NILP (handler
))
2161 return call2 (handler
, Qmake_directory_internal
, directory
);
2163 encoded_dir
= ENCODE_FILE (directory
);
2165 dir
= SSDATA (encoded_dir
);
2168 if (mkdir (dir
) != 0)
2170 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2172 report_file_error ("Creating directory", directory
);
2177 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2178 Sdelete_directory_internal
, 1, 1, 0,
2179 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2180 (Lisp_Object directory
)
2183 Lisp_Object encoded_dir
;
2185 CHECK_STRING (directory
);
2186 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2187 encoded_dir
= ENCODE_FILE (directory
);
2188 dir
= SSDATA (encoded_dir
);
2190 if (rmdir (dir
) != 0)
2191 report_file_error ("Removing directory", directory
);
2196 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2197 "(list (read-file-name \
2198 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2199 \"Move file to trash: \" \"Delete file: \") \
2200 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2201 (null current-prefix-arg))",
2202 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2203 If file has multiple names, it continues to exist with the other names.
2204 TRASH non-nil means to trash the file instead of deleting, provided
2205 `delete-by-moving-to-trash' is non-nil.
2207 When called interactively, TRASH is t if no prefix argument is given.
2208 With a prefix argument, TRASH is nil. */)
2209 (Lisp_Object filename
, Lisp_Object trash
)
2211 Lisp_Object handler
;
2212 Lisp_Object encoded_file
;
2213 struct gcpro gcpro1
;
2216 if (!NILP (Ffile_directory_p (filename
))
2217 && NILP (Ffile_symlink_p (filename
)))
2218 xsignal2 (Qfile_error
,
2219 build_string ("Removing old name: is a directory"),
2222 filename
= Fexpand_file_name (filename
, Qnil
);
2224 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2225 if (!NILP (handler
))
2226 return call3 (handler
, Qdelete_file
, filename
, trash
);
2228 if (delete_by_moving_to_trash
&& !NILP (trash
))
2229 return call1 (Qmove_file_to_trash
, filename
);
2231 encoded_file
= ENCODE_FILE (filename
);
2233 if (unlink (SSDATA (encoded_file
)) < 0)
2234 report_file_error ("Removing old name", filename
);
2239 internal_delete_file_1 (Lisp_Object ignore
)
2244 /* Delete file FILENAME, returning true if successful.
2245 This ignores `delete-by-moving-to-trash'. */
2248 internal_delete_file (Lisp_Object filename
)
2252 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2253 Qt
, internal_delete_file_1
);
2257 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2258 "fRename file: \nGRename %s to file: \np",
2259 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2260 If file has names other than FILE, it continues to have those names.
2261 Signals a `file-already-exists' error if a file NEWNAME already exists
2262 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2263 A number as third arg means request confirmation if NEWNAME already exists.
2264 This is what happens in interactive use with M-x. */)
2265 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2267 Lisp_Object handler
;
2268 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2269 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2271 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2272 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2273 CHECK_STRING (file
);
2274 CHECK_STRING (newname
);
2275 file
= Fexpand_file_name (file
, Qnil
);
2277 if ((!NILP (Ffile_directory_p (newname
)))
2279 /* If the file names are identical but for the case,
2280 don't attempt to move directory to itself. */
2281 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2285 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2286 ? file
: Fdirectory_file_name (file
));
2287 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2290 newname
= Fexpand_file_name (newname
, Qnil
);
2292 /* If the file name has special constructs in it,
2293 call the corresponding file handler. */
2294 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2296 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2297 if (!NILP (handler
))
2298 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2299 file
, newname
, ok_if_already_exists
));
2301 encoded_file
= ENCODE_FILE (file
);
2302 encoded_newname
= ENCODE_FILE (newname
);
2305 /* If the file names are identical but for the case, don't ask for
2306 confirmation: they simply want to change the letter-case of the
2308 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2310 if (NILP (ok_if_already_exists
)
2311 || INTEGERP (ok_if_already_exists
))
2312 barf_or_query_if_file_exists (newname
, "rename to it",
2313 INTEGERP (ok_if_already_exists
), 0, 0);
2314 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2316 int rename_errno
= errno
;
2317 if (rename_errno
== EXDEV
)
2320 symlink_target
= Ffile_symlink_p (file
);
2321 if (! NILP (symlink_target
))
2322 Fmake_symbolic_link (symlink_target
, newname
,
2323 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2324 else if (!NILP (Ffile_directory_p (file
)))
2325 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2327 /* We have already prompted if it was an integer, so don't
2328 have copy-file prompt again. */
2329 Fcopy_file (file
, newname
,
2330 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2333 count
= SPECPDL_INDEX ();
2334 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2336 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2337 call2 (Qdelete_directory
, file
, Qt
);
2339 Fdelete_file (file
, Qnil
);
2340 unbind_to (count
, Qnil
);
2343 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2349 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2350 "fAdd name to file: \nGName to add to %s: \np",
2351 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2352 Signals a `file-already-exists' error if a file NEWNAME already exists
2353 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2354 A number as third arg means request confirmation if NEWNAME already exists.
2355 This is what happens in interactive use with M-x. */)
2356 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2358 Lisp_Object handler
;
2359 Lisp_Object encoded_file
, encoded_newname
;
2360 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2362 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2363 encoded_file
= encoded_newname
= Qnil
;
2364 CHECK_STRING (file
);
2365 CHECK_STRING (newname
);
2366 file
= Fexpand_file_name (file
, Qnil
);
2368 if (!NILP (Ffile_directory_p (newname
)))
2369 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2371 newname
= Fexpand_file_name (newname
, Qnil
);
2373 /* If the file name has special constructs in it,
2374 call the corresponding file handler. */
2375 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2376 if (!NILP (handler
))
2377 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2378 newname
, ok_if_already_exists
));
2380 /* If the new name has special constructs in it,
2381 call the corresponding file handler. */
2382 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2383 if (!NILP (handler
))
2384 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2385 newname
, ok_if_already_exists
));
2387 encoded_file
= ENCODE_FILE (file
);
2388 encoded_newname
= ENCODE_FILE (newname
);
2390 if (NILP (ok_if_already_exists
)
2391 || INTEGERP (ok_if_already_exists
))
2392 barf_or_query_if_file_exists (newname
, "make it a new name",
2393 INTEGERP (ok_if_already_exists
), 0, 0);
2395 unlink (SSDATA (newname
));
2396 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2398 int link_errno
= errno
;
2399 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2406 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2407 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2408 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2409 Both args must be strings.
2410 Signals a `file-already-exists' error if a file LINKNAME already exists
2411 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2412 A number as third arg means request confirmation if LINKNAME already exists.
2413 This happens for interactive use with M-x. */)
2414 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2416 Lisp_Object handler
;
2417 Lisp_Object encoded_filename
, encoded_linkname
;
2418 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2420 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2421 encoded_filename
= encoded_linkname
= Qnil
;
2422 CHECK_STRING (filename
);
2423 CHECK_STRING (linkname
);
2424 /* If the link target has a ~, we must expand it to get
2425 a truly valid file name. Otherwise, do not expand;
2426 we want to permit links to relative file names. */
2427 if (SREF (filename
, 0) == '~')
2428 filename
= Fexpand_file_name (filename
, Qnil
);
2430 if (!NILP (Ffile_directory_p (linkname
)))
2431 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2433 linkname
= Fexpand_file_name (linkname
, Qnil
);
2435 /* If the file name has special constructs in it,
2436 call the corresponding file handler. */
2437 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2438 if (!NILP (handler
))
2439 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2440 linkname
, ok_if_already_exists
));
2442 /* If the new link name has special constructs in it,
2443 call the corresponding file handler. */
2444 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2445 if (!NILP (handler
))
2446 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2447 linkname
, ok_if_already_exists
));
2449 encoded_filename
= ENCODE_FILE (filename
);
2450 encoded_linkname
= ENCODE_FILE (linkname
);
2452 if (NILP (ok_if_already_exists
)
2453 || INTEGERP (ok_if_already_exists
))
2454 barf_or_query_if_file_exists (linkname
, "make it a link",
2455 INTEGERP (ok_if_already_exists
), 0, 0);
2456 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2458 /* If we didn't complain already, silently delete existing file. */
2460 if (errno
== EEXIST
)
2462 unlink (SSDATA (encoded_linkname
));
2463 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2470 if (errno
== ENOSYS
)
2473 xsignal1 (Qfile_error
,
2474 build_string ("Symbolic links are not supported"));
2477 symlink_errno
= errno
;
2478 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2486 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2488 doc
: /* Return t if file FILENAME specifies an absolute file name.
2489 On Unix, this is a name starting with a `/' or a `~'. */)
2490 (Lisp_Object filename
)
2492 CHECK_STRING (filename
);
2493 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2496 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2497 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2498 See also `file-readable-p' and `file-attributes'.
2499 This returns nil for a symlink to a nonexistent file.
2500 Use `file-symlink-p' to test for such links. */)
2501 (Lisp_Object filename
)
2503 Lisp_Object absname
;
2504 Lisp_Object handler
;
2506 CHECK_STRING (filename
);
2507 absname
= Fexpand_file_name (filename
, Qnil
);
2509 /* If the file name has special constructs in it,
2510 call the corresponding file handler. */
2511 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2512 if (!NILP (handler
))
2514 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2519 absname
= ENCODE_FILE (absname
);
2521 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2524 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2525 doc
: /* Return t if FILENAME can be executed by you.
2526 For a directory, this means you can access files in that directory. */)
2527 (Lisp_Object filename
)
2529 Lisp_Object absname
;
2530 Lisp_Object handler
;
2532 CHECK_STRING (filename
);
2533 absname
= Fexpand_file_name (filename
, Qnil
);
2535 /* If the file name has special constructs in it,
2536 call the corresponding file handler. */
2537 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2538 if (!NILP (handler
))
2539 return call2 (handler
, Qfile_executable_p
, absname
);
2541 absname
= ENCODE_FILE (absname
);
2543 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2546 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2547 doc
: /* Return t if file FILENAME exists and you can read it.
2548 See also `file-exists-p' and `file-attributes'. */)
2549 (Lisp_Object filename
)
2551 Lisp_Object absname
;
2552 Lisp_Object handler
;
2554 CHECK_STRING (filename
);
2555 absname
= Fexpand_file_name (filename
, Qnil
);
2557 /* If the file name has special constructs in it,
2558 call the corresponding file handler. */
2559 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2560 if (!NILP (handler
))
2561 return call2 (handler
, Qfile_readable_p
, absname
);
2563 absname
= ENCODE_FILE (absname
);
2564 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2568 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2569 doc
: /* Return t if file FILENAME can be written or created by you. */)
2570 (Lisp_Object filename
)
2572 Lisp_Object absname
, dir
, encoded
;
2573 Lisp_Object handler
;
2575 CHECK_STRING (filename
);
2576 absname
= Fexpand_file_name (filename
, Qnil
);
2578 /* If the file name has special constructs in it,
2579 call the corresponding file handler. */
2580 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2581 if (!NILP (handler
))
2582 return call2 (handler
, Qfile_writable_p
, absname
);
2584 encoded
= ENCODE_FILE (absname
);
2585 if (check_writable (SSDATA (encoded
), W_OK
))
2587 if (errno
!= ENOENT
)
2590 dir
= Ffile_name_directory (absname
);
2591 eassert (!NILP (dir
));
2593 dir
= Fdirectory_file_name (dir
);
2596 dir
= ENCODE_FILE (dir
);
2598 /* The read-only attribute of the parent directory doesn't affect
2599 whether a file or directory can be created within it. Some day we
2600 should check ACLs though, which do affect this. */
2601 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2603 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2607 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2608 doc
: /* Access file FILENAME, and get an error if that does not work.
2609 The second argument STRING is used in the error message.
2610 If there is no error, returns nil. */)
2611 (Lisp_Object filename
, Lisp_Object string
)
2613 Lisp_Object handler
, encoded_filename
, absname
;
2615 CHECK_STRING (filename
);
2616 absname
= Fexpand_file_name (filename
, Qnil
);
2618 CHECK_STRING (string
);
2620 /* If the file name has special constructs in it,
2621 call the corresponding file handler. */
2622 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2623 if (!NILP (handler
))
2624 return call3 (handler
, Qaccess_file
, absname
, string
);
2626 encoded_filename
= ENCODE_FILE (absname
);
2628 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2629 report_file_error (SSDATA (string
), filename
);
2634 /* Relative to directory FD, return the symbolic link value of FILENAME.
2635 On failure, return nil. */
2637 emacs_readlinkat (int fd
, char const *filename
)
2639 static struct allocator
const emacs_norealloc_allocator
=
2640 { xmalloc
, NULL
, xfree
, memory_full
};
2642 char readlink_buf
[1024];
2643 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2644 &emacs_norealloc_allocator
, readlinkat
);
2648 val
= build_unibyte_string (buf
);
2649 if (buf
[0] == '/' && strchr (buf
, ':'))
2650 val
= concat2 (build_unibyte_string ("/:"), val
);
2651 if (buf
!= readlink_buf
)
2653 val
= DECODE_FILE (val
);
2657 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2658 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2659 The value is the link target, as a string.
2660 Otherwise it returns nil.
2662 This function returns t when given the name of a symlink that
2663 points to a nonexistent file. */)
2664 (Lisp_Object filename
)
2666 Lisp_Object handler
;
2668 CHECK_STRING (filename
);
2669 filename
= Fexpand_file_name (filename
, Qnil
);
2671 /* If the file name has special constructs in it,
2672 call the corresponding file handler. */
2673 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2674 if (!NILP (handler
))
2675 return call2 (handler
, Qfile_symlink_p
, filename
);
2677 filename
= ENCODE_FILE (filename
);
2679 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2682 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2683 doc
: /* Return t if FILENAME names an existing directory.
2684 Symbolic links to directories count as directories.
2685 See `file-symlink-p' to distinguish symlinks. */)
2686 (Lisp_Object filename
)
2688 Lisp_Object absname
;
2689 Lisp_Object handler
;
2691 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2693 /* If the file name has special constructs in it,
2694 call the corresponding file handler. */
2695 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2696 if (!NILP (handler
))
2697 return call2 (handler
, Qfile_directory_p
, absname
);
2699 absname
= ENCODE_FILE (absname
);
2701 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2704 /* Return true if FILE is a directory or a symlink to a directory. */
2706 file_directory_p (char const *file
)
2709 /* This is cheaper than 'stat'. */
2710 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2713 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2717 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2718 Sfile_accessible_directory_p
, 1, 1, 0,
2719 doc
: /* Return t if file FILENAME names a directory you can open.
2720 For the value to be t, FILENAME must specify the name of a directory as a file,
2721 and the directory must allow you to open files in it. In order to use a
2722 directory as a buffer's current directory, this predicate must return true.
2723 A directory name spec may be given instead; then the value is t
2724 if the directory so specified exists and really is a readable and
2725 searchable directory. */)
2726 (Lisp_Object filename
)
2728 Lisp_Object absname
;
2729 Lisp_Object handler
;
2731 CHECK_STRING (filename
);
2732 absname
= Fexpand_file_name (filename
, Qnil
);
2734 /* If the file name has special constructs in it,
2735 call the corresponding file handler. */
2736 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2737 if (!NILP (handler
))
2739 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2744 absname
= ENCODE_FILE (absname
);
2745 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2748 /* If FILE is a searchable directory or a symlink to a
2749 searchable directory, return true. Otherwise return
2750 false and set errno to an error number. */
2752 file_accessible_directory_p (char const *file
)
2755 /* There's no need to test whether FILE is searchable, as the
2756 searchable/executable bit is invented on DOS_NT platforms. */
2757 return file_directory_p (file
);
2759 /* On POSIXish platforms, use just one system call; this avoids a
2760 race and is typically faster. */
2761 ptrdiff_t len
= strlen (file
);
2767 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2768 There are three exceptions: "", "/", and "//". Leave "" alone,
2769 as it's invalid. Append only "." to the other two exceptions as
2770 "/" and "//" are distinct on some platforms, whereas "/", "///",
2771 "////", etc. are all equivalent. */
2776 /* Just check for trailing '/' when deciding whether to append '/'.
2777 That's simpler than testing the two special cases "/" and "//",
2778 and it's a safe optimization here. */
2779 char *buf
= SAFE_ALLOCA (len
+ 3);
2780 memcpy (buf
, file
, len
);
2781 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2785 ok
= check_existing (dir
);
2786 saved_errno
= errno
;
2788 errno
= saved_errno
;
2793 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2794 doc
: /* Return t if FILENAME names a regular file.
2795 This is the sort of file that holds an ordinary stream of data bytes.
2796 Symbolic links to regular files count as regular files.
2797 See `file-symlink-p' to distinguish symlinks. */)
2798 (Lisp_Object filename
)
2800 register Lisp_Object absname
;
2802 Lisp_Object handler
;
2804 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2806 /* If the file name has special constructs in it,
2807 call the corresponding file handler. */
2808 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2809 if (!NILP (handler
))
2810 return call2 (handler
, Qfile_regular_p
, absname
);
2812 absname
= ENCODE_FILE (absname
);
2817 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2819 /* Tell stat to use expensive method to get accurate info. */
2820 Vw32_get_true_file_attributes
= Qt
;
2821 result
= stat (SDATA (absname
), &st
);
2822 Vw32_get_true_file_attributes
= tem
;
2826 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2829 if (stat (SSDATA (absname
), &st
) < 0)
2831 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2835 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2836 Sfile_selinux_context
, 1, 1, 0,
2837 doc
: /* Return SELinux context of file named FILENAME.
2838 The return value is a list (USER ROLE TYPE RANGE), where the list
2839 elements are strings naming the user, role, type, and range of the
2840 file's SELinux security context.
2842 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2843 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2844 (Lisp_Object filename
)
2846 Lisp_Object absname
;
2847 Lisp_Object values
[4];
2848 Lisp_Object handler
;
2850 security_context_t con
;
2855 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2857 /* If the file name has special constructs in it,
2858 call the corresponding file handler. */
2859 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2860 if (!NILP (handler
))
2861 return call2 (handler
, Qfile_selinux_context
, absname
);
2863 absname
= ENCODE_FILE (absname
);
2870 if (is_selinux_enabled ())
2872 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2875 context
= context_new (con
);
2876 if (context_user_get (context
))
2877 values
[0] = build_string (context_user_get (context
));
2878 if (context_role_get (context
))
2879 values
[1] = build_string (context_role_get (context
));
2880 if (context_type_get (context
))
2881 values
[2] = build_string (context_type_get (context
));
2882 if (context_range_get (context
))
2883 values
[3] = build_string (context_range_get (context
));
2884 context_free (context
);
2890 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2893 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2894 Sset_file_selinux_context
, 2, 2, 0,
2895 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2896 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2897 elements are strings naming the components of a SELinux context.
2899 Value is t if setting of SELinux context was successful, nil otherwise.
2901 This function does nothing and returns nil if SELinux is disabled,
2902 or if Emacs was not compiled with SELinux support. */)
2903 (Lisp_Object filename
, Lisp_Object context
)
2905 Lisp_Object absname
;
2906 Lisp_Object handler
;
2908 Lisp_Object encoded_absname
;
2909 Lisp_Object user
= CAR_SAFE (context
);
2910 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2911 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2912 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2913 security_context_t con
;
2916 context_t parsed_con
;
2919 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2921 /* If the file name has special constructs in it,
2922 call the corresponding file handler. */
2923 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2924 if (!NILP (handler
))
2925 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2928 if (is_selinux_enabled ())
2930 /* Get current file context. */
2931 encoded_absname
= ENCODE_FILE (absname
);
2932 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2935 parsed_con
= context_new (con
);
2936 /* Change the parts defined in the parameter.*/
2939 if (context_user_set (parsed_con
, SSDATA (user
)))
2940 error ("Doing context_user_set");
2944 if (context_role_set (parsed_con
, SSDATA (role
)))
2945 error ("Doing context_role_set");
2949 if (context_type_set (parsed_con
, SSDATA (type
)))
2950 error ("Doing context_type_set");
2952 if (STRINGP (range
))
2954 if (context_range_set (parsed_con
, SSDATA (range
)))
2955 error ("Doing context_range_set");
2958 /* Set the modified context back to the file. */
2959 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2960 context_str (parsed_con
))
2962 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2963 if (fail
&& errno
!= ENOTSUP
)
2964 report_file_error ("Doing lsetfilecon", absname
);
2966 context_free (parsed_con
);
2968 return fail
? Qnil
: Qt
;
2971 report_file_error ("Doing lgetfilecon", absname
);
2978 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
2979 doc
: /* Return ACL entries of file named FILENAME.
2980 The entries are returned in a format suitable for use in `set-file-acl'
2981 but is otherwise undocumented and subject to change.
2982 Return nil if file does not exist or is not accessible, or if Emacs
2983 was unable to determine the ACL entries. */)
2984 (Lisp_Object filename
)
2986 Lisp_Object absname
;
2987 Lisp_Object handler
;
2988 #ifdef HAVE_ACL_SET_FILE
2990 Lisp_Object acl_string
;
2994 absname
= expand_and_dir_to_file (filename
,
2995 BVAR (current_buffer
, directory
));
2997 /* If the file name has special constructs in it,
2998 call the corresponding file handler. */
2999 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3000 if (!NILP (handler
))
3001 return call2 (handler
, Qfile_acl
, absname
);
3003 #ifdef HAVE_ACL_SET_FILE
3004 absname
= ENCODE_FILE (absname
);
3006 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3010 str
= acl_to_text (acl
, NULL
);
3017 acl_string
= build_string (str
);
3027 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3029 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3030 ACL-STRING should contain the textual representation of the ACL
3031 entries in a format suitable for the platform.
3033 Value is t if setting of ACL was successful, nil otherwise.
3035 Setting ACL for local files requires Emacs to be built with ACL
3037 (Lisp_Object filename
, Lisp_Object acl_string
)
3039 Lisp_Object absname
;
3040 Lisp_Object handler
;
3041 #ifdef HAVE_ACL_SET_FILE
3042 Lisp_Object encoded_absname
;
3047 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3049 /* If the file name has special constructs in it,
3050 call the corresponding file handler. */
3051 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3052 if (!NILP (handler
))
3053 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3055 #ifdef HAVE_ACL_SET_FILE
3056 if (STRINGP (acl_string
))
3058 acl
= acl_from_text (SSDATA (acl_string
));
3061 report_file_error ("Converting ACL", absname
);
3065 encoded_absname
= ENCODE_FILE (absname
);
3067 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3070 if (fail
&& acl_errno_valid (errno
))
3071 report_file_error ("Setting ACL", absname
);
3074 return fail
? Qnil
: Qt
;
3081 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3082 doc
: /* Return mode bits of file named FILENAME, as an integer.
3083 Return nil, if file does not exist or is not accessible. */)
3084 (Lisp_Object filename
)
3086 Lisp_Object absname
;
3088 Lisp_Object handler
;
3090 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3092 /* If the file name has special constructs in it,
3093 call the corresponding file handler. */
3094 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3095 if (!NILP (handler
))
3096 return call2 (handler
, Qfile_modes
, absname
);
3098 absname
= ENCODE_FILE (absname
);
3100 if (stat (SSDATA (absname
), &st
) < 0)
3103 return make_number (st
.st_mode
& 07777);
3106 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3107 "(let ((file (read-file-name \"File: \"))) \
3108 (list file (read-file-modes nil file)))",
3109 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3110 Only the 12 low bits of MODE are used.
3112 Interactively, mode bits are read by `read-file-modes', which accepts
3113 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3114 (Lisp_Object filename
, Lisp_Object mode
)
3116 Lisp_Object absname
, encoded_absname
;
3117 Lisp_Object handler
;
3119 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3120 CHECK_NUMBER (mode
);
3122 /* If the file name has special constructs in it,
3123 call the corresponding file handler. */
3124 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3125 if (!NILP (handler
))
3126 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3128 encoded_absname
= ENCODE_FILE (absname
);
3130 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3131 report_file_error ("Doing chmod", absname
);
3136 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3137 doc
: /* Set the file permission bits for newly created files.
3138 The argument MODE should be an integer; only the low 9 bits are used.
3139 This setting is inherited by subprocesses. */)
3142 CHECK_NUMBER (mode
);
3144 umask ((~ XINT (mode
)) & 0777);
3149 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3150 doc
: /* Return the default file protection for created files.
3151 The value is an integer. */)
3158 realmask
= umask (0);
3162 XSETINT (value
, (~ realmask
) & 0777);
3167 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3168 doc
: /* Set times of file FILENAME to TIMESTAMP.
3169 Set both access and modification times.
3170 Return t on success, else nil.
3171 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3173 (Lisp_Object filename
, Lisp_Object timestamp
)
3175 Lisp_Object absname
, encoded_absname
;
3176 Lisp_Object handler
;
3177 struct timespec t
= lisp_time_argument (timestamp
);
3179 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3181 /* If the file name has special constructs in it,
3182 call the corresponding file handler. */
3183 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3184 if (!NILP (handler
))
3185 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3187 encoded_absname
= ENCODE_FILE (absname
);
3190 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3193 /* Setting times on a directory always fails. */
3194 if (file_directory_p (SSDATA (encoded_absname
)))
3197 report_file_error ("Setting file times", absname
);
3205 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3206 doc
: /* Tell Unix to finish all pending disk updates. */)
3213 #endif /* HAVE_SYNC */
3215 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3216 doc
: /* Return t if file FILE1 is newer than file FILE2.
3217 If FILE1 does not exist, the answer is nil;
3218 otherwise, if FILE2 does not exist, the answer is t. */)
3219 (Lisp_Object file1
, Lisp_Object file2
)
3221 Lisp_Object absname1
, absname2
;
3222 struct stat st1
, st2
;
3223 Lisp_Object handler
;
3224 struct gcpro gcpro1
, gcpro2
;
3226 CHECK_STRING (file1
);
3227 CHECK_STRING (file2
);
3230 GCPRO2 (absname1
, file2
);
3231 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3232 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3235 /* If the file name has special constructs in it,
3236 call the corresponding file handler. */
3237 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3239 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3240 if (!NILP (handler
))
3241 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3243 GCPRO2 (absname1
, absname2
);
3244 absname1
= ENCODE_FILE (absname1
);
3245 absname2
= ENCODE_FILE (absname2
);
3248 if (stat (SSDATA (absname1
), &st1
) < 0)
3251 if (stat (SSDATA (absname2
), &st2
) < 0)
3254 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3258 #ifndef READ_BUF_SIZE
3259 #define READ_BUF_SIZE (64 << 10)
3261 /* Some buffer offsets are stored in 'int' variables. */
3262 verify (READ_BUF_SIZE
<= INT_MAX
);
3264 /* This function is called after Lisp functions to decide a coding
3265 system are called, or when they cause an error. Before they are
3266 called, the current buffer is set unibyte and it contains only a
3267 newly inserted text (thus the buffer was empty before the
3270 The functions may set markers, overlays, text properties, or even
3271 alter the buffer contents, change the current buffer.
3273 Here, we reset all those changes by:
3274 o set back the current buffer.
3275 o move all markers and overlays to BEG.
3276 o remove all text properties.
3277 o set back the buffer multibyteness. */
3280 decide_coding_unwind (Lisp_Object unwind_data
)
3282 Lisp_Object multibyte
, undo_list
, buffer
;
3284 multibyte
= XCAR (unwind_data
);
3285 unwind_data
= XCDR (unwind_data
);
3286 undo_list
= XCAR (unwind_data
);
3287 buffer
= XCDR (unwind_data
);
3289 set_buffer_internal (XBUFFER (buffer
));
3290 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3291 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3292 set_buffer_intervals (current_buffer
, NULL
);
3293 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3295 /* Now we are safe to change the buffer's multibyteness directly. */
3296 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3297 bset_undo_list (current_buffer
, undo_list
);
3300 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3301 object where slot 0 is the file descriptor, slot 1 specifies
3302 an offset to put the read bytes, and slot 2 is the maximum
3303 amount of bytes to read. Value is the number of bytes read. */
3306 read_non_regular (Lisp_Object state
)
3312 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3313 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3314 + XSAVE_INTEGER (state
, 1)),
3315 XSAVE_INTEGER (state
, 2));
3317 /* Fast recycle this object for the likely next call. */
3319 return make_number (nbytes
);
3323 /* Condition-case handler used when reading from non-regular files
3324 in insert-file-contents. */
3327 read_non_regular_quit (Lisp_Object ignore
)
3332 /* Return the file offset that VAL represents, checking for type
3333 errors and overflow. */
3335 file_offset (Lisp_Object val
)
3337 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3342 double v
= XFLOAT_DATA (val
);
3344 && (sizeof (off_t
) < sizeof v
3345 ? v
<= TYPE_MAXIMUM (off_t
)
3346 : v
< TYPE_MAXIMUM (off_t
)))
3350 wrong_type_argument (intern ("file-offset"), val
);
3353 /* Return a special time value indicating the error number ERRNUM. */
3354 static struct timespec
3355 time_error_value (int errnum
)
3357 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3358 ? NONEXISTENT_MODTIME_NSECS
3359 : UNKNOWN_MODTIME_NSECS
);
3360 return make_timespec (0, ns
);
3363 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3365 doc
: /* Insert contents of file FILENAME after point.
3366 Returns list of absolute file name and number of characters inserted.
3367 If second argument VISIT is non-nil, the buffer's visited filename and
3368 last save file modtime are set, and it is marked unmodified. If
3369 visiting and the file does not exist, visiting is completed before the
3372 The optional third and fourth arguments BEG and END specify what portion
3373 of the file to insert. These arguments count bytes in the file, not
3374 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3376 If optional fifth argument REPLACE is non-nil, replace the current
3377 buffer contents (in the accessible portion) with the file contents.
3378 This is better than simply deleting and inserting the whole thing
3379 because (1) it preserves some marker positions and (2) it puts less data
3380 in the undo list. When REPLACE is non-nil, the second return value is
3381 the number of characters that replace previous buffer contents.
3383 This function does code conversion according to the value of
3384 `coding-system-for-read' or `file-coding-system-alist', and sets the
3385 variable `last-coding-system-used' to the coding system actually used.
3387 In addition, this function decodes the inserted text from known formats
3388 by calling `format-decode', which see. */)
3389 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3392 struct timespec mtime
;
3394 ptrdiff_t inserted
= 0;
3396 off_t beg_offset
, end_offset
;
3398 ptrdiff_t count
= SPECPDL_INDEX ();
3399 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3400 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3402 ptrdiff_t total
= 0;
3403 bool not_regular
= 0;
3405 char read_buf
[READ_BUF_SIZE
];
3406 struct coding_system coding
;
3407 bool replace_handled
= 0;
3408 bool set_coding_system
= 0;
3409 Lisp_Object coding_system
;
3411 /* If the undo log only contains the insertion, there's no point
3412 keeping it. It's typically when we first fill a file-buffer. */
3413 bool empty_undo_list_p
3414 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3416 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3417 bool we_locked_file
= 0;
3420 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3421 error ("Cannot do file visiting in an indirect buffer");
3423 if (!NILP (BVAR (current_buffer
, read_only
)))
3424 Fbarf_if_buffer_read_only ();
3428 orig_filename
= Qnil
;
3431 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3433 CHECK_STRING (filename
);
3434 filename
= Fexpand_file_name (filename
, Qnil
);
3436 /* The value Qnil means that the coding system is not yet
3438 coding_system
= Qnil
;
3440 /* If the file name has special constructs in it,
3441 call the corresponding file handler. */
3442 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3443 if (!NILP (handler
))
3445 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3446 visit
, beg
, end
, replace
);
3447 if (CONSP (val
) && CONSP (XCDR (val
))
3448 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3449 inserted
= XINT (XCAR (XCDR (val
)));
3453 orig_filename
= filename
;
3454 filename
= ENCODE_FILE (filename
);
3456 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3461 report_file_error ("Opening input file", orig_filename
);
3462 mtime
= time_error_value (save_errno
);
3464 if (!NILP (Vcoding_system_for_read
))
3465 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3469 fd_index
= SPECPDL_INDEX ();
3470 record_unwind_protect_int (close_file_unwind
, fd
);
3472 /* Replacement should preserve point as it preserves markers. */
3473 if (!NILP (replace
))
3474 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3476 if (fstat (fd
, &st
) != 0)
3477 report_file_error ("Input file status", orig_filename
);
3478 mtime
= get_stat_mtime (&st
);
3480 /* This code will need to be changed in order to work on named
3481 pipes, and it's probably just not worth it. So we should at
3482 least signal an error. */
3483 if (!S_ISREG (st
.st_mode
))
3490 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3491 xsignal2 (Qfile_error
,
3492 build_string ("not a regular file"), orig_filename
);
3497 if (!NILP (beg
) || !NILP (end
))
3498 error ("Attempt to visit less than an entire file");
3499 if (BEG
< Z
&& NILP (replace
))
3500 error ("Cannot do file visiting in a non-empty buffer");
3504 beg_offset
= file_offset (beg
);
3509 end_offset
= file_offset (end
);
3513 end_offset
= TYPE_MAXIMUM (off_t
);
3516 end_offset
= st
.st_size
;
3518 /* A negative size can happen on a platform that allows file
3519 sizes greater than the maximum off_t value. */
3523 /* The file size returned from stat may be zero, but data
3524 may be readable nonetheless, for example when this is a
3525 file in the /proc filesystem. */
3526 if (end_offset
== 0)
3527 end_offset
= READ_BUF_SIZE
;
3531 /* Check now whether the buffer will become too large,
3532 in the likely case where the file's length is not changing.
3533 This saves a lot of needless work before a buffer overflow. */
3536 /* The likely offset where we will stop reading. We could read
3537 more (or less), if the file grows (or shrinks) as we read it. */
3538 off_t likely_end
= min (end_offset
, st
.st_size
);
3540 if (beg_offset
< likely_end
)
3543 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3544 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3545 off_t likely_growth
= likely_end
- beg_offset
;
3546 if (buf_growth_max
< likely_growth
)
3551 /* Prevent redisplay optimizations. */
3552 current_buffer
->clip_changed
= 1;
3554 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3556 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3557 setup_coding_system (coding_system
, &coding
);
3558 /* Ensure we set Vlast_coding_system_used. */
3559 set_coding_system
= 1;
3563 /* Decide the coding system to use for reading the file now
3564 because we can't use an optimized method for handling
3565 `coding:' tag if the current buffer is not empty. */
3566 if (!NILP (Vcoding_system_for_read
))
3567 coding_system
= Vcoding_system_for_read
;
3570 /* Don't try looking inside a file for a coding system
3571 specification if it is not seekable. */
3572 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3574 /* Find a coding system specified in the heading two
3575 lines or in the tailing several lines of the file.
3576 We assume that the 1K-byte and 3K-byte for heading
3577 and tailing respectively are sufficient for this
3581 if (st
.st_size
<= (1024 * 4))
3582 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3585 nread
= emacs_read (fd
, read_buf
, 1024);
3589 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3590 report_file_error ("Setting file position",
3592 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3593 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3598 report_file_error ("Read error", orig_filename
);
3601 struct buffer
*prev
= current_buffer
;
3602 Lisp_Object workbuf
;
3605 record_unwind_current_buffer ();
3607 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3608 buf
= XBUFFER (workbuf
);
3610 delete_all_overlays (buf
);
3611 bset_directory (buf
, BVAR (current_buffer
, directory
));
3612 bset_read_only (buf
, Qnil
);
3613 bset_filename (buf
, Qnil
);
3614 bset_undo_list (buf
, Qt
);
3615 eassert (buf
->overlays_before
== NULL
);
3616 eassert (buf
->overlays_after
== NULL
);
3618 set_buffer_internal (buf
);
3620 bset_enable_multibyte_characters (buf
, Qnil
);
3622 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3623 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3624 coding_system
= call2 (Vset_auto_coding_function
,
3625 filename
, make_number (nread
));
3626 set_buffer_internal (prev
);
3628 /* Discard the unwind protect for recovering the
3632 /* Rewind the file for the actual read done later. */
3633 if (lseek (fd
, 0, SEEK_SET
) < 0)
3634 report_file_error ("Setting file position", orig_filename
);
3638 if (NILP (coding_system
))
3640 /* If we have not yet decided a coding system, check
3641 file-coding-system-alist. */
3642 Lisp_Object args
[6];
3644 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3645 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3646 coding_system
= Ffind_operation_coding_system (6, args
);
3647 if (CONSP (coding_system
))
3648 coding_system
= XCAR (coding_system
);
3652 if (NILP (coding_system
))
3653 coding_system
= Qundecided
;
3655 CHECK_CODING_SYSTEM (coding_system
);
3657 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3658 /* We must suppress all character code conversion except for
3659 end-of-line conversion. */
3660 coding_system
= raw_text_coding_system (coding_system
);
3662 setup_coding_system (coding_system
, &coding
);
3663 /* Ensure we set Vlast_coding_system_used. */
3664 set_coding_system
= 1;
3667 /* If requested, replace the accessible part of the buffer
3668 with the file contents. Avoid replacing text at the
3669 beginning or end of the buffer that matches the file contents;
3670 that preserves markers pointing to the unchanged parts.
3672 Here we implement this feature in an optimized way
3673 for the case where code conversion is NOT needed.
3674 The following if-statement handles the case of conversion
3675 in a less optimal way.
3677 If the code conversion is "automatic" then we try using this
3678 method and hope for the best.
3679 But if we discover the need for conversion, we give up on this method
3680 and let the following if-statement handle the replace job. */
3683 && (NILP (coding_system
)
3684 || ! CODING_REQUIRE_DECODING (&coding
)))
3686 /* same_at_start and same_at_end count bytes,
3687 because file access counts bytes
3688 and BEG and END count bytes. */
3689 ptrdiff_t same_at_start
= BEGV_BYTE
;
3690 ptrdiff_t same_at_end
= ZV_BYTE
;
3692 /* There is still a possibility we will find the need to do code
3693 conversion. If that happens, set this variable to
3694 give up on handling REPLACE in the optimized way. */
3695 bool giveup_match_end
= 0;
3697 if (beg_offset
!= 0)
3699 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3700 report_file_error ("Setting file position", orig_filename
);
3705 /* Count how many chars at the start of the file
3706 match the text at the beginning of the buffer. */
3711 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3713 report_file_error ("Read error", orig_filename
);
3714 else if (nread
== 0)
3717 if (CODING_REQUIRE_DETECTION (&coding
))
3719 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3722 setup_coding_system (coding_system
, &coding
);
3725 if (CODING_REQUIRE_DECODING (&coding
))
3726 /* We found that the file should be decoded somehow.
3727 Let's give up here. */
3729 giveup_match_end
= 1;
3734 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3735 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3736 same_at_start
++, bufpos
++;
3737 /* If we found a discrepancy, stop the scan.
3738 Otherwise loop around and scan the next bufferful. */
3739 if (bufpos
!= nread
)
3743 /* If the file matches the buffer completely,
3744 there's no need to replace anything. */
3745 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3748 clear_unwind_protect (fd_index
);
3750 /* Truncate the buffer to the size of the file. */
3751 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3756 /* Count how many chars at the end of the file
3757 match the text at the end of the buffer. But, if we have
3758 already found that decoding is necessary, don't waste time. */
3759 while (!giveup_match_end
)
3761 int total_read
, nread
, bufpos
, trial
;
3764 /* At what file position are we now scanning? */
3765 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3766 /* If the entire file matches the buffer tail, stop the scan. */
3769 /* How much can we scan in the next step? */
3770 trial
= min (curpos
, sizeof read_buf
);
3771 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3772 report_file_error ("Setting file position", orig_filename
);
3774 total_read
= nread
= 0;
3775 while (total_read
< trial
)
3777 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3779 report_file_error ("Read error", orig_filename
);
3780 else if (nread
== 0)
3782 total_read
+= nread
;
3785 /* Scan this bufferful from the end, comparing with
3786 the Emacs buffer. */
3787 bufpos
= total_read
;
3789 /* Compare with same_at_start to avoid counting some buffer text
3790 as matching both at the file's beginning and at the end. */
3791 while (bufpos
> 0 && same_at_end
> same_at_start
3792 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3793 same_at_end
--, bufpos
--;
3795 /* If we found a discrepancy, stop the scan.
3796 Otherwise loop around and scan the preceding bufferful. */
3799 /* If this discrepancy is because of code conversion,
3800 we cannot use this method; giveup and try the other. */
3801 if (same_at_end
> same_at_start
3802 && FETCH_BYTE (same_at_end
- 1) >= 0200
3803 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3804 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3805 giveup_match_end
= 1;
3814 if (! giveup_match_end
)
3818 /* We win! We can handle REPLACE the optimized way. */
3820 /* Extend the start of non-matching text area to multibyte
3821 character boundary. */
3822 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3823 while (same_at_start
> BEGV_BYTE
3824 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3827 /* Extend the end of non-matching text area to multibyte
3828 character boundary. */
3829 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3830 while (same_at_end
< ZV_BYTE
3831 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3834 /* Don't try to reuse the same piece of text twice. */
3835 overlap
= (same_at_start
- BEGV_BYTE
3837 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3839 same_at_end
+= overlap
;
3841 /* Arrange to read only the nonmatching middle part of the file. */
3842 beg_offset
+= same_at_start
- BEGV_BYTE
;
3843 end_offset
-= ZV_BYTE
- same_at_end
;
3845 invalidate_buffer_caches (current_buffer
,
3846 BYTE_TO_CHAR (same_at_start
),
3847 BYTE_TO_CHAR (same_at_end
));
3848 del_range_byte (same_at_start
, same_at_end
, 0);
3849 /* Insert from the file at the proper position. */
3850 temp
= BYTE_TO_CHAR (same_at_start
);
3851 SET_PT_BOTH (temp
, same_at_start
);
3853 /* If display currently starts at beginning of line,
3854 keep it that way. */
3855 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3856 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3858 replace_handled
= 1;
3862 /* If requested, replace the accessible part of the buffer
3863 with the file contents. Avoid replacing text at the
3864 beginning or end of the buffer that matches the file contents;
3865 that preserves markers pointing to the unchanged parts.
3867 Here we implement this feature for the case where code conversion
3868 is needed, in a simple way that needs a lot of memory.
3869 The preceding if-statement handles the case of no conversion
3870 in a more optimized way. */
3871 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3873 ptrdiff_t same_at_start
= BEGV_BYTE
;
3874 ptrdiff_t same_at_end
= ZV_BYTE
;
3875 ptrdiff_t same_at_start_charpos
;
3876 ptrdiff_t inserted_chars
;
3879 unsigned char *decoded
;
3882 ptrdiff_t this_count
= SPECPDL_INDEX ();
3884 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3885 Lisp_Object conversion_buffer
;
3886 struct gcpro gcpro1
;
3888 conversion_buffer
= code_conversion_save (1, multibyte
);
3890 /* First read the whole file, performing code conversion into
3891 CONVERSION_BUFFER. */
3893 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3894 report_file_error ("Setting file position", orig_filename
);
3896 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3897 unprocessed
= 0; /* Bytes not processed in previous loop. */
3899 GCPRO1 (conversion_buffer
);
3902 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3903 quitting while reading a huge file. */
3905 /* Allow quitting out of the actual I/O. */
3908 this = emacs_read (fd
, read_buf
+ unprocessed
,
3909 READ_BUF_SIZE
- unprocessed
);
3915 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3916 BUF_Z (XBUFFER (conversion_buffer
)));
3917 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3918 unprocessed
+ this, conversion_buffer
);
3919 unprocessed
= coding
.carryover_bytes
;
3920 if (coding
.carryover_bytes
> 0)
3921 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3925 report_file_error ("Read error", orig_filename
);
3927 clear_unwind_protect (fd_index
);
3929 if (unprocessed
> 0)
3931 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3932 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3933 unprocessed
, conversion_buffer
);
3934 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3937 coding_system
= CODING_ID_NAME (coding
.id
);
3938 set_coding_system
= 1;
3939 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3940 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3941 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3943 /* Compare the beginning of the converted string with the buffer
3947 while (bufpos
< inserted
&& same_at_start
< same_at_end
3948 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3949 same_at_start
++, bufpos
++;
3951 /* If the file matches the head of buffer completely,
3952 there's no need to replace anything. */
3954 if (bufpos
== inserted
)
3956 /* Truncate the buffer to the size of the file. */
3957 if (same_at_start
!= same_at_end
)
3959 invalidate_buffer_caches (current_buffer
,
3960 BYTE_TO_CHAR (same_at_start
),
3961 BYTE_TO_CHAR (same_at_end
));
3962 del_range_byte (same_at_start
, same_at_end
, 0);
3966 unbind_to (this_count
, Qnil
);
3970 /* Extend the start of non-matching text area to the previous
3971 multibyte character boundary. */
3972 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3973 while (same_at_start
> BEGV_BYTE
3974 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3977 /* Scan this bufferful from the end, comparing with
3978 the Emacs buffer. */
3981 /* Compare with same_at_start to avoid counting some buffer text
3982 as matching both at the file's beginning and at the end. */
3983 while (bufpos
> 0 && same_at_end
> same_at_start
3984 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3985 same_at_end
--, bufpos
--;
3987 /* Extend the end of non-matching text area to the next
3988 multibyte character boundary. */
3989 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3990 while (same_at_end
< ZV_BYTE
3991 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3994 /* Don't try to reuse the same piece of text twice. */
3995 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3997 same_at_end
+= overlap
;
3999 /* If display currently starts at beginning of line,
4000 keep it that way. */
4001 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4002 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4004 /* Replace the chars that we need to replace,
4005 and update INSERTED to equal the number of bytes
4006 we are taking from the decoded string. */
4007 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4009 if (same_at_end
!= same_at_start
)
4011 invalidate_buffer_caches (current_buffer
,
4012 BYTE_TO_CHAR (same_at_start
),
4013 BYTE_TO_CHAR (same_at_end
));
4014 del_range_byte (same_at_start
, same_at_end
, 0);
4016 eassert (same_at_start
== GPT_BYTE
);
4017 same_at_start
= GPT_BYTE
;
4021 temp
= BYTE_TO_CHAR (same_at_start
);
4023 /* Insert from the file at the proper position. */
4024 SET_PT_BOTH (temp
, same_at_start
);
4025 same_at_start_charpos
4026 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4027 same_at_start
- BEGV_BYTE
4028 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4029 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4031 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4032 same_at_start
+ inserted
- BEGV_BYTE
4033 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4034 - same_at_start_charpos
);
4035 /* This binding is to avoid ask-user-about-supersession-threat
4036 being called in insert_from_buffer (via in
4037 prepare_to_modify_buffer). */
4038 specbind (intern ("buffer-file-name"), Qnil
);
4039 insert_from_buffer (XBUFFER (conversion_buffer
),
4040 same_at_start_charpos
, inserted_chars
, 0);
4041 /* Set `inserted' to the number of inserted characters. */
4042 inserted
= PT
- temp
;
4043 /* Set point before the inserted characters. */
4044 SET_PT_BOTH (temp
, same_at_start
);
4046 unbind_to (this_count
, Qnil
);
4052 total
= end_offset
- beg_offset
;
4054 /* For a special file, all we can do is guess. */
4055 total
= READ_BUF_SIZE
;
4057 if (NILP (visit
) && total
> 0)
4059 #ifdef CLASH_DETECTION
4060 if (!NILP (BVAR (current_buffer
, file_truename
))
4061 /* Make binding buffer-file-name to nil effective. */
4062 && !NILP (BVAR (current_buffer
, filename
))
4063 && SAVE_MODIFF
>= MODIFF
)
4065 #endif /* CLASH_DETECTION */
4066 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4069 move_gap_both (PT
, PT_BYTE
);
4070 if (GAP_SIZE
< total
)
4071 make_gap (total
- GAP_SIZE
);
4073 if (beg_offset
!= 0 || !NILP (replace
))
4075 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4076 report_file_error ("Setting file position", orig_filename
);
4079 /* In the following loop, HOW_MUCH contains the total bytes read so
4080 far for a regular file, and not changed for a special file. But,
4081 before exiting the loop, it is set to a negative value if I/O
4085 /* Total bytes inserted. */
4088 /* Here, we don't do code conversion in the loop. It is done by
4089 decode_coding_gap after all data are read into the buffer. */
4091 ptrdiff_t gap_size
= GAP_SIZE
;
4093 while (how_much
< total
)
4095 /* try is reserved in some compilers (Microsoft C) */
4096 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4103 /* Maybe make more room. */
4104 if (gap_size
< trytry
)
4106 make_gap (trytry
- gap_size
);
4107 gap_size
= GAP_SIZE
- inserted
;
4110 /* Read from the file, capturing `quit'. When an
4111 error occurs, end the loop, and arrange for a quit
4112 to be signaled after decoding the text we read. */
4113 nbytes
= internal_condition_case_1
4115 make_save_int_int_int (fd
, inserted
, trytry
),
4116 Qerror
, read_non_regular_quit
);
4124 this = XINT (nbytes
);
4128 /* Allow quitting out of the actual I/O. We don't make text
4129 part of the buffer until all the reading is done, so a C-g
4130 here doesn't do any harm. */
4133 this = emacs_read (fd
,
4134 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4148 /* For a regular file, where TOTAL is the real size,
4149 count HOW_MUCH to compare with it.
4150 For a special file, where TOTAL is just a buffer size,
4151 so don't bother counting in HOW_MUCH.
4152 (INSERTED is where we count the number of characters inserted.) */
4159 /* Now we have either read all the file data into the gap,
4160 or stop reading on I/O error or quit. If nothing was
4161 read, undo marking the buffer modified. */
4165 #ifdef CLASH_DETECTION
4167 unlock_file (BVAR (current_buffer
, file_truename
));
4169 Vdeactivate_mark
= old_Vdeactivate_mark
;
4172 Vdeactivate_mark
= Qt
;
4175 clear_unwind_protect (fd_index
);
4178 report_file_error ("Read error", orig_filename
);
4180 /* Make the text read part of the buffer. */
4181 GAP_SIZE
-= inserted
;
4183 GPT_BYTE
+= inserted
;
4185 ZV_BYTE
+= inserted
;
4190 /* Put an anchor to ensure multi-byte form ends at gap. */
4195 if (NILP (coding_system
))
4197 /* The coding system is not yet decided. Decide it by an
4198 optimized method for handling `coding:' tag.
4200 Note that we can get here only if the buffer was empty
4201 before the insertion. */
4203 if (!NILP (Vcoding_system_for_read
))
4204 coding_system
= Vcoding_system_for_read
;
4207 /* Since we are sure that the current buffer was empty
4208 before the insertion, we can toggle
4209 enable-multibyte-characters directly here without taking
4210 care of marker adjustment. By this way, we can run Lisp
4211 program safely before decoding the inserted text. */
4212 Lisp_Object unwind_data
;
4213 ptrdiff_t count1
= SPECPDL_INDEX ();
4215 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4216 Fcons (BVAR (current_buffer
, undo_list
),
4217 Fcurrent_buffer ()));
4218 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4219 bset_undo_list (current_buffer
, Qt
);
4220 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4222 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4224 coding_system
= call2 (Vset_auto_coding_function
,
4225 filename
, make_number (inserted
));
4228 if (NILP (coding_system
))
4230 /* If the coding system is not yet decided, check
4231 file-coding-system-alist. */
4232 Lisp_Object args
[6];
4234 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4235 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4236 coding_system
= Ffind_operation_coding_system (6, args
);
4237 if (CONSP (coding_system
))
4238 coding_system
= XCAR (coding_system
);
4240 unbind_to (count1
, Qnil
);
4241 inserted
= Z_BYTE
- BEG_BYTE
;
4244 if (NILP (coding_system
))
4245 coding_system
= Qundecided
;
4247 CHECK_CODING_SYSTEM (coding_system
);
4249 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4250 /* We must suppress all character code conversion except for
4251 end-of-line conversion. */
4252 coding_system
= raw_text_coding_system (coding_system
);
4253 setup_coding_system (coding_system
, &coding
);
4254 /* Ensure we set Vlast_coding_system_used. */
4255 set_coding_system
= 1;
4260 /* When we visit a file by raw-text, we change the buffer to
4262 if (CODING_FOR_UNIBYTE (&coding
)
4263 /* Can't do this if part of the buffer might be preserved. */
4265 /* Visiting a file with these coding system makes the buffer
4267 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4270 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4271 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4272 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4274 move_gap_both (PT
, PT_BYTE
);
4275 GAP_SIZE
+= inserted
;
4276 ZV_BYTE
-= inserted
;
4280 decode_coding_gap (&coding
, inserted
, inserted
);
4281 inserted
= coding
.produced_char
;
4282 coding_system
= CODING_ID_NAME (coding
.id
);
4284 else if (inserted
> 0)
4285 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4288 /* Call after-change hooks for the inserted text, aside from the case
4289 of normal visiting (not with REPLACE), which is done in a new buffer
4290 "before" the buffer is changed. */
4291 if (inserted
> 0 && total
> 0
4292 && (NILP (visit
) || !NILP (replace
)))
4294 signal_after_change (PT
, 0, inserted
);
4295 update_compositions (PT
, PT
, CHECK_BORDER
);
4298 /* Now INSERTED is measured in characters. */
4304 if (empty_undo_list_p
)
4305 bset_undo_list (current_buffer
, Qnil
);
4309 current_buffer
->modtime
= mtime
;
4310 current_buffer
->modtime_size
= st
.st_size
;
4311 bset_filename (current_buffer
, orig_filename
);
4314 SAVE_MODIFF
= MODIFF
;
4315 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4316 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4317 #ifdef CLASH_DETECTION
4320 if (!NILP (BVAR (current_buffer
, file_truename
)))
4321 unlock_file (BVAR (current_buffer
, file_truename
));
4322 unlock_file (filename
);
4324 #endif /* CLASH_DETECTION */
4326 xsignal2 (Qfile_error
,
4327 build_string ("not a regular file"), orig_filename
);
4330 if (set_coding_system
)
4331 Vlast_coding_system_used
= coding_system
;
4333 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4335 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4337 if (! NILP (insval
))
4339 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4340 wrong_type_argument (intern ("inserted-chars"), insval
);
4341 inserted
= XFASTINT (insval
);
4345 /* Decode file format. */
4348 /* Don't run point motion or modification hooks when decoding. */
4349 ptrdiff_t count1
= SPECPDL_INDEX ();
4350 ptrdiff_t old_inserted
= inserted
;
4351 specbind (Qinhibit_point_motion_hooks
, Qt
);
4352 specbind (Qinhibit_modification_hooks
, Qt
);
4354 /* Save old undo list and don't record undo for decoding. */
4355 old_undo
= BVAR (current_buffer
, undo_list
);
4356 bset_undo_list (current_buffer
, Qt
);
4360 insval
= call3 (Qformat_decode
,
4361 Qnil
, make_number (inserted
), visit
);
4362 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4363 wrong_type_argument (intern ("inserted-chars"), insval
);
4364 inserted
= XFASTINT (insval
);
4368 /* If REPLACE is non-nil and we succeeded in not replacing the
4369 beginning or end of the buffer text with the file's contents,
4370 call format-decode with `point' positioned at the beginning
4371 of the buffer and `inserted' equaling the number of
4372 characters in the buffer. Otherwise, format-decode might
4373 fail to correctly analyze the beginning or end of the buffer.
4374 Hence we temporarily save `point' and `inserted' here and
4375 restore `point' iff format-decode did not insert or delete
4376 any text. Otherwise we leave `point' at point-min. */
4377 ptrdiff_t opoint
= PT
;
4378 ptrdiff_t opoint_byte
= PT_BYTE
;
4379 ptrdiff_t oinserted
= ZV
- BEGV
;
4380 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4382 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4383 insval
= call3 (Qformat_decode
,
4384 Qnil
, make_number (oinserted
), visit
);
4385 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4386 wrong_type_argument (intern ("inserted-chars"), insval
);
4387 if (ochars_modiff
== CHARS_MODIFF
)
4388 /* format_decode didn't modify buffer's characters => move
4389 point back to position before inserted text and leave
4390 value of inserted alone. */
4391 SET_PT_BOTH (opoint
, opoint_byte
);
4393 /* format_decode modified buffer's characters => consider
4394 entire buffer changed and leave point at point-min. */
4395 inserted
= XFASTINT (insval
);
4398 /* For consistency with format-decode call these now iff inserted > 0
4399 (martin 2007-06-28). */
4400 p
= Vafter_insert_file_functions
;
4405 insval
= call1 (XCAR (p
), make_number (inserted
));
4408 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4409 wrong_type_argument (intern ("inserted-chars"), insval
);
4410 inserted
= XFASTINT (insval
);
4415 /* For the rationale of this see the comment on
4416 format-decode above. */
4417 ptrdiff_t opoint
= PT
;
4418 ptrdiff_t opoint_byte
= PT_BYTE
;
4419 ptrdiff_t oinserted
= ZV
- BEGV
;
4420 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4422 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4423 insval
= call1 (XCAR (p
), make_number (oinserted
));
4426 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4427 wrong_type_argument (intern ("inserted-chars"), insval
);
4428 if (ochars_modiff
== CHARS_MODIFF
)
4429 /* after_insert_file_functions didn't modify
4430 buffer's characters => move point back to
4431 position before inserted text and leave value of
4433 SET_PT_BOTH (opoint
, opoint_byte
);
4435 /* after_insert_file_functions did modify buffer's
4436 characters => consider entire buffer changed and
4437 leave point at point-min. */
4438 inserted
= XFASTINT (insval
);
4446 if (!empty_undo_list_p
)
4448 bset_undo_list (current_buffer
, old_undo
);
4449 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4451 /* Adjust the last undo record for the size change during
4452 the format conversion. */
4453 Lisp_Object tem
= XCAR (old_undo
);
4454 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4455 && INTEGERP (XCDR (tem
))
4456 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4457 XSETCDR (tem
, make_number (PT
+ inserted
));
4461 /* If undo_list was Qt before, keep it that way.
4462 Otherwise start with an empty undo_list. */
4463 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4465 unbind_to (count1
, Qnil
);
4469 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4471 /* If visiting nonexistent file, return nil. */
4472 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4475 /* We made a lot of deletions and insertions above, so invalidate
4476 the newline cache for the entire region of the inserted
4478 if (current_buffer
->newline_cache
)
4479 invalidate_region_cache (current_buffer
,
4480 current_buffer
->newline_cache
,
4481 PT
- BEG
, Z
- PT
- inserted
);
4484 Fsignal (Qquit
, Qnil
);
4486 /* Retval needs to be dealt with in all cases consistently. */
4488 val
= list2 (orig_filename
, make_number (inserted
));
4490 RETURN_UNGCPRO (unbind_to (count
, val
));
4493 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4496 build_annotations_unwind (Lisp_Object arg
)
4498 Vwrite_region_annotation_buffers
= arg
;
4501 /* Decide the coding-system to encode the data with. */
4503 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4504 Schoose_write_coding_system
, 3, 6, 0,
4505 doc
: /* Choose the coding system for writing a file.
4506 Arguments are as for `write-region'.
4507 This function is for internal use only. It may prompt the user. */ )
4508 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4509 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4512 Lisp_Object eol_parent
= Qnil
;
4514 /* Mimic write-region behavior. */
4517 XSETFASTINT (start
, BEGV
);
4518 XSETFASTINT (end
, ZV
);
4522 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4523 BVAR (current_buffer
, auto_save_file_name
))))
4528 else if (!NILP (Vcoding_system_for_write
))
4530 val
= Vcoding_system_for_write
;
4531 if (coding_system_require_warning
4532 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4533 /* Confirm that VAL can surely encode the current region. */
4534 val
= call5 (Vselect_safe_coding_system_function
,
4535 start
, end
, list2 (Qt
, val
),
4540 /* If the variable `buffer-file-coding-system' is set locally,
4541 it means that the file was read with some kind of code
4542 conversion or the variable is explicitly set by users. We
4543 had better write it out with the same coding system even if
4544 `enable-multibyte-characters' is nil.
4546 If it is not set locally, we anyway have to convert EOL
4547 format if the default value of `buffer-file-coding-system'
4548 tells that it is not Unix-like (LF only) format. */
4549 bool using_default_coding
= 0;
4550 bool force_raw_text
= 0;
4552 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4554 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4557 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4563 /* Check file-coding-system-alist. */
4564 Lisp_Object args
[7], coding_systems
;
4566 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4567 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4569 coding_systems
= Ffind_operation_coding_system (7, args
);
4570 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4571 val
= XCDR (coding_systems
);
4576 /* If we still have not decided a coding system, use the
4577 default value of buffer-file-coding-system. */
4578 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4579 using_default_coding
= 1;
4582 if (! NILP (val
) && ! force_raw_text
)
4584 Lisp_Object spec
, attrs
;
4586 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4587 attrs
= AREF (spec
, 0);
4588 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4593 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4594 /* Confirm that VAL can surely encode the current region. */
4595 val
= call5 (Vselect_safe_coding_system_function
,
4596 start
, end
, val
, Qnil
, filename
);
4598 /* If the decided coding-system doesn't specify end-of-line
4599 format, we use that of
4600 `default-buffer-file-coding-system'. */
4601 if (! using_default_coding
4602 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4603 val
= (coding_inherit_eol_type
4604 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4606 /* If we decide not to encode text, use `raw-text' or one of its
4609 val
= raw_text_coding_system (val
);
4612 val
= coding_inherit_eol_type (val
, eol_parent
);
4616 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4617 "r\nFWrite region to file: \ni\ni\ni\np",
4618 doc
: /* Write current region into specified file.
4619 When called from a program, requires three arguments:
4620 START, END and FILENAME. START and END are normally buffer positions
4621 specifying the part of the buffer to write.
4622 If START is nil, that means to use the entire buffer contents.
4623 If START is a string, then output that string to the file
4624 instead of any buffer contents; END is ignored.
4626 Optional fourth argument APPEND if non-nil means
4627 append to existing file contents (if any). If it is a number,
4628 seek to that offset in the file before writing.
4629 Optional fifth argument VISIT, if t or a string, means
4630 set the last-save-file-modtime of buffer to this file's modtime
4631 and mark buffer not modified.
4632 If VISIT is a string, it is a second file name;
4633 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4634 VISIT is also the file name to lock and unlock for clash detection.
4635 If VISIT is neither t nor nil nor a string,
4636 that means do not display the \"Wrote file\" message.
4637 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4638 use for locking and unlocking, overriding FILENAME and VISIT.
4639 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4640 for an existing file with the same name. If MUSTBENEW is `excl',
4641 that means to get an error if the file already exists; never overwrite.
4642 If MUSTBENEW is neither nil nor `excl', that means ask for
4643 confirmation before overwriting, but do go ahead and overwrite the file
4644 if the user confirms.
4646 This does code conversion according to the value of
4647 `coding-system-for-write', `buffer-file-coding-system', or
4648 `file-coding-system-alist', and sets the variable
4649 `last-coding-system-used' to the coding system actually used.
4651 This calls `write-region-annotate-functions' at the start, and
4652 `write-region-post-annotation-function' at the end. */)
4653 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4654 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4656 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4660 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4661 descriptor for FILENAME, so do not open or close FILENAME. */
4664 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4665 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4666 Lisp_Object mustbenew
, int desc
)
4670 off_t offset
IF_LINT (= 0);
4671 bool open_and_close_file
= desc
< 0;
4676 struct timespec modtime
;
4677 ptrdiff_t count
= SPECPDL_INDEX ();
4678 ptrdiff_t count1
IF_LINT (= 0);
4679 Lisp_Object handler
;
4680 Lisp_Object visit_file
;
4681 Lisp_Object annotations
;
4682 Lisp_Object encoded_filename
;
4683 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4684 bool quietly
= !NILP (visit
);
4685 bool file_locked
= 0;
4686 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4687 struct buffer
*given_buffer
;
4688 struct coding_system coding
;
4690 if (current_buffer
->base_buffer
&& visiting
)
4691 error ("Cannot do file visiting in an indirect buffer");
4693 if (!NILP (start
) && !STRINGP (start
))
4694 validate_region (&start
, &end
);
4697 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4699 filename
= Fexpand_file_name (filename
, Qnil
);
4701 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4702 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4704 if (STRINGP (visit
))
4705 visit_file
= Fexpand_file_name (visit
, Qnil
);
4707 visit_file
= filename
;
4709 if (NILP (lockname
))
4710 lockname
= visit_file
;
4714 /* If the file name has special constructs in it,
4715 call the corresponding file handler. */
4716 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4717 /* If FILENAME has no handler, see if VISIT has one. */
4718 if (NILP (handler
) && STRINGP (visit
))
4719 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4721 if (!NILP (handler
))
4724 val
= call6 (handler
, Qwrite_region
, start
, end
,
4725 filename
, append
, visit
);
4729 SAVE_MODIFF
= MODIFF
;
4730 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4731 bset_filename (current_buffer
, visit_file
);
4737 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4739 /* Special kludge to simplify auto-saving. */
4742 /* Do it later, so write-region-annotate-function can work differently
4743 if we save "the buffer" vs "a region".
4744 This is useful in tar-mode. --Stef
4745 XSETFASTINT (start, BEG);
4746 XSETFASTINT (end, Z); */
4750 record_unwind_protect (build_annotations_unwind
,
4751 Vwrite_region_annotation_buffers
);
4752 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4754 given_buffer
= current_buffer
;
4756 if (!STRINGP (start
))
4758 annotations
= build_annotations (start
, end
);
4760 if (current_buffer
!= given_buffer
)
4762 XSETFASTINT (start
, BEGV
);
4763 XSETFASTINT (end
, ZV
);
4769 XSETFASTINT (start
, BEGV
);
4770 XSETFASTINT (end
, ZV
);
4775 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4777 /* Decide the coding-system to encode the data with.
4778 We used to make this choice before calling build_annotations, but that
4779 leads to problems when a write-annotate-function takes care of
4780 unsavable chars (as was the case with X-Symbol). */
4781 Vlast_coding_system_used
=
4782 Fchoose_write_coding_system (start
, end
, filename
,
4783 append
, visit
, lockname
);
4785 setup_coding_system (Vlast_coding_system_used
, &coding
);
4787 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4788 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4790 #ifdef CLASH_DETECTION
4791 if (open_and_close_file
&& !auto_saving
)
4793 lock_file (lockname
);
4796 #endif /* CLASH_DETECTION */
4798 encoded_filename
= ENCODE_FILE (filename
);
4799 fn
= SSDATA (encoded_filename
);
4800 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4801 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4802 if (NUMBERP (append
))
4803 offset
= file_offset (append
);
4804 else if (!NILP (append
))
4805 open_flags
|= O_APPEND
;
4807 mode
= S_IREAD
| S_IWRITE
;
4809 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4812 if (open_and_close_file
)
4814 desc
= emacs_open (fn
, open_flags
, mode
);
4817 int open_errno
= errno
;
4818 #ifdef CLASH_DETECTION
4820 unlock_file (lockname
);
4821 #endif /* CLASH_DETECTION */
4823 report_file_errno ("Opening output file", filename
, open_errno
);
4826 count1
= SPECPDL_INDEX ();
4827 record_unwind_protect_int (close_file_unwind
, desc
);
4830 if (NUMBERP (append
))
4832 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4835 int lseek_errno
= errno
;
4836 #ifdef CLASH_DETECTION
4838 unlock_file (lockname
);
4839 #endif /* CLASH_DETECTION */
4841 report_file_errno ("Lseek error", filename
, lseek_errno
);
4849 if (STRINGP (start
))
4850 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4851 else if (XINT (start
) != XINT (end
))
4852 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4853 &annotations
, &coding
);
4856 /* If file was empty, still need to write the annotations. */
4857 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4858 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4862 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4863 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4865 /* We have to flush out a data. */
4866 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4867 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4873 /* fsync is not crucial for temporary files. Nor for auto-save
4874 files, since they might lose some work anyway. */
4875 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4877 /* Transfer data and metadata to disk, retrying if interrupted.
4878 fsync can report a write failure here, e.g., due to disk full
4879 under NFS. But ignore EINVAL, which means fsync is not
4880 supported on this file. */
4881 while (fsync (desc
) != 0)
4884 if (errno
!= EINVAL
)
4885 ok
= 0, save_errno
= errno
;
4890 modtime
= invalid_timespec ();
4893 if (fstat (desc
, &st
) == 0)
4894 modtime
= get_stat_mtime (&st
);
4896 ok
= 0, save_errno
= errno
;
4899 if (open_and_close_file
)
4901 /* NFS can report a write failure now. */
4902 if (emacs_close (desc
) < 0)
4903 ok
= 0, save_errno
= errno
;
4905 /* Discard the unwind protect for close_file_unwind. */
4906 specpdl_ptr
= specpdl
+ count1
;
4909 /* Some file systems have a bug where st_mtime is not updated
4910 properly after a write. For example, CIFS might not see the
4911 st_mtime change until after the file is opened again.
4913 Attempt to detect this file system bug, and update MODTIME to the
4914 newer st_mtime if the bug appears to be present. This introduces
4915 a race condition, so to avoid most instances of the race condition
4916 on non-buggy file systems, skip this check if the most recently
4917 encountered non-buggy file system was the current file system.
4919 A race condition can occur if some other process modifies the
4920 file between the fstat above and the fstat below, but the race is
4921 unlikely and a similar race between the last write and the fstat
4922 above cannot possibly be closed anyway. */
4924 if (timespec_valid_p (modtime
)
4925 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4927 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4931 if (fstat (desc1
, &st1
) == 0
4932 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4934 /* Use the heuristic if it appears to be valid. With neither
4935 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4936 file, the time stamp won't change. Also, some non-POSIX
4937 systems don't update an empty file's time stamp when
4938 truncating it. Finally, file systems with 100 ns or worse
4939 resolution sometimes seem to have bugs: on a system with ns
4940 resolution, checking ns % 100 incorrectly avoids the heuristic
4941 1% of the time, but the problem should be temporary as we will
4942 try again on the next time stamp. */
4944 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4946 && modtime
.tv_nsec
% 100 != 0);
4948 struct timespec modtime1
= get_stat_mtime (&st1
);
4950 && timespec_cmp (modtime
, modtime1
) == 0
4951 && st
.st_size
== st1
.st_size
)
4953 timestamp_file_system
= st
.st_dev
;
4954 valid_timestamp_file_system
= 1;
4958 st
.st_size
= st1
.st_size
;
4962 emacs_close (desc1
);
4966 /* Call write-region-post-annotation-function. */
4967 while (CONSP (Vwrite_region_annotation_buffers
))
4969 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4970 if (!NILP (Fbuffer_live_p (buf
)))
4973 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4974 call0 (Vwrite_region_post_annotation_function
);
4976 Vwrite_region_annotation_buffers
4977 = XCDR (Vwrite_region_annotation_buffers
);
4980 unbind_to (count
, Qnil
);
4982 #ifdef CLASH_DETECTION
4984 unlock_file (lockname
);
4985 #endif /* CLASH_DETECTION */
4987 /* Do this before reporting IO error
4988 to avoid a "file has changed on disk" warning on
4989 next attempt to save. */
4990 if (timespec_valid_p (modtime
))
4992 current_buffer
->modtime
= modtime
;
4993 current_buffer
->modtime_size
= st
.st_size
;
4997 report_file_errno ("Write error", filename
, save_errno
);
5001 SAVE_MODIFF
= MODIFF
;
5002 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5003 bset_filename (current_buffer
, visit_file
);
5004 update_mode_lines
= 14;
5009 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5010 BVAR (current_buffer
, auto_save_file_name
))))
5011 SAVE_MODIFF
= MODIFF
;
5017 message_with_string ((NUMBERP (append
)
5027 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5028 doc
: /* Return t if (car A) is numerically less than (car B). */)
5029 (Lisp_Object a
, Lisp_Object b
)
5031 Lisp_Object args
[2] = { Fcar (a
), Fcar (b
), };
5032 return Flss (2, args
);
5035 /* Build the complete list of annotations appropriate for writing out
5036 the text between START and END, by calling all the functions in
5037 write-region-annotate-functions and merging the lists they return.
5038 If one of these functions switches to a different buffer, we assume
5039 that buffer contains altered text. Therefore, the caller must
5040 make sure to restore the current buffer in all cases,
5041 as save-excursion would do. */
5044 build_annotations (Lisp_Object start
, Lisp_Object end
)
5046 Lisp_Object annotations
;
5048 struct gcpro gcpro1
, gcpro2
;
5049 Lisp_Object original_buffer
;
5051 bool used_global
= 0;
5053 XSETBUFFER (original_buffer
, current_buffer
);
5056 p
= Vwrite_region_annotate_functions
;
5057 GCPRO2 (annotations
, p
);
5060 struct buffer
*given_buffer
= current_buffer
;
5061 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5062 { /* Use the global value of the hook. */
5065 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5067 p
= Fappend (2, arg
);
5070 Vwrite_region_annotations_so_far
= annotations
;
5071 res
= call2 (XCAR (p
), start
, end
);
5072 /* If the function makes a different buffer current,
5073 assume that means this buffer contains altered text to be output.
5074 Reset START and END from the buffer bounds
5075 and discard all previous annotations because they should have
5076 been dealt with by this function. */
5077 if (current_buffer
!= given_buffer
)
5079 Vwrite_region_annotation_buffers
5080 = Fcons (Fcurrent_buffer (),
5081 Vwrite_region_annotation_buffers
);
5082 XSETFASTINT (start
, BEGV
);
5083 XSETFASTINT (end
, ZV
);
5086 Flength (res
); /* Check basic validity of return value */
5087 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5091 /* Now do the same for annotation functions implied by the file-format */
5092 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5093 p
= BVAR (current_buffer
, auto_save_file_format
);
5095 p
= BVAR (current_buffer
, file_format
);
5096 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5098 struct buffer
*given_buffer
= current_buffer
;
5100 Vwrite_region_annotations_so_far
= annotations
;
5102 /* Value is either a list of annotations or nil if the function
5103 has written annotations to a temporary buffer, which is now
5105 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5106 original_buffer
, make_number (i
));
5107 if (current_buffer
!= given_buffer
)
5109 XSETFASTINT (start
, BEGV
);
5110 XSETFASTINT (end
, ZV
);
5115 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5123 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5124 If STRING is nil, POS is the character position in the current buffer.
5125 Intersperse with them the annotations from *ANNOT
5126 which fall within the range of POS to POS + NCHARS,
5127 each at its appropriate position.
5129 We modify *ANNOT by discarding elements as we use them up.
5131 Return true if successful. */
5134 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5135 ptrdiff_t nchars
, Lisp_Object
*annot
,
5136 struct coding_system
*coding
)
5140 ptrdiff_t lastpos
= pos
+ nchars
;
5142 while (NILP (*annot
) || CONSP (*annot
))
5144 tem
= Fcar_safe (Fcar (*annot
));
5147 nextpos
= XFASTINT (tem
);
5149 /* If there are no more annotations in this range,
5150 output the rest of the range all at once. */
5151 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5152 return e_write (desc
, string
, pos
, lastpos
, coding
);
5154 /* Output buffer text up to the next annotation's position. */
5157 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5161 /* Output the annotation. */
5162 tem
= Fcdr (Fcar (*annot
));
5165 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5168 *annot
= Fcdr (*annot
);
5173 /* Maximum number of characters that the next
5174 function encodes per one loop iteration. */
5176 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5178 /* Write text in the range START and END into descriptor DESC,
5179 encoding them with coding system CODING. If STRING is nil, START
5180 and END are character positions of the current buffer, else they
5181 are indexes to the string STRING. Return true if successful. */
5184 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5185 struct coding_system
*coding
)
5187 if (STRINGP (string
))
5190 end
= SCHARS (string
);
5193 /* We used to have a code for handling selective display here. But,
5194 now it is handled within encode_coding. */
5198 if (STRINGP (string
))
5200 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5201 if (CODING_REQUIRE_ENCODING (coding
))
5203 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5205 /* Avoid creating huge Lisp string in encode_coding_object. */
5206 if (nchars
== E_WRITE_MAX
)
5207 coding
->raw_destination
= 1;
5209 encode_coding_object
5210 (coding
, string
, start
, string_char_to_byte (string
, start
),
5211 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5216 coding
->dst_object
= string
;
5217 coding
->consumed_char
= SCHARS (string
);
5218 coding
->produced
= SBYTES (string
);
5223 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5224 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5226 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5227 if (CODING_REQUIRE_ENCODING (coding
))
5229 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5232 if (nchars
== E_WRITE_MAX
)
5233 coding
->raw_destination
= 1;
5235 encode_coding_object
5236 (coding
, Fcurrent_buffer (), start
, start_byte
,
5237 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5241 coding
->dst_object
= Qnil
;
5242 coding
->dst_pos_byte
= start_byte
;
5243 if (start
>= GPT
|| end
<= GPT
)
5245 coding
->consumed_char
= end
- start
;
5246 coding
->produced
= end_byte
- start_byte
;
5250 coding
->consumed_char
= GPT
- start
;
5251 coding
->produced
= GPT_BYTE
- start_byte
;
5256 if (coding
->produced
> 0)
5258 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5259 : (STRINGP (coding
->dst_object
)
5260 ? SSDATA (coding
->dst_object
)
5261 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5262 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5264 if (coding
->raw_destination
)
5266 /* We're responsible for freeing this, see
5267 encode_coding_object to check why. */
5268 xfree (coding
->destination
);
5269 coding
->raw_destination
= 0;
5271 if (coding
->produced
)
5274 start
+= coding
->consumed_char
;
5280 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5281 Sverify_visited_file_modtime
, 0, 1, 0,
5282 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5283 This means that the file has not been changed since it was visited or saved.
5284 If BUF is omitted or nil, it defaults to the current buffer.
5285 See Info node `(elisp)Modification Time' for more details. */)
5290 Lisp_Object handler
;
5291 Lisp_Object filename
;
5292 struct timespec mtime
;
5302 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5303 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5305 /* If the file name has special constructs in it,
5306 call the corresponding file handler. */
5307 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5308 Qverify_visited_file_modtime
);
5309 if (!NILP (handler
))
5310 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5312 filename
= ENCODE_FILE (BVAR (b
, filename
));
5314 mtime
= (stat (SSDATA (filename
), &st
) == 0
5315 ? get_stat_mtime (&st
)
5316 : time_error_value (errno
));
5317 if (timespec_cmp (mtime
, b
->modtime
) == 0
5318 && (b
->modtime_size
< 0
5319 || st
.st_size
== b
->modtime_size
))
5324 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5325 Svisited_file_modtime
, 0, 0, 0,
5326 doc
: /* Return the current buffer's recorded visited file modification time.
5327 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5328 `file-attributes' returns. If the current buffer has no recorded file
5329 modification time, this function returns 0. If the visited file
5330 doesn't exist, return -1.
5331 See Info node `(elisp)Modification Time' for more details. */)
5334 int ns
= current_buffer
->modtime
.tv_nsec
;
5336 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5337 return make_lisp_time (current_buffer
->modtime
);
5340 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5341 Sset_visited_file_modtime
, 0, 1, 0,
5342 doc
: /* Update buffer's recorded modification time from the visited file's time.
5343 Useful if the buffer was not read from the file normally
5344 or if the file itself has been changed for some known benign reason.
5345 An argument specifies the modification time value to use
5346 \(instead of that of the visited file), in the form of a list
5347 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5348 `visited-file-modtime'. */)
5349 (Lisp_Object time_flag
)
5351 if (!NILP (time_flag
))
5353 struct timespec mtime
;
5354 if (INTEGERP (time_flag
))
5356 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5357 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5360 mtime
= lisp_time_argument (time_flag
);
5362 current_buffer
->modtime
= mtime
;
5363 current_buffer
->modtime_size
= -1;
5367 register Lisp_Object filename
;
5369 Lisp_Object handler
;
5371 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5373 /* If the file name has special constructs in it,
5374 call the corresponding file handler. */
5375 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5376 if (!NILP (handler
))
5377 /* The handler can find the file name the same way we did. */
5378 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5380 filename
= ENCODE_FILE (filename
);
5382 if (stat (SSDATA (filename
), &st
) >= 0)
5384 current_buffer
->modtime
= get_stat_mtime (&st
);
5385 current_buffer
->modtime_size
= st
.st_size
;
5393 auto_save_error (Lisp_Object error_val
)
5395 Lisp_Object args
[3], msg
;
5397 struct gcpro gcpro1
;
5399 auto_save_error_occurred
= 1;
5401 ring_bell (XFRAME (selected_frame
));
5403 args
[0] = build_string ("Auto-saving %s: %s");
5404 args
[1] = BVAR (current_buffer
, name
);
5405 args
[2] = Ferror_message_string (error_val
);
5406 msg
= Fformat (3, args
);
5409 for (i
= 0; i
< 3; ++i
)
5414 message3_nolog (msg
);
5415 Fsleep_for (make_number (1), Qnil
);
5428 auto_save_mode_bits
= 0666;
5430 /* Get visited file's mode to become the auto save file's mode. */
5431 if (! NILP (BVAR (current_buffer
, filename
)))
5433 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5434 /* But make sure we can overwrite it later! */
5435 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5436 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5438 /* Remote files don't cooperate with stat. */
5439 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5443 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5444 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5448 struct auto_save_unwind
5455 do_auto_save_unwind (void *arg
)
5457 struct auto_save_unwind
*p
= arg
;
5458 FILE *stream
= p
->stream
;
5459 minibuffer_auto_raise
= p
->auto_raise
;
5470 do_auto_save_make_dir (Lisp_Object dir
)
5474 auto_saving_dir_umask
= 077;
5475 result
= call2 (Qmake_directory
, dir
, Qt
);
5476 auto_saving_dir_umask
= 0;
5481 do_auto_save_eh (Lisp_Object ignore
)
5483 auto_saving_dir_umask
= 0;
5487 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5488 doc
: /* Auto-save all buffers that need it.
5489 This is all buffers that have auto-saving enabled
5490 and are changed since last auto-saved.
5491 Auto-saving writes the buffer into a file
5492 so that your editing is not lost if the system crashes.
5493 This file is not the file you visited; that changes only when you save.
5494 Normally we run the normal hook `auto-save-hook' before saving.
5496 A non-nil NO-MESSAGE argument means do not print any message if successful.
5497 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5498 (Lisp_Object no_message
, Lisp_Object current_only
)
5500 struct buffer
*old
= current_buffer
, *b
;
5501 Lisp_Object tail
, buf
, hook
;
5502 bool auto_saved
= 0;
5503 int do_handled_files
;
5505 FILE *stream
= NULL
;
5506 ptrdiff_t count
= SPECPDL_INDEX ();
5507 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5508 bool old_message_p
= 0;
5509 struct auto_save_unwind auto_save_unwind
;
5510 struct gcpro gcpro1
, gcpro2
;
5512 if (max_specpdl_size
< specpdl_size
+ 40)
5513 max_specpdl_size
= specpdl_size
+ 40;
5518 if (NILP (no_message
))
5520 old_message_p
= push_message ();
5521 record_unwind_protect_void (pop_message_unwind
);
5524 /* Ordinarily don't quit within this function,
5525 but don't make it impossible to quit (in case we get hung in I/O). */
5529 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5530 point to non-strings reached from Vbuffer_alist. */
5532 hook
= intern ("auto-save-hook");
5533 safe_run_hooks (hook
);
5535 if (STRINGP (Vauto_save_list_file_name
))
5537 Lisp_Object listfile
;
5539 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5541 /* Don't try to create the directory when shutting down Emacs,
5542 because creating the directory might signal an error, and
5543 that would leave Emacs in a strange state. */
5544 if (!NILP (Vrun_hooks
))
5548 GCPRO2 (dir
, listfile
);
5549 dir
= Ffile_name_directory (listfile
);
5550 if (NILP (Ffile_directory_p (dir
)))
5551 internal_condition_case_1 (do_auto_save_make_dir
,
5557 stream
= emacs_fopen (SSDATA (listfile
), "w");
5560 auto_save_unwind
.stream
= stream
;
5561 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5562 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5563 minibuffer_auto_raise
= 0;
5565 auto_save_error_occurred
= 0;
5567 /* On first pass, save all files that don't have handlers.
5568 On second pass, save all files that do have handlers.
5570 If Emacs is crashing, the handlers may tweak what is causing
5571 Emacs to crash in the first place, and it would be a shame if
5572 Emacs failed to autosave perfectly ordinary files because it
5573 couldn't handle some ange-ftp'd file. */
5575 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5576 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5580 /* Record all the buffers that have auto save mode
5581 in the special file that lists them. For each of these buffers,
5582 Record visited name (if any) and auto save name. */
5583 if (STRINGP (BVAR (b
, auto_save_file_name
))
5584 && stream
!= NULL
&& do_handled_files
== 0)
5587 if (!NILP (BVAR (b
, filename
)))
5589 fwrite (SDATA (BVAR (b
, filename
)), 1,
5590 SBYTES (BVAR (b
, filename
)), stream
);
5592 putc ('\n', stream
);
5593 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5594 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5595 putc ('\n', stream
);
5599 if (!NILP (current_only
)
5600 && b
!= current_buffer
)
5603 /* Don't auto-save indirect buffers.
5604 The base buffer takes care of it. */
5608 /* Check for auto save enabled
5609 and file changed since last auto save
5610 and file changed since last real save. */
5611 if (STRINGP (BVAR (b
, auto_save_file_name
))
5612 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5613 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5614 /* -1 means we've turned off autosaving for a while--see below. */
5615 && XINT (BVAR (b
, save_length
)) >= 0
5616 && (do_handled_files
5617 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5620 struct timespec before_time
= current_timespec ();
5621 struct timespec after_time
;
5623 /* If we had a failure, don't try again for 20 minutes. */
5624 if (b
->auto_save_failure_time
> 0
5625 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5628 set_buffer_internal (b
);
5629 if (NILP (Vauto_save_include_big_deletions
)
5630 && (XFASTINT (BVAR (b
, save_length
)) * 10
5631 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5632 /* A short file is likely to change a large fraction;
5633 spare the user annoying messages. */
5634 && XFASTINT (BVAR (b
, save_length
)) > 5000
5635 /* These messages are frequent and annoying for `*mail*'. */
5636 && !EQ (BVAR (b
, filename
), Qnil
)
5637 && NILP (no_message
))
5639 /* It has shrunk too much; turn off auto-saving here. */
5640 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5641 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5643 minibuffer_auto_raise
= 0;
5644 /* Turn off auto-saving until there's a real save,
5645 and prevent any more warnings. */
5646 XSETINT (BVAR (b
, save_length
), -1);
5647 Fsleep_for (make_number (1), Qnil
);
5650 if (!auto_saved
&& NILP (no_message
))
5651 message1 ("Auto-saving...");
5652 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5654 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5655 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5656 set_buffer_internal (old
);
5658 after_time
= current_timespec ();
5660 /* If auto-save took more than 60 seconds,
5661 assume it was an NFS failure that got a timeout. */
5662 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5663 b
->auto_save_failure_time
= after_time
.tv_sec
;
5667 /* Prevent another auto save till enough input events come in. */
5668 record_auto_save ();
5670 if (auto_saved
&& NILP (no_message
))
5674 /* If we are going to restore an old message,
5675 give time to read ours. */
5676 sit_for (make_number (1), 0, 0);
5679 else if (!auto_save_error_occurred
)
5680 /* Don't overwrite the error message if an error occurred.
5681 If we displayed a message and then restored a state
5682 with no message, leave a "done" message on the screen. */
5683 message1 ("Auto-saving...done");
5688 /* This restores the message-stack status. */
5689 unbind_to (count
, Qnil
);
5693 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5694 Sset_buffer_auto_saved
, 0, 0, 0,
5695 doc
: /* Mark current buffer as auto-saved with its current text.
5696 No auto-save file will be written until the buffer changes again. */)
5699 /* FIXME: This should not be called in indirect buffers, since
5700 they're not autosaved. */
5701 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5702 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5703 current_buffer
->auto_save_failure_time
= 0;
5707 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5708 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5709 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5712 current_buffer
->auto_save_failure_time
= 0;
5716 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5718 doc
: /* Return t if current buffer has been auto-saved recently.
5719 More precisely, if it has been auto-saved since last read from or saved
5720 in the visited file. If the buffer has no visited file,
5721 then any auto-save counts as "recent". */)
5724 /* FIXME: maybe we should return nil for indirect buffers since
5725 they're never autosaved. */
5726 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5729 /* Reading and completing file names */
5731 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5732 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5733 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5734 The return value is only relevant for a call to `read-file-name' that happens
5735 before any other event (mouse or keypress) is handled. */)
5738 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5739 || defined (HAVE_NS)
5740 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5743 && window_system_available (SELECTED_FRAME ()))
5750 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5752 struct gcpro gcpro1
;
5753 Lisp_Object args
[7];
5755 GCPRO1 (default_filename
);
5756 args
[0] = intern ("read-file-name");
5759 args
[3] = default_filename
;
5760 args
[4] = mustmatch
;
5762 args
[6] = predicate
;
5763 RETURN_UNGCPRO (Ffuncall (7, args
));
5770 valid_timestamp_file_system
= 0;
5772 /* fsync can be a significant performance hit. Often it doesn't
5773 suffice to make the file-save operation survive a crash. For
5774 batch scripts, which are typically part of larger shell commands
5775 that don't fsync other files, its effect on performance can be
5776 significant so its utility is particularly questionable.
5777 Hence, for now by default fsync is used only when interactive.
5779 For more on why fsync often fails to work on today's hardware, see:
5780 Zheng M et al. Understanding the robustness of SSDs under power fault.
5781 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5782 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5784 For more on why fsync does not suffice even if it works properly, see:
5785 Roche X. Necessary step(s) to synchronize filename operations on disk.
5786 Austin Group Defect 672, 2013-03-19
5787 http://austingroupbugs.net/view.php?id=672 */
5788 write_region_inhibit_fsync
= noninteractive
;
5792 syms_of_fileio (void)
5794 DEFSYM (Qoperations
, "operations");
5795 DEFSYM (Qexpand_file_name
, "expand-file-name");
5796 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5797 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5798 DEFSYM (Qfile_name_directory
, "file-name-directory");
5799 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5800 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5801 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5802 DEFSYM (Qcopy_file
, "copy-file");
5803 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5804 DEFSYM (Qmake_directory
, "make-directory");
5805 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5806 DEFSYM (Qdelete_file
, "delete-file");
5807 DEFSYM (Qrename_file
, "rename-file");
5808 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5809 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5810 DEFSYM (Qfile_exists_p
, "file-exists-p");
5811 DEFSYM (Qfile_executable_p
, "file-executable-p");
5812 DEFSYM (Qfile_readable_p
, "file-readable-p");
5813 DEFSYM (Qfile_writable_p
, "file-writable-p");
5814 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5815 DEFSYM (Qaccess_file
, "access-file");
5816 DEFSYM (Qfile_directory_p
, "file-directory-p");
5817 DEFSYM (Qfile_regular_p
, "file-regular-p");
5818 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5819 DEFSYM (Qfile_modes
, "file-modes");
5820 DEFSYM (Qset_file_modes
, "set-file-modes");
5821 DEFSYM (Qset_file_times
, "set-file-times");
5822 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5823 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5824 DEFSYM (Qfile_acl
, "file-acl");
5825 DEFSYM (Qset_file_acl
, "set-file-acl");
5826 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5827 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5828 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5829 DEFSYM (Qwrite_region
, "write-region");
5830 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5831 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5832 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5834 DEFSYM (Qfile_name_history
, "file-name-history");
5835 Fset (Qfile_name_history
, Qnil
);
5837 DEFSYM (Qfile_error
, "file-error");
5838 DEFSYM (Qfile_already_exists
, "file-already-exists");
5839 DEFSYM (Qfile_date_error
, "file-date-error");
5840 DEFSYM (Qfile_notify_error
, "file-notify-error");
5841 DEFSYM (Qexcl
, "excl");
5843 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5844 doc
: /* Coding system for encoding file names.
5845 If it is nil, `default-file-name-coding-system' (which see) is used.
5847 On MS-Windows, the value of this variable is largely ignored if
5848 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5849 behaves as if file names were encoded in `utf-8'. */);
5850 Vfile_name_coding_system
= Qnil
;
5852 DEFVAR_LISP ("default-file-name-coding-system",
5853 Vdefault_file_name_coding_system
,
5854 doc
: /* Default coding system for encoding file names.
5855 This variable is used only when `file-name-coding-system' is nil.
5857 This variable is set/changed by the command `set-language-environment'.
5858 User should not set this variable manually,
5859 instead use `file-name-coding-system' to get a constant encoding
5860 of file names regardless of the current language environment.
5862 On MS-Windows, the value of this variable is largely ignored if
5863 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5864 behaves as if file names were encoded in `utf-8'. */);
5865 Vdefault_file_name_coding_system
= Qnil
;
5867 DEFSYM (Qformat_decode
, "format-decode");
5868 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5869 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5870 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5872 Fput (Qfile_error
, Qerror_conditions
,
5873 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5874 Fput (Qfile_error
, Qerror_message
,
5875 build_pure_c_string ("File error"));
5877 Fput (Qfile_already_exists
, Qerror_conditions
,
5878 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5879 Fput (Qfile_already_exists
, Qerror_message
,
5880 build_pure_c_string ("File already exists"));
5882 Fput (Qfile_date_error
, Qerror_conditions
,
5883 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5884 Fput (Qfile_date_error
, Qerror_message
,
5885 build_pure_c_string ("Cannot set file date"));
5887 Fput (Qfile_notify_error
, Qerror_conditions
,
5888 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5889 Fput (Qfile_notify_error
, Qerror_message
,
5890 build_pure_c_string ("File notification error"));
5892 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5893 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5894 If a file name matches REGEXP, all I/O on that file is done by calling
5895 HANDLER. If a file name matches more than one handler, the handler
5896 whose match starts last in the file name gets precedence. The
5897 function `find-file-name-handler' checks this list for a handler for
5900 HANDLER should be a function. The first argument given to it is the
5901 name of the I/O primitive to be handled; the remaining arguments are
5902 the arguments that were passed to that primitive. For example, if you
5903 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5904 HANDLER is called like this:
5906 (funcall HANDLER 'file-exists-p FILENAME)
5908 Note that HANDLER must be able to handle all I/O primitives; if it has
5909 nothing special to do for a primitive, it should reinvoke the
5910 primitive to handle the operation \"the usual way\".
5911 See Info node `(elisp)Magic File Names' for more details. */);
5912 Vfile_name_handler_alist
= Qnil
;
5914 DEFVAR_LISP ("set-auto-coding-function",
5915 Vset_auto_coding_function
,
5916 doc
: /* If non-nil, a function to call to decide a coding system of file.
5917 Two arguments are passed to this function: the file name
5918 and the length of a file contents following the point.
5919 This function should return a coding system to decode the file contents.
5920 It should check the file name against `auto-coding-alist'.
5921 If no coding system is decided, it should check a coding system
5922 specified in the heading lines with the format:
5923 -*- ... coding: CODING-SYSTEM; ... -*-
5924 or local variable spec of the tailing lines with `coding:' tag. */);
5925 Vset_auto_coding_function
= Qnil
;
5927 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5928 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5929 Each is passed one argument, the number of characters inserted,
5930 with point at the start of the inserted text. Each function
5931 should leave point the same, and return the new character count.
5932 If `insert-file-contents' is intercepted by a handler from
5933 `file-name-handler-alist', that handler is responsible for calling the
5934 functions in `after-insert-file-functions' if appropriate. */);
5935 Vafter_insert_file_functions
= Qnil
;
5937 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5938 doc
: /* A list of functions to be called at the start of `write-region'.
5939 Each is passed two arguments, START and END as for `write-region'.
5940 These are usually two numbers but not always; see the documentation
5941 for `write-region'. The function should return a list of pairs
5942 of the form (POSITION . STRING), consisting of strings to be effectively
5943 inserted at the specified positions of the file being written (1 means to
5944 insert before the first byte written). The POSITIONs must be sorted into
5947 If there are several annotation functions, the lists returned by these
5948 functions are merged destructively. As each annotation function runs,
5949 the variable `write-region-annotations-so-far' contains a list of all
5950 annotations returned by previous annotation functions.
5952 An annotation function can return with a different buffer current.
5953 Doing so removes the annotations returned by previous functions, and
5954 resets START and END to `point-min' and `point-max' of the new buffer.
5956 After `write-region' completes, Emacs calls the function stored in
5957 `write-region-post-annotation-function', once for each buffer that was
5958 current when building the annotations (i.e., at least once), with that
5959 buffer current. */);
5960 Vwrite_region_annotate_functions
= Qnil
;
5961 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5963 DEFVAR_LISP ("write-region-post-annotation-function",
5964 Vwrite_region_post_annotation_function
,
5965 doc
: /* Function to call after `write-region' completes.
5966 The function is called with no arguments. If one or more of the
5967 annotation functions in `write-region-annotate-functions' changed the
5968 current buffer, the function stored in this variable is called for
5969 each of those additional buffers as well, in addition to the original
5970 buffer. The relevant buffer is current during each function call. */);
5971 Vwrite_region_post_annotation_function
= Qnil
;
5972 staticpro (&Vwrite_region_annotation_buffers
);
5974 DEFVAR_LISP ("write-region-annotations-so-far",
5975 Vwrite_region_annotations_so_far
,
5976 doc
: /* When an annotation function is called, this holds the previous annotations.
5977 These are the annotations made by other annotation functions
5978 that were already called. See also `write-region-annotate-functions'. */);
5979 Vwrite_region_annotations_so_far
= Qnil
;
5981 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5982 doc
: /* A list of file name handlers that temporarily should not be used.
5983 This applies only to the operation `inhibit-file-name-operation'. */);
5984 Vinhibit_file_name_handlers
= Qnil
;
5986 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5987 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5988 Vinhibit_file_name_operation
= Qnil
;
5990 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5991 doc
: /* File name in which we write a list of all auto save file names.
5992 This variable is initialized automatically from `auto-save-list-file-prefix'
5993 shortly after Emacs reads your init file, if you have not yet given it
5994 a non-nil value. */);
5995 Vauto_save_list_file_name
= Qnil
;
5997 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5998 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5999 Normally auto-save files are written under other names. */);
6000 Vauto_save_visited_file_name
= Qnil
;
6002 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6003 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6004 If nil, deleting a substantial portion of the text disables auto-save
6005 in the buffer; this is the default behavior, because the auto-save
6006 file is usually more useful if it contains the deleted text. */);
6007 Vauto_save_include_big_deletions
= Qnil
;
6009 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6010 doc
: /* Non-nil means don't call fsync in `write-region'.
6011 This variable affects calls to `write-region' as well as save commands.
6012 Setting this to nil may avoid data loss if the system loses power or
6013 the operating system crashes. */);
6014 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6016 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6017 doc
: /* Specifies whether to use the system's trash can.
6018 When non-nil, certain file deletion commands use the function
6019 `move-file-to-trash' instead of deleting files outright.
6020 This includes interactive calls to `delete-file' and
6021 `delete-directory' and the Dired deletion commands. */);
6022 delete_by_moving_to_trash
= 0;
6023 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6025 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6026 DEFSYM (Qcopy_directory
, "copy-directory");
6027 DEFSYM (Qdelete_directory
, "delete-directory");
6028 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");
6030 defsubr (&Sfind_file_name_handler
);
6031 defsubr (&Sfile_name_directory
);
6032 defsubr (&Sfile_name_nondirectory
);
6033 defsubr (&Sunhandled_file_name_directory
);
6034 defsubr (&Sfile_name_as_directory
);
6035 defsubr (&Sdirectory_file_name
);
6036 defsubr (&Smake_temp_name
);
6037 defsubr (&Sexpand_file_name
);
6038 defsubr (&Ssubstitute_in_file_name
);
6039 defsubr (&Scopy_file
);
6040 defsubr (&Smake_directory_internal
);
6041 defsubr (&Sdelete_directory_internal
);
6042 defsubr (&Sdelete_file
);
6043 defsubr (&Srename_file
);
6044 defsubr (&Sadd_name_to_file
);
6045 defsubr (&Smake_symbolic_link
);
6046 defsubr (&Sfile_name_absolute_p
);
6047 defsubr (&Sfile_exists_p
);
6048 defsubr (&Sfile_executable_p
);
6049 defsubr (&Sfile_readable_p
);
6050 defsubr (&Sfile_writable_p
);
6051 defsubr (&Saccess_file
);
6052 defsubr (&Sfile_symlink_p
);
6053 defsubr (&Sfile_directory_p
);
6054 defsubr (&Sfile_accessible_directory_p
);
6055 defsubr (&Sfile_regular_p
);
6056 defsubr (&Sfile_modes
);
6057 defsubr (&Sset_file_modes
);
6058 defsubr (&Sset_file_times
);
6059 defsubr (&Sfile_selinux_context
);
6060 defsubr (&Sfile_acl
);
6061 defsubr (&Sset_file_acl
);
6062 defsubr (&Sset_file_selinux_context
);
6063 defsubr (&Sset_default_file_modes
);
6064 defsubr (&Sdefault_file_modes
);
6065 defsubr (&Sfile_newer_than_file_p
);
6066 defsubr (&Sinsert_file_contents
);
6067 defsubr (&Schoose_write_coding_system
);
6068 defsubr (&Swrite_region
);
6069 defsubr (&Scar_less_than_car
);
6070 defsubr (&Sverify_visited_file_modtime
);
6071 defsubr (&Svisited_file_modtime
);
6072 defsubr (&Sset_visited_file_modtime
);
6073 defsubr (&Sdo_auto_save
);
6074 defsubr (&Sset_buffer_auto_saved
);
6075 defsubr (&Sclear_buffer_auto_save_failure
);
6076 defsubr (&Srecent_auto_save_p
);
6078 defsubr (&Snext_read_file_uses_dialog_p
);
6081 defsubr (&Sunix_sync
);