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"
53 #include "dispextern.h"
60 #endif /* not WINDOWSNT */
64 #include <sys/param.h>
68 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
69 redirector allows the six letters between 'Z' and 'a' as well. */
71 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
74 #define IS_DRIVE(x) c_isalpha (x)
76 /* Need to lower-case the drive letter, or else expanded
77 filenames will sometimes compare unequal, because
78 `expand-file-name' doesn't always down-case the drive letter. */
79 #define DRIVE_LETTER(x) c_tolower (x)
84 #include <allocator.h>
85 #include <careadlinkat.h>
86 #include <stat-time.h>
94 /* True during writing of auto-save files. */
95 static bool auto_saving
;
97 /* Nonzero umask during creation of auto-save directories. */
98 static mode_t auto_saving_dir_umask
;
100 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
101 a new file with the same mode as the original. */
102 static mode_t auto_save_mode_bits
;
104 /* Set by auto_save_1 if an error occurred during the last auto-save. */
105 static bool auto_save_error_occurred
;
107 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
108 number of a file system where time stamps were observed to to work. */
109 static bool valid_timestamp_file_system
;
110 static dev_t timestamp_file_system
;
112 /* The symbol bound to coding-system-for-read when
113 insert-file-contents is called for recovering a file. This is not
114 an actual coding system name, but just an indicator to tell
115 insert-file-contents to use `emacs-mule' with a special flag for
116 auto saving and recovering a file. */
117 static Lisp_Object Qauto_save_coding
;
119 /* Property name of a file name handler,
120 which gives a list of operations it handles.. */
121 static Lisp_Object Qoperations
;
123 /* Lisp functions for translating file formats. */
124 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
126 /* Lisp function for setting buffer-file-coding-system and the
127 multibyteness of the current buffer after inserting a file. */
128 static Lisp_Object Qafter_insert_file_set_coding
;
130 static Lisp_Object Qwrite_region_annotate_functions
;
131 /* Each time an annotation function changes the buffer, the new buffer
133 static Lisp_Object Vwrite_region_annotation_buffers
;
135 static Lisp_Object Qdelete_by_moving_to_trash
;
137 /* Lisp function for moving files to trash. */
138 static Lisp_Object Qmove_file_to_trash
;
140 /* Lisp function for recursively copying directories. */
141 static Lisp_Object Qcopy_directory
;
143 /* Lisp function for recursively deleting directories. */
144 static Lisp_Object Qdelete_directory
;
149 Lisp_Object Qfile_error
, Qfile_notify_error
;
150 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
151 static Lisp_Object Qexcl
;
152 Lisp_Object Qfile_name_history
;
154 static Lisp_Object Qcar_less_than_car
;
156 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
157 Lisp_Object
*, struct coding_system
*);
158 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
159 struct coding_system
*);
162 /* Signal a file-access failure. STRING describes the failure,
163 NAME the file involved, and ERRORNO the errno value.
165 If NAME is neither null nor a pair, package it up as a singleton
166 list before reporting it; this saves report_file_errno's caller the
167 trouble of preserving errno before calling list1. */
170 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
172 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
173 Lisp_Object errstring
;
176 synchronize_system_messages_locale ();
177 str
= strerror (errorno
);
178 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
179 Vlocale_coding_system
, 0);
185 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
188 /* System error messages are capitalized. Downcase the initial
189 unless it is followed by a slash. (The slash case caters to
190 error messages that begin with "I/O" or, in German, "E/A".) */
191 if (STRING_MULTIBYTE (errstring
)
192 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
196 str
= SSDATA (errstring
);
197 c
= STRING_CHAR ((unsigned char *) str
);
198 Faset (errstring
, make_number (0), make_number (downcase (c
)));
201 xsignal (Qfile_error
,
202 Fcons (build_string (string
), Fcons (errstring
, data
)));
206 /* Signal a file-access failure that set errno. STRING describes the
207 failure, NAME the file involved. */
210 report_file_error (char const *string
, Lisp_Object name
)
212 report_file_errno (string
, name
, errno
);
216 close_file_unwind (Lisp_Object fd
)
218 emacs_close (XFASTINT (fd
));
222 /* Restore point, having saved it as a marker. */
225 restore_point_unwind (Lisp_Object location
)
227 Fgoto_char (location
);
228 Fset_marker (location
, Qnil
, Qnil
);
233 static Lisp_Object Qexpand_file_name
;
234 static Lisp_Object Qsubstitute_in_file_name
;
235 static Lisp_Object Qdirectory_file_name
;
236 static Lisp_Object Qfile_name_directory
;
237 static Lisp_Object Qfile_name_nondirectory
;
238 static Lisp_Object Qunhandled_file_name_directory
;
239 static Lisp_Object Qfile_name_as_directory
;
240 static Lisp_Object Qcopy_file
;
241 static Lisp_Object Qmake_directory_internal
;
242 static Lisp_Object Qmake_directory
;
243 static Lisp_Object Qdelete_directory_internal
;
244 Lisp_Object Qdelete_file
;
245 static Lisp_Object Qrename_file
;
246 static Lisp_Object Qadd_name_to_file
;
247 static Lisp_Object Qmake_symbolic_link
;
248 Lisp_Object Qfile_exists_p
;
249 static Lisp_Object Qfile_executable_p
;
250 static Lisp_Object Qfile_readable_p
;
251 static Lisp_Object Qfile_writable_p
;
252 static Lisp_Object Qfile_symlink_p
;
253 static Lisp_Object Qaccess_file
;
254 Lisp_Object Qfile_directory_p
;
255 static Lisp_Object Qfile_regular_p
;
256 static Lisp_Object Qfile_accessible_directory_p
;
257 static Lisp_Object Qfile_modes
;
258 static Lisp_Object Qset_file_modes
;
259 static Lisp_Object Qset_file_times
;
260 static Lisp_Object Qfile_selinux_context
;
261 static Lisp_Object Qset_file_selinux_context
;
262 static Lisp_Object Qfile_acl
;
263 static Lisp_Object Qset_file_acl
;
264 static Lisp_Object Qfile_newer_than_file_p
;
265 Lisp_Object Qinsert_file_contents
;
266 static Lisp_Object Qchoose_write_coding_system
;
267 Lisp_Object Qwrite_region
;
268 static Lisp_Object Qverify_visited_file_modtime
;
269 static Lisp_Object Qset_visited_file_modtime
;
271 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
272 Sfind_file_name_handler
, 2, 2, 0,
273 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
274 Otherwise, return nil.
275 A file name is handled if one of the regular expressions in
276 `file-name-handler-alist' matches it.
278 If OPERATION equals `inhibit-file-name-operation', then we ignore
279 any handlers that are members of `inhibit-file-name-handlers',
280 but we still do run any other handlers. This lets handlers
281 use the standard functions without calling themselves recursively. */)
282 (Lisp_Object filename
, Lisp_Object operation
)
284 /* This function must not munge the match data. */
285 Lisp_Object chain
, inhibited_handlers
, result
;
289 CHECK_STRING (filename
);
291 if (EQ (operation
, Vinhibit_file_name_operation
))
292 inhibited_handlers
= Vinhibit_file_name_handlers
;
294 inhibited_handlers
= Qnil
;
296 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
297 chain
= XCDR (chain
))
303 Lisp_Object string
= XCAR (elt
);
305 Lisp_Object handler
= XCDR (elt
);
306 Lisp_Object operations
= Qnil
;
308 if (SYMBOLP (handler
))
309 operations
= Fget (handler
, Qoperations
);
312 && (match_pos
= fast_string_match (string
, filename
)) > pos
313 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
317 handler
= XCDR (elt
);
318 tem
= Fmemq (handler
, inhibited_handlers
);
332 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
334 doc
: /* Return the directory component in file name FILENAME.
335 Return nil if FILENAME does not include a directory.
336 Otherwise return a directory name.
337 Given a Unix syntax file name, returns a string ending in slash. */)
338 (Lisp_Object filename
)
341 register const char *beg
;
346 register const char *p
;
349 CHECK_STRING (filename
);
351 /* If the file name has special constructs in it,
352 call the corresponding file handler. */
353 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
356 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
358 return STRINGP (handled_name
) ? handled_name
: Qnil
;
362 beg
= alloca (SBYTES (filename
) + 1);
363 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
365 beg
= SSDATA (filename
);
367 p
= beg
+ SBYTES (filename
);
369 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
371 /* only recognize drive specifier at the beginning */
373 /* handle the "/:d:foo" and "/:foo" cases correctly */
374 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
375 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
382 /* Expansion of "c:" to drive and default directory. */
385 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
386 char *res
= alloca (MAXPATHLEN
+ 1);
389 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
391 memcpy (res
, beg
, 2);
396 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
398 size_t l
= strlen (res
);
400 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
403 p
= beg
+ strlen (beg
);
404 dostounix_filename (beg
, 0);
405 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
406 STRING_MULTIBYTE (filename
));
409 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
410 STRING_MULTIBYTE (filename
));
412 else if (STRING_MULTIBYTE (filename
))
414 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
415 dostounix_filename (SSDATA (tem_fn
), 1);
417 if (!NILP (Vw32_downcase_file_names
))
418 tem_fn
= Fdowncase (tem_fn
);
423 dostounix_filename (beg
, 0);
424 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
428 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
432 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
433 Sfile_name_nondirectory
, 1, 1, 0,
434 doc
: /* Return file name FILENAME sans its directory.
435 For example, in a Unix-syntax file name,
436 this is everything after the last slash,
437 or the entire name if it contains no slash. */)
438 (Lisp_Object filename
)
440 register const char *beg
, *p
, *end
;
443 CHECK_STRING (filename
);
445 /* If the file name has special constructs in it,
446 call the corresponding file handler. */
447 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
450 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
452 if (STRINGP (handled_name
))
454 error ("Invalid handler in `file-name-handler-alist'");
457 beg
= SSDATA (filename
);
458 end
= p
= beg
+ SBYTES (filename
);
460 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
462 /* only recognize drive specifier at beginning */
464 /* handle the "/:d:foo" case correctly */
465 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
470 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
473 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
474 Sunhandled_file_name_directory
, 1, 1, 0,
475 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
476 A `directly usable' directory name is one that may be used without the
477 intervention of any file handler.
478 If FILENAME is a directly usable file itself, return
479 \(file-name-directory FILENAME).
480 If FILENAME refers to a file which is not accessible from a local process,
481 then this should return nil.
482 The `call-process' and `start-process' functions use this function to
483 get a current directory to run processes in. */)
484 (Lisp_Object filename
)
488 /* If the file name has special constructs in it,
489 call the corresponding file handler. */
490 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
493 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
495 return STRINGP (handled_name
) ? handled_name
: Qnil
;
498 return Ffile_name_directory (filename
);
501 /* Convert from file name SRC of length SRCLEN to directory name in
502 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
503 string. On UNIX, just make sure there is a terminating /. Return
504 the length of DST in bytes. */
507 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
520 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
522 dst
[srclen
] = DIRECTORY_SEP
;
523 dst
[srclen
+ 1] = '\0';
527 dostounix_filename (dst
, multibyte
);
532 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
533 Sfile_name_as_directory
, 1, 1, 0,
534 doc
: /* Return a string representing the file name FILE interpreted as a directory.
535 This operation exists because a directory is also a file, but its name as
536 a directory is different from its name as a file.
537 The result can be used as the value of `default-directory'
538 or passed as second argument to `expand-file-name'.
539 For a Unix-syntax file name, just appends a slash. */)
550 /* If the file name has special constructs in it,
551 call the corresponding file handler. */
552 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
555 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
557 if (STRINGP (handled_name
))
559 error ("Invalid handler in `file-name-handler-alist'");
563 if (!NILP (Vw32_downcase_file_names
))
564 file
= Fdowncase (file
);
566 buf
= alloca (SBYTES (file
) + 10);
567 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
568 STRING_MULTIBYTE (file
));
569 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
572 /* Convert from directory name SRC of length SRCLEN to file name in
573 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
574 string. On UNIX, just make sure there isn't a terminating /.
575 Return the length of DST in bytes. */
578 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
580 /* Process as Unix format: just remove any final slash.
581 But leave "/" unchanged; do not change it to "". */
584 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
586 && !IS_ANY_SEP (dst
[srclen
- 2])
594 dostounix_filename (dst
, multibyte
);
599 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
601 doc
: /* Returns the file name of the directory named DIRECTORY.
602 This is the name of the file that holds the data for the directory DIRECTORY.
603 This operation exists because a directory is also a file, but its name as
604 a directory is different from its name as a file.
605 In Unix-syntax, this function just removes the final slash. */)
606 (Lisp_Object directory
)
612 CHECK_STRING (directory
);
614 if (NILP (directory
))
617 /* If the file name has special constructs in it,
618 call the corresponding file handler. */
619 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
622 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
624 if (STRINGP (handled_name
))
626 error ("Invalid handler in `file-name-handler-alist'");
630 if (!NILP (Vw32_downcase_file_names
))
631 directory
= Fdowncase (directory
);
633 buf
= alloca (SBYTES (directory
) + 20);
634 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
635 STRING_MULTIBYTE (directory
));
636 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
639 static const char make_temp_name_tbl
[64] =
641 'A','B','C','D','E','F','G','H',
642 'I','J','K','L','M','N','O','P',
643 'Q','R','S','T','U','V','W','X',
644 'Y','Z','a','b','c','d','e','f',
645 'g','h','i','j','k','l','m','n',
646 'o','p','q','r','s','t','u','v',
647 'w','x','y','z','0','1','2','3',
648 '4','5','6','7','8','9','-','_'
651 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
653 /* Value is a temporary file name starting with PREFIX, a string.
655 The Emacs process number forms part of the result, so there is
656 no danger of generating a name being used by another process.
657 In addition, this function makes an attempt to choose a name
658 which has no existing file. To make this work, PREFIX should be
659 an absolute file name.
661 BASE64_P means add the pid as 3 characters in base64
662 encoding. In this case, 6 characters will be added to PREFIX to
663 form the file name. Otherwise, if Emacs is running on a system
664 with long file names, add the pid as a decimal number.
666 This function signals an error if no unique file name could be
670 make_temp_name (Lisp_Object prefix
, bool base64_p
)
676 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
679 CHECK_STRING (prefix
);
681 /* VAL is created by adding 6 characters to PREFIX. The first
682 three are the PID of this process, in base 64, and the second
683 three are incremented if the file already exists. This ensures
684 262144 unique file names per PID per PREFIX. */
690 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
691 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
692 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
697 #ifdef HAVE_LONG_FILE_NAMES
698 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
700 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
701 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
702 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
707 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
708 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
709 if (!STRING_MULTIBYTE (prefix
))
710 STRING_SET_UNIBYTE (val
);
712 memcpy (data
, SSDATA (prefix
), len
);
715 memcpy (p
, pidbuf
, pidlen
);
718 /* Here we try to minimize useless stat'ing when this function is
719 invoked many times successively with the same PREFIX. We achieve
720 this by initializing count to a random value, and incrementing it
723 We don't want make-temp-name to be called while dumping,
724 because then make_temp_name_count_initialized_p would get set
725 and then make_temp_name_count would not be set when Emacs starts. */
727 if (!make_temp_name_count_initialized_p
)
729 make_temp_name_count
= time (NULL
);
730 make_temp_name_count_initialized_p
= 1;
735 unsigned num
= make_temp_name_count
;
737 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
738 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
739 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
741 /* Poor man's congruential RN generator. Replace with
742 ++make_temp_name_count for debugging. */
743 make_temp_name_count
+= 25229;
744 make_temp_name_count
%= 225307;
746 if (!check_existing (data
))
748 /* We want to return only if errno is ENOENT. */
752 /* The error here is dubious, but there is little else we
753 can do. The alternatives are to return nil, which is
754 as bad as (and in many cases worse than) throwing the
755 error, or to ignore the error, which will likely result
756 in looping through 225307 stat's, which is not only
757 dog-slow, but also useless since eventually nil would
758 have to be returned anyway. */
759 report_file_error ("Cannot create temporary name for prefix",
767 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
768 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
769 The Emacs process number forms part of the result,
770 so there is no danger of generating a name being used by another process.
772 In addition, this function makes an attempt to choose a name
773 which has no existing file. To make this work,
774 PREFIX should be an absolute file name.
776 There is a race condition between calling `make-temp-name' and creating the
777 file which opens all kinds of security holes. For that reason, you should
778 probably use `make-temp-file' instead, except in three circumstances:
780 * If you are creating the file in the user's home directory.
781 * If you are creating a directory rather than an ordinary file.
782 * If you are taking special precautions as `make-temp-file' does. */)
785 return make_temp_name (prefix
, 0);
790 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
791 doc
: /* Convert filename NAME to absolute, and canonicalize it.
792 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
793 \(does not start with slash or tilde); both the directory name and
794 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
795 missing, the current buffer's value of `default-directory' is used.
796 NAME should be a string that is a valid file name for the underlying
798 File name components that are `.' are removed, and
799 so are file name components followed by `..', along with the `..' itself;
800 note that these simplifications are done without checking the resulting
801 file names in the file system.
802 Multiple consecutive slashes are collapsed into a single slash,
803 except at the beginning of the file name when they are significant (e.g.,
804 UNC file names on MS-Windows.)
805 An initial `~/' expands to your home directory.
806 An initial `~USER/' expands to USER's home directory.
807 See also the function `substitute-in-file-name'.
809 For technical reasons, this function can return correct but
810 non-intuitive results for the root directory; for instance,
811 \(expand-file-name ".." "/") returns "/..". For this reason, use
812 \(directory-file-name (file-name-directory dirname)) to traverse a
813 filesystem tree, not (expand-file-name ".." dirname). */)
814 (Lisp_Object name
, Lisp_Object default_directory
)
816 /* These point to SDATA and need to be careful with string-relocation
817 during GC (via DECODE_FILE). */
820 /* This should only point to alloca'd data. */
827 bool collapse_newdir
= 1;
831 Lisp_Object handler
, result
, handled_name
;
837 /* If the file name has special constructs in it,
838 call the corresponding file handler. */
839 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
842 handled_name
= call3 (handler
, Qexpand_file_name
,
843 name
, default_directory
);
844 if (STRINGP (handled_name
))
846 error ("Invalid handler in `file-name-handler-alist'");
850 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
851 if (NILP (default_directory
))
852 default_directory
= BVAR (current_buffer
, directory
);
853 if (! STRINGP (default_directory
))
856 /* "/" is not considered a root directory on DOS_NT, so using "/"
857 here causes an infinite recursion in, e.g., the following:
859 (let (default-directory)
860 (expand-file-name "a"))
862 To avoid this, we set default_directory to the root of the
864 default_directory
= build_string (emacs_root_dir ());
866 default_directory
= build_string ("/");
870 if (!NILP (default_directory
))
872 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
875 handled_name
= call3 (handler
, Qexpand_file_name
,
876 name
, default_directory
);
877 if (STRINGP (handled_name
))
879 error ("Invalid handler in `file-name-handler-alist'");
884 char *o
= SSDATA (default_directory
);
886 /* Make sure DEFAULT_DIRECTORY is properly expanded.
887 It would be better to do this down below where we actually use
888 default_directory. Unfortunately, calling Fexpand_file_name recursively
889 could invoke GC, and the strings might be relocated. This would
890 be annoying because we have pointers into strings lying around
891 that would need adjusting, and people would add new pointers to
892 the code and forget to adjust them, resulting in intermittent bugs.
893 Putting this call here avoids all that crud.
895 The EQ test avoids infinite recursion. */
896 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
897 /* Save time in some common cases - as long as default_directory
898 is not relative, it can be canonicalized with name below (if it
899 is needed at all) without requiring it to be expanded now. */
901 /* Detect MSDOS file names with drive specifiers. */
902 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
903 && IS_DIRECTORY_SEP (o
[2]))
905 /* Detect Windows file names in UNC format. */
906 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
908 #else /* not DOS_NT */
909 /* Detect Unix absolute file names (/... alone is not absolute on
911 && ! (IS_DIRECTORY_SEP (o
[0]))
912 #endif /* not DOS_NT */
918 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
922 multibyte
= STRING_MULTIBYTE (name
);
923 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
926 default_directory
= string_to_multibyte (default_directory
);
929 name
= string_to_multibyte (name
);
935 if (!NILP (Vw32_downcase_file_names
))
936 default_directory
= Fdowncase (default_directory
);
939 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
940 nm
= alloca (SBYTES (name
) + 1);
941 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
944 /* Note if special escape prefix is present, but remove for now. */
945 if (nm
[0] == '/' && nm
[1] == ':')
951 /* Find and remove drive specifier if present; this makes nm absolute
952 even if the rest of the name appears to be relative. Only look for
953 drive specifier at the beginning. */
954 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
956 drive
= (unsigned char) nm
[0];
961 /* If we see "c://somedir", we want to strip the first slash after the
962 colon when stripping the drive letter. Otherwise, this expands to
964 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
967 /* Discard any previous drive specifier if nm is now in UNC format. */
968 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
972 #endif /* WINDOWSNT */
975 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
976 none are found, we can probably return right away. We will avoid
977 allocating a new string if name is already fully expanded. */
979 IS_DIRECTORY_SEP (nm
[0])
981 && drive
&& !is_escaped
984 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
988 /* If it turns out that the filename we want to return is just a
989 suffix of FILENAME, we don't need to go through and edit
990 things; we just need to construct a new string using data
991 starting at the middle of FILENAME. If we set LOSE, that
992 means we've discovered that we can't do that cool trick. */
998 /* Since we know the name is absolute, we can assume that each
999 element starts with a "/". */
1001 /* "." and ".." are hairy. */
1002 if (IS_DIRECTORY_SEP (p
[0])
1004 && (IS_DIRECTORY_SEP (p
[2])
1006 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1009 /* We want to replace multiple `/' in a row with a single
1012 && IS_DIRECTORY_SEP (p
[0])
1013 && IS_DIRECTORY_SEP (p
[1]))
1020 /* Make sure directories are all separated with /, but
1021 avoid allocation of a new string when not required. */
1022 dostounix_filename (nm
, multibyte
);
1024 if (IS_DIRECTORY_SEP (nm
[1]))
1026 if (strcmp (nm
, SSDATA (name
)) != 0)
1027 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1031 /* Drive must be set, so this is okay. */
1032 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1036 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1037 temp
[0] = DRIVE_LETTER (drive
);
1038 name
= concat2 (build_string (temp
), name
);
1041 if (!NILP (Vw32_downcase_file_names
))
1042 name
= Fdowncase (name
);
1045 #else /* not DOS_NT */
1046 if (strcmp (nm
, SSDATA (name
)) == 0)
1048 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1049 #endif /* not DOS_NT */
1053 /* At this point, nm might or might not be an absolute file name. We
1054 need to expand ~ or ~user if present, otherwise prefix nm with
1055 default_directory if nm is not absolute, and finally collapse /./
1056 and /foo/../ sequences.
1058 We set newdir to be the appropriate prefix if one is needed:
1059 - the relevant user directory if nm starts with ~ or ~user
1060 - the specified drive's working dir (DOS/NT only) if nm does not
1062 - the value of default_directory.
1064 Note that these prefixes are not guaranteed to be absolute (except
1065 for the working dir of a drive). Therefore, to ensure we always
1066 return an absolute name, if the final prefix is not absolute we
1067 append it to the current working directory. */
1071 if (nm
[0] == '~') /* prefix ~ */
1073 if (IS_DIRECTORY_SEP (nm
[1])
1074 || nm
[1] == 0) /* ~ by itself */
1078 if (!(newdir
= egetenv ("HOME")))
1081 /* `egetenv' may return a unibyte string, which will bite us since
1082 we expect the directory to be multibyte. */
1083 tem
= build_string (newdir
);
1084 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1086 hdir
= DECODE_FILE (tem
);
1087 newdir
= SSDATA (hdir
);
1090 collapse_newdir
= 0;
1093 else /* ~user/filename */
1096 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1097 o
= alloca (p
- nm
+ 1);
1098 memcpy (o
, nm
, p
- nm
);
1102 pw
= getpwnam (o
+ 1);
1108 newdir
= pw
->pw_dir
;
1109 /* `getpwnam' may return a unibyte string, which will
1110 bite us since we expect the directory to be
1112 tem
= build_string (newdir
);
1113 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1115 hdir
= DECODE_FILE (tem
);
1116 newdir
= SSDATA (hdir
);
1120 collapse_newdir
= 0;
1124 /* If we don't find a user of that name, leave the name
1125 unchanged; don't move nm forward to p. */
1130 /* On DOS and Windows, nm is absolute if a drive name was specified;
1131 use the drive's current directory as the prefix if needed. */
1132 if (!newdir
&& drive
)
1134 /* Get default directory if needed to make nm absolute. */
1136 if (!IS_DIRECTORY_SEP (nm
[0]))
1138 adir
= alloca (MAXPATHLEN
+ 1);
1139 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1143 Lisp_Object tem
= build_string (adir
);
1145 tem
= DECODE_FILE (tem
);
1146 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1151 /* Either nm starts with /, or drive isn't mounted. */
1153 adir
[0] = DRIVE_LETTER (drive
);
1162 /* Finally, if no prefix has been specified and nm is not absolute,
1163 then it must be expanded relative to default_directory. */
1167 /* /... alone is not absolute on DOS and Windows. */
1168 && !IS_DIRECTORY_SEP (nm
[0])
1171 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1175 newdir
= SSDATA (default_directory
);
1177 /* Note if special escape prefix is present, but remove for now. */
1178 if (newdir
[0] == '/' && newdir
[1] == ':')
1189 /* First ensure newdir is an absolute name. */
1191 /* Detect MSDOS file names with drive specifiers. */
1192 ! (IS_DRIVE (newdir
[0])
1193 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1195 /* Detect Windows file names in UNC format. */
1196 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1200 /* Effectively, let newdir be (expand-file-name newdir cwd).
1201 Because of the admonition against calling expand-file-name
1202 when we have pointers into lisp strings, we accomplish this
1203 indirectly by prepending newdir to nm if necessary, and using
1204 cwd (or the wd of newdir's drive) as the new newdir. */
1207 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1209 drive
= (unsigned char) newdir
[0];
1212 if (!IS_DIRECTORY_SEP (nm
[0]))
1214 ptrdiff_t newlen
= strlen (newdir
);
1215 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1216 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1220 adir
= alloca (MAXPATHLEN
+ 1);
1223 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1227 getcwd (adir
, MAXPATHLEN
+ 1);
1230 Lisp_Object tem
= build_string (adir
);
1232 tem
= DECODE_FILE (tem
);
1233 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1238 /* Strip off drive name from prefix, if present. */
1239 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1245 /* Keep only a prefix from newdir if nm starts with slash
1246 (//server/share for UNC, nothing otherwise). */
1247 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1250 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1252 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1254 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1256 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1269 /* Get rid of any slash at the end of newdir, unless newdir is
1270 just / or // (an incomplete UNC name). */
1271 length
= strlen (newdir
);
1273 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1275 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1279 char *temp
= alloca (length
);
1280 memcpy (temp
, newdir
, length
- 1);
1281 temp
[length
- 1] = 0;
1292 /* Now concatenate the directory and name to new space in the stack frame. */
1293 tlen
+= strlen (nm
) + 1;
1295 /* Reserve space for drive specifier and escape prefix, since either
1296 or both may need to be inserted. (The Microsoft x86 compiler
1297 produces incorrect code if the following two lines are combined.) */
1298 target
= alloca (tlen
+ 4);
1300 #else /* not DOS_NT */
1301 target
= alloca (tlen
);
1302 #endif /* not DOS_NT */
1307 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1310 /* If newdir is effectively "C:/", then the drive letter will have
1311 been stripped and newdir will be "/". Concatenating with an
1312 absolute directory in nm produces "//", which will then be
1313 incorrectly treated as a network share. Ignore newdir in
1314 this case (keeping the drive letter). */
1315 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1316 && newdir
[1] == '\0'))
1318 strcpy (target
, newdir
);
1321 file_name_as_directory (target
, newdir
, length
, multibyte
);
1324 strcat (target
, nm
);
1326 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1334 if (!IS_DIRECTORY_SEP (*p
))
1338 else if (p
[1] == '.'
1339 && (IS_DIRECTORY_SEP (p
[2])
1342 /* If "/." is the entire filename, keep the "/". Otherwise,
1343 just delete the whole "/.". */
1344 if (o
== target
&& p
[2] == '\0')
1348 else if (p
[1] == '.' && p
[2] == '.'
1349 /* `/../' is the "superroot" on certain file systems.
1350 Turned off on DOS_NT systems because they have no
1351 "superroot" and because this causes us to produce
1352 file names like "d:/../foo" which fail file-related
1353 functions of the underlying OS. (To reproduce, try a
1354 long series of "../../" in default_directory, longer
1355 than the number of levels from the root.) */
1359 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1364 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1367 /* Don't go below server level in UNC filenames. */
1368 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1369 && IS_DIRECTORY_SEP (*target
))
1373 /* Keep initial / only if this is the whole name. */
1374 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1378 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1379 /* Collapse multiple `/' in a row. */
1388 /* At last, set drive name. */
1390 /* Except for network file name. */
1391 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1392 #endif /* WINDOWSNT */
1394 if (!drive
) emacs_abort ();
1396 target
[0] = DRIVE_LETTER (drive
);
1399 /* Reinsert the escape prefix if required. */
1406 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1407 dostounix_filename (SSDATA (result
), multibyte
);
1409 if (!NILP (Vw32_downcase_file_names
))
1410 result
= Fdowncase (result
);
1413 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1414 #endif /* !DOS_NT */
1417 /* Again look to see if the file name has special constructs in it
1418 and perhaps call the corresponding file handler. This is needed
1419 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1420 the ".." component gives us "/user@host:/bar/../baz" which needs
1421 to be expanded again. */
1422 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1423 if (!NILP (handler
))
1425 handled_name
= call3 (handler
, Qexpand_file_name
,
1426 result
, default_directory
);
1427 if (STRINGP (handled_name
))
1428 return handled_name
;
1429 error ("Invalid handler in `file-name-handler-alist'");
1436 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1437 This is the old version of expand-file-name, before it was thoroughly
1438 rewritten for Emacs 10.31. We leave this version here commented-out,
1439 because the code is very complex and likely to have subtle bugs. If
1440 bugs _are_ found, it might be of interest to look at the old code and
1441 see what did it do in the relevant situation.
1443 Don't remove this code: it's true that it will be accessible
1444 from the repository, but a few years from deletion, people will
1445 forget it is there. */
1447 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1448 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1449 "Convert FILENAME to absolute, and canonicalize it.\n\
1450 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1451 \(does not start with slash); if DEFAULT is nil or missing,\n\
1452 the current buffer's value of default-directory is used.\n\
1453 Filenames containing `.' or `..' as components are simplified;\n\
1454 initial `~/' expands to your home directory.\n\
1455 See also the function `substitute-in-file-name'.")
1457 Lisp_Object name
, defalt
;
1461 register unsigned char *newdir
, *p
, *o
;
1463 unsigned char *target
;
1466 CHECK_STRING (name
);
1469 /* If nm is absolute, flush ...// and detect /./ and /../.
1470 If no /./ or /../ we can return right away. */
1477 if (p
[0] == '/' && p
[1] == '/')
1479 if (p
[0] == '/' && p
[1] == '~')
1480 nm
= p
+ 1, lose
= 1;
1481 if (p
[0] == '/' && p
[1] == '.'
1482 && (p
[2] == '/' || p
[2] == 0
1483 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1489 if (nm
== SDATA (name
))
1491 return build_string (nm
);
1495 /* Now determine directory to start with and put it in NEWDIR. */
1499 if (nm
[0] == '~') /* prefix ~ */
1500 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1502 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1503 newdir
= (unsigned char *) "";
1506 else /* ~user/filename */
1508 /* Get past ~ to user. */
1509 unsigned char *user
= nm
+ 1;
1510 /* Find end of name. */
1511 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1512 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1513 /* Copy the user name into temp storage. */
1514 o
= alloca (len
+ 1);
1515 memcpy (o
, user
, len
);
1518 /* Look up the user name. */
1520 pw
= (struct passwd
*) getpwnam (o
+ 1);
1523 error ("\"%s\" isn't a registered user", o
+ 1);
1525 newdir
= (unsigned char *) pw
->pw_dir
;
1527 /* Discard the user name from NM. */
1531 if (nm
[0] != '/' && !newdir
)
1534 defalt
= current_buffer
->directory
;
1535 CHECK_STRING (defalt
);
1536 newdir
= SDATA (defalt
);
1539 /* Now concatenate the directory and name to new space in the stack frame. */
1541 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1542 target
= alloca (tlen
);
1547 if (nm
[0] == 0 || nm
[0] == '/')
1548 strcpy (target
, newdir
);
1550 file_name_as_directory (target
, newdir
);
1553 strcat (target
, nm
);
1555 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1566 else if (!strncmp (p
, "//", 2)
1572 else if (p
[0] == '/' && p
[1] == '.'
1573 && (p
[2] == '/' || p
[2] == 0))
1575 else if (!strncmp (p
, "/..", 3)
1576 /* `/../' is the "superroot" on certain file systems. */
1578 && (p
[3] == '/' || p
[3] == 0))
1580 while (o
!= target
&& *--o
!= '/')
1582 if (o
== target
&& *o
== '/')
1592 return make_string (target
, o
- target
);
1596 /* If /~ or // appears, discard everything through first slash. */
1598 file_name_absolute_p (const char *filename
)
1601 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1603 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1604 && IS_DIRECTORY_SEP (filename
[2]))
1610 search_embedded_absfilename (char *nm
, char *endp
)
1614 for (p
= nm
+ 1; p
< endp
; p
++)
1616 if (IS_DIRECTORY_SEP (p
[-1])
1617 && file_name_absolute_p (p
)
1618 #if defined (WINDOWSNT) || defined (CYGWIN)
1619 /* // at start of file name is meaningful in Apollo,
1620 WindowsNT and Cygwin systems. */
1621 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1622 #endif /* not (WINDOWSNT || CYGWIN) */
1625 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1626 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1628 char *o
= alloca (s
- p
+ 1);
1630 memcpy (o
, p
, s
- p
);
1633 /* If we have ~user and `user' exists, discard
1634 everything up to ~. But if `user' does not exist, leave
1635 ~user alone, it might be a literal file name. */
1637 pw
= getpwnam (o
+ 1);
1649 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1650 Ssubstitute_in_file_name
, 1, 1, 0,
1651 doc
: /* Substitute environment variables referred to in FILENAME.
1652 `$FOO' where FOO is an environment variable name means to substitute
1653 the value of that variable. The variable name should be terminated
1654 with a character not a letter, digit or underscore; otherwise, enclose
1655 the entire variable name in braces.
1657 If `/~' appears, all of FILENAME through that `/' is discarded.
1658 If `//' appears, everything up to and including the first of
1659 those `/' is discarded. */)
1660 (Lisp_Object filename
)
1662 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1663 char *target
= NULL
;
1664 ptrdiff_t total
= 0;
1665 bool substituted
= 0;
1668 Lisp_Object handler
;
1670 CHECK_STRING (filename
);
1672 multibyte
= STRING_MULTIBYTE (filename
);
1674 /* If the file name has special constructs in it,
1675 call the corresponding file handler. */
1676 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1677 if (!NILP (handler
))
1679 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1681 if (STRINGP (handled_name
))
1682 return handled_name
;
1683 error ("Invalid handler in `file-name-handler-alist'");
1686 /* Always work on a copy of the string, in case GC happens during
1687 decode of environment variables, causing the original Lisp_String
1688 data to be relocated. */
1689 nm
= alloca (SBYTES (filename
) + 1);
1690 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1693 dostounix_filename (nm
, multibyte
);
1694 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1696 endp
= nm
+ SBYTES (filename
);
1698 /* If /~ or // appears, discard everything through first slash. */
1699 p
= search_embedded_absfilename (nm
, endp
);
1701 /* Start over with the new string, so we check the file-name-handler
1702 again. Important with filenames like "/home/foo//:/hello///there"
1703 which would substitute to "/:/hello///there" rather than "/there". */
1704 return Fsubstitute_in_file_name
1705 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1707 /* See if any variables are substituted into the string
1708 and find the total length of their values in `total'. */
1710 for (p
= nm
; p
!= endp
;)
1720 /* "$$" means a single "$". */
1729 p
= memchr (p
, '}', endp
- p
);
1737 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1741 /* Copy out the variable name. */
1742 target
= alloca (s
- o
+ 1);
1743 memcpy (target
, o
, s
- o
);
1746 strupr (target
); /* $home == $HOME etc. */
1749 /* Get variable value. */
1750 o
= egetenv (target
);
1753 /* Don't try to guess a maximum length - UTF8 can use up to
1754 four bytes per character. This code is unlikely to run
1755 in a situation that requires performance, so decoding the
1756 env variables twice should be acceptable. Note that
1757 decoding may cause a garbage collect. */
1758 Lisp_Object orig
, decoded
;
1759 orig
= build_unibyte_string (o
);
1760 decoded
= DECODE_FILE (orig
);
1761 total
+= SBYTES (decoded
);
1771 if (!NILP (Vw32_downcase_file_names
))
1772 filename
= Fdowncase (filename
);
1777 /* If substitution required, recopy the string and do it. */
1778 /* Make space in stack frame for the new copy. */
1779 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1782 /* Copy the rest of the name through, replacing $ constructs with values. */
1799 p
= memchr (p
, '}', endp
- p
);
1807 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1811 /* Copy out the variable name. */
1812 target
= alloca (s
- o
+ 1);
1813 memcpy (target
, o
, s
- o
);
1816 /* Get variable value. */
1817 o
= egetenv (target
);
1821 strcpy (x
, target
); x
+= strlen (target
);
1825 Lisp_Object orig
, decoded
;
1826 ptrdiff_t orig_length
, decoded_length
;
1827 orig_length
= strlen (o
);
1828 orig
= make_unibyte_string (o
, orig_length
);
1829 decoded
= DECODE_FILE (orig
);
1830 decoded_length
= SBYTES (decoded
);
1831 memcpy (x
, SDATA (decoded
), decoded_length
);
1832 x
+= decoded_length
;
1834 /* If environment variable needed decoding, return value
1835 needs to be multibyte. */
1836 if (decoded_length
!= orig_length
1837 || memcmp (SDATA (decoded
), o
, orig_length
))
1844 /* If /~ or // appears, discard everything through first slash. */
1845 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1846 /* This time we do not start over because we've already expanded envvars
1847 and replaced $$ with $. Maybe we should start over as well, but we'd
1848 need to quote some $ to $$ first. */
1852 if (!NILP (Vw32_downcase_file_names
))
1854 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1856 xname
= Fdowncase (xname
);
1861 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1864 error ("Bad format environment-variable substitution");
1866 error ("Missing \"}\" in environment-variable substitution");
1868 error ("Substituting nonexistent environment variable \"%s\"", target
);
1871 /* A slightly faster and more convenient way to get
1872 (directory-file-name (expand-file-name FOO)). */
1875 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1877 register Lisp_Object absname
;
1879 absname
= Fexpand_file_name (filename
, defdir
);
1881 /* Remove final slash, if any (unless this is the root dir).
1882 stat behaves differently depending! */
1883 if (SCHARS (absname
) > 1
1884 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1885 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1886 /* We cannot take shortcuts; they might be wrong for magic file names. */
1887 absname
= Fdirectory_file_name (absname
);
1891 /* Signal an error if the file ABSNAME already exists.
1892 If INTERACTIVE, ask the user whether to proceed,
1893 and bypass the error if the user says to go ahead.
1894 QUERYSTRING is a name for the action that is being considered
1897 *STATPTR is used to store the stat information if the file exists.
1898 If the file does not exist, STATPTR->st_mode is set to 0.
1899 If STATPTR is null, we don't store into it.
1901 If QUICK, ask for y or n, not yes or no. */
1904 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1905 bool interactive
, struct stat
*statptr
,
1908 Lisp_Object tem
, encoded_filename
;
1909 struct stat statbuf
;
1910 struct gcpro gcpro1
;
1912 encoded_filename
= ENCODE_FILE (absname
);
1914 /* `stat' is a good way to tell whether the file exists,
1915 regardless of what access permissions it has. */
1916 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1918 if (S_ISDIR (statbuf
.st_mode
))
1919 xsignal2 (Qfile_error
,
1920 build_string ("File is a directory"), absname
);
1923 xsignal2 (Qfile_already_exists
,
1924 build_string ("File already exists"), absname
);
1926 tem
= format2 ("File %s already exists; %s anyway? ",
1927 absname
, build_string (querystring
));
1929 tem
= call1 (intern ("y-or-n-p"), tem
);
1931 tem
= do_yes_or_no_p (tem
);
1934 xsignal2 (Qfile_already_exists
,
1935 build_string ("File already exists"), absname
);
1942 statptr
->st_mode
= 0;
1947 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1948 "fCopy file: \nGCopy %s to file: \np\nP",
1949 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1950 If NEWNAME names a directory, copy FILE there.
1952 This function always sets the file modes of the output file to match
1955 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1956 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1957 signal a `file-already-exists' error without overwriting. If
1958 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1959 about overwriting; this is what happens in interactive use with M-x.
1960 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1963 Fourth arg KEEP-TIME non-nil means give the output file the same
1964 last-modified time as the old one. (This works on only some systems.)
1966 A prefix arg makes KEEP-TIME non-nil.
1968 If PRESERVE-UID-GID is non-nil, we try to transfer the
1969 uid and gid of FILE to NEWNAME.
1971 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1972 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1973 entries (depending on how Emacs was built). */)
1974 (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
)
1978 char buf
[16 * 1024];
1979 struct stat st
, out_st
;
1980 Lisp_Object handler
;
1981 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1982 ptrdiff_t count
= SPECPDL_INDEX ();
1983 Lisp_Object encoded_file
, encoded_newname
;
1985 security_context_t con
;
1992 encoded_file
= encoded_newname
= Qnil
;
1993 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1994 CHECK_STRING (file
);
1995 CHECK_STRING (newname
);
1997 if (!NILP (Ffile_directory_p (newname
)))
1998 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2000 newname
= Fexpand_file_name (newname
, Qnil
);
2002 file
= Fexpand_file_name (file
, Qnil
);
2004 /* If the input file name has special constructs in it,
2005 call the corresponding file handler. */
2006 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2007 /* Likewise for output file name. */
2009 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2010 if (!NILP (handler
))
2011 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
2012 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
2013 preserve_extended_attributes
));
2015 encoded_file
= ENCODE_FILE (file
);
2016 encoded_newname
= ENCODE_FILE (newname
);
2018 if (NILP (ok_if_already_exists
)
2019 || INTEGERP (ok_if_already_exists
))
2020 barf_or_query_if_file_exists (newname
, "copy to it",
2021 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2022 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
2026 if (!NILP (preserve_extended_attributes
))
2028 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2029 if (acl
== NULL
&& acl_errno_valid (errno
))
2030 report_file_error ("Getting ACL", file
);
2032 if (!CopyFile (SDATA (encoded_file
),
2033 SDATA (encoded_newname
),
2036 /* CopyFile doesn't set errno when it fails. By far the most
2037 "popular" reason is that the target is read-only. */
2038 report_file_errno ("Copying file", list2 (file
, newname
),
2039 GetLastError () == 5 ? EACCES
: EPERM
);
2041 /* CopyFile retains the timestamp by default. */
2042 else if (NILP (keep_time
))
2048 filename
= SDATA (encoded_newname
);
2050 /* Ensure file is writable while its modified time is set. */
2051 attributes
= GetFileAttributes (filename
);
2052 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2053 now
= current_emacs_time ();
2054 if (set_file_times (-1, filename
, now
, now
))
2056 /* Restore original attributes. */
2057 SetFileAttributes (filename
, attributes
);
2058 xsignal2 (Qfile_date_error
,
2059 build_string ("Cannot set file date"), newname
);
2061 /* Restore original attributes. */
2062 SetFileAttributes (filename
, attributes
);
2067 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2068 if (fail
&& acl_errno_valid (errno
))
2069 report_file_error ("Setting ACL", newname
);
2073 #else /* not WINDOWSNT */
2075 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2079 report_file_error ("Opening input file", file
);
2081 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2083 if (fstat (ifd
, &st
) != 0)
2084 report_file_error ("Input file status", file
);
2086 if (!NILP (preserve_extended_attributes
))
2089 if (is_selinux_enabled ())
2091 conlength
= fgetfilecon (ifd
, &con
);
2092 if (conlength
== -1)
2093 report_file_error ("Doing fgetfilecon", file
);
2098 if (out_st
.st_mode
!= 0
2099 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2100 report_file_errno ("Input and output files are the same",
2101 list2 (file
, newname
), 0);
2103 /* We can copy only regular files. */
2104 if (!S_ISREG (st
.st_mode
))
2105 report_file_errno ("Non-regular file", file
,
2106 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
2110 int new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0600 : 0666);
2112 int new_mask
= S_IREAD
| S_IWRITE
;
2114 ofd
= emacs_open (SSDATA (encoded_newname
),
2115 (O_WRONLY
| O_TRUNC
| O_CREAT
2116 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2120 report_file_error ("Opening output file", newname
);
2122 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2126 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2127 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2128 report_file_error ("Write error", newname
);
2132 /* Preserve the original file permissions, and if requested, also its
2135 mode_t mode_mask
= 07777;
2136 if (!NILP (preserve_uid_gid
))
2138 /* Attempt to change owner and group. If that doesn't work
2139 attempt to change just the group, as that is sometimes allowed.
2140 Adjust the mode mask to eliminate setuid or setgid bits
2141 that are inappropriate if the owner and group are wrong. */
2142 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2144 mode_mask
&= ~06000;
2145 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2150 switch (!NILP (preserve_extended_attributes
)
2151 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2152 SSDATA (encoded_newname
), ofd
,
2153 st
.st_mode
& mode_mask
)
2154 : fchmod (ofd
, st
.st_mode
& mode_mask
))
2156 case -2: report_file_error ("Copying permissions from", file
);
2157 case -1: report_file_error ("Copying permissions to", newname
);
2160 #endif /* not MSDOS */
2165 /* Set the modified context back to the file. */
2166 bool fail
= fsetfilecon (ofd
, con
) != 0;
2167 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2168 if (fail
&& errno
!= ENOTSUP
)
2169 report_file_error ("Doing fsetfilecon", newname
);
2175 if (!NILP (keep_time
))
2177 EMACS_TIME atime
= get_stat_atime (&st
);
2178 EMACS_TIME mtime
= get_stat_mtime (&st
);
2179 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2180 xsignal2 (Qfile_date_error
,
2181 build_string ("Cannot set file date"), newname
);
2184 if (emacs_close (ofd
) < 0)
2185 report_file_error ("Write error", newname
);
2190 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2191 and if it can't, it tells so. Otherwise, under MSDOS we usually
2192 get only the READ bit, which will make the copied file read-only,
2193 so it's better not to chmod at all. */
2194 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2195 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2197 #endif /* not WINDOWSNT */
2199 /* Discard the unwind protects. */
2200 specpdl_ptr
= specpdl
+ count
;
2206 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2207 Smake_directory_internal
, 1, 1, 0,
2208 doc
: /* Create a new directory named DIRECTORY. */)
2209 (Lisp_Object directory
)
2212 Lisp_Object handler
;
2213 Lisp_Object encoded_dir
;
2215 CHECK_STRING (directory
);
2216 directory
= Fexpand_file_name (directory
, Qnil
);
2218 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2219 if (!NILP (handler
))
2220 return call2 (handler
, Qmake_directory_internal
, directory
);
2222 encoded_dir
= ENCODE_FILE (directory
);
2224 dir
= SSDATA (encoded_dir
);
2227 if (mkdir (dir
) != 0)
2229 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2231 report_file_error ("Creating directory", directory
);
2236 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2237 Sdelete_directory_internal
, 1, 1, 0,
2238 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2239 (Lisp_Object directory
)
2242 Lisp_Object encoded_dir
;
2244 CHECK_STRING (directory
);
2245 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2246 encoded_dir
= ENCODE_FILE (directory
);
2247 dir
= SSDATA (encoded_dir
);
2249 if (rmdir (dir
) != 0)
2250 report_file_error ("Removing directory", directory
);
2255 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2256 "(list (read-file-name \
2257 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2258 \"Move file to trash: \" \"Delete file: \") \
2259 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2260 (null current-prefix-arg))",
2261 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2262 If file has multiple names, it continues to exist with the other names.
2263 TRASH non-nil means to trash the file instead of deleting, provided
2264 `delete-by-moving-to-trash' is non-nil.
2266 When called interactively, TRASH is t if no prefix argument is given.
2267 With a prefix argument, TRASH is nil. */)
2268 (Lisp_Object filename
, Lisp_Object trash
)
2270 Lisp_Object handler
;
2271 Lisp_Object encoded_file
;
2272 struct gcpro gcpro1
;
2275 if (!NILP (Ffile_directory_p (filename
))
2276 && NILP (Ffile_symlink_p (filename
)))
2277 xsignal2 (Qfile_error
,
2278 build_string ("Removing old name: is a directory"),
2281 filename
= Fexpand_file_name (filename
, Qnil
);
2283 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2284 if (!NILP (handler
))
2285 return call3 (handler
, Qdelete_file
, filename
, trash
);
2287 if (delete_by_moving_to_trash
&& !NILP (trash
))
2288 return call1 (Qmove_file_to_trash
, filename
);
2290 encoded_file
= ENCODE_FILE (filename
);
2292 if (unlink (SSDATA (encoded_file
)) < 0)
2293 report_file_error ("Removing old name", filename
);
2298 internal_delete_file_1 (Lisp_Object ignore
)
2303 /* Delete file FILENAME, returning true if successful.
2304 This ignores `delete-by-moving-to-trash'. */
2307 internal_delete_file (Lisp_Object filename
)
2311 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2312 Qt
, internal_delete_file_1
);
2316 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2317 "fRename file: \nGRename %s to file: \np",
2318 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2319 If file has names other than FILE, it continues to have those names.
2320 Signals a `file-already-exists' error if a file NEWNAME already exists
2321 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2322 A number as third arg means request confirmation if NEWNAME already exists.
2323 This is what happens in interactive use with M-x. */)
2324 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2326 Lisp_Object handler
;
2327 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2328 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2330 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2331 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2332 CHECK_STRING (file
);
2333 CHECK_STRING (newname
);
2334 file
= Fexpand_file_name (file
, Qnil
);
2336 if ((!NILP (Ffile_directory_p (newname
)))
2338 /* If the file names are identical but for the case,
2339 don't attempt to move directory to itself. */
2340 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2344 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2345 ? file
: Fdirectory_file_name (file
));
2346 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2349 newname
= Fexpand_file_name (newname
, Qnil
);
2351 /* If the file name has special constructs in it,
2352 call the corresponding file handler. */
2353 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2355 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2356 if (!NILP (handler
))
2357 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2358 file
, newname
, ok_if_already_exists
));
2360 encoded_file
= ENCODE_FILE (file
);
2361 encoded_newname
= ENCODE_FILE (newname
);
2364 /* If the file names are identical but for the case, don't ask for
2365 confirmation: they simply want to change the letter-case of the
2367 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2369 if (NILP (ok_if_already_exists
)
2370 || INTEGERP (ok_if_already_exists
))
2371 barf_or_query_if_file_exists (newname
, "rename to it",
2372 INTEGERP (ok_if_already_exists
), 0, 0);
2373 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2378 symlink_target
= Ffile_symlink_p (file
);
2379 if (! NILP (symlink_target
))
2380 Fmake_symbolic_link (symlink_target
, newname
,
2381 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2382 else if (!NILP (Ffile_directory_p (file
)))
2383 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2385 /* We have already prompted if it was an integer, so don't
2386 have copy-file prompt again. */
2387 Fcopy_file (file
, newname
,
2388 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2391 count
= SPECPDL_INDEX ();
2392 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2394 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2395 call2 (Qdelete_directory
, file
, Qt
);
2397 Fdelete_file (file
, Qnil
);
2398 unbind_to (count
, Qnil
);
2401 report_file_error ("Renaming", list2 (file
, newname
));
2407 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2408 "fAdd name to file: \nGName to add to %s: \np",
2409 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2410 Signals a `file-already-exists' error if a file NEWNAME already exists
2411 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2412 A number as third arg means request confirmation if NEWNAME already exists.
2413 This is what happens in interactive use with M-x. */)
2414 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2416 Lisp_Object handler
;
2417 Lisp_Object encoded_file
, encoded_newname
;
2418 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2420 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2421 encoded_file
= encoded_newname
= Qnil
;
2422 CHECK_STRING (file
);
2423 CHECK_STRING (newname
);
2424 file
= Fexpand_file_name (file
, Qnil
);
2426 if (!NILP (Ffile_directory_p (newname
)))
2427 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2429 newname
= Fexpand_file_name (newname
, Qnil
);
2431 /* If the file name has special constructs in it,
2432 call the corresponding file handler. */
2433 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2434 if (!NILP (handler
))
2435 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2436 newname
, ok_if_already_exists
));
2438 /* If the new name has special constructs in it,
2439 call the corresponding file handler. */
2440 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2441 if (!NILP (handler
))
2442 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2443 newname
, ok_if_already_exists
));
2445 encoded_file
= ENCODE_FILE (file
);
2446 encoded_newname
= ENCODE_FILE (newname
);
2448 if (NILP (ok_if_already_exists
)
2449 || INTEGERP (ok_if_already_exists
))
2450 barf_or_query_if_file_exists (newname
, "make it a new name",
2451 INTEGERP (ok_if_already_exists
), 0, 0);
2453 unlink (SSDATA (newname
));
2454 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2455 report_file_error ("Adding new name", list2 (file
, newname
));
2461 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2462 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2463 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2464 Both args must be strings.
2465 Signals a `file-already-exists' error if a file LINKNAME already exists
2466 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2467 A number as third arg means request confirmation if LINKNAME already exists.
2468 This happens for interactive use with M-x. */)
2469 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2471 Lisp_Object handler
;
2472 Lisp_Object encoded_filename
, encoded_linkname
;
2473 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2475 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2476 encoded_filename
= encoded_linkname
= Qnil
;
2477 CHECK_STRING (filename
);
2478 CHECK_STRING (linkname
);
2479 /* If the link target has a ~, we must expand it to get
2480 a truly valid file name. Otherwise, do not expand;
2481 we want to permit links to relative file names. */
2482 if (SREF (filename
, 0) == '~')
2483 filename
= Fexpand_file_name (filename
, Qnil
);
2485 if (!NILP (Ffile_directory_p (linkname
)))
2486 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2488 linkname
= Fexpand_file_name (linkname
, Qnil
);
2490 /* If the file name has special constructs in it,
2491 call the corresponding file handler. */
2492 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2493 if (!NILP (handler
))
2494 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2495 linkname
, ok_if_already_exists
));
2497 /* If the new link name has special constructs in it,
2498 call the corresponding file handler. */
2499 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2500 if (!NILP (handler
))
2501 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2502 linkname
, ok_if_already_exists
));
2504 encoded_filename
= ENCODE_FILE (filename
);
2505 encoded_linkname
= ENCODE_FILE (linkname
);
2507 if (NILP (ok_if_already_exists
)
2508 || INTEGERP (ok_if_already_exists
))
2509 barf_or_query_if_file_exists (linkname
, "make it a link",
2510 INTEGERP (ok_if_already_exists
), 0, 0);
2511 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2513 /* If we didn't complain already, silently delete existing file. */
2514 if (errno
== EEXIST
)
2516 unlink (SSDATA (encoded_linkname
));
2517 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2524 if (errno
== ENOSYS
)
2527 xsignal1 (Qfile_error
,
2528 build_string ("Symbolic links are not supported"));
2531 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2538 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2540 doc
: /* Return t if file FILENAME specifies an absolute file name.
2541 On Unix, this is a name starting with a `/' or a `~'. */)
2542 (Lisp_Object filename
)
2544 CHECK_STRING (filename
);
2545 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2548 /* Return true if FILENAME exists. */
2550 check_existing (const char *filename
)
2552 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2555 /* Return true if file FILENAME exists and can be executed. */
2558 check_executable (char *filename
)
2560 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2563 /* Return true if file FILENAME exists and can be accessed
2564 according to AMODE, which should include W_OK.
2565 On failure, return false and set errno. */
2568 check_writable (const char *filename
, int amode
)
2571 /* FIXME: an faccessat implementation should be added to the
2572 DOS/Windows ports and this #ifdef branch should be removed. */
2574 if (stat (filename
, &st
) < 0)
2577 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2578 #else /* not MSDOS */
2579 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2581 /* faccessat may have returned failure because Cygwin couldn't
2582 determine the file's UID or GID; if so, we return success. */
2585 int faccessat_errno
= errno
;
2587 if (stat (filename
, &st
) < 0)
2589 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2590 errno
= faccessat_errno
;
2594 #endif /* not MSDOS */
2597 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2598 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2599 See also `file-readable-p' and `file-attributes'.
2600 This returns nil for a symlink to a nonexistent file.
2601 Use `file-symlink-p' to test for such links. */)
2602 (Lisp_Object filename
)
2604 Lisp_Object absname
;
2605 Lisp_Object handler
;
2607 CHECK_STRING (filename
);
2608 absname
= Fexpand_file_name (filename
, Qnil
);
2610 /* If the file name has special constructs in it,
2611 call the corresponding file handler. */
2612 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2613 if (!NILP (handler
))
2615 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2620 absname
= ENCODE_FILE (absname
);
2622 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2625 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2626 doc
: /* Return t if FILENAME can be executed by you.
2627 For a directory, this means you can access files in that directory. */)
2628 (Lisp_Object filename
)
2630 Lisp_Object absname
;
2631 Lisp_Object handler
;
2633 CHECK_STRING (filename
);
2634 absname
= Fexpand_file_name (filename
, Qnil
);
2636 /* If the file name has special constructs in it,
2637 call the corresponding file handler. */
2638 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2639 if (!NILP (handler
))
2640 return call2 (handler
, Qfile_executable_p
, absname
);
2642 absname
= ENCODE_FILE (absname
);
2644 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2647 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2648 doc
: /* Return t if file FILENAME exists and you can read it.
2649 See also `file-exists-p' and `file-attributes'. */)
2650 (Lisp_Object filename
)
2652 Lisp_Object absname
;
2653 Lisp_Object handler
;
2655 CHECK_STRING (filename
);
2656 absname
= Fexpand_file_name (filename
, Qnil
);
2658 /* If the file name has special constructs in it,
2659 call the corresponding file handler. */
2660 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2661 if (!NILP (handler
))
2662 return call2 (handler
, Qfile_readable_p
, absname
);
2664 absname
= ENCODE_FILE (absname
);
2665 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2669 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2670 doc
: /* Return t if file FILENAME can be written or created by you. */)
2671 (Lisp_Object filename
)
2673 Lisp_Object absname
, dir
, encoded
;
2674 Lisp_Object handler
;
2676 CHECK_STRING (filename
);
2677 absname
= Fexpand_file_name (filename
, Qnil
);
2679 /* If the file name has special constructs in it,
2680 call the corresponding file handler. */
2681 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2682 if (!NILP (handler
))
2683 return call2 (handler
, Qfile_writable_p
, absname
);
2685 encoded
= ENCODE_FILE (absname
);
2686 if (check_writable (SSDATA (encoded
), W_OK
))
2688 if (errno
!= ENOENT
)
2691 dir
= Ffile_name_directory (absname
);
2692 eassert (!NILP (dir
));
2694 dir
= Fdirectory_file_name (dir
);
2697 dir
= ENCODE_FILE (dir
);
2699 /* The read-only attribute of the parent directory doesn't affect
2700 whether a file or directory can be created within it. Some day we
2701 should check ACLs though, which do affect this. */
2702 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2704 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2708 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2709 doc
: /* Access file FILENAME, and get an error if that does not work.
2710 The second argument STRING is used in the error message.
2711 If there is no error, returns nil. */)
2712 (Lisp_Object filename
, Lisp_Object string
)
2714 Lisp_Object handler
, encoded_filename
, absname
;
2716 CHECK_STRING (filename
);
2717 absname
= Fexpand_file_name (filename
, Qnil
);
2719 CHECK_STRING (string
);
2721 /* If the file name has special constructs in it,
2722 call the corresponding file handler. */
2723 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2724 if (!NILP (handler
))
2725 return call3 (handler
, Qaccess_file
, absname
, string
);
2727 encoded_filename
= ENCODE_FILE (absname
);
2729 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2730 report_file_error (SSDATA (string
), filename
);
2735 /* Relative to directory FD, return the symbolic link value of FILENAME.
2736 On failure, return nil. */
2738 emacs_readlinkat (int fd
, char const *filename
)
2740 static struct allocator
const emacs_norealloc_allocator
=
2741 { xmalloc
, NULL
, xfree
, memory_full
};
2743 char readlink_buf
[1024];
2744 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2745 &emacs_norealloc_allocator
, readlinkat
);
2749 val
= build_string (buf
);
2750 if (buf
[0] == '/' && strchr (buf
, ':'))
2751 val
= concat2 (build_string ("/:"), val
);
2752 if (buf
!= readlink_buf
)
2754 val
= DECODE_FILE (val
);
2758 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2759 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2760 The value is the link target, as a string.
2761 Otherwise it returns nil.
2763 This function returns t when given the name of a symlink that
2764 points to a nonexistent file. */)
2765 (Lisp_Object filename
)
2767 Lisp_Object handler
;
2769 CHECK_STRING (filename
);
2770 filename
= Fexpand_file_name (filename
, Qnil
);
2772 /* If the file name has special constructs in it,
2773 call the corresponding file handler. */
2774 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2775 if (!NILP (handler
))
2776 return call2 (handler
, Qfile_symlink_p
, filename
);
2778 filename
= ENCODE_FILE (filename
);
2780 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2783 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2784 doc
: /* Return t if FILENAME names an existing directory.
2785 Symbolic links to directories count as directories.
2786 See `file-symlink-p' to distinguish symlinks. */)
2787 (Lisp_Object filename
)
2789 Lisp_Object absname
;
2790 Lisp_Object handler
;
2792 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2794 /* If the file name has special constructs in it,
2795 call the corresponding file handler. */
2796 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2797 if (!NILP (handler
))
2798 return call2 (handler
, Qfile_directory_p
, absname
);
2800 absname
= ENCODE_FILE (absname
);
2802 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2805 /* Return true if FILE is a directory or a symlink to a directory. */
2807 file_directory_p (char const *file
)
2810 /* This is cheaper than 'stat'. */
2811 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2814 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2818 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2819 Sfile_accessible_directory_p
, 1, 1, 0,
2820 doc
: /* Return t if file FILENAME names a directory you can open.
2821 For the value to be t, FILENAME must specify the name of a directory as a file,
2822 and the directory must allow you to open files in it. In order to use a
2823 directory as a buffer's current directory, this predicate must return true.
2824 A directory name spec may be given instead; then the value is t
2825 if the directory so specified exists and really is a readable and
2826 searchable directory. */)
2827 (Lisp_Object filename
)
2829 Lisp_Object absname
;
2830 Lisp_Object handler
;
2832 CHECK_STRING (filename
);
2833 absname
= Fexpand_file_name (filename
, Qnil
);
2835 /* If the file name has special constructs in it,
2836 call the corresponding file handler. */
2837 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2838 if (!NILP (handler
))
2840 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2845 absname
= ENCODE_FILE (absname
);
2846 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2849 /* If FILE is a searchable directory or a symlink to a
2850 searchable directory, return true. Otherwise return
2851 false and set errno to an error number. */
2853 file_accessible_directory_p (char const *file
)
2856 /* There's no need to test whether FILE is searchable, as the
2857 searchable/executable bit is invented on DOS_NT platforms. */
2858 return file_directory_p (file
);
2860 /* On POSIXish platforms, use just one system call; this avoids a
2861 race and is typically faster. */
2862 ptrdiff_t len
= strlen (file
);
2868 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2869 There are three exceptions: "", "/", and "//". Leave "" alone,
2870 as it's invalid. Append only "." to the other two exceptions as
2871 "/" and "//" are distinct on some platforms, whereas "/", "///",
2872 "////", etc. are all equivalent. */
2877 /* Just check for trailing '/' when deciding whether to append '/'.
2878 That's simpler than testing the two special cases "/" and "//",
2879 and it's a safe optimization here. */
2880 char *buf
= SAFE_ALLOCA (len
+ 3);
2881 memcpy (buf
, file
, len
);
2882 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2886 ok
= check_existing (dir
);
2887 saved_errno
= errno
;
2889 errno
= saved_errno
;
2894 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2895 doc
: /* Return t if FILENAME names a regular file.
2896 This is the sort of file that holds an ordinary stream of data bytes.
2897 Symbolic links to regular files count as regular files.
2898 See `file-symlink-p' to distinguish symlinks. */)
2899 (Lisp_Object filename
)
2901 register Lisp_Object absname
;
2903 Lisp_Object handler
;
2905 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2907 /* If the file name has special constructs in it,
2908 call the corresponding file handler. */
2909 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2910 if (!NILP (handler
))
2911 return call2 (handler
, Qfile_regular_p
, absname
);
2913 absname
= ENCODE_FILE (absname
);
2918 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2920 /* Tell stat to use expensive method to get accurate info. */
2921 Vw32_get_true_file_attributes
= Qt
;
2922 result
= stat (SDATA (absname
), &st
);
2923 Vw32_get_true_file_attributes
= tem
;
2927 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2930 if (stat (SSDATA (absname
), &st
) < 0)
2932 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2936 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2937 Sfile_selinux_context
, 1, 1, 0,
2938 doc
: /* Return SELinux context of file named FILENAME.
2939 The return value is a list (USER ROLE TYPE RANGE), where the list
2940 elements are strings naming the user, role, type, and range of the
2941 file's SELinux security context.
2943 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2944 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2945 (Lisp_Object filename
)
2947 Lisp_Object absname
;
2948 Lisp_Object values
[4];
2949 Lisp_Object handler
;
2951 security_context_t con
;
2956 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2958 /* If the file name has special constructs in it,
2959 call the corresponding file handler. */
2960 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2961 if (!NILP (handler
))
2962 return call2 (handler
, Qfile_selinux_context
, absname
);
2964 absname
= ENCODE_FILE (absname
);
2971 if (is_selinux_enabled ())
2973 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2976 context
= context_new (con
);
2977 if (context_user_get (context
))
2978 values
[0] = build_string (context_user_get (context
));
2979 if (context_role_get (context
))
2980 values
[1] = build_string (context_role_get (context
));
2981 if (context_type_get (context
))
2982 values
[2] = build_string (context_type_get (context
));
2983 if (context_range_get (context
))
2984 values
[3] = build_string (context_range_get (context
));
2985 context_free (context
);
2991 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2994 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2995 Sset_file_selinux_context
, 2, 2, 0,
2996 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2997 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2998 elements are strings naming the components of a SELinux context.
3000 Value is t if setting of SELinux context was successful, nil otherwise.
3002 This function does nothing and returns nil if SELinux is disabled,
3003 or if Emacs was not compiled with SELinux support. */)
3004 (Lisp_Object filename
, Lisp_Object context
)
3006 Lisp_Object absname
;
3007 Lisp_Object handler
;
3009 Lisp_Object encoded_absname
;
3010 Lisp_Object user
= CAR_SAFE (context
);
3011 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
3012 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
3013 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
3014 security_context_t con
;
3017 context_t parsed_con
;
3020 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3022 /* If the file name has special constructs in it,
3023 call the corresponding file handler. */
3024 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
3025 if (!NILP (handler
))
3026 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
3029 if (is_selinux_enabled ())
3031 /* Get current file context. */
3032 encoded_absname
= ENCODE_FILE (absname
);
3033 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
3036 parsed_con
= context_new (con
);
3037 /* Change the parts defined in the parameter.*/
3040 if (context_user_set (parsed_con
, SSDATA (user
)))
3041 error ("Doing context_user_set");
3045 if (context_role_set (parsed_con
, SSDATA (role
)))
3046 error ("Doing context_role_set");
3050 if (context_type_set (parsed_con
, SSDATA (type
)))
3051 error ("Doing context_type_set");
3053 if (STRINGP (range
))
3055 if (context_range_set (parsed_con
, SSDATA (range
)))
3056 error ("Doing context_range_set");
3059 /* Set the modified context back to the file. */
3060 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3061 context_str (parsed_con
))
3063 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3064 if (fail
&& errno
!= ENOTSUP
)
3065 report_file_error ("Doing lsetfilecon", absname
);
3067 context_free (parsed_con
);
3069 return fail
? Qnil
: Qt
;
3072 report_file_error ("Doing lgetfilecon", absname
);
3079 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3080 doc
: /* Return ACL entries of file named FILENAME.
3081 The entries are returned in a format suitable for use in `set-file-acl'
3082 but is otherwise undocumented and subject to change.
3083 Return nil if file does not exist or is not accessible, or if Emacs
3084 was unable to determine the ACL entries. */)
3085 (Lisp_Object filename
)
3087 Lisp_Object absname
;
3088 Lisp_Object handler
;
3089 #ifdef HAVE_ACL_SET_FILE
3091 Lisp_Object acl_string
;
3095 absname
= expand_and_dir_to_file (filename
,
3096 BVAR (current_buffer
, directory
));
3098 /* If the file name has special constructs in it,
3099 call the corresponding file handler. */
3100 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3101 if (!NILP (handler
))
3102 return call2 (handler
, Qfile_acl
, absname
);
3104 #ifdef HAVE_ACL_SET_FILE
3105 absname
= ENCODE_FILE (absname
);
3107 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3111 str
= acl_to_text (acl
, NULL
);
3118 acl_string
= build_string (str
);
3128 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3130 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3131 ACL-STRING should contain the textual representation of the ACL
3132 entries in a format suitable for the platform.
3134 Value is t if setting of ACL was successful, nil otherwise.
3136 Setting ACL for local files requires Emacs to be built with ACL
3138 (Lisp_Object filename
, Lisp_Object acl_string
)
3140 Lisp_Object absname
;
3141 Lisp_Object handler
;
3142 #ifdef HAVE_ACL_SET_FILE
3143 Lisp_Object encoded_absname
;
3148 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3150 /* If the file name has special constructs in it,
3151 call the corresponding file handler. */
3152 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3153 if (!NILP (handler
))
3154 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3156 #ifdef HAVE_ACL_SET_FILE
3157 if (STRINGP (acl_string
))
3159 acl
= acl_from_text (SSDATA (acl_string
));
3162 report_file_error ("Converting ACL", absname
);
3166 encoded_absname
= ENCODE_FILE (absname
);
3168 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3171 if (fail
&& acl_errno_valid (errno
))
3172 report_file_error ("Setting ACL", absname
);
3175 return fail
? Qnil
: Qt
;
3182 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3183 doc
: /* Return mode bits of file named FILENAME, as an integer.
3184 Return nil, if file does not exist or is not accessible. */)
3185 (Lisp_Object filename
)
3187 Lisp_Object absname
;
3189 Lisp_Object handler
;
3191 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3193 /* If the file name has special constructs in it,
3194 call the corresponding file handler. */
3195 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3196 if (!NILP (handler
))
3197 return call2 (handler
, Qfile_modes
, absname
);
3199 absname
= ENCODE_FILE (absname
);
3201 if (stat (SSDATA (absname
), &st
) < 0)
3204 return make_number (st
.st_mode
& 07777);
3207 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3208 "(let ((file (read-file-name \"File: \"))) \
3209 (list file (read-file-modes nil file)))",
3210 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3211 Only the 12 low bits of MODE are used.
3213 Interactively, mode bits are read by `read-file-modes', which accepts
3214 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3215 (Lisp_Object filename
, Lisp_Object mode
)
3217 Lisp_Object absname
, encoded_absname
;
3218 Lisp_Object handler
;
3220 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3221 CHECK_NUMBER (mode
);
3223 /* If the file name has special constructs in it,
3224 call the corresponding file handler. */
3225 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3226 if (!NILP (handler
))
3227 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3229 encoded_absname
= ENCODE_FILE (absname
);
3231 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3232 report_file_error ("Doing chmod", absname
);
3237 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3238 doc
: /* Set the file permission bits for newly created files.
3239 The argument MODE should be an integer; only the low 9 bits are used.
3240 This setting is inherited by subprocesses. */)
3243 CHECK_NUMBER (mode
);
3245 umask ((~ XINT (mode
)) & 0777);
3250 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3251 doc
: /* Return the default file protection for created files.
3252 The value is an integer. */)
3259 realmask
= umask (0);
3263 XSETINT (value
, (~ realmask
) & 0777);
3268 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3269 doc
: /* Set times of file FILENAME to TIMESTAMP.
3270 Set both access and modification times.
3271 Return t on success, else nil.
3272 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3274 (Lisp_Object filename
, Lisp_Object timestamp
)
3276 Lisp_Object absname
, encoded_absname
;
3277 Lisp_Object handler
;
3278 EMACS_TIME t
= lisp_time_argument (timestamp
);
3280 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3282 /* If the file name has special constructs in it,
3283 call the corresponding file handler. */
3284 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3285 if (!NILP (handler
))
3286 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3288 encoded_absname
= ENCODE_FILE (absname
);
3291 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3294 /* Setting times on a directory always fails. */
3295 if (file_directory_p (SSDATA (encoded_absname
)))
3298 report_file_error ("Setting file times", absname
);
3306 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3307 doc
: /* Tell Unix to finish all pending disk updates. */)
3314 #endif /* HAVE_SYNC */
3316 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3317 doc
: /* Return t if file FILE1 is newer than file FILE2.
3318 If FILE1 does not exist, the answer is nil;
3319 otherwise, if FILE2 does not exist, the answer is t. */)
3320 (Lisp_Object file1
, Lisp_Object file2
)
3322 Lisp_Object absname1
, absname2
;
3323 struct stat st1
, st2
;
3324 Lisp_Object handler
;
3325 struct gcpro gcpro1
, gcpro2
;
3327 CHECK_STRING (file1
);
3328 CHECK_STRING (file2
);
3331 GCPRO2 (absname1
, file2
);
3332 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3333 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3336 /* If the file name has special constructs in it,
3337 call the corresponding file handler. */
3338 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3340 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3341 if (!NILP (handler
))
3342 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3344 GCPRO2 (absname1
, absname2
);
3345 absname1
= ENCODE_FILE (absname1
);
3346 absname2
= ENCODE_FILE (absname2
);
3349 if (stat (SSDATA (absname1
), &st1
) < 0)
3352 if (stat (SSDATA (absname2
), &st2
) < 0)
3355 return (EMACS_TIME_LT (get_stat_mtime (&st2
), get_stat_mtime (&st1
))
3359 #ifndef READ_BUF_SIZE
3360 #define READ_BUF_SIZE (64 << 10)
3362 /* Some buffer offsets are stored in 'int' variables. */
3363 verify (READ_BUF_SIZE
<= INT_MAX
);
3365 /* This function is called after Lisp functions to decide a coding
3366 system are called, or when they cause an error. Before they are
3367 called, the current buffer is set unibyte and it contains only a
3368 newly inserted text (thus the buffer was empty before the
3371 The functions may set markers, overlays, text properties, or even
3372 alter the buffer contents, change the current buffer.
3374 Here, we reset all those changes by:
3375 o set back the current buffer.
3376 o move all markers and overlays to BEG.
3377 o remove all text properties.
3378 o set back the buffer multibyteness. */
3381 decide_coding_unwind (Lisp_Object unwind_data
)
3383 Lisp_Object multibyte
, undo_list
, buffer
;
3385 multibyte
= XCAR (unwind_data
);
3386 unwind_data
= XCDR (unwind_data
);
3387 undo_list
= XCAR (unwind_data
);
3388 buffer
= XCDR (unwind_data
);
3390 set_buffer_internal (XBUFFER (buffer
));
3391 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3392 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3393 set_buffer_intervals (current_buffer
, NULL
);
3394 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3396 /* Now we are safe to change the buffer's multibyteness directly. */
3397 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3398 bset_undo_list (current_buffer
, undo_list
);
3403 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3404 object where slot 0 is the file descriptor, slot 1 specifies
3405 an offset to put the read bytes, and slot 2 is the maximum
3406 amount of bytes to read. Value is the number of bytes read. */
3409 read_non_regular (Lisp_Object state
)
3415 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3416 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3417 + XSAVE_INTEGER (state
, 1)),
3418 XSAVE_INTEGER (state
, 2));
3420 /* Fast recycle this object for the likely next call. */
3422 return make_number (nbytes
);
3426 /* Condition-case handler used when reading from non-regular files
3427 in insert-file-contents. */
3430 read_non_regular_quit (Lisp_Object ignore
)
3435 /* Return the file offset that VAL represents, checking for type
3436 errors and overflow. */
3438 file_offset (Lisp_Object val
)
3440 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3445 double v
= XFLOAT_DATA (val
);
3447 && (sizeof (off_t
) < sizeof v
3448 ? v
<= TYPE_MAXIMUM (off_t
)
3449 : v
< TYPE_MAXIMUM (off_t
)))
3453 wrong_type_argument (intern ("file-offset"), val
);
3456 /* Return a special time value indicating the error number ERRNUM. */
3458 time_error_value (int errnum
)
3460 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3461 ? NONEXISTENT_MODTIME_NSECS
3462 : UNKNOWN_MODTIME_NSECS
);
3463 return make_emacs_time (0, ns
);
3466 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3468 doc
: /* Insert contents of file FILENAME after point.
3469 Returns list of absolute file name and number of characters inserted.
3470 If second argument VISIT is non-nil, the buffer's visited filename and
3471 last save file modtime are set, and it is marked unmodified. If
3472 visiting and the file does not exist, visiting is completed before the
3475 The optional third and fourth arguments BEG and END specify what portion
3476 of the file to insert. These arguments count bytes in the file, not
3477 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3479 If optional fifth argument REPLACE is non-nil, replace the current
3480 buffer contents (in the accessible portion) with the file contents.
3481 This is better than simply deleting and inserting the whole thing
3482 because (1) it preserves some marker positions and (2) it puts less data
3483 in the undo list. When REPLACE is non-nil, the second return value is
3484 the number of characters that replace previous buffer contents.
3486 This function does code conversion according to the value of
3487 `coding-system-for-read' or `file-coding-system-alist', and sets the
3488 variable `last-coding-system-used' to the coding system actually used.
3490 In addition, this function decodes the inserted text from known formats
3491 by calling `format-decode', which see. */)
3492 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3497 ptrdiff_t inserted
= 0;
3499 off_t beg_offset
, end_offset
;
3501 ptrdiff_t count
= SPECPDL_INDEX ();
3502 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3503 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3505 ptrdiff_t total
= 0;
3506 bool not_regular
= 0;
3508 char read_buf
[READ_BUF_SIZE
];
3509 struct coding_system coding
;
3510 bool replace_handled
= 0;
3511 bool set_coding_system
= 0;
3512 Lisp_Object coding_system
;
3514 /* If the undo log only contains the insertion, there's no point
3515 keeping it. It's typically when we first fill a file-buffer. */
3516 bool empty_undo_list_p
3517 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3519 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3520 bool we_locked_file
= 0;
3521 bool deferred_remove_unwind_protect
= 0;
3523 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3524 error ("Cannot do file visiting in an indirect buffer");
3526 if (!NILP (BVAR (current_buffer
, read_only
)))
3527 Fbarf_if_buffer_read_only ();
3531 orig_filename
= Qnil
;
3534 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3536 CHECK_STRING (filename
);
3537 filename
= Fexpand_file_name (filename
, Qnil
);
3539 /* The value Qnil means that the coding system is not yet
3541 coding_system
= Qnil
;
3543 /* If the file name has special constructs in it,
3544 call the corresponding file handler. */
3545 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3546 if (!NILP (handler
))
3548 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3549 visit
, beg
, end
, replace
);
3550 if (CONSP (val
) && CONSP (XCDR (val
))
3551 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3552 inserted
= XINT (XCAR (XCDR (val
)));
3556 orig_filename
= filename
;
3557 filename
= ENCODE_FILE (filename
);
3559 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3564 report_file_error ("Opening input file", orig_filename
);
3565 mtime
= time_error_value (save_errno
);
3567 if (!NILP (Vcoding_system_for_read
))
3568 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3572 /* Replacement should preserve point as it preserves markers. */
3573 if (!NILP (replace
))
3574 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3576 record_unwind_protect (close_file_unwind
, make_number (fd
));
3578 if (fstat (fd
, &st
) != 0)
3579 report_file_error ("Input file status", orig_filename
);
3580 mtime
= get_stat_mtime (&st
);
3582 /* This code will need to be changed in order to work on named
3583 pipes, and it's probably just not worth it. So we should at
3584 least signal an error. */
3585 if (!S_ISREG (st
.st_mode
))
3592 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3593 xsignal2 (Qfile_error
,
3594 build_string ("not a regular file"), orig_filename
);
3599 if (!NILP (beg
) || !NILP (end
))
3600 error ("Attempt to visit less than an entire file");
3601 if (BEG
< Z
&& NILP (replace
))
3602 error ("Cannot do file visiting in a non-empty buffer");
3606 beg_offset
= file_offset (beg
);
3611 end_offset
= file_offset (end
);
3615 end_offset
= TYPE_MAXIMUM (off_t
);
3618 end_offset
= st
.st_size
;
3620 /* A negative size can happen on a platform that allows file
3621 sizes greater than the maximum off_t value. */
3625 /* The file size returned from stat may be zero, but data
3626 may be readable nonetheless, for example when this is a
3627 file in the /proc filesystem. */
3628 if (end_offset
== 0)
3629 end_offset
= READ_BUF_SIZE
;
3633 /* Check now whether the buffer will become too large,
3634 in the likely case where the file's length is not changing.
3635 This saves a lot of needless work before a buffer overflow. */
3638 /* The likely offset where we will stop reading. We could read
3639 more (or less), if the file grows (or shrinks) as we read it. */
3640 off_t likely_end
= min (end_offset
, st
.st_size
);
3642 if (beg_offset
< likely_end
)
3645 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3646 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3647 off_t likely_growth
= likely_end
- beg_offset
;
3648 if (buf_growth_max
< likely_growth
)
3653 /* Prevent redisplay optimizations. */
3654 current_buffer
->clip_changed
= 1;
3656 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3658 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3659 setup_coding_system (coding_system
, &coding
);
3660 /* Ensure we set Vlast_coding_system_used. */
3661 set_coding_system
= 1;
3665 /* Decide the coding system to use for reading the file now
3666 because we can't use an optimized method for handling
3667 `coding:' tag if the current buffer is not empty. */
3668 if (!NILP (Vcoding_system_for_read
))
3669 coding_system
= Vcoding_system_for_read
;
3672 /* Don't try looking inside a file for a coding system
3673 specification if it is not seekable. */
3674 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3676 /* Find a coding system specified in the heading two
3677 lines or in the tailing several lines of the file.
3678 We assume that the 1K-byte and 3K-byte for heading
3679 and tailing respectively are sufficient for this
3683 if (st
.st_size
<= (1024 * 4))
3684 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3687 nread
= emacs_read (fd
, read_buf
, 1024);
3691 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3692 report_file_error ("Setting file position",
3694 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3695 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3700 report_file_error ("Read error", orig_filename
);
3703 struct buffer
*prev
= current_buffer
;
3704 Lisp_Object workbuf
;
3707 record_unwind_current_buffer ();
3709 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3710 buf
= XBUFFER (workbuf
);
3712 delete_all_overlays (buf
);
3713 bset_directory (buf
, BVAR (current_buffer
, directory
));
3714 bset_read_only (buf
, Qnil
);
3715 bset_filename (buf
, Qnil
);
3716 bset_undo_list (buf
, Qt
);
3717 eassert (buf
->overlays_before
== NULL
);
3718 eassert (buf
->overlays_after
== NULL
);
3720 set_buffer_internal (buf
);
3722 bset_enable_multibyte_characters (buf
, Qnil
);
3724 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3725 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3726 coding_system
= call2 (Vset_auto_coding_function
,
3727 filename
, make_number (nread
));
3728 set_buffer_internal (prev
);
3730 /* Discard the unwind protect for recovering the
3734 /* Rewind the file for the actual read done later. */
3735 if (lseek (fd
, 0, SEEK_SET
) < 0)
3736 report_file_error ("Setting file position", orig_filename
);
3740 if (NILP (coding_system
))
3742 /* If we have not yet decided a coding system, check
3743 file-coding-system-alist. */
3744 Lisp_Object args
[6];
3746 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3747 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3748 coding_system
= Ffind_operation_coding_system (6, args
);
3749 if (CONSP (coding_system
))
3750 coding_system
= XCAR (coding_system
);
3754 if (NILP (coding_system
))
3755 coding_system
= Qundecided
;
3757 CHECK_CODING_SYSTEM (coding_system
);
3759 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3760 /* We must suppress all character code conversion except for
3761 end-of-line conversion. */
3762 coding_system
= raw_text_coding_system (coding_system
);
3764 setup_coding_system (coding_system
, &coding
);
3765 /* Ensure we set Vlast_coding_system_used. */
3766 set_coding_system
= 1;
3769 /* If requested, replace the accessible part of the buffer
3770 with the file contents. Avoid replacing text at the
3771 beginning or end of the buffer that matches the file contents;
3772 that preserves markers pointing to the unchanged parts.
3774 Here we implement this feature in an optimized way
3775 for the case where code conversion is NOT needed.
3776 The following if-statement handles the case of conversion
3777 in a less optimal way.
3779 If the code conversion is "automatic" then we try using this
3780 method and hope for the best.
3781 But if we discover the need for conversion, we give up on this method
3782 and let the following if-statement handle the replace job. */
3785 && (NILP (coding_system
)
3786 || ! CODING_REQUIRE_DECODING (&coding
)))
3788 /* same_at_start and same_at_end count bytes,
3789 because file access counts bytes
3790 and BEG and END count bytes. */
3791 ptrdiff_t same_at_start
= BEGV_BYTE
;
3792 ptrdiff_t same_at_end
= ZV_BYTE
;
3794 /* There is still a possibility we will find the need to do code
3795 conversion. If that happens, set this variable to
3796 give up on handling REPLACE in the optimized way. */
3797 bool giveup_match_end
= 0;
3799 if (beg_offset
!= 0)
3801 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3802 report_file_error ("Setting file position", orig_filename
);
3807 /* Count how many chars at the start of the file
3808 match the text at the beginning of the buffer. */
3813 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3815 report_file_error ("Read error", orig_filename
);
3816 else if (nread
== 0)
3819 if (CODING_REQUIRE_DETECTION (&coding
))
3821 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3824 setup_coding_system (coding_system
, &coding
);
3827 if (CODING_REQUIRE_DECODING (&coding
))
3828 /* We found that the file should be decoded somehow.
3829 Let's give up here. */
3831 giveup_match_end
= 1;
3836 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3837 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3838 same_at_start
++, bufpos
++;
3839 /* If we found a discrepancy, stop the scan.
3840 Otherwise loop around and scan the next bufferful. */
3841 if (bufpos
!= nread
)
3845 /* If the file matches the buffer completely,
3846 there's no need to replace anything. */
3847 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3851 /* Truncate the buffer to the size of the file. */
3852 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3857 /* Count how many chars at the end of the file
3858 match the text at the end of the buffer. But, if we have
3859 already found that decoding is necessary, don't waste time. */
3860 while (!giveup_match_end
)
3862 int total_read
, nread
, bufpos
, trial
;
3865 /* At what file position are we now scanning? */
3866 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3867 /* If the entire file matches the buffer tail, stop the scan. */
3870 /* How much can we scan in the next step? */
3871 trial
= min (curpos
, sizeof read_buf
);
3872 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3873 report_file_error ("Setting file position", orig_filename
);
3875 total_read
= nread
= 0;
3876 while (total_read
< trial
)
3878 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3880 report_file_error ("Read error", orig_filename
);
3881 else if (nread
== 0)
3883 total_read
+= nread
;
3886 /* Scan this bufferful from the end, comparing with
3887 the Emacs buffer. */
3888 bufpos
= total_read
;
3890 /* Compare with same_at_start to avoid counting some buffer text
3891 as matching both at the file's beginning and at the end. */
3892 while (bufpos
> 0 && same_at_end
> same_at_start
3893 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3894 same_at_end
--, bufpos
--;
3896 /* If we found a discrepancy, stop the scan.
3897 Otherwise loop around and scan the preceding bufferful. */
3900 /* If this discrepancy is because of code conversion,
3901 we cannot use this method; giveup and try the other. */
3902 if (same_at_end
> same_at_start
3903 && FETCH_BYTE (same_at_end
- 1) >= 0200
3904 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3905 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3906 giveup_match_end
= 1;
3915 if (! giveup_match_end
)
3919 /* We win! We can handle REPLACE the optimized way. */
3921 /* Extend the start of non-matching text area to multibyte
3922 character boundary. */
3923 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3924 while (same_at_start
> BEGV_BYTE
3925 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3928 /* Extend the end of non-matching text area to multibyte
3929 character boundary. */
3930 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3931 while (same_at_end
< ZV_BYTE
3932 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3935 /* Don't try to reuse the same piece of text twice. */
3936 overlap
= (same_at_start
- BEGV_BYTE
3938 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3940 same_at_end
+= overlap
;
3942 /* Arrange to read only the nonmatching middle part of the file. */
3943 beg_offset
+= same_at_start
- BEGV_BYTE
;
3944 end_offset
-= ZV_BYTE
- same_at_end
;
3946 del_range_byte (same_at_start
, same_at_end
, 0);
3947 /* Insert from the file at the proper position. */
3948 temp
= BYTE_TO_CHAR (same_at_start
);
3949 SET_PT_BOTH (temp
, same_at_start
);
3951 /* If display currently starts at beginning of line,
3952 keep it that way. */
3953 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3954 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3956 replace_handled
= 1;
3960 /* If requested, replace the accessible part of the buffer
3961 with the file contents. Avoid replacing text at the
3962 beginning or end of the buffer that matches the file contents;
3963 that preserves markers pointing to the unchanged parts.
3965 Here we implement this feature for the case where code conversion
3966 is needed, in a simple way that needs a lot of memory.
3967 The preceding if-statement handles the case of no conversion
3968 in a more optimized way. */
3969 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3971 ptrdiff_t same_at_start
= BEGV_BYTE
;
3972 ptrdiff_t same_at_end
= ZV_BYTE
;
3973 ptrdiff_t same_at_start_charpos
;
3974 ptrdiff_t inserted_chars
;
3977 unsigned char *decoded
;
3980 ptrdiff_t this_count
= SPECPDL_INDEX ();
3982 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3983 Lisp_Object conversion_buffer
;
3984 struct gcpro gcpro1
;
3986 conversion_buffer
= code_conversion_save (1, multibyte
);
3988 /* First read the whole file, performing code conversion into
3989 CONVERSION_BUFFER. */
3991 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3992 report_file_error ("Setting file position", orig_filename
);
3994 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3995 unprocessed
= 0; /* Bytes not processed in previous loop. */
3997 GCPRO1 (conversion_buffer
);
4000 /* Read at most READ_BUF_SIZE bytes at a time, to allow
4001 quitting while reading a huge file. */
4003 /* Allow quitting out of the actual I/O. */
4006 this = emacs_read (fd
, read_buf
+ unprocessed
,
4007 READ_BUF_SIZE
- unprocessed
);
4013 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
4014 BUF_Z (XBUFFER (conversion_buffer
)));
4015 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4016 unprocessed
+ this, conversion_buffer
);
4017 unprocessed
= coding
.carryover_bytes
;
4018 if (coding
.carryover_bytes
> 0)
4019 memcpy (read_buf
, coding
.carryover
, unprocessed
);
4024 /* We should remove the unwind_protect calling
4025 close_file_unwind, but other stuff has been added the stack,
4026 so defer the removal till we reach the `handled' label. */
4027 deferred_remove_unwind_protect
= 1;
4030 report_file_error ("Read error", orig_filename
);
4032 if (unprocessed
> 0)
4034 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4035 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4036 unprocessed
, conversion_buffer
);
4037 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4040 coding_system
= CODING_ID_NAME (coding
.id
);
4041 set_coding_system
= 1;
4042 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4043 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4044 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4046 /* Compare the beginning of the converted string with the buffer
4050 while (bufpos
< inserted
&& same_at_start
< same_at_end
4051 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4052 same_at_start
++, bufpos
++;
4054 /* If the file matches the head of buffer completely,
4055 there's no need to replace anything. */
4057 if (bufpos
== inserted
)
4059 /* Truncate the buffer to the size of the file. */
4060 if (same_at_start
!= same_at_end
)
4061 del_range_byte (same_at_start
, same_at_end
, 0);
4064 unbind_to (this_count
, Qnil
);
4068 /* Extend the start of non-matching text area to the previous
4069 multibyte character boundary. */
4070 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4071 while (same_at_start
> BEGV_BYTE
4072 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4075 /* Scan this bufferful from the end, comparing with
4076 the Emacs buffer. */
4079 /* Compare with same_at_start to avoid counting some buffer text
4080 as matching both at the file's beginning and at the end. */
4081 while (bufpos
> 0 && same_at_end
> same_at_start
4082 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4083 same_at_end
--, bufpos
--;
4085 /* Extend the end of non-matching text area to the next
4086 multibyte character boundary. */
4087 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4088 while (same_at_end
< ZV_BYTE
4089 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4092 /* Don't try to reuse the same piece of text twice. */
4093 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4095 same_at_end
+= overlap
;
4097 /* If display currently starts at beginning of line,
4098 keep it that way. */
4099 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4100 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4102 /* Replace the chars that we need to replace,
4103 and update INSERTED to equal the number of bytes
4104 we are taking from the decoded string. */
4105 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4107 if (same_at_end
!= same_at_start
)
4109 del_range_byte (same_at_start
, same_at_end
, 0);
4111 eassert (same_at_start
== GPT_BYTE
);
4112 same_at_start
= GPT_BYTE
;
4116 temp
= BYTE_TO_CHAR (same_at_start
);
4118 /* Insert from the file at the proper position. */
4119 SET_PT_BOTH (temp
, same_at_start
);
4120 same_at_start_charpos
4121 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4122 same_at_start
- BEGV_BYTE
4123 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4124 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4126 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4127 same_at_start
+ inserted
- BEGV_BYTE
4128 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4129 - same_at_start_charpos
);
4130 /* This binding is to avoid ask-user-about-supersession-threat
4131 being called in insert_from_buffer (via in
4132 prepare_to_modify_buffer). */
4133 specbind (intern ("buffer-file-name"), Qnil
);
4134 insert_from_buffer (XBUFFER (conversion_buffer
),
4135 same_at_start_charpos
, inserted_chars
, 0);
4136 /* Set `inserted' to the number of inserted characters. */
4137 inserted
= PT
- temp
;
4138 /* Set point before the inserted characters. */
4139 SET_PT_BOTH (temp
, same_at_start
);
4141 unbind_to (this_count
, Qnil
);
4147 total
= end_offset
- beg_offset
;
4149 /* For a special file, all we can do is guess. */
4150 total
= READ_BUF_SIZE
;
4152 if (NILP (visit
) && total
> 0)
4154 #ifdef CLASH_DETECTION
4155 if (!NILP (BVAR (current_buffer
, file_truename
))
4156 /* Make binding buffer-file-name to nil effective. */
4157 && !NILP (BVAR (current_buffer
, filename
))
4158 && SAVE_MODIFF
>= MODIFF
)
4160 #endif /* CLASH_DETECTION */
4161 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4164 move_gap_both (PT
, PT_BYTE
);
4165 if (GAP_SIZE
< total
)
4166 make_gap (total
- GAP_SIZE
);
4168 if (beg_offset
!= 0 || !NILP (replace
))
4170 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4171 report_file_error ("Setting file position", orig_filename
);
4174 /* In the following loop, HOW_MUCH contains the total bytes read so
4175 far for a regular file, and not changed for a special file. But,
4176 before exiting the loop, it is set to a negative value if I/O
4180 /* Total bytes inserted. */
4183 /* Here, we don't do code conversion in the loop. It is done by
4184 decode_coding_gap after all data are read into the buffer. */
4186 ptrdiff_t gap_size
= GAP_SIZE
;
4188 while (how_much
< total
)
4190 /* try is reserved in some compilers (Microsoft C) */
4191 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4198 /* Maybe make more room. */
4199 if (gap_size
< trytry
)
4201 make_gap (trytry
- gap_size
);
4202 gap_size
= GAP_SIZE
- inserted
;
4205 /* Read from the file, capturing `quit'. When an
4206 error occurs, end the loop, and arrange for a quit
4207 to be signaled after decoding the text we read. */
4208 nbytes
= internal_condition_case_1
4210 make_save_value (SAVE_TYPE_INT_INT_INT
, (ptrdiff_t) fd
,
4212 Qerror
, read_non_regular_quit
);
4220 this = XINT (nbytes
);
4224 /* Allow quitting out of the actual I/O. We don't make text
4225 part of the buffer until all the reading is done, so a C-g
4226 here doesn't do any harm. */
4229 this = emacs_read (fd
,
4230 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4244 /* For a regular file, where TOTAL is the real size,
4245 count HOW_MUCH to compare with it.
4246 For a special file, where TOTAL is just a buffer size,
4247 so don't bother counting in HOW_MUCH.
4248 (INSERTED is where we count the number of characters inserted.) */
4255 /* Now we have either read all the file data into the gap,
4256 or stop reading on I/O error or quit. If nothing was
4257 read, undo marking the buffer modified. */
4261 #ifdef CLASH_DETECTION
4263 unlock_file (BVAR (current_buffer
, file_truename
));
4265 Vdeactivate_mark
= old_Vdeactivate_mark
;
4268 Vdeactivate_mark
= Qt
;
4272 /* Discard the unwind protect for closing the file. */
4276 report_file_error ("Read error", orig_filename
);
4278 /* Make the text read part of the buffer. */
4279 GAP_SIZE
-= inserted
;
4281 GPT_BYTE
+= inserted
;
4283 ZV_BYTE
+= inserted
;
4288 /* Put an anchor to ensure multi-byte form ends at gap. */
4293 if (NILP (coding_system
))
4295 /* The coding system is not yet decided. Decide it by an
4296 optimized method for handling `coding:' tag.
4298 Note that we can get here only if the buffer was empty
4299 before the insertion. */
4301 if (!NILP (Vcoding_system_for_read
))
4302 coding_system
= Vcoding_system_for_read
;
4305 /* Since we are sure that the current buffer was empty
4306 before the insertion, we can toggle
4307 enable-multibyte-characters directly here without taking
4308 care of marker adjustment. By this way, we can run Lisp
4309 program safely before decoding the inserted text. */
4310 Lisp_Object unwind_data
;
4311 ptrdiff_t count1
= SPECPDL_INDEX ();
4313 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4314 Fcons (BVAR (current_buffer
, undo_list
),
4315 Fcurrent_buffer ()));
4316 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4317 bset_undo_list (current_buffer
, Qt
);
4318 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4320 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4322 coding_system
= call2 (Vset_auto_coding_function
,
4323 filename
, make_number (inserted
));
4326 if (NILP (coding_system
))
4328 /* If the coding system is not yet decided, check
4329 file-coding-system-alist. */
4330 Lisp_Object args
[6];
4332 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4333 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4334 coding_system
= Ffind_operation_coding_system (6, args
);
4335 if (CONSP (coding_system
))
4336 coding_system
= XCAR (coding_system
);
4338 unbind_to (count1
, Qnil
);
4339 inserted
= Z_BYTE
- BEG_BYTE
;
4342 if (NILP (coding_system
))
4343 coding_system
= Qundecided
;
4345 CHECK_CODING_SYSTEM (coding_system
);
4347 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4348 /* We must suppress all character code conversion except for
4349 end-of-line conversion. */
4350 coding_system
= raw_text_coding_system (coding_system
);
4351 setup_coding_system (coding_system
, &coding
);
4352 /* Ensure we set Vlast_coding_system_used. */
4353 set_coding_system
= 1;
4358 /* When we visit a file by raw-text, we change the buffer to
4360 if (CODING_FOR_UNIBYTE (&coding
)
4361 /* Can't do this if part of the buffer might be preserved. */
4363 /* Visiting a file with these coding system makes the buffer
4365 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4368 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4369 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4370 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4372 move_gap_both (PT
, PT_BYTE
);
4373 GAP_SIZE
+= inserted
;
4374 ZV_BYTE
-= inserted
;
4378 decode_coding_gap (&coding
, inserted
, inserted
);
4379 inserted
= coding
.produced_char
;
4380 coding_system
= CODING_ID_NAME (coding
.id
);
4382 else if (inserted
> 0)
4383 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4386 /* Call after-change hooks for the inserted text, aside from the case
4387 of normal visiting (not with REPLACE), which is done in a new buffer
4388 "before" the buffer is changed. */
4389 if (inserted
> 0 && total
> 0
4390 && (NILP (visit
) || !NILP (replace
)))
4392 signal_after_change (PT
, 0, inserted
);
4393 update_compositions (PT
, PT
, CHECK_BORDER
);
4396 /* Now INSERTED is measured in characters. */
4400 if (deferred_remove_unwind_protect
)
4401 /* If requested above, discard the unwind protect for closing the
4407 if (empty_undo_list_p
)
4408 bset_undo_list (current_buffer
, Qnil
);
4412 current_buffer
->modtime
= mtime
;
4413 current_buffer
->modtime_size
= st
.st_size
;
4414 bset_filename (current_buffer
, orig_filename
);
4417 SAVE_MODIFF
= MODIFF
;
4418 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4419 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4420 #ifdef CLASH_DETECTION
4423 if (!NILP (BVAR (current_buffer
, file_truename
)))
4424 unlock_file (BVAR (current_buffer
, file_truename
));
4425 unlock_file (filename
);
4427 #endif /* CLASH_DETECTION */
4429 xsignal2 (Qfile_error
,
4430 build_string ("not a regular file"), orig_filename
);
4433 if (set_coding_system
)
4434 Vlast_coding_system_used
= coding_system
;
4436 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4438 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4440 if (! NILP (insval
))
4442 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4443 wrong_type_argument (intern ("inserted-chars"), insval
);
4444 inserted
= XFASTINT (insval
);
4448 /* Decode file format. */
4451 /* Don't run point motion or modification hooks when decoding. */
4452 ptrdiff_t count1
= SPECPDL_INDEX ();
4453 ptrdiff_t old_inserted
= inserted
;
4454 specbind (Qinhibit_point_motion_hooks
, Qt
);
4455 specbind (Qinhibit_modification_hooks
, Qt
);
4457 /* Save old undo list and don't record undo for decoding. */
4458 old_undo
= BVAR (current_buffer
, undo_list
);
4459 bset_undo_list (current_buffer
, Qt
);
4463 insval
= call3 (Qformat_decode
,
4464 Qnil
, make_number (inserted
), visit
);
4465 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4466 wrong_type_argument (intern ("inserted-chars"), insval
);
4467 inserted
= XFASTINT (insval
);
4471 /* If REPLACE is non-nil and we succeeded in not replacing the
4472 beginning or end of the buffer text with the file's contents,
4473 call format-decode with `point' positioned at the beginning
4474 of the buffer and `inserted' equaling the number of
4475 characters in the buffer. Otherwise, format-decode might
4476 fail to correctly analyze the beginning or end of the buffer.
4477 Hence we temporarily save `point' and `inserted' here and
4478 restore `point' iff format-decode did not insert or delete
4479 any text. Otherwise we leave `point' at point-min. */
4480 ptrdiff_t opoint
= PT
;
4481 ptrdiff_t opoint_byte
= PT_BYTE
;
4482 ptrdiff_t oinserted
= ZV
- BEGV
;
4483 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4485 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4486 insval
= call3 (Qformat_decode
,
4487 Qnil
, make_number (oinserted
), visit
);
4488 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4489 wrong_type_argument (intern ("inserted-chars"), insval
);
4490 if (ochars_modiff
== CHARS_MODIFF
)
4491 /* format_decode didn't modify buffer's characters => move
4492 point back to position before inserted text and leave
4493 value of inserted alone. */
4494 SET_PT_BOTH (opoint
, opoint_byte
);
4496 /* format_decode modified buffer's characters => consider
4497 entire buffer changed and leave point at point-min. */
4498 inserted
= XFASTINT (insval
);
4501 /* For consistency with format-decode call these now iff inserted > 0
4502 (martin 2007-06-28). */
4503 p
= Vafter_insert_file_functions
;
4508 insval
= call1 (XCAR (p
), make_number (inserted
));
4511 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4512 wrong_type_argument (intern ("inserted-chars"), insval
);
4513 inserted
= XFASTINT (insval
);
4518 /* For the rationale of this see the comment on
4519 format-decode above. */
4520 ptrdiff_t opoint
= PT
;
4521 ptrdiff_t opoint_byte
= PT_BYTE
;
4522 ptrdiff_t oinserted
= ZV
- BEGV
;
4523 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4525 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4526 insval
= call1 (XCAR (p
), make_number (oinserted
));
4529 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4530 wrong_type_argument (intern ("inserted-chars"), insval
);
4531 if (ochars_modiff
== CHARS_MODIFF
)
4532 /* after_insert_file_functions didn't modify
4533 buffer's characters => move point back to
4534 position before inserted text and leave value of
4536 SET_PT_BOTH (opoint
, opoint_byte
);
4538 /* after_insert_file_functions did modify buffer's
4539 characters => consider entire buffer changed and
4540 leave point at point-min. */
4541 inserted
= XFASTINT (insval
);
4549 if (!empty_undo_list_p
)
4551 bset_undo_list (current_buffer
, old_undo
);
4552 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4554 /* Adjust the last undo record for the size change during
4555 the format conversion. */
4556 Lisp_Object tem
= XCAR (old_undo
);
4557 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4558 && INTEGERP (XCDR (tem
))
4559 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4560 XSETCDR (tem
, make_number (PT
+ inserted
));
4564 /* If undo_list was Qt before, keep it that way.
4565 Otherwise start with an empty undo_list. */
4566 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4568 unbind_to (count1
, Qnil
);
4572 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4574 /* If visiting nonexistent file, return nil. */
4575 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4579 Fsignal (Qquit
, Qnil
);
4581 /* Retval needs to be dealt with in all cases consistently. */
4583 val
= list2 (orig_filename
, make_number (inserted
));
4585 RETURN_UNGCPRO (unbind_to (count
, val
));
4588 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4591 build_annotations_unwind (Lisp_Object arg
)
4593 Vwrite_region_annotation_buffers
= arg
;
4597 /* Decide the coding-system to encode the data with. */
4599 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4600 Schoose_write_coding_system
, 3, 6, 0,
4601 doc
: /* Choose the coding system for writing a file.
4602 Arguments are as for `write-region'.
4603 This function is for internal use only. It may prompt the user. */ )
4604 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4605 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4608 Lisp_Object eol_parent
= Qnil
;
4610 /* Mimic write-region behavior. */
4613 XSETFASTINT (start
, BEGV
);
4614 XSETFASTINT (end
, ZV
);
4618 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4619 BVAR (current_buffer
, auto_save_file_name
))))
4624 else if (!NILP (Vcoding_system_for_write
))
4626 val
= Vcoding_system_for_write
;
4627 if (coding_system_require_warning
4628 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4629 /* Confirm that VAL can surely encode the current region. */
4630 val
= call5 (Vselect_safe_coding_system_function
,
4631 start
, end
, list2 (Qt
, val
),
4636 /* If the variable `buffer-file-coding-system' is set locally,
4637 it means that the file was read with some kind of code
4638 conversion or the variable is explicitly set by users. We
4639 had better write it out with the same coding system even if
4640 `enable-multibyte-characters' is nil.
4642 If it is not set locally, we anyway have to convert EOL
4643 format if the default value of `buffer-file-coding-system'
4644 tells that it is not Unix-like (LF only) format. */
4645 bool using_default_coding
= 0;
4646 bool force_raw_text
= 0;
4648 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4650 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4653 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4659 /* Check file-coding-system-alist. */
4660 Lisp_Object args
[7], coding_systems
;
4662 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4663 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4665 coding_systems
= Ffind_operation_coding_system (7, args
);
4666 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4667 val
= XCDR (coding_systems
);
4672 /* If we still have not decided a coding system, use the
4673 default value of buffer-file-coding-system. */
4674 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4675 using_default_coding
= 1;
4678 if (! NILP (val
) && ! force_raw_text
)
4680 Lisp_Object spec
, attrs
;
4682 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4683 attrs
= AREF (spec
, 0);
4684 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4689 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4690 /* Confirm that VAL can surely encode the current region. */
4691 val
= call5 (Vselect_safe_coding_system_function
,
4692 start
, end
, val
, Qnil
, filename
);
4694 /* If the decided coding-system doesn't specify end-of-line
4695 format, we use that of
4696 `default-buffer-file-coding-system'. */
4697 if (! using_default_coding
4698 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4699 val
= (coding_inherit_eol_type
4700 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4702 /* If we decide not to encode text, use `raw-text' or one of its
4705 val
= raw_text_coding_system (val
);
4708 val
= coding_inherit_eol_type (val
, eol_parent
);
4712 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4713 "r\nFWrite region to file: \ni\ni\ni\np",
4714 doc
: /* Write current region into specified file.
4715 When called from a program, requires three arguments:
4716 START, END and FILENAME. START and END are normally buffer positions
4717 specifying the part of the buffer to write.
4718 If START is nil, that means to use the entire buffer contents.
4719 If START is a string, then output that string to the file
4720 instead of any buffer contents; END is ignored.
4722 Optional fourth argument APPEND if non-nil means
4723 append to existing file contents (if any). If it is a number,
4724 seek to that offset in the file before writing.
4725 Optional fifth argument VISIT, if t or a string, means
4726 set the last-save-file-modtime of buffer to this file's modtime
4727 and mark buffer not modified.
4728 If VISIT is a string, it is a second file name;
4729 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4730 VISIT is also the file name to lock and unlock for clash detection.
4731 If VISIT is neither t nor nil nor a string,
4732 that means do not display the \"Wrote file\" message.
4733 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4734 use for locking and unlocking, overriding FILENAME and VISIT.
4735 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4736 for an existing file with the same name. If MUSTBENEW is `excl',
4737 that means to get an error if the file already exists; never overwrite.
4738 If MUSTBENEW is neither nil nor `excl', that means ask for
4739 confirmation before overwriting, but do go ahead and overwrite the file
4740 if the user confirms.
4742 This does code conversion according to the value of
4743 `coding-system-for-write', `buffer-file-coding-system', or
4744 `file-coding-system-alist', and sets the variable
4745 `last-coding-system-used' to the coding system actually used.
4747 This calls `write-region-annotate-functions' at the start, and
4748 `write-region-post-annotation-function' at the end. */)
4749 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4754 off_t offset
IF_LINT (= 0);
4760 ptrdiff_t count
= SPECPDL_INDEX ();
4762 Lisp_Object handler
;
4763 Lisp_Object visit_file
;
4764 Lisp_Object annotations
;
4765 Lisp_Object encoded_filename
;
4766 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4767 bool quietly
= !NILP (visit
);
4768 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4769 struct buffer
*given_buffer
;
4770 struct coding_system coding
;
4772 if (current_buffer
->base_buffer
&& visiting
)
4773 error ("Cannot do file visiting in an indirect buffer");
4775 if (!NILP (start
) && !STRINGP (start
))
4776 validate_region (&start
, &end
);
4779 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4781 filename
= Fexpand_file_name (filename
, Qnil
);
4783 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4784 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4786 if (STRINGP (visit
))
4787 visit_file
= Fexpand_file_name (visit
, Qnil
);
4789 visit_file
= filename
;
4791 if (NILP (lockname
))
4792 lockname
= visit_file
;
4796 /* If the file name has special constructs in it,
4797 call the corresponding file handler. */
4798 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4799 /* If FILENAME has no handler, see if VISIT has one. */
4800 if (NILP (handler
) && STRINGP (visit
))
4801 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4803 if (!NILP (handler
))
4806 val
= call6 (handler
, Qwrite_region
, start
, end
,
4807 filename
, append
, visit
);
4811 SAVE_MODIFF
= MODIFF
;
4812 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4813 bset_filename (current_buffer
, visit_file
);
4819 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4821 /* Special kludge to simplify auto-saving. */
4824 /* Do it later, so write-region-annotate-function can work differently
4825 if we save "the buffer" vs "a region".
4826 This is useful in tar-mode. --Stef
4827 XSETFASTINT (start, BEG);
4828 XSETFASTINT (end, Z); */
4832 record_unwind_protect (build_annotations_unwind
,
4833 Vwrite_region_annotation_buffers
);
4834 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4835 count1
= SPECPDL_INDEX ();
4837 given_buffer
= current_buffer
;
4839 if (!STRINGP (start
))
4841 annotations
= build_annotations (start
, end
);
4843 if (current_buffer
!= given_buffer
)
4845 XSETFASTINT (start
, BEGV
);
4846 XSETFASTINT (end
, ZV
);
4852 XSETFASTINT (start
, BEGV
);
4853 XSETFASTINT (end
, ZV
);
4858 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4860 /* Decide the coding-system to encode the data with.
4861 We used to make this choice before calling build_annotations, but that
4862 leads to problems when a write-annotate-function takes care of
4863 unsavable chars (as was the case with X-Symbol). */
4864 Vlast_coding_system_used
=
4865 Fchoose_write_coding_system (start
, end
, filename
,
4866 append
, visit
, lockname
);
4868 setup_coding_system (Vlast_coding_system_used
, &coding
);
4870 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4871 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4873 #ifdef CLASH_DETECTION
4875 lock_file (lockname
);
4876 #endif /* CLASH_DETECTION */
4878 encoded_filename
= ENCODE_FILE (filename
);
4879 fn
= SSDATA (encoded_filename
);
4880 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4881 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4882 if (NUMBERP (append
))
4883 offset
= file_offset (append
);
4884 else if (!NILP (append
))
4885 open_flags
|= O_APPEND
;
4887 mode
= S_IREAD
| S_IWRITE
;
4889 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4892 desc
= emacs_open (fn
, open_flags
, mode
);
4896 int open_errno
= errno
;
4897 #ifdef CLASH_DETECTION
4898 if (!auto_saving
) unlock_file (lockname
);
4899 #endif /* CLASH_DETECTION */
4901 report_file_errno ("Opening output file", filename
, open_errno
);
4904 record_unwind_protect (close_file_unwind
, make_number (desc
));
4906 if (NUMBERP (append
))
4908 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4911 int lseek_errno
= errno
;
4912 #ifdef CLASH_DETECTION
4913 if (!auto_saving
) unlock_file (lockname
);
4914 #endif /* CLASH_DETECTION */
4916 report_file_errno ("Lseek error", filename
, lseek_errno
);
4924 if (STRINGP (start
))
4925 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4926 else if (XINT (start
) != XINT (end
))
4927 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4928 &annotations
, &coding
);
4931 /* If file was empty, still need to write the annotations. */
4932 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4933 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4937 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4938 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4940 /* We have to flush out a data. */
4941 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4942 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4948 /* fsync is not crucial for auto-save files, since they might lose
4949 some work anyway. */
4950 if (!auto_saving
&& !write_region_inhibit_fsync
)
4952 /* Transfer data and metadata to disk, retrying if interrupted.
4953 fsync can report a write failure here, e.g., due to disk full
4954 under NFS. But ignore EINVAL, which means fsync is not
4955 supported on this file. */
4956 while (fsync (desc
) != 0)
4959 if (errno
!= EINVAL
)
4960 ok
= 0, save_errno
= errno
;
4965 modtime
= invalid_emacs_time ();
4968 if (fstat (desc
, &st
) == 0)
4969 modtime
= get_stat_mtime (&st
);
4971 ok
= 0, save_errno
= errno
;
4974 /* NFS can report a write failure now. */
4975 if (emacs_close (desc
) < 0)
4976 ok
= 0, save_errno
= errno
;
4978 /* Discard the unwind protect for close_file_unwind. */
4979 specpdl_ptr
= specpdl
+ count1
;
4981 /* Some file systems have a bug where st_mtime is not updated
4982 properly after a write. For example, CIFS might not see the
4983 st_mtime change until after the file is opened again.
4985 Attempt to detect this file system bug, and update MODTIME to the
4986 newer st_mtime if the bug appears to be present. This introduces
4987 a race condition, so to avoid most instances of the race condition
4988 on non-buggy file systems, skip this check if the most recently
4989 encountered non-buggy file system was the current file system.
4991 A race condition can occur if some other process modifies the
4992 file between the fstat above and the fstat below, but the race is
4993 unlikely and a similar race between the last write and the fstat
4994 above cannot possibly be closed anyway. */
4996 if (EMACS_TIME_VALID_P (modtime
)
4997 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4999 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
5003 if (fstat (desc1
, &st1
) == 0
5004 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
5006 /* Use the heuristic if it appears to be valid. With neither
5007 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
5008 file, the time stamp won't change. Also, some non-POSIX
5009 systems don't update an empty file's time stamp when
5010 truncating it. Finally, file systems with 100 ns or worse
5011 resolution sometimes seem to have bugs: on a system with ns
5012 resolution, checking ns % 100 incorrectly avoids the heuristic
5013 1% of the time, but the problem should be temporary as we will
5014 try again on the next time stamp. */
5016 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
5018 && EMACS_NSECS (modtime
) % 100 != 0);
5020 EMACS_TIME modtime1
= get_stat_mtime (&st1
);
5022 && EMACS_TIME_EQ (modtime
, modtime1
)
5023 && st
.st_size
== st1
.st_size
)
5025 timestamp_file_system
= st
.st_dev
;
5026 valid_timestamp_file_system
= 1;
5030 st
.st_size
= st1
.st_size
;
5034 emacs_close (desc1
);
5038 /* Call write-region-post-annotation-function. */
5039 while (CONSP (Vwrite_region_annotation_buffers
))
5041 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5042 if (!NILP (Fbuffer_live_p (buf
)))
5045 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5046 call0 (Vwrite_region_post_annotation_function
);
5048 Vwrite_region_annotation_buffers
5049 = XCDR (Vwrite_region_annotation_buffers
);
5052 unbind_to (count
, Qnil
);
5054 #ifdef CLASH_DETECTION
5056 unlock_file (lockname
);
5057 #endif /* CLASH_DETECTION */
5059 /* Do this before reporting IO error
5060 to avoid a "file has changed on disk" warning on
5061 next attempt to save. */
5062 if (EMACS_TIME_VALID_P (modtime
))
5064 current_buffer
->modtime
= modtime
;
5065 current_buffer
->modtime_size
= st
.st_size
;
5069 report_file_errno ("Write error", filename
, save_errno
);
5073 SAVE_MODIFF
= MODIFF
;
5074 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5075 bset_filename (current_buffer
, visit_file
);
5076 update_mode_lines
++;
5081 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5082 BVAR (current_buffer
, auto_save_file_name
))))
5083 SAVE_MODIFF
= MODIFF
;
5089 message_with_string ((NUMBERP (append
)
5099 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
5101 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5102 doc
: /* Return t if (car A) is numerically less than (car B). */)
5103 (Lisp_Object a
, Lisp_Object b
)
5105 return Flss (Fcar (a
), Fcar (b
));
5108 /* Build the complete list of annotations appropriate for writing out
5109 the text between START and END, by calling all the functions in
5110 write-region-annotate-functions and merging the lists they return.
5111 If one of these functions switches to a different buffer, we assume
5112 that buffer contains altered text. Therefore, the caller must
5113 make sure to restore the current buffer in all cases,
5114 as save-excursion would do. */
5117 build_annotations (Lisp_Object start
, Lisp_Object end
)
5119 Lisp_Object annotations
;
5121 struct gcpro gcpro1
, gcpro2
;
5122 Lisp_Object original_buffer
;
5124 bool used_global
= 0;
5126 XSETBUFFER (original_buffer
, current_buffer
);
5129 p
= Vwrite_region_annotate_functions
;
5130 GCPRO2 (annotations
, p
);
5133 struct buffer
*given_buffer
= current_buffer
;
5134 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5135 { /* Use the global value of the hook. */
5138 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5140 p
= Fappend (2, arg
);
5143 Vwrite_region_annotations_so_far
= annotations
;
5144 res
= call2 (XCAR (p
), start
, end
);
5145 /* If the function makes a different buffer current,
5146 assume that means this buffer contains altered text to be output.
5147 Reset START and END from the buffer bounds
5148 and discard all previous annotations because they should have
5149 been dealt with by this function. */
5150 if (current_buffer
!= given_buffer
)
5152 Vwrite_region_annotation_buffers
5153 = Fcons (Fcurrent_buffer (),
5154 Vwrite_region_annotation_buffers
);
5155 XSETFASTINT (start
, BEGV
);
5156 XSETFASTINT (end
, ZV
);
5159 Flength (res
); /* Check basic validity of return value */
5160 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5164 /* Now do the same for annotation functions implied by the file-format */
5165 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5166 p
= BVAR (current_buffer
, auto_save_file_format
);
5168 p
= BVAR (current_buffer
, file_format
);
5169 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5171 struct buffer
*given_buffer
= current_buffer
;
5173 Vwrite_region_annotations_so_far
= annotations
;
5175 /* Value is either a list of annotations or nil if the function
5176 has written annotations to a temporary buffer, which is now
5178 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5179 original_buffer
, make_number (i
));
5180 if (current_buffer
!= given_buffer
)
5182 XSETFASTINT (start
, BEGV
);
5183 XSETFASTINT (end
, ZV
);
5188 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5196 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5197 If STRING is nil, POS is the character position in the current buffer.
5198 Intersperse with them the annotations from *ANNOT
5199 which fall within the range of POS to POS + NCHARS,
5200 each at its appropriate position.
5202 We modify *ANNOT by discarding elements as we use them up.
5204 Return true if successful. */
5207 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5208 ptrdiff_t nchars
, Lisp_Object
*annot
,
5209 struct coding_system
*coding
)
5213 ptrdiff_t lastpos
= pos
+ nchars
;
5215 while (NILP (*annot
) || CONSP (*annot
))
5217 tem
= Fcar_safe (Fcar (*annot
));
5220 nextpos
= XFASTINT (tem
);
5222 /* If there are no more annotations in this range,
5223 output the rest of the range all at once. */
5224 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5225 return e_write (desc
, string
, pos
, lastpos
, coding
);
5227 /* Output buffer text up to the next annotation's position. */
5230 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5234 /* Output the annotation. */
5235 tem
= Fcdr (Fcar (*annot
));
5238 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5241 *annot
= Fcdr (*annot
);
5247 /* Write text in the range START and END into descriptor DESC,
5248 encoding them with coding system CODING. If STRING is nil, START
5249 and END are character positions of the current buffer, else they
5250 are indexes to the string STRING. Return true if successful. */
5253 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5254 struct coding_system
*coding
)
5256 if (STRINGP (string
))
5259 end
= SCHARS (string
);
5262 /* We used to have a code for handling selective display here. But,
5263 now it is handled within encode_coding. */
5267 if (STRINGP (string
))
5269 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5270 if (CODING_REQUIRE_ENCODING (coding
))
5272 encode_coding_object (coding
, string
,
5273 start
, string_char_to_byte (string
, start
),
5274 end
, string_char_to_byte (string
, end
), Qt
);
5278 coding
->dst_object
= string
;
5279 coding
->consumed_char
= SCHARS (string
);
5280 coding
->produced
= SBYTES (string
);
5285 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5286 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5288 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5289 if (CODING_REQUIRE_ENCODING (coding
))
5291 encode_coding_object (coding
, Fcurrent_buffer (),
5292 start
, start_byte
, end
, end_byte
, Qt
);
5296 coding
->dst_object
= Qnil
;
5297 coding
->dst_pos_byte
= start_byte
;
5298 if (start
>= GPT
|| end
<= GPT
)
5300 coding
->consumed_char
= end
- start
;
5301 coding
->produced
= end_byte
- start_byte
;
5305 coding
->consumed_char
= GPT
- start
;
5306 coding
->produced
= GPT_BYTE
- start_byte
;
5311 if (coding
->produced
> 0)
5313 char *buf
= (STRINGP (coding
->dst_object
)
5314 ? SSDATA (coding
->dst_object
)
5315 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
));
5316 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5318 if (coding
->produced
)
5321 start
+= coding
->consumed_char
;
5327 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5328 Sverify_visited_file_modtime
, 0, 1, 0,
5329 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5330 This means that the file has not been changed since it was visited or saved.
5331 If BUF is omitted or nil, it defaults to the current buffer.
5332 See Info node `(elisp)Modification Time' for more details. */)
5337 Lisp_Object handler
;
5338 Lisp_Object filename
;
5349 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5350 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5352 /* If the file name has special constructs in it,
5353 call the corresponding file handler. */
5354 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5355 Qverify_visited_file_modtime
);
5356 if (!NILP (handler
))
5357 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5359 filename
= ENCODE_FILE (BVAR (b
, filename
));
5361 mtime
= (stat (SSDATA (filename
), &st
) == 0
5362 ? get_stat_mtime (&st
)
5363 : time_error_value (errno
));
5364 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5365 && (b
->modtime_size
< 0
5366 || st
.st_size
== b
->modtime_size
))
5371 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5372 Svisited_file_modtime
, 0, 0, 0,
5373 doc
: /* Return the current buffer's recorded visited file modification time.
5374 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5375 `file-attributes' returns. If the current buffer has no recorded file
5376 modification time, this function returns 0. If the visited file
5377 doesn't exist, return -1.
5378 See Info node `(elisp)Modification Time' for more details. */)
5381 int ns
= EMACS_NSECS (current_buffer
->modtime
);
5383 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5384 return make_lisp_time (current_buffer
->modtime
);
5387 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5388 Sset_visited_file_modtime
, 0, 1, 0,
5389 doc
: /* Update buffer's recorded modification time from the visited file's time.
5390 Useful if the buffer was not read from the file normally
5391 or if the file itself has been changed for some known benign reason.
5392 An argument specifies the modification time value to use
5393 \(instead of that of the visited file), in the form of a list
5394 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5395 `visited-file-modtime'. */)
5396 (Lisp_Object time_flag
)
5398 if (!NILP (time_flag
))
5401 if (INTEGERP (time_flag
))
5403 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5404 mtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5407 mtime
= lisp_time_argument (time_flag
);
5409 current_buffer
->modtime
= mtime
;
5410 current_buffer
->modtime_size
= -1;
5414 register Lisp_Object filename
;
5416 Lisp_Object handler
;
5418 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5420 /* If the file name has special constructs in it,
5421 call the corresponding file handler. */
5422 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5423 if (!NILP (handler
))
5424 /* The handler can find the file name the same way we did. */
5425 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5427 filename
= ENCODE_FILE (filename
);
5429 if (stat (SSDATA (filename
), &st
) >= 0)
5431 current_buffer
->modtime
= get_stat_mtime (&st
);
5432 current_buffer
->modtime_size
= st
.st_size
;
5440 auto_save_error (Lisp_Object error_val
)
5442 Lisp_Object args
[3], msg
;
5444 struct gcpro gcpro1
;
5446 auto_save_error_occurred
= 1;
5448 ring_bell (XFRAME (selected_frame
));
5450 args
[0] = build_string ("Auto-saving %s: %s");
5451 args
[1] = BVAR (current_buffer
, name
);
5452 args
[2] = Ferror_message_string (error_val
);
5453 msg
= Fformat (3, args
);
5456 for (i
= 0; i
< 3; ++i
)
5461 message3_nolog (msg
);
5462 Fsleep_for (make_number (1), Qnil
);
5475 auto_save_mode_bits
= 0666;
5477 /* Get visited file's mode to become the auto save file's mode. */
5478 if (! NILP (BVAR (current_buffer
, filename
)))
5480 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5481 /* But make sure we can overwrite it later! */
5482 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5483 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5485 /* Remote files don't cooperate with stat. */
5486 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5490 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5491 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5496 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5499 FILE *stream
= XSAVE_POINTER (arg
, 0);
5511 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5514 minibuffer_auto_raise
= XINT (value
);
5519 do_auto_save_make_dir (Lisp_Object dir
)
5523 auto_saving_dir_umask
= 077;
5524 result
= call2 (Qmake_directory
, dir
, Qt
);
5525 auto_saving_dir_umask
= 0;
5530 do_auto_save_eh (Lisp_Object ignore
)
5532 auto_saving_dir_umask
= 0;
5536 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5537 doc
: /* Auto-save all buffers that need it.
5538 This is all buffers that have auto-saving enabled
5539 and are changed since last auto-saved.
5540 Auto-saving writes the buffer into a file
5541 so that your editing is not lost if the system crashes.
5542 This file is not the file you visited; that changes only when you save.
5543 Normally we run the normal hook `auto-save-hook' before saving.
5545 A non-nil NO-MESSAGE argument means do not print any message if successful.
5546 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5547 (Lisp_Object no_message
, Lisp_Object current_only
)
5549 struct buffer
*old
= current_buffer
, *b
;
5550 Lisp_Object tail
, buf
, hook
;
5551 bool auto_saved
= 0;
5552 int do_handled_files
;
5554 FILE *stream
= NULL
;
5555 ptrdiff_t count
= SPECPDL_INDEX ();
5556 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5557 bool old_message_p
= 0;
5558 struct gcpro gcpro1
, gcpro2
;
5560 if (max_specpdl_size
< specpdl_size
+ 40)
5561 max_specpdl_size
= specpdl_size
+ 40;
5566 if (NILP (no_message
))
5568 old_message_p
= push_message ();
5569 record_unwind_protect (pop_message_unwind
, Qnil
);
5572 /* Ordinarily don't quit within this function,
5573 but don't make it impossible to quit (in case we get hung in I/O). */
5577 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5578 point to non-strings reached from Vbuffer_alist. */
5580 hook
= intern ("auto-save-hook");
5581 safe_run_hooks (hook
);
5583 if (STRINGP (Vauto_save_list_file_name
))
5585 Lisp_Object listfile
;
5587 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5589 /* Don't try to create the directory when shutting down Emacs,
5590 because creating the directory might signal an error, and
5591 that would leave Emacs in a strange state. */
5592 if (!NILP (Vrun_hooks
))
5596 GCPRO2 (dir
, listfile
);
5597 dir
= Ffile_name_directory (listfile
);
5598 if (NILP (Ffile_directory_p (dir
)))
5599 internal_condition_case_1 (do_auto_save_make_dir
,
5605 stream
= emacs_fopen (SSDATA (listfile
), "w");
5608 record_unwind_protect (do_auto_save_unwind
,
5609 make_save_pointer (stream
));
5610 record_unwind_protect (do_auto_save_unwind_1
,
5611 make_number (minibuffer_auto_raise
));
5612 minibuffer_auto_raise
= 0;
5614 auto_save_error_occurred
= 0;
5616 /* On first pass, save all files that don't have handlers.
5617 On second pass, save all files that do have handlers.
5619 If Emacs is crashing, the handlers may tweak what is causing
5620 Emacs to crash in the first place, and it would be a shame if
5621 Emacs failed to autosave perfectly ordinary files because it
5622 couldn't handle some ange-ftp'd file. */
5624 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5625 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5627 buf
= XCDR (XCAR (tail
));
5630 /* Record all the buffers that have auto save mode
5631 in the special file that lists them. For each of these buffers,
5632 Record visited name (if any) and auto save name. */
5633 if (STRINGP (BVAR (b
, auto_save_file_name
))
5634 && stream
!= NULL
&& do_handled_files
== 0)
5637 if (!NILP (BVAR (b
, filename
)))
5639 fwrite (SDATA (BVAR (b
, filename
)), 1,
5640 SBYTES (BVAR (b
, filename
)), stream
);
5642 putc ('\n', stream
);
5643 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5644 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5645 putc ('\n', stream
);
5649 if (!NILP (current_only
)
5650 && b
!= current_buffer
)
5653 /* Don't auto-save indirect buffers.
5654 The base buffer takes care of it. */
5658 /* Check for auto save enabled
5659 and file changed since last auto save
5660 and file changed since last real save. */
5661 if (STRINGP (BVAR (b
, auto_save_file_name
))
5662 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5663 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5664 /* -1 means we've turned off autosaving for a while--see below. */
5665 && XINT (BVAR (b
, save_length
)) >= 0
5666 && (do_handled_files
5667 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5670 EMACS_TIME before_time
= current_emacs_time ();
5671 EMACS_TIME after_time
;
5673 /* If we had a failure, don't try again for 20 minutes. */
5674 if (b
->auto_save_failure_time
> 0
5675 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5678 set_buffer_internal (b
);
5679 if (NILP (Vauto_save_include_big_deletions
)
5680 && (XFASTINT (BVAR (b
, save_length
)) * 10
5681 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5682 /* A short file is likely to change a large fraction;
5683 spare the user annoying messages. */
5684 && XFASTINT (BVAR (b
, save_length
)) > 5000
5685 /* These messages are frequent and annoying for `*mail*'. */
5686 && !EQ (BVAR (b
, filename
), Qnil
)
5687 && NILP (no_message
))
5689 /* It has shrunk too much; turn off auto-saving here. */
5690 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5691 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5693 minibuffer_auto_raise
= 0;
5694 /* Turn off auto-saving until there's a real save,
5695 and prevent any more warnings. */
5696 XSETINT (BVAR (b
, save_length
), -1);
5697 Fsleep_for (make_number (1), Qnil
);
5700 if (!auto_saved
&& NILP (no_message
))
5701 message1 ("Auto-saving...");
5702 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5704 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5705 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5706 set_buffer_internal (old
);
5708 after_time
= current_emacs_time ();
5710 /* If auto-save took more than 60 seconds,
5711 assume it was an NFS failure that got a timeout. */
5712 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5713 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5717 /* Prevent another auto save till enough input events come in. */
5718 record_auto_save ();
5720 if (auto_saved
&& NILP (no_message
))
5724 /* If we are going to restore an old message,
5725 give time to read ours. */
5726 sit_for (make_number (1), 0, 0);
5729 else if (!auto_save_error_occurred
)
5730 /* Don't overwrite the error message if an error occurred.
5731 If we displayed a message and then restored a state
5732 with no message, leave a "done" message on the screen. */
5733 message1 ("Auto-saving...done");
5738 /* This restores the message-stack status. */
5739 unbind_to (count
, Qnil
);
5743 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5744 Sset_buffer_auto_saved
, 0, 0, 0,
5745 doc
: /* Mark current buffer as auto-saved with its current text.
5746 No auto-save file will be written until the buffer changes again. */)
5749 /* FIXME: This should not be called in indirect buffers, since
5750 they're not autosaved. */
5751 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5752 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5753 current_buffer
->auto_save_failure_time
= 0;
5757 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5758 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5759 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5762 current_buffer
->auto_save_failure_time
= 0;
5766 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5768 doc
: /* Return t if current buffer has been auto-saved recently.
5769 More precisely, if it has been auto-saved since last read from or saved
5770 in the visited file. If the buffer has no visited file,
5771 then any auto-save counts as "recent". */)
5774 /* FIXME: maybe we should return nil for indirect buffers since
5775 they're never autosaved. */
5776 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5779 /* Reading and completing file names */
5781 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5782 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5783 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5784 The return value is only relevant for a call to `read-file-name' that happens
5785 before any other event (mouse or keypress) is handled. */)
5788 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5789 || defined (HAVE_NS)
5790 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5793 && window_system_available (SELECTED_FRAME ()))
5800 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5802 struct gcpro gcpro1
;
5803 Lisp_Object args
[7];
5805 GCPRO1 (default_filename
);
5806 args
[0] = intern ("read-file-name");
5809 args
[3] = default_filename
;
5810 args
[4] = mustmatch
;
5812 args
[6] = predicate
;
5813 RETURN_UNGCPRO (Ffuncall (7, args
));
5820 valid_timestamp_file_system
= 0;
5824 syms_of_fileio (void)
5826 DEFSYM (Qoperations
, "operations");
5827 DEFSYM (Qexpand_file_name
, "expand-file-name");
5828 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5829 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5830 DEFSYM (Qfile_name_directory
, "file-name-directory");
5831 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5832 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5833 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5834 DEFSYM (Qcopy_file
, "copy-file");
5835 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5836 DEFSYM (Qmake_directory
, "make-directory");
5837 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5838 DEFSYM (Qdelete_file
, "delete-file");
5839 DEFSYM (Qrename_file
, "rename-file");
5840 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5841 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5842 DEFSYM (Qfile_exists_p
, "file-exists-p");
5843 DEFSYM (Qfile_executable_p
, "file-executable-p");
5844 DEFSYM (Qfile_readable_p
, "file-readable-p");
5845 DEFSYM (Qfile_writable_p
, "file-writable-p");
5846 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5847 DEFSYM (Qaccess_file
, "access-file");
5848 DEFSYM (Qfile_directory_p
, "file-directory-p");
5849 DEFSYM (Qfile_regular_p
, "file-regular-p");
5850 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5851 DEFSYM (Qfile_modes
, "file-modes");
5852 DEFSYM (Qset_file_modes
, "set-file-modes");
5853 DEFSYM (Qset_file_times
, "set-file-times");
5854 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5855 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5856 DEFSYM (Qfile_acl
, "file-acl");
5857 DEFSYM (Qset_file_acl
, "set-file-acl");
5858 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5859 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5860 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5861 DEFSYM (Qwrite_region
, "write-region");
5862 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5863 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5864 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5866 DEFSYM (Qfile_name_history
, "file-name-history");
5867 Fset (Qfile_name_history
, Qnil
);
5869 DEFSYM (Qfile_error
, "file-error");
5870 DEFSYM (Qfile_already_exists
, "file-already-exists");
5871 DEFSYM (Qfile_date_error
, "file-date-error");
5872 DEFSYM (Qfile_notify_error
, "file-notify-error");
5873 DEFSYM (Qexcl
, "excl");
5875 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5876 doc
: /* Coding system for encoding file names.
5877 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5878 Vfile_name_coding_system
= Qnil
;
5880 DEFVAR_LISP ("default-file-name-coding-system",
5881 Vdefault_file_name_coding_system
,
5882 doc
: /* Default coding system for encoding file names.
5883 This variable is used only when `file-name-coding-system' is nil.
5885 This variable is set/changed by the command `set-language-environment'.
5886 User should not set this variable manually,
5887 instead use `file-name-coding-system' to get a constant encoding
5888 of file names regardless of the current language environment. */);
5889 Vdefault_file_name_coding_system
= Qnil
;
5891 DEFSYM (Qformat_decode
, "format-decode");
5892 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5893 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5894 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5896 Fput (Qfile_error
, Qerror_conditions
,
5897 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5898 Fput (Qfile_error
, Qerror_message
,
5899 build_pure_c_string ("File error"));
5901 Fput (Qfile_already_exists
, Qerror_conditions
,
5902 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5903 Fput (Qfile_already_exists
, Qerror_message
,
5904 build_pure_c_string ("File already exists"));
5906 Fput (Qfile_date_error
, Qerror_conditions
,
5907 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5908 Fput (Qfile_date_error
, Qerror_message
,
5909 build_pure_c_string ("Cannot set file date"));
5911 Fput (Qfile_notify_error
, Qerror_conditions
,
5912 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5913 Fput (Qfile_notify_error
, Qerror_message
,
5914 build_pure_c_string ("File notification error"));
5916 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5917 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5918 If a file name matches REGEXP, all I/O on that file is done by calling
5919 HANDLER. If a file name matches more than one handler, the handler
5920 whose match starts last in the file name gets precedence. The
5921 function `find-file-name-handler' checks this list for a handler for
5924 HANDLER should be a function. The first argument given to it is the
5925 name of the I/O primitive to be handled; the remaining arguments are
5926 the arguments that were passed to that primitive. For example, if you
5927 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5928 HANDLER is called like this:
5930 (funcall HANDLER 'file-exists-p FILENAME)
5932 Note that HANDLER must be able to handle all I/O primitives; if it has
5933 nothing special to do for a primitive, it should reinvoke the
5934 primitive to handle the operation \"the usual way\".
5935 See Info node `(elisp)Magic File Names' for more details. */);
5936 Vfile_name_handler_alist
= Qnil
;
5938 DEFVAR_LISP ("set-auto-coding-function",
5939 Vset_auto_coding_function
,
5940 doc
: /* If non-nil, a function to call to decide a coding system of file.
5941 Two arguments are passed to this function: the file name
5942 and the length of a file contents following the point.
5943 This function should return a coding system to decode the file contents.
5944 It should check the file name against `auto-coding-alist'.
5945 If no coding system is decided, it should check a coding system
5946 specified in the heading lines with the format:
5947 -*- ... coding: CODING-SYSTEM; ... -*-
5948 or local variable spec of the tailing lines with `coding:' tag. */);
5949 Vset_auto_coding_function
= Qnil
;
5951 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5952 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5953 Each is passed one argument, the number of characters inserted,
5954 with point at the start of the inserted text. Each function
5955 should leave point the same, and return the new character count.
5956 If `insert-file-contents' is intercepted by a handler from
5957 `file-name-handler-alist', that handler is responsible for calling the
5958 functions in `after-insert-file-functions' if appropriate. */);
5959 Vafter_insert_file_functions
= Qnil
;
5961 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5962 doc
: /* A list of functions to be called at the start of `write-region'.
5963 Each is passed two arguments, START and END as for `write-region'.
5964 These are usually two numbers but not always; see the documentation
5965 for `write-region'. The function should return a list of pairs
5966 of the form (POSITION . STRING), consisting of strings to be effectively
5967 inserted at the specified positions of the file being written (1 means to
5968 insert before the first byte written). The POSITIONs must be sorted into
5971 If there are several annotation functions, the lists returned by these
5972 functions are merged destructively. As each annotation function runs,
5973 the variable `write-region-annotations-so-far' contains a list of all
5974 annotations returned by previous annotation functions.
5976 An annotation function can return with a different buffer current.
5977 Doing so removes the annotations returned by previous functions, and
5978 resets START and END to `point-min' and `point-max' of the new buffer.
5980 After `write-region' completes, Emacs calls the function stored in
5981 `write-region-post-annotation-function', once for each buffer that was
5982 current when building the annotations (i.e., at least once), with that
5983 buffer current. */);
5984 Vwrite_region_annotate_functions
= Qnil
;
5985 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5987 DEFVAR_LISP ("write-region-post-annotation-function",
5988 Vwrite_region_post_annotation_function
,
5989 doc
: /* Function to call after `write-region' completes.
5990 The function is called with no arguments. If one or more of the
5991 annotation functions in `write-region-annotate-functions' changed the
5992 current buffer, the function stored in this variable is called for
5993 each of those additional buffers as well, in addition to the original
5994 buffer. The relevant buffer is current during each function call. */);
5995 Vwrite_region_post_annotation_function
= Qnil
;
5996 staticpro (&Vwrite_region_annotation_buffers
);
5998 DEFVAR_LISP ("write-region-annotations-so-far",
5999 Vwrite_region_annotations_so_far
,
6000 doc
: /* When an annotation function is called, this holds the previous annotations.
6001 These are the annotations made by other annotation functions
6002 that were already called. See also `write-region-annotate-functions'. */);
6003 Vwrite_region_annotations_so_far
= Qnil
;
6005 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6006 doc
: /* A list of file name handlers that temporarily should not be used.
6007 This applies only to the operation `inhibit-file-name-operation'. */);
6008 Vinhibit_file_name_handlers
= Qnil
;
6010 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6011 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6012 Vinhibit_file_name_operation
= Qnil
;
6014 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6015 doc
: /* File name in which we write a list of all auto save file names.
6016 This variable is initialized automatically from `auto-save-list-file-prefix'
6017 shortly after Emacs reads your init file, if you have not yet given it
6018 a non-nil value. */);
6019 Vauto_save_list_file_name
= Qnil
;
6021 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6022 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6023 Normally auto-save files are written under other names. */);
6024 Vauto_save_visited_file_name
= Qnil
;
6026 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6027 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6028 If nil, deleting a substantial portion of the text disables auto-save
6029 in the buffer; this is the default behavior, because the auto-save
6030 file is usually more useful if it contains the deleted text. */);
6031 Vauto_save_include_big_deletions
= Qnil
;
6033 /* fsync can be a significant performance hit. Often it doesn't
6034 suffice to make the file-save operation survive a crash. For
6035 batch scripts, which are typically part of larger shell commands
6036 that don't fsync other files, its effect on performance can be
6037 significant so its utility is particularly questionable.
6038 Hence, for now by default fsync is used only when interactive.
6040 For more on why fsync often fails to work on today's hardware, see:
6041 Zheng M et al. Understanding the robustness of SSDs under power fault.
6042 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
6043 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
6045 For more on why fsync does not suffice even if it works properly, see:
6046 Roche X. Necessary step(s) to synchronize filename operations on disk.
6047 Austin Group Defect 672, 2013-03-19
6048 http://austingroupbugs.net/view.php?id=672 */
6049 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6050 doc
: /* Non-nil means don't call fsync in `write-region'.
6051 This variable affects calls to `write-region' as well as save commands.
6052 Setting this to nil may avoid data loss if the system loses power or
6053 the operating system crashes. */);
6054 write_region_inhibit_fsync
= noninteractive
;
6056 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6057 doc
: /* Specifies whether to use the system's trash can.
6058 When non-nil, certain file deletion commands use the function
6059 `move-file-to-trash' instead of deleting files outright.
6060 This includes interactive calls to `delete-file' and
6061 `delete-directory' and the Dired deletion commands. */);
6062 delete_by_moving_to_trash
= 0;
6063 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6065 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6066 DEFSYM (Qcopy_directory
, "copy-directory");
6067 DEFSYM (Qdelete_directory
, "delete-directory");
6069 defsubr (&Sfind_file_name_handler
);
6070 defsubr (&Sfile_name_directory
);
6071 defsubr (&Sfile_name_nondirectory
);
6072 defsubr (&Sunhandled_file_name_directory
);
6073 defsubr (&Sfile_name_as_directory
);
6074 defsubr (&Sdirectory_file_name
);
6075 defsubr (&Smake_temp_name
);
6076 defsubr (&Sexpand_file_name
);
6077 defsubr (&Ssubstitute_in_file_name
);
6078 defsubr (&Scopy_file
);
6079 defsubr (&Smake_directory_internal
);
6080 defsubr (&Sdelete_directory_internal
);
6081 defsubr (&Sdelete_file
);
6082 defsubr (&Srename_file
);
6083 defsubr (&Sadd_name_to_file
);
6084 defsubr (&Smake_symbolic_link
);
6085 defsubr (&Sfile_name_absolute_p
);
6086 defsubr (&Sfile_exists_p
);
6087 defsubr (&Sfile_executable_p
);
6088 defsubr (&Sfile_readable_p
);
6089 defsubr (&Sfile_writable_p
);
6090 defsubr (&Saccess_file
);
6091 defsubr (&Sfile_symlink_p
);
6092 defsubr (&Sfile_directory_p
);
6093 defsubr (&Sfile_accessible_directory_p
);
6094 defsubr (&Sfile_regular_p
);
6095 defsubr (&Sfile_modes
);
6096 defsubr (&Sset_file_modes
);
6097 defsubr (&Sset_file_times
);
6098 defsubr (&Sfile_selinux_context
);
6099 defsubr (&Sfile_acl
);
6100 defsubr (&Sset_file_acl
);
6101 defsubr (&Sset_file_selinux_context
);
6102 defsubr (&Sset_default_file_modes
);
6103 defsubr (&Sdefault_file_modes
);
6104 defsubr (&Sfile_newer_than_file_p
);
6105 defsubr (&Sinsert_file_contents
);
6106 defsubr (&Schoose_write_coding_system
);
6107 defsubr (&Swrite_region
);
6108 defsubr (&Scar_less_than_car
);
6109 defsubr (&Sverify_visited_file_modtime
);
6110 defsubr (&Svisited_file_modtime
);
6111 defsubr (&Sset_visited_file_modtime
);
6112 defsubr (&Sdo_auto_save
);
6113 defsubr (&Sset_buffer_auto_saved
);
6114 defsubr (&Sclear_buffer_auto_save_failure
);
6115 defsubr (&Srecent_auto_save_p
);
6117 defsubr (&Snext_read_file_uses_dialog_p
);
6120 defsubr (&Sunix_sync
);