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
;
146 static Lisp_Object Qsubstitute_env_in_file_name
;
151 Lisp_Object Qfile_error
, Qfile_notify_error
;
152 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
153 static Lisp_Object Qexcl
;
154 Lisp_Object Qfile_name_history
;
156 static Lisp_Object Qcar_less_than_car
;
158 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
159 Lisp_Object
*, struct coding_system
*);
160 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
161 struct coding_system
*);
164 /* Return true if FILENAME exists. */
167 check_existing (const char *filename
)
169 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
172 /* Return true if file FILENAME exists and can be executed. */
175 check_executable (char *filename
)
177 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
180 /* Return true if file FILENAME exists and can be accessed
181 according to AMODE, which should include W_OK.
182 On failure, return false and set errno. */
185 check_writable (const char *filename
, int amode
)
188 /* FIXME: an faccessat implementation should be added to the
189 DOS/Windows ports and this #ifdef branch should be removed. */
191 if (stat (filename
, &st
) < 0)
194 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
195 #else /* not MSDOS */
196 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
198 /* faccessat may have returned failure because Cygwin couldn't
199 determine the file's UID or GID; if so, we return success. */
202 int faccessat_errno
= errno
;
204 if (stat (filename
, &st
) < 0)
206 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
207 errno
= faccessat_errno
;
211 #endif /* not MSDOS */
214 /* Signal a file-access failure. STRING describes the failure,
215 NAME the file involved, and ERRORNO the errno value.
217 If NAME is neither null nor a pair, package it up as a singleton
218 list before reporting it; this saves report_file_errno's caller the
219 trouble of preserving errno before calling list1. */
222 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
224 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
225 Lisp_Object errstring
;
228 synchronize_system_messages_locale ();
229 str
= strerror (errorno
);
230 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
231 Vlocale_coding_system
, 0);
237 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
240 /* System error messages are capitalized. Downcase the initial
241 unless it is followed by a slash. (The slash case caters to
242 error messages that begin with "I/O" or, in German, "E/A".) */
243 if (STRING_MULTIBYTE (errstring
)
244 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
248 str
= SSDATA (errstring
);
249 c
= STRING_CHAR ((unsigned char *) str
);
250 Faset (errstring
, make_number (0), make_number (downcase (c
)));
253 xsignal (Qfile_error
,
254 Fcons (build_string (string
), Fcons (errstring
, data
)));
258 /* Signal a file-access failure that set errno. STRING describes the
259 failure, NAME the file involved. When invoking this function, take
260 care to not use arguments such as build_string ("foo") that involve
261 side effects that may set errno. */
264 report_file_error (char const *string
, Lisp_Object name
)
266 report_file_errno (string
, name
, errno
);
270 close_file_unwind (int fd
)
276 fclose_unwind (void *arg
)
282 /* Restore point, having saved it as a marker. */
285 restore_point_unwind (Lisp_Object location
)
287 Fgoto_char (location
);
288 unchain_marker (XMARKER (location
));
292 static Lisp_Object Qexpand_file_name
;
293 static Lisp_Object Qsubstitute_in_file_name
;
294 static Lisp_Object Qdirectory_file_name
;
295 static Lisp_Object Qfile_name_directory
;
296 static Lisp_Object Qfile_name_nondirectory
;
297 static Lisp_Object Qunhandled_file_name_directory
;
298 static Lisp_Object Qfile_name_as_directory
;
299 static Lisp_Object Qcopy_file
;
300 static Lisp_Object Qmake_directory_internal
;
301 static Lisp_Object Qmake_directory
;
302 static Lisp_Object Qdelete_directory_internal
;
303 Lisp_Object Qdelete_file
;
304 static Lisp_Object Qrename_file
;
305 static Lisp_Object Qadd_name_to_file
;
306 static Lisp_Object Qmake_symbolic_link
;
307 Lisp_Object Qfile_exists_p
;
308 static Lisp_Object Qfile_executable_p
;
309 static Lisp_Object Qfile_readable_p
;
310 static Lisp_Object Qfile_writable_p
;
311 static Lisp_Object Qfile_symlink_p
;
312 static Lisp_Object Qaccess_file
;
313 Lisp_Object Qfile_directory_p
;
314 static Lisp_Object Qfile_regular_p
;
315 static Lisp_Object Qfile_accessible_directory_p
;
316 static Lisp_Object Qfile_modes
;
317 static Lisp_Object Qset_file_modes
;
318 static Lisp_Object Qset_file_times
;
319 static Lisp_Object Qfile_selinux_context
;
320 static Lisp_Object Qset_file_selinux_context
;
321 static Lisp_Object Qfile_acl
;
322 static Lisp_Object Qset_file_acl
;
323 static Lisp_Object Qfile_newer_than_file_p
;
324 Lisp_Object Qinsert_file_contents
;
325 static Lisp_Object Qchoose_write_coding_system
;
326 Lisp_Object Qwrite_region
;
327 static Lisp_Object Qverify_visited_file_modtime
;
328 static Lisp_Object Qset_visited_file_modtime
;
330 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
331 Sfind_file_name_handler
, 2, 2, 0,
332 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
333 Otherwise, return nil.
334 A file name is handled if one of the regular expressions in
335 `file-name-handler-alist' matches it.
337 If OPERATION equals `inhibit-file-name-operation', then we ignore
338 any handlers that are members of `inhibit-file-name-handlers',
339 but we still do run any other handlers. This lets handlers
340 use the standard functions without calling themselves recursively. */)
341 (Lisp_Object filename
, Lisp_Object operation
)
343 /* This function must not munge the match data. */
344 Lisp_Object chain
, inhibited_handlers
, result
;
348 CHECK_STRING (filename
);
350 if (EQ (operation
, Vinhibit_file_name_operation
))
351 inhibited_handlers
= Vinhibit_file_name_handlers
;
353 inhibited_handlers
= Qnil
;
355 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
356 chain
= XCDR (chain
))
362 Lisp_Object string
= XCAR (elt
);
364 Lisp_Object handler
= XCDR (elt
);
365 Lisp_Object operations
= Qnil
;
367 if (SYMBOLP (handler
))
368 operations
= Fget (handler
, Qoperations
);
371 && (match_pos
= fast_string_match (string
, filename
)) > pos
372 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
376 handler
= XCDR (elt
);
377 tem
= Fmemq (handler
, inhibited_handlers
);
391 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
393 doc
: /* Return the directory component in file name FILENAME.
394 Return nil if FILENAME does not include a directory.
395 Otherwise return a directory name.
396 Given a Unix syntax file name, returns a string ending in slash. */)
397 (Lisp_Object filename
)
400 register const char *beg
;
405 register const char *p
;
408 CHECK_STRING (filename
);
410 /* If the file name has special constructs in it,
411 call the corresponding file handler. */
412 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
415 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
417 return STRINGP (handled_name
) ? handled_name
: Qnil
;
421 beg
= xlispstrdupa (filename
);
423 beg
= SSDATA (filename
);
425 p
= beg
+ SBYTES (filename
);
427 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
429 /* only recognize drive specifier at the beginning */
431 /* handle the "/:d:foo" and "/:foo" cases correctly */
432 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
433 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
440 /* Expansion of "c:" to drive and default directory. */
443 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
444 char *res
= alloca (MAXPATHLEN
+ 1);
447 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
449 memcpy (res
, beg
, 2);
454 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
456 size_t l
= strlen (res
);
458 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
461 p
= beg
+ strlen (beg
);
462 dostounix_filename (beg
, 0);
463 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
464 STRING_MULTIBYTE (filename
));
467 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
468 STRING_MULTIBYTE (filename
));
470 else if (STRING_MULTIBYTE (filename
))
472 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
473 dostounix_filename (SSDATA (tem_fn
), 1);
475 if (!NILP (Vw32_downcase_file_names
))
476 tem_fn
= Fdowncase (tem_fn
);
481 dostounix_filename (beg
, 0);
482 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
486 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
490 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
491 Sfile_name_nondirectory
, 1, 1, 0,
492 doc
: /* Return file name FILENAME sans its directory.
493 For example, in a Unix-syntax file name,
494 this is everything after the last slash,
495 or the entire name if it contains no slash. */)
496 (Lisp_Object filename
)
498 register const char *beg
, *p
, *end
;
501 CHECK_STRING (filename
);
503 /* If the file name has special constructs in it,
504 call the corresponding file handler. */
505 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
508 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
510 if (STRINGP (handled_name
))
512 error ("Invalid handler in `file-name-handler-alist'");
515 beg
= SSDATA (filename
);
516 end
= p
= beg
+ SBYTES (filename
);
518 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
520 /* only recognize drive specifier at beginning */
522 /* handle the "/:d:foo" case correctly */
523 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
528 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
531 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
532 Sunhandled_file_name_directory
, 1, 1, 0,
533 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
534 A `directly usable' directory name is one that may be used without the
535 intervention of any file handler.
536 If FILENAME is a directly usable file itself, return
537 \(file-name-directory FILENAME).
538 If FILENAME refers to a file which is not accessible from a local process,
539 then this should return nil.
540 The `call-process' and `start-process' functions use this function to
541 get a current directory to run processes in. */)
542 (Lisp_Object filename
)
546 /* If the file name has special constructs in it,
547 call the corresponding file handler. */
548 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
551 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
553 return STRINGP (handled_name
) ? handled_name
: Qnil
;
556 return Ffile_name_directory (filename
);
559 /* Maximum number of bytes that DST will be longer than SRC
560 in file_name_as_directory. This occurs when SRCLEN == 0. */
561 enum { file_name_as_directory_slop
= 2 };
563 /* Convert from file name SRC of length SRCLEN to directory name in
564 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
565 string. On UNIX, just make sure there is a terminating /. Return
566 the length of DST in bytes. */
569 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
580 memcpy (dst
, src
, srclen
);
581 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
582 dst
[srclen
++] = DIRECTORY_SEP
;
585 dostounix_filename (dst
, multibyte
);
590 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
591 Sfile_name_as_directory
, 1, 1, 0,
592 doc
: /* Return a string representing the file name FILE interpreted as a directory.
593 This operation exists because a directory is also a file, but its name as
594 a directory is different from its name as a file.
595 The result can be used as the value of `default-directory'
596 or passed as second argument to `expand-file-name'.
597 For a Unix-syntax file name, just appends a slash. */)
602 Lisp_Object handler
, val
;
609 /* If the file name has special constructs in it,
610 call the corresponding file handler. */
611 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
614 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
616 if (STRINGP (handled_name
))
618 error ("Invalid handler in `file-name-handler-alist'");
622 if (!NILP (Vw32_downcase_file_names
))
623 file
= Fdowncase (file
);
625 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
626 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
627 STRING_MULTIBYTE (file
));
628 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
633 /* Convert from directory name SRC of length SRCLEN to file name in
634 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
635 string. On UNIX, just make sure there isn't a terminating /.
636 Return the length of DST in bytes. */
639 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
641 /* Process as Unix format: just remove any final slash.
642 But leave "/" and "//" unchanged. */
645 && !IS_ANY_SEP (src
[srclen
- 2])
647 && IS_DIRECTORY_SEP (src
[srclen
- 1])
648 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
651 memcpy (dst
, src
, srclen
);
654 dostounix_filename (dst
, multibyte
);
659 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
661 doc
: /* Returns the file name of the directory named DIRECTORY.
662 This is the name of the file that holds the data for the directory DIRECTORY.
663 This operation exists because a directory is also a file, but its name as
664 a directory is different from its name as a file.
665 In Unix-syntax, this function just removes the final slash. */)
666 (Lisp_Object directory
)
670 Lisp_Object handler
, val
;
673 CHECK_STRING (directory
);
675 if (NILP (directory
))
678 /* If the file name has special constructs in it,
679 call the corresponding file handler. */
680 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
683 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
685 if (STRINGP (handled_name
))
687 error ("Invalid handler in `file-name-handler-alist'");
691 if (!NILP (Vw32_downcase_file_names
))
692 directory
= Fdowncase (directory
);
694 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
695 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
696 STRING_MULTIBYTE (directory
));
697 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
702 static const char make_temp_name_tbl
[64] =
704 'A','B','C','D','E','F','G','H',
705 'I','J','K','L','M','N','O','P',
706 'Q','R','S','T','U','V','W','X',
707 'Y','Z','a','b','c','d','e','f',
708 'g','h','i','j','k','l','m','n',
709 'o','p','q','r','s','t','u','v',
710 'w','x','y','z','0','1','2','3',
711 '4','5','6','7','8','9','-','_'
714 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
716 /* Value is a temporary file name starting with PREFIX, a string.
718 The Emacs process number forms part of the result, so there is
719 no danger of generating a name being used by another process.
720 In addition, this function makes an attempt to choose a name
721 which has no existing file. To make this work, PREFIX should be
722 an absolute file name.
724 BASE64_P means add the pid as 3 characters in base64
725 encoding. In this case, 6 characters will be added to PREFIX to
726 form the file name. Otherwise, if Emacs is running on a system
727 with long file names, add the pid as a decimal number.
729 This function signals an error if no unique file name could be
733 make_temp_name (Lisp_Object prefix
, bool base64_p
)
739 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
742 CHECK_STRING (prefix
);
744 /* VAL is created by adding 6 characters to PREFIX. The first
745 three are the PID of this process, in base 64, and the second
746 three are incremented if the file already exists. This ensures
747 262144 unique file names per PID per PREFIX. */
753 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
754 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
755 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
760 #ifdef HAVE_LONG_FILE_NAMES
761 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
763 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
764 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
765 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
770 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
771 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
772 if (!STRING_MULTIBYTE (prefix
))
773 STRING_SET_UNIBYTE (val
);
775 memcpy (data
, SSDATA (prefix
), len
);
778 memcpy (p
, pidbuf
, pidlen
);
781 /* Here we try to minimize useless stat'ing when this function is
782 invoked many times successively with the same PREFIX. We achieve
783 this by initializing count to a random value, and incrementing it
786 We don't want make-temp-name to be called while dumping,
787 because then make_temp_name_count_initialized_p would get set
788 and then make_temp_name_count would not be set when Emacs starts. */
790 if (!make_temp_name_count_initialized_p
)
792 make_temp_name_count
= time (NULL
);
793 make_temp_name_count_initialized_p
= 1;
798 unsigned num
= make_temp_name_count
;
800 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
801 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
802 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
804 /* Poor man's congruential RN generator. Replace with
805 ++make_temp_name_count for debugging. */
806 make_temp_name_count
+= 25229;
807 make_temp_name_count
%= 225307;
809 if (!check_existing (data
))
811 /* We want to return only if errno is ENOENT. */
815 /* The error here is dubious, but there is little else we
816 can do. The alternatives are to return nil, which is
817 as bad as (and in many cases worse than) throwing the
818 error, or to ignore the error, which will likely result
819 in looping through 225307 stat's, which is not only
820 dog-slow, but also useless since eventually nil would
821 have to be returned anyway. */
822 report_file_error ("Cannot create temporary name for prefix",
830 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
831 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
832 The Emacs process number forms part of the result,
833 so there is no danger of generating a name being used by another process.
835 In addition, this function makes an attempt to choose a name
836 which has no existing file. To make this work,
837 PREFIX should be an absolute file name.
839 There is a race condition between calling `make-temp-name' and creating the
840 file which opens all kinds of security holes. For that reason, you should
841 probably use `make-temp-file' instead, except in three circumstances:
843 * If you are creating the file in the user's home directory.
844 * If you are creating a directory rather than an ordinary file.
845 * If you are taking special precautions as `make-temp-file' does. */)
848 return make_temp_name (prefix
, 0);
853 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
854 doc
: /* Convert filename NAME to absolute, and canonicalize it.
855 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
856 \(does not start with slash or tilde); both the directory name and
857 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
858 missing, the current buffer's value of `default-directory' is used.
859 NAME should be a string that is a valid file name for the underlying
861 File name components that are `.' are removed, and
862 so are file name components followed by `..', along with the `..' itself;
863 note that these simplifications are done without checking the resulting
864 file names in the file system.
865 Multiple consecutive slashes are collapsed into a single slash,
866 except at the beginning of the file name when they are significant (e.g.,
867 UNC file names on MS-Windows.)
868 An initial `~/' expands to your home directory.
869 An initial `~USER/' expands to USER's home directory.
870 See also the function `substitute-in-file-name'.
872 For technical reasons, this function can return correct but
873 non-intuitive results for the root directory; for instance,
874 \(expand-file-name ".." "/") returns "/..". For this reason, use
875 \(directory-file-name (file-name-directory dirname)) to traverse a
876 filesystem tree, not (expand-file-name ".." dirname). */)
877 (Lisp_Object name
, Lisp_Object default_directory
)
879 /* These point to SDATA and need to be careful with string-relocation
880 during GC (via DECODE_FILE). */
883 /* This should only point to alloca'd data. */
890 bool collapse_newdir
= 1;
894 Lisp_Object handler
, result
, handled_name
;
901 /* If the file name has special constructs in it,
902 call the corresponding file handler. */
903 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
906 handled_name
= call3 (handler
, Qexpand_file_name
,
907 name
, default_directory
);
908 if (STRINGP (handled_name
))
910 error ("Invalid handler in `file-name-handler-alist'");
914 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
915 if (NILP (default_directory
))
916 default_directory
= BVAR (current_buffer
, directory
);
917 if (! STRINGP (default_directory
))
920 /* "/" is not considered a root directory on DOS_NT, so using "/"
921 here causes an infinite recursion in, e.g., the following:
923 (let (default-directory)
924 (expand-file-name "a"))
926 To avoid this, we set default_directory to the root of the
928 default_directory
= build_string (emacs_root_dir ());
930 default_directory
= build_string ("/");
934 if (!NILP (default_directory
))
936 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
939 handled_name
= call3 (handler
, Qexpand_file_name
,
940 name
, default_directory
);
941 if (STRINGP (handled_name
))
943 error ("Invalid handler in `file-name-handler-alist'");
948 char *o
= SSDATA (default_directory
);
950 /* Make sure DEFAULT_DIRECTORY is properly expanded.
951 It would be better to do this down below where we actually use
952 default_directory. Unfortunately, calling Fexpand_file_name recursively
953 could invoke GC, and the strings might be relocated. This would
954 be annoying because we have pointers into strings lying around
955 that would need adjusting, and people would add new pointers to
956 the code and forget to adjust them, resulting in intermittent bugs.
957 Putting this call here avoids all that crud.
959 The EQ test avoids infinite recursion. */
960 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
961 /* Save time in some common cases - as long as default_directory
962 is not relative, it can be canonicalized with name below (if it
963 is needed at all) without requiring it to be expanded now. */
965 /* Detect MSDOS file names with drive specifiers. */
966 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
967 && IS_DIRECTORY_SEP (o
[2]))
969 /* Detect Windows file names in UNC format. */
970 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
972 #else /* not DOS_NT */
973 /* Detect Unix absolute file names (/... alone is not absolute on
975 && ! (IS_DIRECTORY_SEP (o
[0]))
976 #endif /* not DOS_NT */
982 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
986 multibyte
= STRING_MULTIBYTE (name
);
987 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
990 default_directory
= string_to_multibyte (default_directory
);
993 name
= string_to_multibyte (name
);
999 if (!NILP (Vw32_downcase_file_names
))
1000 default_directory
= Fdowncase (default_directory
);
1003 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
1004 nm
= xlispstrdupa (name
);
1007 /* Note if special escape prefix is present, but remove for now. */
1008 if (nm
[0] == '/' && nm
[1] == ':')
1014 /* Find and remove drive specifier if present; this makes nm absolute
1015 even if the rest of the name appears to be relative. Only look for
1016 drive specifier at the beginning. */
1017 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1019 drive
= (unsigned char) nm
[0];
1024 /* If we see "c://somedir", we want to strip the first slash after the
1025 colon when stripping the drive letter. Otherwise, this expands to
1027 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1030 /* Discard any previous drive specifier if nm is now in UNC format. */
1031 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1035 #endif /* WINDOWSNT */
1038 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1039 none are found, we can probably return right away. We will avoid
1040 allocating a new string if name is already fully expanded. */
1042 IS_DIRECTORY_SEP (nm
[0])
1044 && drive
&& !is_escaped
1047 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1051 /* If it turns out that the filename we want to return is just a
1052 suffix of FILENAME, we don't need to go through and edit
1053 things; we just need to construct a new string using data
1054 starting at the middle of FILENAME. If we set LOSE, that
1055 means we've discovered that we can't do that cool trick. */
1061 /* Since we know the name is absolute, we can assume that each
1062 element starts with a "/". */
1064 /* "." and ".." are hairy. */
1065 if (IS_DIRECTORY_SEP (p
[0])
1067 && (IS_DIRECTORY_SEP (p
[2])
1069 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1072 /* Replace multiple slashes with a single one, except
1073 leave leading "//" alone. */
1074 else if (IS_DIRECTORY_SEP (p
[0])
1075 && IS_DIRECTORY_SEP (p
[1])
1076 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1083 /* Make sure directories are all separated with /, but
1084 avoid allocation of a new string when not required. */
1085 dostounix_filename (nm
, multibyte
);
1087 if (IS_DIRECTORY_SEP (nm
[1]))
1089 if (strcmp (nm
, SSDATA (name
)) != 0)
1090 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1094 /* Drive must be set, so this is okay. */
1095 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1099 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1100 temp
[0] = DRIVE_LETTER (drive
);
1101 name
= concat2 (build_string (temp
), name
);
1104 if (!NILP (Vw32_downcase_file_names
))
1105 name
= Fdowncase (name
);
1108 #else /* not DOS_NT */
1109 if (strcmp (nm
, SSDATA (name
)) == 0)
1111 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1112 #endif /* not DOS_NT */
1116 /* At this point, nm might or might not be an absolute file name. We
1117 need to expand ~ or ~user if present, otherwise prefix nm with
1118 default_directory if nm is not absolute, and finally collapse /./
1119 and /foo/../ sequences.
1121 We set newdir to be the appropriate prefix if one is needed:
1122 - the relevant user directory if nm starts with ~ or ~user
1123 - the specified drive's working dir (DOS/NT only) if nm does not
1125 - the value of default_directory.
1127 Note that these prefixes are not guaranteed to be absolute (except
1128 for the working dir of a drive). Therefore, to ensure we always
1129 return an absolute name, if the final prefix is not absolute we
1130 append it to the current working directory. */
1134 if (nm
[0] == '~') /* prefix ~ */
1136 if (IS_DIRECTORY_SEP (nm
[1])
1137 || nm
[1] == 0) /* ~ by itself */
1141 if (!(newdir
= egetenv ("HOME")))
1144 /* `egetenv' may return a unibyte string, which will bite us since
1145 we expect the directory to be multibyte. */
1146 tem
= build_string (newdir
);
1147 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1149 hdir
= DECODE_FILE (tem
);
1150 newdir
= SSDATA (hdir
);
1153 collapse_newdir
= 0;
1156 else /* ~user/filename */
1159 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1161 o
= SAFE_ALLOCA (p
- nm
+ 1);
1162 memcpy (o
, nm
, p
- nm
);
1166 pw
= getpwnam (o
+ 1);
1172 newdir
= pw
->pw_dir
;
1173 /* `getpwnam' may return a unibyte string, which will
1174 bite us since we expect the directory to be
1176 tem
= build_string (newdir
);
1177 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1179 hdir
= DECODE_FILE (tem
);
1180 newdir
= SSDATA (hdir
);
1184 collapse_newdir
= 0;
1188 /* If we don't find a user of that name, leave the name
1189 unchanged; don't move nm forward to p. */
1194 /* On DOS and Windows, nm is absolute if a drive name was specified;
1195 use the drive's current directory as the prefix if needed. */
1196 if (!newdir
&& drive
)
1198 /* Get default directory if needed to make nm absolute. */
1200 if (!IS_DIRECTORY_SEP (nm
[0]))
1202 adir
= alloca (MAXPATHLEN
+ 1);
1203 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1207 Lisp_Object tem
= build_string (adir
);
1209 tem
= DECODE_FILE (tem
);
1210 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1215 /* Either nm starts with /, or drive isn't mounted. */
1217 adir
[0] = DRIVE_LETTER (drive
);
1226 /* Finally, if no prefix has been specified and nm is not absolute,
1227 then it must be expanded relative to default_directory. */
1231 /* /... alone is not absolute on DOS and Windows. */
1232 && !IS_DIRECTORY_SEP (nm
[0])
1235 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1239 newdir
= SSDATA (default_directory
);
1241 /* Note if special escape prefix is present, but remove for now. */
1242 if (newdir
[0] == '/' && newdir
[1] == ':')
1253 /* First ensure newdir is an absolute name. */
1255 /* Detect MSDOS file names with drive specifiers. */
1256 ! (IS_DRIVE (newdir
[0])
1257 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1259 /* Detect Windows file names in UNC format. */
1260 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1264 /* Effectively, let newdir be (expand-file-name newdir cwd).
1265 Because of the admonition against calling expand-file-name
1266 when we have pointers into lisp strings, we accomplish this
1267 indirectly by prepending newdir to nm if necessary, and using
1268 cwd (or the wd of newdir's drive) as the new newdir. */
1271 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1273 drive
= (unsigned char) newdir
[0];
1276 if (!IS_DIRECTORY_SEP (nm
[0]))
1278 ptrdiff_t newlen
= strlen (newdir
);
1279 char *tmp
= alloca (newlen
+ file_name_as_directory_slop
1281 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1285 adir
= alloca (MAXPATHLEN
+ 1);
1288 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1292 getcwd (adir
, MAXPATHLEN
+ 1);
1295 Lisp_Object tem
= build_string (adir
);
1297 tem
= DECODE_FILE (tem
);
1298 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1303 /* Strip off drive name from prefix, if present. */
1304 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1310 /* Keep only a prefix from newdir if nm starts with slash
1311 (//server/share for UNC, nothing otherwise). */
1312 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1315 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1317 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1319 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1321 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1334 /* Ignore any slash at the end of newdir, unless newdir is
1335 just "/" or "//". */
1336 length
= strlen (newdir
);
1337 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1338 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1344 /* Now concatenate the directory and name to new space in the stack frame. */
1345 tlen
= length
+ file_name_as_directory_slop
+ strlen (nm
) + 1;
1347 /* Reserve space for drive specifier and escape prefix, since either
1348 or both may need to be inserted. (The Microsoft x86 compiler
1349 produces incorrect code if the following two lines are combined.) */
1350 target
= alloca (tlen
+ 4);
1352 #else /* not DOS_NT */
1353 target
= SAFE_ALLOCA (tlen
);
1354 #endif /* not DOS_NT */
1359 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1362 /* If newdir is effectively "C:/", then the drive letter will have
1363 been stripped and newdir will be "/". Concatenating with an
1364 absolute directory in nm produces "//", which will then be
1365 incorrectly treated as a network share. Ignore newdir in
1366 this case (keeping the drive letter). */
1367 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1368 && newdir
[1] == '\0'))
1371 memcpy (target
, newdir
, length
);
1376 file_name_as_directory (target
, newdir
, length
, multibyte
);
1379 strcat (target
, nm
);
1381 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1389 if (!IS_DIRECTORY_SEP (*p
))
1393 else if (p
[1] == '.'
1394 && (IS_DIRECTORY_SEP (p
[2])
1397 /* If "/." is the entire filename, keep the "/". Otherwise,
1398 just delete the whole "/.". */
1399 if (o
== target
&& p
[2] == '\0')
1403 else if (p
[1] == '.' && p
[2] == '.'
1404 /* `/../' is the "superroot" on certain file systems.
1405 Turned off on DOS_NT systems because they have no
1406 "superroot" and because this causes us to produce
1407 file names like "d:/../foo" which fail file-related
1408 functions of the underlying OS. (To reproduce, try a
1409 long series of "../../" in default_directory, longer
1410 than the number of levels from the root.) */
1414 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1419 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1422 /* Don't go below server level in UNC filenames. */
1423 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1424 && IS_DIRECTORY_SEP (*target
))
1428 /* Keep initial / only if this is the whole name. */
1429 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1433 else if (IS_DIRECTORY_SEP (p
[1])
1434 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1435 /* Collapse multiple "/", except leave leading "//" alone. */
1444 /* At last, set drive name. */
1446 /* Except for network file name. */
1447 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1448 #endif /* WINDOWSNT */
1450 if (!drive
) emacs_abort ();
1452 target
[0] = DRIVE_LETTER (drive
);
1455 /* Reinsert the escape prefix if required. */
1462 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1463 dostounix_filename (SSDATA (result
), multibyte
);
1465 if (!NILP (Vw32_downcase_file_names
))
1466 result
= Fdowncase (result
);
1469 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1470 #endif /* !DOS_NT */
1473 /* Again look to see if the file name has special constructs in it
1474 and perhaps call the corresponding file handler. This is needed
1475 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1476 the ".." component gives us "/user@host:/bar/../baz" which needs
1477 to be expanded again. */
1478 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1479 if (!NILP (handler
))
1481 handled_name
= call3 (handler
, Qexpand_file_name
,
1482 result
, default_directory
);
1483 if (! STRINGP (handled_name
))
1484 error ("Invalid handler in `file-name-handler-alist'");
1485 result
= handled_name
;
1493 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1494 This is the old version of expand-file-name, before it was thoroughly
1495 rewritten for Emacs 10.31. We leave this version here commented-out,
1496 because the code is very complex and likely to have subtle bugs. If
1497 bugs _are_ found, it might be of interest to look at the old code and
1498 see what did it do in the relevant situation.
1500 Don't remove this code: it's true that it will be accessible
1501 from the repository, but a few years from deletion, people will
1502 forget it is there. */
1504 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1505 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1506 "Convert FILENAME to absolute, and canonicalize it.\n\
1507 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1508 \(does not start with slash); if DEFAULT is nil or missing,\n\
1509 the current buffer's value of default-directory is used.\n\
1510 Filenames containing `.' or `..' as components are simplified;\n\
1511 initial `~/' expands to your home directory.\n\
1512 See also the function `substitute-in-file-name'.")
1514 Lisp_Object name
, defalt
;
1518 register unsigned char *newdir
, *p
, *o
;
1520 unsigned char *target
;
1523 CHECK_STRING (name
);
1526 /* If nm is absolute, flush ...// and detect /./ and /../.
1527 If no /./ or /../ we can return right away. */
1534 if (p
[0] == '/' && p
[1] == '/')
1536 if (p
[0] == '/' && p
[1] == '~')
1537 nm
= p
+ 1, lose
= 1;
1538 if (p
[0] == '/' && p
[1] == '.'
1539 && (p
[2] == '/' || p
[2] == 0
1540 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1546 if (nm
== SDATA (name
))
1548 return build_string (nm
);
1552 /* Now determine directory to start with and put it in NEWDIR. */
1556 if (nm
[0] == '~') /* prefix ~ */
1557 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1559 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1560 newdir
= (unsigned char *) "";
1563 else /* ~user/filename */
1565 /* Get past ~ to user. */
1566 unsigned char *user
= nm
+ 1;
1567 /* Find end of name. */
1568 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1569 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1570 /* Copy the user name into temp storage. */
1571 o
= alloca (len
+ 1);
1572 memcpy (o
, user
, len
);
1575 /* Look up the user name. */
1577 pw
= (struct passwd
*) getpwnam (o
+ 1);
1580 error ("\"%s\" isn't a registered user", o
+ 1);
1582 newdir
= (unsigned char *) pw
->pw_dir
;
1584 /* Discard the user name from NM. */
1588 if (nm
[0] != '/' && !newdir
)
1591 defalt
= current_buffer
->directory
;
1592 CHECK_STRING (defalt
);
1593 newdir
= SDATA (defalt
);
1596 /* Now concatenate the directory and name to new space in the stack frame. */
1598 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1599 target
= alloca (tlen
);
1604 if (nm
[0] == 0 || nm
[0] == '/')
1605 strcpy (target
, newdir
);
1607 file_name_as_directory (target
, newdir
);
1610 strcat (target
, nm
);
1612 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1623 else if (!strncmp (p
, "//", 2)
1629 else if (p
[0] == '/' && p
[1] == '.'
1630 && (p
[2] == '/' || p
[2] == 0))
1632 else if (!strncmp (p
, "/..", 3)
1633 /* `/../' is the "superroot" on certain file systems. */
1635 && (p
[3] == '/' || p
[3] == 0))
1637 while (o
!= target
&& *--o
!= '/')
1639 if (o
== target
&& *o
== '/')
1649 return make_string (target
, o
- target
);
1653 /* If /~ or // appears, discard everything through first slash. */
1655 file_name_absolute_p (const char *filename
)
1658 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1660 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1661 && IS_DIRECTORY_SEP (filename
[2]))
1667 search_embedded_absfilename (char *nm
, char *endp
)
1671 for (p
= nm
+ 1; p
< endp
; p
++)
1673 if (IS_DIRECTORY_SEP (p
[-1])
1674 && file_name_absolute_p (p
)
1675 #if defined (WINDOWSNT) || defined (CYGWIN)
1676 /* // at start of file name is meaningful in Apollo,
1677 WindowsNT and Cygwin systems. */
1678 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1679 #endif /* not (WINDOWSNT || CYGWIN) */
1682 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1683 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1685 char *o
= alloca (s
- p
+ 1);
1687 memcpy (o
, p
, s
- p
);
1690 /* If we have ~user and `user' exists, discard
1691 everything up to ~. But if `user' does not exist, leave
1692 ~user alone, it might be a literal file name. */
1694 pw
= getpwnam (o
+ 1);
1706 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1707 Ssubstitute_in_file_name
, 1, 1, 0,
1708 doc
: /* Substitute environment variables referred to in FILENAME.
1709 `$FOO' where FOO is an environment variable name means to substitute
1710 the value of that variable. The variable name should be terminated
1711 with a character not a letter, digit or underscore; otherwise, enclose
1712 the entire variable name in braces.
1714 If `/~' appears, all of FILENAME through that `/' is discarded.
1715 If `//' appears, everything up to and including the first of
1716 those `/' is discarded. */)
1717 (Lisp_Object filename
)
1719 char *nm
, *p
, *x
, *endp
;
1720 bool substituted
= false;
1723 Lisp_Object handler
;
1725 CHECK_STRING (filename
);
1727 multibyte
= STRING_MULTIBYTE (filename
);
1729 /* If the file name has special constructs in it,
1730 call the corresponding file handler. */
1731 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1732 if (!NILP (handler
))
1734 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1736 if (STRINGP (handled_name
))
1737 return handled_name
;
1738 error ("Invalid handler in `file-name-handler-alist'");
1741 /* Always work on a copy of the string, in case GC happens during
1742 decode of environment variables, causing the original Lisp_String
1743 data to be relocated. */
1744 nm
= xlispstrdupa (filename
);
1747 dostounix_filename (nm
, multibyte
);
1748 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1750 endp
= nm
+ SBYTES (filename
);
1752 /* If /~ or // appears, discard everything through first slash. */
1753 p
= search_embedded_absfilename (nm
, endp
);
1755 /* Start over with the new string, so we check the file-name-handler
1756 again. Important with filenames like "/home/foo//:/hello///there"
1757 which would substitute to "/:/hello///there" rather than "/there". */
1758 return Fsubstitute_in_file_name
1759 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1761 /* See if any variables are substituted into the string. */
1763 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1766 = (!substituted
? filename
1767 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1768 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1770 if (!EQ (tmp
, name
))
1778 if (!NILP (Vw32_downcase_file_names
))
1779 filename
= Fdowncase (filename
);
1784 xnm
= SSDATA (filename
);
1785 x
= xnm
+ SBYTES (filename
);
1787 /* If /~ or // appears, discard everything through first slash. */
1788 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1789 /* This time we do not start over because we've already expanded envvars
1790 and replaced $$ with $. Maybe we should start over as well, but we'd
1791 need to quote some $ to $$ first. */
1795 if (!NILP (Vw32_downcase_file_names
))
1797 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1799 xname
= Fdowncase (xname
);
1804 return (xnm
== SSDATA (filename
)
1806 : make_specified_string (xnm
, -1, x
- xnm
, multibyte
));
1809 /* A slightly faster and more convenient way to get
1810 (directory-file-name (expand-file-name FOO)). */
1813 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1815 register Lisp_Object absname
;
1817 absname
= Fexpand_file_name (filename
, defdir
);
1819 /* Remove final slash, if any (unless this is the root dir).
1820 stat behaves differently depending! */
1821 if (SCHARS (absname
) > 1
1822 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1823 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1824 /* We cannot take shortcuts; they might be wrong for magic file names. */
1825 absname
= Fdirectory_file_name (absname
);
1829 /* Signal an error if the file ABSNAME already exists.
1830 If INTERACTIVE, ask the user whether to proceed,
1831 and bypass the error if the user says to go ahead.
1832 QUERYSTRING is a name for the action that is being considered
1835 *STATPTR is used to store the stat information if the file exists.
1836 If the file does not exist, STATPTR->st_mode is set to 0.
1837 If STATPTR is null, we don't store into it.
1839 If QUICK, ask for y or n, not yes or no. */
1842 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1843 bool interactive
, struct stat
*statptr
,
1846 Lisp_Object tem
, encoded_filename
;
1847 struct stat statbuf
;
1848 struct gcpro gcpro1
;
1850 encoded_filename
= ENCODE_FILE (absname
);
1852 /* `stat' is a good way to tell whether the file exists,
1853 regardless of what access permissions it has. */
1854 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1856 if (S_ISDIR (statbuf
.st_mode
))
1857 xsignal2 (Qfile_error
,
1858 build_string ("File is a directory"), absname
);
1861 xsignal2 (Qfile_already_exists
,
1862 build_string ("File already exists"), absname
);
1864 tem
= format2 ("File %s already exists; %s anyway? ",
1865 absname
, build_string (querystring
));
1867 tem
= call1 (intern ("y-or-n-p"), tem
);
1869 tem
= do_yes_or_no_p (tem
);
1872 xsignal2 (Qfile_already_exists
,
1873 build_string ("File already exists"), absname
);
1880 statptr
->st_mode
= 0;
1885 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1886 "fCopy file: \nGCopy %s to file: \np\nP",
1887 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1888 If NEWNAME names a directory, copy FILE there.
1890 This function always sets the file modes of the output file to match
1893 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1894 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1895 signal a `file-already-exists' error without overwriting. If
1896 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1897 about overwriting; this is what happens in interactive use with M-x.
1898 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1901 Fourth arg KEEP-TIME non-nil means give the output file the same
1902 last-modified time as the old one. (This works on only some systems.)
1904 A prefix arg makes KEEP-TIME non-nil.
1906 If PRESERVE-UID-GID is non-nil, we try to transfer the
1907 uid and gid of FILE to NEWNAME.
1909 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1910 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1911 entries (depending on how Emacs was built). */)
1912 (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
)
1916 char buf
[16 * 1024];
1917 struct stat st
, out_st
;
1918 Lisp_Object handler
;
1919 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1920 ptrdiff_t count
= SPECPDL_INDEX ();
1921 Lisp_Object encoded_file
, encoded_newname
;
1923 security_context_t con
;
1930 encoded_file
= encoded_newname
= Qnil
;
1931 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1932 CHECK_STRING (file
);
1933 CHECK_STRING (newname
);
1935 if (!NILP (Ffile_directory_p (newname
)))
1936 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1938 newname
= Fexpand_file_name (newname
, Qnil
);
1940 file
= Fexpand_file_name (file
, Qnil
);
1942 /* If the input file name has special constructs in it,
1943 call the corresponding file handler. */
1944 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1945 /* Likewise for output file name. */
1947 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1948 if (!NILP (handler
))
1949 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1950 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1951 preserve_extended_attributes
));
1953 encoded_file
= ENCODE_FILE (file
);
1954 encoded_newname
= ENCODE_FILE (newname
);
1956 if (NILP (ok_if_already_exists
)
1957 || INTEGERP (ok_if_already_exists
))
1958 barf_or_query_if_file_exists (newname
, "copy to it",
1959 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1960 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1964 if (!NILP (preserve_extended_attributes
))
1966 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
1967 if (acl
== NULL
&& acl_errno_valid (errno
))
1968 report_file_error ("Getting ACL", file
);
1970 if (!CopyFile (SDATA (encoded_file
),
1971 SDATA (encoded_newname
),
1974 /* CopyFile doesn't set errno when it fails. By far the most
1975 "popular" reason is that the target is read-only. */
1976 report_file_errno ("Copying file", list2 (file
, newname
),
1977 GetLastError () == 5 ? EACCES
: EPERM
);
1979 /* CopyFile retains the timestamp by default. */
1980 else if (NILP (keep_time
))
1982 struct timespec now
;
1986 filename
= SDATA (encoded_newname
);
1988 /* Ensure file is writable while its modified time is set. */
1989 attributes
= GetFileAttributes (filename
);
1990 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1991 now
= current_timespec ();
1992 if (set_file_times (-1, filename
, now
, now
))
1994 /* Restore original attributes. */
1995 SetFileAttributes (filename
, attributes
);
1996 xsignal2 (Qfile_date_error
,
1997 build_string ("Cannot set file date"), newname
);
1999 /* Restore original attributes. */
2000 SetFileAttributes (filename
, attributes
);
2005 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2006 if (fail
&& acl_errno_valid (errno
))
2007 report_file_error ("Setting ACL", newname
);
2011 #else /* not WINDOWSNT */
2013 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2017 report_file_error ("Opening input file", file
);
2019 record_unwind_protect_int (close_file_unwind
, ifd
);
2021 if (fstat (ifd
, &st
) != 0)
2022 report_file_error ("Input file status", file
);
2024 if (!NILP (preserve_extended_attributes
))
2027 if (is_selinux_enabled ())
2029 conlength
= fgetfilecon (ifd
, &con
);
2030 if (conlength
== -1)
2031 report_file_error ("Doing fgetfilecon", file
);
2036 if (out_st
.st_mode
!= 0
2037 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2038 report_file_errno ("Input and output files are the same",
2039 list2 (file
, newname
), 0);
2041 /* We can copy only regular files. */
2042 if (!S_ISREG (st
.st_mode
))
2043 report_file_errno ("Non-regular file", file
,
2044 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
2048 int new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0600 : 0666);
2050 int new_mask
= S_IREAD
| S_IWRITE
;
2052 ofd
= emacs_open (SSDATA (encoded_newname
),
2053 (O_WRONLY
| O_TRUNC
| O_CREAT
2054 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2058 report_file_error ("Opening output file", newname
);
2060 record_unwind_protect_int (close_file_unwind
, ofd
);
2064 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2065 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2066 report_file_error ("Write error", newname
);
2070 /* Preserve the original file permissions, and if requested, also its
2073 mode_t mode_mask
= 07777;
2074 if (!NILP (preserve_uid_gid
))
2076 /* Attempt to change owner and group. If that doesn't work
2077 attempt to change just the group, as that is sometimes allowed.
2078 Adjust the mode mask to eliminate setuid or setgid bits
2079 that are inappropriate if the owner and group are wrong. */
2080 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2082 mode_mask
&= ~06000;
2083 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2088 switch (!NILP (preserve_extended_attributes
)
2089 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2090 SSDATA (encoded_newname
), ofd
,
2091 st
.st_mode
& mode_mask
)
2092 : fchmod (ofd
, st
.st_mode
& mode_mask
))
2094 case -2: report_file_error ("Copying permissions from", file
);
2095 case -1: report_file_error ("Copying permissions to", newname
);
2098 #endif /* not MSDOS */
2103 /* Set the modified context back to the file. */
2104 bool fail
= fsetfilecon (ofd
, con
) != 0;
2105 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2106 if (fail
&& errno
!= ENOTSUP
)
2107 report_file_error ("Doing fsetfilecon", newname
);
2113 if (!NILP (keep_time
))
2115 struct timespec atime
= get_stat_atime (&st
);
2116 struct timespec mtime
= get_stat_mtime (&st
);
2117 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2118 xsignal2 (Qfile_date_error
,
2119 build_string ("Cannot set file date"), newname
);
2122 if (emacs_close (ofd
) < 0)
2123 report_file_error ("Write error", newname
);
2128 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2129 and if it can't, it tells so. Otherwise, under MSDOS we usually
2130 get only the READ bit, which will make the copied file read-only,
2131 so it's better not to chmod at all. */
2132 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2133 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2135 #endif /* not WINDOWSNT */
2137 /* Discard the unwind protects. */
2138 specpdl_ptr
= specpdl
+ count
;
2144 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2145 Smake_directory_internal
, 1, 1, 0,
2146 doc
: /* Create a new directory named DIRECTORY. */)
2147 (Lisp_Object directory
)
2150 Lisp_Object handler
;
2151 Lisp_Object encoded_dir
;
2153 CHECK_STRING (directory
);
2154 directory
= Fexpand_file_name (directory
, Qnil
);
2156 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2157 if (!NILP (handler
))
2158 return call2 (handler
, Qmake_directory_internal
, directory
);
2160 encoded_dir
= ENCODE_FILE (directory
);
2162 dir
= SSDATA (encoded_dir
);
2165 if (mkdir (dir
) != 0)
2167 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2169 report_file_error ("Creating directory", directory
);
2174 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2175 Sdelete_directory_internal
, 1, 1, 0,
2176 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2177 (Lisp_Object directory
)
2180 Lisp_Object encoded_dir
;
2182 CHECK_STRING (directory
);
2183 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2184 encoded_dir
= ENCODE_FILE (directory
);
2185 dir
= SSDATA (encoded_dir
);
2187 if (rmdir (dir
) != 0)
2188 report_file_error ("Removing directory", directory
);
2193 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2194 "(list (read-file-name \
2195 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2196 \"Move file to trash: \" \"Delete file: \") \
2197 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2198 (null current-prefix-arg))",
2199 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2200 If file has multiple names, it continues to exist with the other names.
2201 TRASH non-nil means to trash the file instead of deleting, provided
2202 `delete-by-moving-to-trash' is non-nil.
2204 When called interactively, TRASH is t if no prefix argument is given.
2205 With a prefix argument, TRASH is nil. */)
2206 (Lisp_Object filename
, Lisp_Object trash
)
2208 Lisp_Object handler
;
2209 Lisp_Object encoded_file
;
2210 struct gcpro gcpro1
;
2213 if (!NILP (Ffile_directory_p (filename
))
2214 && NILP (Ffile_symlink_p (filename
)))
2215 xsignal2 (Qfile_error
,
2216 build_string ("Removing old name: is a directory"),
2219 filename
= Fexpand_file_name (filename
, Qnil
);
2221 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2222 if (!NILP (handler
))
2223 return call3 (handler
, Qdelete_file
, filename
, trash
);
2225 if (delete_by_moving_to_trash
&& !NILP (trash
))
2226 return call1 (Qmove_file_to_trash
, filename
);
2228 encoded_file
= ENCODE_FILE (filename
);
2230 if (unlink (SSDATA (encoded_file
)) < 0)
2231 report_file_error ("Removing old name", filename
);
2236 internal_delete_file_1 (Lisp_Object ignore
)
2241 /* Delete file FILENAME, returning true if successful.
2242 This ignores `delete-by-moving-to-trash'. */
2245 internal_delete_file (Lisp_Object filename
)
2249 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2250 Qt
, internal_delete_file_1
);
2254 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2255 "fRename file: \nGRename %s to file: \np",
2256 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2257 If file has names other than FILE, it continues to have those names.
2258 Signals a `file-already-exists' error if a file NEWNAME already exists
2259 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2260 A number as third arg means request confirmation if NEWNAME already exists.
2261 This is what happens in interactive use with M-x. */)
2262 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2264 Lisp_Object handler
;
2265 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2266 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2268 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2269 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2270 CHECK_STRING (file
);
2271 CHECK_STRING (newname
);
2272 file
= Fexpand_file_name (file
, Qnil
);
2274 if ((!NILP (Ffile_directory_p (newname
)))
2276 /* If the file names are identical but for the case,
2277 don't attempt to move directory to itself. */
2278 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2282 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2283 ? file
: Fdirectory_file_name (file
));
2284 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2287 newname
= Fexpand_file_name (newname
, Qnil
);
2289 /* If the file name has special constructs in it,
2290 call the corresponding file handler. */
2291 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2293 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2294 if (!NILP (handler
))
2295 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2296 file
, newname
, ok_if_already_exists
));
2298 encoded_file
= ENCODE_FILE (file
);
2299 encoded_newname
= ENCODE_FILE (newname
);
2302 /* If the file names are identical but for the case, don't ask for
2303 confirmation: they simply want to change the letter-case of the
2305 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2307 if (NILP (ok_if_already_exists
)
2308 || INTEGERP (ok_if_already_exists
))
2309 barf_or_query_if_file_exists (newname
, "rename to it",
2310 INTEGERP (ok_if_already_exists
), 0, 0);
2311 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2313 int rename_errno
= errno
;
2314 if (rename_errno
== EXDEV
)
2317 symlink_target
= Ffile_symlink_p (file
);
2318 if (! NILP (symlink_target
))
2319 Fmake_symbolic_link (symlink_target
, newname
,
2320 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2321 else if (!NILP (Ffile_directory_p (file
)))
2322 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2324 /* We have already prompted if it was an integer, so don't
2325 have copy-file prompt again. */
2326 Fcopy_file (file
, newname
,
2327 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2330 count
= SPECPDL_INDEX ();
2331 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2333 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2334 call2 (Qdelete_directory
, file
, Qt
);
2336 Fdelete_file (file
, Qnil
);
2337 unbind_to (count
, Qnil
);
2340 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2346 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2347 "fAdd name to file: \nGName to add to %s: \np",
2348 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2349 Signals a `file-already-exists' error if a file NEWNAME already exists
2350 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2351 A number as third arg means request confirmation if NEWNAME already exists.
2352 This is what happens in interactive use with M-x. */)
2353 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2355 Lisp_Object handler
;
2356 Lisp_Object encoded_file
, encoded_newname
;
2357 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2359 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2360 encoded_file
= encoded_newname
= Qnil
;
2361 CHECK_STRING (file
);
2362 CHECK_STRING (newname
);
2363 file
= Fexpand_file_name (file
, Qnil
);
2365 if (!NILP (Ffile_directory_p (newname
)))
2366 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2368 newname
= Fexpand_file_name (newname
, Qnil
);
2370 /* If the file name has special constructs in it,
2371 call the corresponding file handler. */
2372 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2373 if (!NILP (handler
))
2374 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2375 newname
, ok_if_already_exists
));
2377 /* If the new name has special constructs in it,
2378 call the corresponding file handler. */
2379 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2380 if (!NILP (handler
))
2381 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2382 newname
, ok_if_already_exists
));
2384 encoded_file
= ENCODE_FILE (file
);
2385 encoded_newname
= ENCODE_FILE (newname
);
2387 if (NILP (ok_if_already_exists
)
2388 || INTEGERP (ok_if_already_exists
))
2389 barf_or_query_if_file_exists (newname
, "make it a new name",
2390 INTEGERP (ok_if_already_exists
), 0, 0);
2392 unlink (SSDATA (newname
));
2393 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2395 int link_errno
= errno
;
2396 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2403 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2404 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2405 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2406 Both args must be strings.
2407 Signals a `file-already-exists' error if a file LINKNAME already exists
2408 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2409 A number as third arg means request confirmation if LINKNAME already exists.
2410 This happens for interactive use with M-x. */)
2411 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2413 Lisp_Object handler
;
2414 Lisp_Object encoded_filename
, encoded_linkname
;
2415 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2417 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2418 encoded_filename
= encoded_linkname
= Qnil
;
2419 CHECK_STRING (filename
);
2420 CHECK_STRING (linkname
);
2421 /* If the link target has a ~, we must expand it to get
2422 a truly valid file name. Otherwise, do not expand;
2423 we want to permit links to relative file names. */
2424 if (SREF (filename
, 0) == '~')
2425 filename
= Fexpand_file_name (filename
, Qnil
);
2427 if (!NILP (Ffile_directory_p (linkname
)))
2428 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2430 linkname
= Fexpand_file_name (linkname
, Qnil
);
2432 /* If the file name has special constructs in it,
2433 call the corresponding file handler. */
2434 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2435 if (!NILP (handler
))
2436 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2437 linkname
, ok_if_already_exists
));
2439 /* If the new link name has special constructs in it,
2440 call the corresponding file handler. */
2441 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2442 if (!NILP (handler
))
2443 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2444 linkname
, ok_if_already_exists
));
2446 encoded_filename
= ENCODE_FILE (filename
);
2447 encoded_linkname
= ENCODE_FILE (linkname
);
2449 if (NILP (ok_if_already_exists
)
2450 || INTEGERP (ok_if_already_exists
))
2451 barf_or_query_if_file_exists (linkname
, "make it a link",
2452 INTEGERP (ok_if_already_exists
), 0, 0);
2453 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2455 /* If we didn't complain already, silently delete existing file. */
2457 if (errno
== EEXIST
)
2459 unlink (SSDATA (encoded_linkname
));
2460 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2467 if (errno
== ENOSYS
)
2470 xsignal1 (Qfile_error
,
2471 build_string ("Symbolic links are not supported"));
2474 symlink_errno
= errno
;
2475 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2483 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2485 doc
: /* Return t if file FILENAME specifies an absolute file name.
2486 On Unix, this is a name starting with a `/' or a `~'. */)
2487 (Lisp_Object filename
)
2489 CHECK_STRING (filename
);
2490 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2493 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2494 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2495 See also `file-readable-p' and `file-attributes'.
2496 This returns nil for a symlink to a nonexistent file.
2497 Use `file-symlink-p' to test for such links. */)
2498 (Lisp_Object filename
)
2500 Lisp_Object absname
;
2501 Lisp_Object handler
;
2503 CHECK_STRING (filename
);
2504 absname
= Fexpand_file_name (filename
, Qnil
);
2506 /* If the file name has special constructs in it,
2507 call the corresponding file handler. */
2508 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2509 if (!NILP (handler
))
2511 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2516 absname
= ENCODE_FILE (absname
);
2518 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2521 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2522 doc
: /* Return t if FILENAME can be executed by you.
2523 For a directory, this means you can access files in that directory. */)
2524 (Lisp_Object filename
)
2526 Lisp_Object absname
;
2527 Lisp_Object handler
;
2529 CHECK_STRING (filename
);
2530 absname
= Fexpand_file_name (filename
, Qnil
);
2532 /* If the file name has special constructs in it,
2533 call the corresponding file handler. */
2534 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2535 if (!NILP (handler
))
2536 return call2 (handler
, Qfile_executable_p
, absname
);
2538 absname
= ENCODE_FILE (absname
);
2540 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2543 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2544 doc
: /* Return t if file FILENAME exists and you can read it.
2545 See also `file-exists-p' and `file-attributes'. */)
2546 (Lisp_Object filename
)
2548 Lisp_Object absname
;
2549 Lisp_Object handler
;
2551 CHECK_STRING (filename
);
2552 absname
= Fexpand_file_name (filename
, Qnil
);
2554 /* If the file name has special constructs in it,
2555 call the corresponding file handler. */
2556 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2557 if (!NILP (handler
))
2558 return call2 (handler
, Qfile_readable_p
, absname
);
2560 absname
= ENCODE_FILE (absname
);
2561 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2565 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2566 doc
: /* Return t if file FILENAME can be written or created by you. */)
2567 (Lisp_Object filename
)
2569 Lisp_Object absname
, dir
, encoded
;
2570 Lisp_Object handler
;
2572 CHECK_STRING (filename
);
2573 absname
= Fexpand_file_name (filename
, Qnil
);
2575 /* If the file name has special constructs in it,
2576 call the corresponding file handler. */
2577 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2578 if (!NILP (handler
))
2579 return call2 (handler
, Qfile_writable_p
, absname
);
2581 encoded
= ENCODE_FILE (absname
);
2582 if (check_writable (SSDATA (encoded
), W_OK
))
2584 if (errno
!= ENOENT
)
2587 dir
= Ffile_name_directory (absname
);
2588 eassert (!NILP (dir
));
2590 dir
= Fdirectory_file_name (dir
);
2593 dir
= ENCODE_FILE (dir
);
2595 /* The read-only attribute of the parent directory doesn't affect
2596 whether a file or directory can be created within it. Some day we
2597 should check ACLs though, which do affect this. */
2598 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2600 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2604 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2605 doc
: /* Access file FILENAME, and get an error if that does not work.
2606 The second argument STRING is used in the error message.
2607 If there is no error, returns nil. */)
2608 (Lisp_Object filename
, Lisp_Object string
)
2610 Lisp_Object handler
, encoded_filename
, absname
;
2612 CHECK_STRING (filename
);
2613 absname
= Fexpand_file_name (filename
, Qnil
);
2615 CHECK_STRING (string
);
2617 /* If the file name has special constructs in it,
2618 call the corresponding file handler. */
2619 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2620 if (!NILP (handler
))
2621 return call3 (handler
, Qaccess_file
, absname
, string
);
2623 encoded_filename
= ENCODE_FILE (absname
);
2625 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2626 report_file_error (SSDATA (string
), filename
);
2631 /* Relative to directory FD, return the symbolic link value of FILENAME.
2632 On failure, return nil. */
2634 emacs_readlinkat (int fd
, char const *filename
)
2636 static struct allocator
const emacs_norealloc_allocator
=
2637 { xmalloc
, NULL
, xfree
, memory_full
};
2639 char readlink_buf
[1024];
2640 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2641 &emacs_norealloc_allocator
, readlinkat
);
2645 val
= build_string (buf
);
2646 if (buf
[0] == '/' && strchr (buf
, ':'))
2647 val
= concat2 (build_string ("/:"), val
);
2648 if (buf
!= readlink_buf
)
2650 val
= DECODE_FILE (val
);
2654 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2655 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2656 The value is the link target, as a string.
2657 Otherwise it returns nil.
2659 This function returns t when given the name of a symlink that
2660 points to a nonexistent file. */)
2661 (Lisp_Object filename
)
2663 Lisp_Object handler
;
2665 CHECK_STRING (filename
);
2666 filename
= Fexpand_file_name (filename
, Qnil
);
2668 /* If the file name has special constructs in it,
2669 call the corresponding file handler. */
2670 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2671 if (!NILP (handler
))
2672 return call2 (handler
, Qfile_symlink_p
, filename
);
2674 filename
= ENCODE_FILE (filename
);
2676 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2679 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2680 doc
: /* Return t if FILENAME names an existing directory.
2681 Symbolic links to directories count as directories.
2682 See `file-symlink-p' to distinguish symlinks. */)
2683 (Lisp_Object filename
)
2685 Lisp_Object absname
;
2686 Lisp_Object handler
;
2688 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2690 /* If the file name has special constructs in it,
2691 call the corresponding file handler. */
2692 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2693 if (!NILP (handler
))
2694 return call2 (handler
, Qfile_directory_p
, absname
);
2696 absname
= ENCODE_FILE (absname
);
2698 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2701 /* Return true if FILE is a directory or a symlink to a directory. */
2703 file_directory_p (char const *file
)
2706 /* This is cheaper than 'stat'. */
2707 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2710 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2714 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2715 Sfile_accessible_directory_p
, 1, 1, 0,
2716 doc
: /* Return t if file FILENAME names a directory you can open.
2717 For the value to be t, FILENAME must specify the name of a directory as a file,
2718 and the directory must allow you to open files in it. In order to use a
2719 directory as a buffer's current directory, this predicate must return true.
2720 A directory name spec may be given instead; then the value is t
2721 if the directory so specified exists and really is a readable and
2722 searchable directory. */)
2723 (Lisp_Object filename
)
2725 Lisp_Object absname
;
2726 Lisp_Object handler
;
2728 CHECK_STRING (filename
);
2729 absname
= Fexpand_file_name (filename
, Qnil
);
2731 /* If the file name has special constructs in it,
2732 call the corresponding file handler. */
2733 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2734 if (!NILP (handler
))
2736 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2741 absname
= ENCODE_FILE (absname
);
2742 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2745 /* If FILE is a searchable directory or a symlink to a
2746 searchable directory, return true. Otherwise return
2747 false and set errno to an error number. */
2749 file_accessible_directory_p (char const *file
)
2752 /* There's no need to test whether FILE is searchable, as the
2753 searchable/executable bit is invented on DOS_NT platforms. */
2754 return file_directory_p (file
);
2756 /* On POSIXish platforms, use just one system call; this avoids a
2757 race and is typically faster. */
2758 ptrdiff_t len
= strlen (file
);
2764 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2765 There are three exceptions: "", "/", and "//". Leave "" alone,
2766 as it's invalid. Append only "." to the other two exceptions as
2767 "/" and "//" are distinct on some platforms, whereas "/", "///",
2768 "////", etc. are all equivalent. */
2773 /* Just check for trailing '/' when deciding whether to append '/'.
2774 That's simpler than testing the two special cases "/" and "//",
2775 and it's a safe optimization here. */
2776 char *buf
= SAFE_ALLOCA (len
+ 3);
2777 memcpy (buf
, file
, len
);
2778 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2782 ok
= check_existing (dir
);
2783 saved_errno
= errno
;
2785 errno
= saved_errno
;
2790 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2791 doc
: /* Return t if FILENAME names a regular file.
2792 This is the sort of file that holds an ordinary stream of data bytes.
2793 Symbolic links to regular files count as regular files.
2794 See `file-symlink-p' to distinguish symlinks. */)
2795 (Lisp_Object filename
)
2797 register Lisp_Object absname
;
2799 Lisp_Object handler
;
2801 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2803 /* If the file name has special constructs in it,
2804 call the corresponding file handler. */
2805 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2806 if (!NILP (handler
))
2807 return call2 (handler
, Qfile_regular_p
, absname
);
2809 absname
= ENCODE_FILE (absname
);
2814 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2816 /* Tell stat to use expensive method to get accurate info. */
2817 Vw32_get_true_file_attributes
= Qt
;
2818 result
= stat (SDATA (absname
), &st
);
2819 Vw32_get_true_file_attributes
= tem
;
2823 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2826 if (stat (SSDATA (absname
), &st
) < 0)
2828 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2832 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2833 Sfile_selinux_context
, 1, 1, 0,
2834 doc
: /* Return SELinux context of file named FILENAME.
2835 The return value is a list (USER ROLE TYPE RANGE), where the list
2836 elements are strings naming the user, role, type, and range of the
2837 file's SELinux security context.
2839 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2840 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2841 (Lisp_Object filename
)
2843 Lisp_Object absname
;
2844 Lisp_Object values
[4];
2845 Lisp_Object handler
;
2847 security_context_t con
;
2852 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2854 /* If the file name has special constructs in it,
2855 call the corresponding file handler. */
2856 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2857 if (!NILP (handler
))
2858 return call2 (handler
, Qfile_selinux_context
, absname
);
2860 absname
= ENCODE_FILE (absname
);
2867 if (is_selinux_enabled ())
2869 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2872 context
= context_new (con
);
2873 if (context_user_get (context
))
2874 values
[0] = build_string (context_user_get (context
));
2875 if (context_role_get (context
))
2876 values
[1] = build_string (context_role_get (context
));
2877 if (context_type_get (context
))
2878 values
[2] = build_string (context_type_get (context
));
2879 if (context_range_get (context
))
2880 values
[3] = build_string (context_range_get (context
));
2881 context_free (context
);
2887 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2890 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2891 Sset_file_selinux_context
, 2, 2, 0,
2892 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2893 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2894 elements are strings naming the components of a SELinux context.
2896 Value is t if setting of SELinux context was successful, nil otherwise.
2898 This function does nothing and returns nil if SELinux is disabled,
2899 or if Emacs was not compiled with SELinux support. */)
2900 (Lisp_Object filename
, Lisp_Object context
)
2902 Lisp_Object absname
;
2903 Lisp_Object handler
;
2905 Lisp_Object encoded_absname
;
2906 Lisp_Object user
= CAR_SAFE (context
);
2907 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2908 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2909 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2910 security_context_t con
;
2913 context_t parsed_con
;
2916 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2918 /* If the file name has special constructs in it,
2919 call the corresponding file handler. */
2920 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2921 if (!NILP (handler
))
2922 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2925 if (is_selinux_enabled ())
2927 /* Get current file context. */
2928 encoded_absname
= ENCODE_FILE (absname
);
2929 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2932 parsed_con
= context_new (con
);
2933 /* Change the parts defined in the parameter.*/
2936 if (context_user_set (parsed_con
, SSDATA (user
)))
2937 error ("Doing context_user_set");
2941 if (context_role_set (parsed_con
, SSDATA (role
)))
2942 error ("Doing context_role_set");
2946 if (context_type_set (parsed_con
, SSDATA (type
)))
2947 error ("Doing context_type_set");
2949 if (STRINGP (range
))
2951 if (context_range_set (parsed_con
, SSDATA (range
)))
2952 error ("Doing context_range_set");
2955 /* Set the modified context back to the file. */
2956 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2957 context_str (parsed_con
))
2959 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2960 if (fail
&& errno
!= ENOTSUP
)
2961 report_file_error ("Doing lsetfilecon", absname
);
2963 context_free (parsed_con
);
2965 return fail
? Qnil
: Qt
;
2968 report_file_error ("Doing lgetfilecon", absname
);
2975 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
2976 doc
: /* Return ACL entries of file named FILENAME.
2977 The entries are returned in a format suitable for use in `set-file-acl'
2978 but is otherwise undocumented and subject to change.
2979 Return nil if file does not exist or is not accessible, or if Emacs
2980 was unable to determine the ACL entries. */)
2981 (Lisp_Object filename
)
2983 Lisp_Object absname
;
2984 Lisp_Object handler
;
2985 #ifdef HAVE_ACL_SET_FILE
2987 Lisp_Object acl_string
;
2991 absname
= expand_and_dir_to_file (filename
,
2992 BVAR (current_buffer
, directory
));
2994 /* If the file name has special constructs in it,
2995 call the corresponding file handler. */
2996 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
2997 if (!NILP (handler
))
2998 return call2 (handler
, Qfile_acl
, absname
);
3000 #ifdef HAVE_ACL_SET_FILE
3001 absname
= ENCODE_FILE (absname
);
3003 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3007 str
= acl_to_text (acl
, NULL
);
3014 acl_string
= build_string (str
);
3024 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3026 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3027 ACL-STRING should contain the textual representation of the ACL
3028 entries in a format suitable for the platform.
3030 Value is t if setting of ACL was successful, nil otherwise.
3032 Setting ACL for local files requires Emacs to be built with ACL
3034 (Lisp_Object filename
, Lisp_Object acl_string
)
3036 Lisp_Object absname
;
3037 Lisp_Object handler
;
3038 #ifdef HAVE_ACL_SET_FILE
3039 Lisp_Object encoded_absname
;
3044 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3046 /* If the file name has special constructs in it,
3047 call the corresponding file handler. */
3048 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3049 if (!NILP (handler
))
3050 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3052 #ifdef HAVE_ACL_SET_FILE
3053 if (STRINGP (acl_string
))
3055 acl
= acl_from_text (SSDATA (acl_string
));
3058 report_file_error ("Converting ACL", absname
);
3062 encoded_absname
= ENCODE_FILE (absname
);
3064 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3067 if (fail
&& acl_errno_valid (errno
))
3068 report_file_error ("Setting ACL", absname
);
3071 return fail
? Qnil
: Qt
;
3078 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3079 doc
: /* Return mode bits of file named FILENAME, as an integer.
3080 Return nil, if file does not exist or is not accessible. */)
3081 (Lisp_Object filename
)
3083 Lisp_Object absname
;
3085 Lisp_Object handler
;
3087 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3089 /* If the file name has special constructs in it,
3090 call the corresponding file handler. */
3091 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3092 if (!NILP (handler
))
3093 return call2 (handler
, Qfile_modes
, absname
);
3095 absname
= ENCODE_FILE (absname
);
3097 if (stat (SSDATA (absname
), &st
) < 0)
3100 return make_number (st
.st_mode
& 07777);
3103 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3104 "(let ((file (read-file-name \"File: \"))) \
3105 (list file (read-file-modes nil file)))",
3106 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3107 Only the 12 low bits of MODE are used.
3109 Interactively, mode bits are read by `read-file-modes', which accepts
3110 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3111 (Lisp_Object filename
, Lisp_Object mode
)
3113 Lisp_Object absname
, encoded_absname
;
3114 Lisp_Object handler
;
3116 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3117 CHECK_NUMBER (mode
);
3119 /* If the file name has special constructs in it,
3120 call the corresponding file handler. */
3121 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3122 if (!NILP (handler
))
3123 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3125 encoded_absname
= ENCODE_FILE (absname
);
3127 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3128 report_file_error ("Doing chmod", absname
);
3133 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3134 doc
: /* Set the file permission bits for newly created files.
3135 The argument MODE should be an integer; only the low 9 bits are used.
3136 This setting is inherited by subprocesses. */)
3139 CHECK_NUMBER (mode
);
3141 umask ((~ XINT (mode
)) & 0777);
3146 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3147 doc
: /* Return the default file protection for created files.
3148 The value is an integer. */)
3155 realmask
= umask (0);
3159 XSETINT (value
, (~ realmask
) & 0777);
3164 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3165 doc
: /* Set times of file FILENAME to TIMESTAMP.
3166 Set both access and modification times.
3167 Return t on success, else nil.
3168 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3170 (Lisp_Object filename
, Lisp_Object timestamp
)
3172 Lisp_Object absname
, encoded_absname
;
3173 Lisp_Object handler
;
3174 struct timespec t
= lisp_time_argument (timestamp
);
3176 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3178 /* If the file name has special constructs in it,
3179 call the corresponding file handler. */
3180 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3181 if (!NILP (handler
))
3182 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3184 encoded_absname
= ENCODE_FILE (absname
);
3187 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3190 /* Setting times on a directory always fails. */
3191 if (file_directory_p (SSDATA (encoded_absname
)))
3194 report_file_error ("Setting file times", absname
);
3202 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3203 doc
: /* Tell Unix to finish all pending disk updates. */)
3210 #endif /* HAVE_SYNC */
3212 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3213 doc
: /* Return t if file FILE1 is newer than file FILE2.
3214 If FILE1 does not exist, the answer is nil;
3215 otherwise, if FILE2 does not exist, the answer is t. */)
3216 (Lisp_Object file1
, Lisp_Object file2
)
3218 Lisp_Object absname1
, absname2
;
3219 struct stat st1
, st2
;
3220 Lisp_Object handler
;
3221 struct gcpro gcpro1
, gcpro2
;
3223 CHECK_STRING (file1
);
3224 CHECK_STRING (file2
);
3227 GCPRO2 (absname1
, file2
);
3228 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3229 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3232 /* If the file name has special constructs in it,
3233 call the corresponding file handler. */
3234 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3236 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3237 if (!NILP (handler
))
3238 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3240 GCPRO2 (absname1
, absname2
);
3241 absname1
= ENCODE_FILE (absname1
);
3242 absname2
= ENCODE_FILE (absname2
);
3245 if (stat (SSDATA (absname1
), &st1
) < 0)
3248 if (stat (SSDATA (absname2
), &st2
) < 0)
3251 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3255 #ifndef READ_BUF_SIZE
3256 #define READ_BUF_SIZE (64 << 10)
3258 /* Some buffer offsets are stored in 'int' variables. */
3259 verify (READ_BUF_SIZE
<= INT_MAX
);
3261 /* This function is called after Lisp functions to decide a coding
3262 system are called, or when they cause an error. Before they are
3263 called, the current buffer is set unibyte and it contains only a
3264 newly inserted text (thus the buffer was empty before the
3267 The functions may set markers, overlays, text properties, or even
3268 alter the buffer contents, change the current buffer.
3270 Here, we reset all those changes by:
3271 o set back the current buffer.
3272 o move all markers and overlays to BEG.
3273 o remove all text properties.
3274 o set back the buffer multibyteness. */
3277 decide_coding_unwind (Lisp_Object unwind_data
)
3279 Lisp_Object multibyte
, undo_list
, buffer
;
3281 multibyte
= XCAR (unwind_data
);
3282 unwind_data
= XCDR (unwind_data
);
3283 undo_list
= XCAR (unwind_data
);
3284 buffer
= XCDR (unwind_data
);
3286 set_buffer_internal (XBUFFER (buffer
));
3287 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3288 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3289 set_buffer_intervals (current_buffer
, NULL
);
3290 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3292 /* Now we are safe to change the buffer's multibyteness directly. */
3293 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3294 bset_undo_list (current_buffer
, undo_list
);
3297 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3298 object where slot 0 is the file descriptor, slot 1 specifies
3299 an offset to put the read bytes, and slot 2 is the maximum
3300 amount of bytes to read. Value is the number of bytes read. */
3303 read_non_regular (Lisp_Object state
)
3309 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3310 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3311 + XSAVE_INTEGER (state
, 1)),
3312 XSAVE_INTEGER (state
, 2));
3314 /* Fast recycle this object for the likely next call. */
3316 return make_number (nbytes
);
3320 /* Condition-case handler used when reading from non-regular files
3321 in insert-file-contents. */
3324 read_non_regular_quit (Lisp_Object ignore
)
3329 /* Return the file offset that VAL represents, checking for type
3330 errors and overflow. */
3332 file_offset (Lisp_Object val
)
3334 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3339 double v
= XFLOAT_DATA (val
);
3341 && (sizeof (off_t
) < sizeof v
3342 ? v
<= TYPE_MAXIMUM (off_t
)
3343 : v
< TYPE_MAXIMUM (off_t
)))
3347 wrong_type_argument (intern ("file-offset"), val
);
3350 /* Return a special time value indicating the error number ERRNUM. */
3351 static struct timespec
3352 time_error_value (int errnum
)
3354 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3355 ? NONEXISTENT_MODTIME_NSECS
3356 : UNKNOWN_MODTIME_NSECS
);
3357 return make_timespec (0, ns
);
3360 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3362 doc
: /* Insert contents of file FILENAME after point.
3363 Returns list of absolute file name and number of characters inserted.
3364 If second argument VISIT is non-nil, the buffer's visited filename and
3365 last save file modtime are set, and it is marked unmodified. If
3366 visiting and the file does not exist, visiting is completed before the
3369 The optional third and fourth arguments BEG and END specify what portion
3370 of the file to insert. These arguments count bytes in the file, not
3371 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3373 If optional fifth argument REPLACE is non-nil, replace the current
3374 buffer contents (in the accessible portion) with the file contents.
3375 This is better than simply deleting and inserting the whole thing
3376 because (1) it preserves some marker positions and (2) it puts less data
3377 in the undo list. When REPLACE is non-nil, the second return value is
3378 the number of characters that replace previous buffer contents.
3380 This function does code conversion according to the value of
3381 `coding-system-for-read' or `file-coding-system-alist', and sets the
3382 variable `last-coding-system-used' to the coding system actually used.
3384 In addition, this function decodes the inserted text from known formats
3385 by calling `format-decode', which see. */)
3386 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3389 struct timespec mtime
;
3391 ptrdiff_t inserted
= 0;
3393 off_t beg_offset
, end_offset
;
3395 ptrdiff_t count
= SPECPDL_INDEX ();
3396 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3397 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3399 ptrdiff_t total
= 0;
3400 bool not_regular
= 0;
3402 char read_buf
[READ_BUF_SIZE
];
3403 struct coding_system coding
;
3404 bool replace_handled
= 0;
3405 bool set_coding_system
= 0;
3406 Lisp_Object coding_system
;
3408 /* If the undo log only contains the insertion, there's no point
3409 keeping it. It's typically when we first fill a file-buffer. */
3410 bool empty_undo_list_p
3411 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3413 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3414 bool we_locked_file
= 0;
3417 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3418 error ("Cannot do file visiting in an indirect buffer");
3420 if (!NILP (BVAR (current_buffer
, read_only
)))
3421 Fbarf_if_buffer_read_only ();
3425 orig_filename
= Qnil
;
3428 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3430 CHECK_STRING (filename
);
3431 filename
= Fexpand_file_name (filename
, Qnil
);
3433 /* The value Qnil means that the coding system is not yet
3435 coding_system
= Qnil
;
3437 /* If the file name has special constructs in it,
3438 call the corresponding file handler. */
3439 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3440 if (!NILP (handler
))
3442 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3443 visit
, beg
, end
, replace
);
3444 if (CONSP (val
) && CONSP (XCDR (val
))
3445 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3446 inserted
= XINT (XCAR (XCDR (val
)));
3450 orig_filename
= filename
;
3451 filename
= ENCODE_FILE (filename
);
3453 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3458 report_file_error ("Opening input file", orig_filename
);
3459 mtime
= time_error_value (save_errno
);
3461 if (!NILP (Vcoding_system_for_read
))
3462 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3466 fd_index
= SPECPDL_INDEX ();
3467 record_unwind_protect_int (close_file_unwind
, fd
);
3469 /* Replacement should preserve point as it preserves markers. */
3470 if (!NILP (replace
))
3471 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3473 if (fstat (fd
, &st
) != 0)
3474 report_file_error ("Input file status", orig_filename
);
3475 mtime
= get_stat_mtime (&st
);
3477 /* This code will need to be changed in order to work on named
3478 pipes, and it's probably just not worth it. So we should at
3479 least signal an error. */
3480 if (!S_ISREG (st
.st_mode
))
3487 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3488 xsignal2 (Qfile_error
,
3489 build_string ("not a regular file"), orig_filename
);
3494 if (!NILP (beg
) || !NILP (end
))
3495 error ("Attempt to visit less than an entire file");
3496 if (BEG
< Z
&& NILP (replace
))
3497 error ("Cannot do file visiting in a non-empty buffer");
3501 beg_offset
= file_offset (beg
);
3506 end_offset
= file_offset (end
);
3510 end_offset
= TYPE_MAXIMUM (off_t
);
3513 end_offset
= st
.st_size
;
3515 /* A negative size can happen on a platform that allows file
3516 sizes greater than the maximum off_t value. */
3520 /* The file size returned from stat may be zero, but data
3521 may be readable nonetheless, for example when this is a
3522 file in the /proc filesystem. */
3523 if (end_offset
== 0)
3524 end_offset
= READ_BUF_SIZE
;
3528 /* Check now whether the buffer will become too large,
3529 in the likely case where the file's length is not changing.
3530 This saves a lot of needless work before a buffer overflow. */
3533 /* The likely offset where we will stop reading. We could read
3534 more (or less), if the file grows (or shrinks) as we read it. */
3535 off_t likely_end
= min (end_offset
, st
.st_size
);
3537 if (beg_offset
< likely_end
)
3540 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3541 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3542 off_t likely_growth
= likely_end
- beg_offset
;
3543 if (buf_growth_max
< likely_growth
)
3548 /* Prevent redisplay optimizations. */
3549 current_buffer
->clip_changed
= 1;
3551 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3553 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3554 setup_coding_system (coding_system
, &coding
);
3555 /* Ensure we set Vlast_coding_system_used. */
3556 set_coding_system
= 1;
3560 /* Decide the coding system to use for reading the file now
3561 because we can't use an optimized method for handling
3562 `coding:' tag if the current buffer is not empty. */
3563 if (!NILP (Vcoding_system_for_read
))
3564 coding_system
= Vcoding_system_for_read
;
3567 /* Don't try looking inside a file for a coding system
3568 specification if it is not seekable. */
3569 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3571 /* Find a coding system specified in the heading two
3572 lines or in the tailing several lines of the file.
3573 We assume that the 1K-byte and 3K-byte for heading
3574 and tailing respectively are sufficient for this
3578 if (st
.st_size
<= (1024 * 4))
3579 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3582 nread
= emacs_read (fd
, read_buf
, 1024);
3586 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3587 report_file_error ("Setting file position",
3589 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3590 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3595 report_file_error ("Read error", orig_filename
);
3598 struct buffer
*prev
= current_buffer
;
3599 Lisp_Object workbuf
;
3602 record_unwind_current_buffer ();
3604 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3605 buf
= XBUFFER (workbuf
);
3607 delete_all_overlays (buf
);
3608 bset_directory (buf
, BVAR (current_buffer
, directory
));
3609 bset_read_only (buf
, Qnil
);
3610 bset_filename (buf
, Qnil
);
3611 bset_undo_list (buf
, Qt
);
3612 eassert (buf
->overlays_before
== NULL
);
3613 eassert (buf
->overlays_after
== NULL
);
3615 set_buffer_internal (buf
);
3617 bset_enable_multibyte_characters (buf
, Qnil
);
3619 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3620 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3621 coding_system
= call2 (Vset_auto_coding_function
,
3622 filename
, make_number (nread
));
3623 set_buffer_internal (prev
);
3625 /* Discard the unwind protect for recovering the
3629 /* Rewind the file for the actual read done later. */
3630 if (lseek (fd
, 0, SEEK_SET
) < 0)
3631 report_file_error ("Setting file position", orig_filename
);
3635 if (NILP (coding_system
))
3637 /* If we have not yet decided a coding system, check
3638 file-coding-system-alist. */
3639 Lisp_Object args
[6];
3641 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3642 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3643 coding_system
= Ffind_operation_coding_system (6, args
);
3644 if (CONSP (coding_system
))
3645 coding_system
= XCAR (coding_system
);
3649 if (NILP (coding_system
))
3650 coding_system
= Qundecided
;
3652 CHECK_CODING_SYSTEM (coding_system
);
3654 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3655 /* We must suppress all character code conversion except for
3656 end-of-line conversion. */
3657 coding_system
= raw_text_coding_system (coding_system
);
3659 setup_coding_system (coding_system
, &coding
);
3660 /* Ensure we set Vlast_coding_system_used. */
3661 set_coding_system
= 1;
3664 /* If requested, replace the accessible part of the buffer
3665 with the file contents. Avoid replacing text at the
3666 beginning or end of the buffer that matches the file contents;
3667 that preserves markers pointing to the unchanged parts.
3669 Here we implement this feature in an optimized way
3670 for the case where code conversion is NOT needed.
3671 The following if-statement handles the case of conversion
3672 in a less optimal way.
3674 If the code conversion is "automatic" then we try using this
3675 method and hope for the best.
3676 But if we discover the need for conversion, we give up on this method
3677 and let the following if-statement handle the replace job. */
3680 && (NILP (coding_system
)
3681 || ! CODING_REQUIRE_DECODING (&coding
)))
3683 /* same_at_start and same_at_end count bytes,
3684 because file access counts bytes
3685 and BEG and END count bytes. */
3686 ptrdiff_t same_at_start
= BEGV_BYTE
;
3687 ptrdiff_t same_at_end
= ZV_BYTE
;
3689 /* There is still a possibility we will find the need to do code
3690 conversion. If that happens, set this variable to
3691 give up on handling REPLACE in the optimized way. */
3692 bool giveup_match_end
= 0;
3694 if (beg_offset
!= 0)
3696 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3697 report_file_error ("Setting file position", orig_filename
);
3702 /* Count how many chars at the start of the file
3703 match the text at the beginning of the buffer. */
3708 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3710 report_file_error ("Read error", orig_filename
);
3711 else if (nread
== 0)
3714 if (CODING_REQUIRE_DETECTION (&coding
))
3716 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3719 setup_coding_system (coding_system
, &coding
);
3722 if (CODING_REQUIRE_DECODING (&coding
))
3723 /* We found that the file should be decoded somehow.
3724 Let's give up here. */
3726 giveup_match_end
= 1;
3731 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3732 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3733 same_at_start
++, bufpos
++;
3734 /* If we found a discrepancy, stop the scan.
3735 Otherwise loop around and scan the next bufferful. */
3736 if (bufpos
!= nread
)
3740 /* If the file matches the buffer completely,
3741 there's no need to replace anything. */
3742 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3745 clear_unwind_protect (fd_index
);
3747 /* Truncate the buffer to the size of the file. */
3748 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3753 /* Count how many chars at the end of the file
3754 match the text at the end of the buffer. But, if we have
3755 already found that decoding is necessary, don't waste time. */
3756 while (!giveup_match_end
)
3758 int total_read
, nread
, bufpos
, trial
;
3761 /* At what file position are we now scanning? */
3762 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3763 /* If the entire file matches the buffer tail, stop the scan. */
3766 /* How much can we scan in the next step? */
3767 trial
= min (curpos
, sizeof read_buf
);
3768 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3769 report_file_error ("Setting file position", orig_filename
);
3771 total_read
= nread
= 0;
3772 while (total_read
< trial
)
3774 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3776 report_file_error ("Read error", orig_filename
);
3777 else if (nread
== 0)
3779 total_read
+= nread
;
3782 /* Scan this bufferful from the end, comparing with
3783 the Emacs buffer. */
3784 bufpos
= total_read
;
3786 /* Compare with same_at_start to avoid counting some buffer text
3787 as matching both at the file's beginning and at the end. */
3788 while (bufpos
> 0 && same_at_end
> same_at_start
3789 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3790 same_at_end
--, bufpos
--;
3792 /* If we found a discrepancy, stop the scan.
3793 Otherwise loop around and scan the preceding bufferful. */
3796 /* If this discrepancy is because of code conversion,
3797 we cannot use this method; giveup and try the other. */
3798 if (same_at_end
> same_at_start
3799 && FETCH_BYTE (same_at_end
- 1) >= 0200
3800 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3801 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3802 giveup_match_end
= 1;
3811 if (! giveup_match_end
)
3815 /* We win! We can handle REPLACE the optimized way. */
3817 /* Extend the start of non-matching text area to multibyte
3818 character boundary. */
3819 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3820 while (same_at_start
> BEGV_BYTE
3821 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3824 /* Extend the end of non-matching text area to multibyte
3825 character boundary. */
3826 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3827 while (same_at_end
< ZV_BYTE
3828 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3831 /* Don't try to reuse the same piece of text twice. */
3832 overlap
= (same_at_start
- BEGV_BYTE
3834 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3836 same_at_end
+= overlap
;
3838 /* Arrange to read only the nonmatching middle part of the file. */
3839 beg_offset
+= same_at_start
- BEGV_BYTE
;
3840 end_offset
-= ZV_BYTE
- same_at_end
;
3842 del_range_byte (same_at_start
, same_at_end
, 0);
3843 /* Insert from the file at the proper position. */
3844 temp
= BYTE_TO_CHAR (same_at_start
);
3845 SET_PT_BOTH (temp
, same_at_start
);
3847 /* If display currently starts at beginning of line,
3848 keep it that way. */
3849 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3850 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3852 replace_handled
= 1;
3856 /* If requested, replace the accessible part of the buffer
3857 with the file contents. Avoid replacing text at the
3858 beginning or end of the buffer that matches the file contents;
3859 that preserves markers pointing to the unchanged parts.
3861 Here we implement this feature for the case where code conversion
3862 is needed, in a simple way that needs a lot of memory.
3863 The preceding if-statement handles the case of no conversion
3864 in a more optimized way. */
3865 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3867 ptrdiff_t same_at_start
= BEGV_BYTE
;
3868 ptrdiff_t same_at_end
= ZV_BYTE
;
3869 ptrdiff_t same_at_start_charpos
;
3870 ptrdiff_t inserted_chars
;
3873 unsigned char *decoded
;
3876 ptrdiff_t this_count
= SPECPDL_INDEX ();
3878 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3879 Lisp_Object conversion_buffer
;
3880 struct gcpro gcpro1
;
3882 conversion_buffer
= code_conversion_save (1, multibyte
);
3884 /* First read the whole file, performing code conversion into
3885 CONVERSION_BUFFER. */
3887 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3888 report_file_error ("Setting file position", orig_filename
);
3890 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3891 unprocessed
= 0; /* Bytes not processed in previous loop. */
3893 GCPRO1 (conversion_buffer
);
3896 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3897 quitting while reading a huge file. */
3899 /* Allow quitting out of the actual I/O. */
3902 this = emacs_read (fd
, read_buf
+ unprocessed
,
3903 READ_BUF_SIZE
- unprocessed
);
3909 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3910 BUF_Z (XBUFFER (conversion_buffer
)));
3911 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3912 unprocessed
+ this, conversion_buffer
);
3913 unprocessed
= coding
.carryover_bytes
;
3914 if (coding
.carryover_bytes
> 0)
3915 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3919 report_file_error ("Read error", orig_filename
);
3921 clear_unwind_protect (fd_index
);
3923 if (unprocessed
> 0)
3925 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3926 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3927 unprocessed
, conversion_buffer
);
3928 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3931 coding_system
= CODING_ID_NAME (coding
.id
);
3932 set_coding_system
= 1;
3933 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3934 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3935 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3937 /* Compare the beginning of the converted string with the buffer
3941 while (bufpos
< inserted
&& same_at_start
< same_at_end
3942 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3943 same_at_start
++, bufpos
++;
3945 /* If the file matches the head of buffer completely,
3946 there's no need to replace anything. */
3948 if (bufpos
== inserted
)
3950 /* Truncate the buffer to the size of the file. */
3951 if (same_at_start
!= same_at_end
)
3952 del_range_byte (same_at_start
, same_at_end
, 0);
3955 unbind_to (this_count
, Qnil
);
3959 /* Extend the start of non-matching text area to the previous
3960 multibyte character boundary. */
3961 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3962 while (same_at_start
> BEGV_BYTE
3963 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3966 /* Scan this bufferful from the end, comparing with
3967 the Emacs buffer. */
3970 /* Compare with same_at_start to avoid counting some buffer text
3971 as matching both at the file's beginning and at the end. */
3972 while (bufpos
> 0 && same_at_end
> same_at_start
3973 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3974 same_at_end
--, bufpos
--;
3976 /* Extend the end of non-matching text area to the next
3977 multibyte character boundary. */
3978 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3979 while (same_at_end
< ZV_BYTE
3980 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3983 /* Don't try to reuse the same piece of text twice. */
3984 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3986 same_at_end
+= overlap
;
3988 /* If display currently starts at beginning of line,
3989 keep it that way. */
3990 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3991 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3993 /* Replace the chars that we need to replace,
3994 and update INSERTED to equal the number of bytes
3995 we are taking from the decoded string. */
3996 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3998 if (same_at_end
!= same_at_start
)
4000 del_range_byte (same_at_start
, same_at_end
, 0);
4002 eassert (same_at_start
== GPT_BYTE
);
4003 same_at_start
= GPT_BYTE
;
4007 temp
= BYTE_TO_CHAR (same_at_start
);
4009 /* Insert from the file at the proper position. */
4010 SET_PT_BOTH (temp
, same_at_start
);
4011 same_at_start_charpos
4012 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4013 same_at_start
- BEGV_BYTE
4014 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4015 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4017 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4018 same_at_start
+ inserted
- BEGV_BYTE
4019 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4020 - same_at_start_charpos
);
4021 /* This binding is to avoid ask-user-about-supersession-threat
4022 being called in insert_from_buffer (via in
4023 prepare_to_modify_buffer). */
4024 specbind (intern ("buffer-file-name"), Qnil
);
4025 insert_from_buffer (XBUFFER (conversion_buffer
),
4026 same_at_start_charpos
, inserted_chars
, 0);
4027 /* Set `inserted' to the number of inserted characters. */
4028 inserted
= PT
- temp
;
4029 /* Set point before the inserted characters. */
4030 SET_PT_BOTH (temp
, same_at_start
);
4032 unbind_to (this_count
, Qnil
);
4038 total
= end_offset
- beg_offset
;
4040 /* For a special file, all we can do is guess. */
4041 total
= READ_BUF_SIZE
;
4043 if (NILP (visit
) && total
> 0)
4045 #ifdef CLASH_DETECTION
4046 if (!NILP (BVAR (current_buffer
, file_truename
))
4047 /* Make binding buffer-file-name to nil effective. */
4048 && !NILP (BVAR (current_buffer
, filename
))
4049 && SAVE_MODIFF
>= MODIFF
)
4051 #endif /* CLASH_DETECTION */
4052 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4055 move_gap_both (PT
, PT_BYTE
);
4056 if (GAP_SIZE
< total
)
4057 make_gap (total
- GAP_SIZE
);
4059 if (beg_offset
!= 0 || !NILP (replace
))
4061 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4062 report_file_error ("Setting file position", orig_filename
);
4065 /* In the following loop, HOW_MUCH contains the total bytes read so
4066 far for a regular file, and not changed for a special file. But,
4067 before exiting the loop, it is set to a negative value if I/O
4071 /* Total bytes inserted. */
4074 /* Here, we don't do code conversion in the loop. It is done by
4075 decode_coding_gap after all data are read into the buffer. */
4077 ptrdiff_t gap_size
= GAP_SIZE
;
4079 while (how_much
< total
)
4081 /* try is reserved in some compilers (Microsoft C) */
4082 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4089 /* Maybe make more room. */
4090 if (gap_size
< trytry
)
4092 make_gap (trytry
- gap_size
);
4093 gap_size
= GAP_SIZE
- inserted
;
4096 /* Read from the file, capturing `quit'. When an
4097 error occurs, end the loop, and arrange for a quit
4098 to be signaled after decoding the text we read. */
4099 nbytes
= internal_condition_case_1
4101 make_save_int_int_int (fd
, inserted
, trytry
),
4102 Qerror
, read_non_regular_quit
);
4110 this = XINT (nbytes
);
4114 /* Allow quitting out of the actual I/O. We don't make text
4115 part of the buffer until all the reading is done, so a C-g
4116 here doesn't do any harm. */
4119 this = emacs_read (fd
,
4120 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4134 /* For a regular file, where TOTAL is the real size,
4135 count HOW_MUCH to compare with it.
4136 For a special file, where TOTAL is just a buffer size,
4137 so don't bother counting in HOW_MUCH.
4138 (INSERTED is where we count the number of characters inserted.) */
4145 /* Now we have either read all the file data into the gap,
4146 or stop reading on I/O error or quit. If nothing was
4147 read, undo marking the buffer modified. */
4151 #ifdef CLASH_DETECTION
4153 unlock_file (BVAR (current_buffer
, file_truename
));
4155 Vdeactivate_mark
= old_Vdeactivate_mark
;
4158 Vdeactivate_mark
= Qt
;
4161 clear_unwind_protect (fd_index
);
4164 report_file_error ("Read error", orig_filename
);
4166 /* Make the text read part of the buffer. */
4167 GAP_SIZE
-= inserted
;
4169 GPT_BYTE
+= inserted
;
4171 ZV_BYTE
+= inserted
;
4176 /* Put an anchor to ensure multi-byte form ends at gap. */
4181 if (NILP (coding_system
))
4183 /* The coding system is not yet decided. Decide it by an
4184 optimized method for handling `coding:' tag.
4186 Note that we can get here only if the buffer was empty
4187 before the insertion. */
4189 if (!NILP (Vcoding_system_for_read
))
4190 coding_system
= Vcoding_system_for_read
;
4193 /* Since we are sure that the current buffer was empty
4194 before the insertion, we can toggle
4195 enable-multibyte-characters directly here without taking
4196 care of marker adjustment. By this way, we can run Lisp
4197 program safely before decoding the inserted text. */
4198 Lisp_Object unwind_data
;
4199 ptrdiff_t count1
= SPECPDL_INDEX ();
4201 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4202 Fcons (BVAR (current_buffer
, undo_list
),
4203 Fcurrent_buffer ()));
4204 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4205 bset_undo_list (current_buffer
, Qt
);
4206 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4208 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4210 coding_system
= call2 (Vset_auto_coding_function
,
4211 filename
, make_number (inserted
));
4214 if (NILP (coding_system
))
4216 /* If the coding system is not yet decided, check
4217 file-coding-system-alist. */
4218 Lisp_Object args
[6];
4220 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4221 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4222 coding_system
= Ffind_operation_coding_system (6, args
);
4223 if (CONSP (coding_system
))
4224 coding_system
= XCAR (coding_system
);
4226 unbind_to (count1
, Qnil
);
4227 inserted
= Z_BYTE
- BEG_BYTE
;
4230 if (NILP (coding_system
))
4231 coding_system
= Qundecided
;
4233 CHECK_CODING_SYSTEM (coding_system
);
4235 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4236 /* We must suppress all character code conversion except for
4237 end-of-line conversion. */
4238 coding_system
= raw_text_coding_system (coding_system
);
4239 setup_coding_system (coding_system
, &coding
);
4240 /* Ensure we set Vlast_coding_system_used. */
4241 set_coding_system
= 1;
4246 /* When we visit a file by raw-text, we change the buffer to
4248 if (CODING_FOR_UNIBYTE (&coding
)
4249 /* Can't do this if part of the buffer might be preserved. */
4251 /* Visiting a file with these coding system makes the buffer
4253 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4256 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4257 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4258 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4260 move_gap_both (PT
, PT_BYTE
);
4261 GAP_SIZE
+= inserted
;
4262 ZV_BYTE
-= inserted
;
4266 decode_coding_gap (&coding
, inserted
, inserted
);
4267 inserted
= coding
.produced_char
;
4268 coding_system
= CODING_ID_NAME (coding
.id
);
4270 else if (inserted
> 0)
4271 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4274 /* Call after-change hooks for the inserted text, aside from the case
4275 of normal visiting (not with REPLACE), which is done in a new buffer
4276 "before" the buffer is changed. */
4277 if (inserted
> 0 && total
> 0
4278 && (NILP (visit
) || !NILP (replace
)))
4280 signal_after_change (PT
, 0, inserted
);
4281 update_compositions (PT
, PT
, CHECK_BORDER
);
4284 /* Now INSERTED is measured in characters. */
4290 if (empty_undo_list_p
)
4291 bset_undo_list (current_buffer
, Qnil
);
4295 current_buffer
->modtime
= mtime
;
4296 current_buffer
->modtime_size
= st
.st_size
;
4297 bset_filename (current_buffer
, orig_filename
);
4300 SAVE_MODIFF
= MODIFF
;
4301 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4302 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4303 #ifdef CLASH_DETECTION
4306 if (!NILP (BVAR (current_buffer
, file_truename
)))
4307 unlock_file (BVAR (current_buffer
, file_truename
));
4308 unlock_file (filename
);
4310 #endif /* CLASH_DETECTION */
4312 xsignal2 (Qfile_error
,
4313 build_string ("not a regular file"), orig_filename
);
4316 if (set_coding_system
)
4317 Vlast_coding_system_used
= coding_system
;
4319 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4321 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4323 if (! NILP (insval
))
4325 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4326 wrong_type_argument (intern ("inserted-chars"), insval
);
4327 inserted
= XFASTINT (insval
);
4331 /* Decode file format. */
4334 /* Don't run point motion or modification hooks when decoding. */
4335 ptrdiff_t count1
= SPECPDL_INDEX ();
4336 ptrdiff_t old_inserted
= inserted
;
4337 specbind (Qinhibit_point_motion_hooks
, Qt
);
4338 specbind (Qinhibit_modification_hooks
, Qt
);
4340 /* Save old undo list and don't record undo for decoding. */
4341 old_undo
= BVAR (current_buffer
, undo_list
);
4342 bset_undo_list (current_buffer
, Qt
);
4346 insval
= call3 (Qformat_decode
,
4347 Qnil
, make_number (inserted
), visit
);
4348 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4349 wrong_type_argument (intern ("inserted-chars"), insval
);
4350 inserted
= XFASTINT (insval
);
4354 /* If REPLACE is non-nil and we succeeded in not replacing the
4355 beginning or end of the buffer text with the file's contents,
4356 call format-decode with `point' positioned at the beginning
4357 of the buffer and `inserted' equaling the number of
4358 characters in the buffer. Otherwise, format-decode might
4359 fail to correctly analyze the beginning or end of the buffer.
4360 Hence we temporarily save `point' and `inserted' here and
4361 restore `point' iff format-decode did not insert or delete
4362 any text. Otherwise we leave `point' at point-min. */
4363 ptrdiff_t opoint
= PT
;
4364 ptrdiff_t opoint_byte
= PT_BYTE
;
4365 ptrdiff_t oinserted
= ZV
- BEGV
;
4366 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4368 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4369 insval
= call3 (Qformat_decode
,
4370 Qnil
, make_number (oinserted
), visit
);
4371 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4372 wrong_type_argument (intern ("inserted-chars"), insval
);
4373 if (ochars_modiff
== CHARS_MODIFF
)
4374 /* format_decode didn't modify buffer's characters => move
4375 point back to position before inserted text and leave
4376 value of inserted alone. */
4377 SET_PT_BOTH (opoint
, opoint_byte
);
4379 /* format_decode modified buffer's characters => consider
4380 entire buffer changed and leave point at point-min. */
4381 inserted
= XFASTINT (insval
);
4384 /* For consistency with format-decode call these now iff inserted > 0
4385 (martin 2007-06-28). */
4386 p
= Vafter_insert_file_functions
;
4391 insval
= call1 (XCAR (p
), make_number (inserted
));
4394 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4395 wrong_type_argument (intern ("inserted-chars"), insval
);
4396 inserted
= XFASTINT (insval
);
4401 /* For the rationale of this see the comment on
4402 format-decode above. */
4403 ptrdiff_t opoint
= PT
;
4404 ptrdiff_t opoint_byte
= PT_BYTE
;
4405 ptrdiff_t oinserted
= ZV
- BEGV
;
4406 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4408 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4409 insval
= call1 (XCAR (p
), make_number (oinserted
));
4412 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4413 wrong_type_argument (intern ("inserted-chars"), insval
);
4414 if (ochars_modiff
== CHARS_MODIFF
)
4415 /* after_insert_file_functions didn't modify
4416 buffer's characters => move point back to
4417 position before inserted text and leave value of
4419 SET_PT_BOTH (opoint
, opoint_byte
);
4421 /* after_insert_file_functions did modify buffer's
4422 characters => consider entire buffer changed and
4423 leave point at point-min. */
4424 inserted
= XFASTINT (insval
);
4432 if (!empty_undo_list_p
)
4434 bset_undo_list (current_buffer
, old_undo
);
4435 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4437 /* Adjust the last undo record for the size change during
4438 the format conversion. */
4439 Lisp_Object tem
= XCAR (old_undo
);
4440 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4441 && INTEGERP (XCDR (tem
))
4442 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4443 XSETCDR (tem
, make_number (PT
+ inserted
));
4447 /* If undo_list was Qt before, keep it that way.
4448 Otherwise start with an empty undo_list. */
4449 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4451 unbind_to (count1
, Qnil
);
4455 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4457 /* If visiting nonexistent file, return nil. */
4458 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4462 Fsignal (Qquit
, Qnil
);
4464 /* Retval needs to be dealt with in all cases consistently. */
4466 val
= list2 (orig_filename
, make_number (inserted
));
4468 RETURN_UNGCPRO (unbind_to (count
, val
));
4471 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4474 build_annotations_unwind (Lisp_Object arg
)
4476 Vwrite_region_annotation_buffers
= arg
;
4479 /* Decide the coding-system to encode the data with. */
4481 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4482 Schoose_write_coding_system
, 3, 6, 0,
4483 doc
: /* Choose the coding system for writing a file.
4484 Arguments are as for `write-region'.
4485 This function is for internal use only. It may prompt the user. */ )
4486 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4487 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4490 Lisp_Object eol_parent
= Qnil
;
4492 /* Mimic write-region behavior. */
4495 XSETFASTINT (start
, BEGV
);
4496 XSETFASTINT (end
, ZV
);
4500 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4501 BVAR (current_buffer
, auto_save_file_name
))))
4506 else if (!NILP (Vcoding_system_for_write
))
4508 val
= Vcoding_system_for_write
;
4509 if (coding_system_require_warning
4510 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4511 /* Confirm that VAL can surely encode the current region. */
4512 val
= call5 (Vselect_safe_coding_system_function
,
4513 start
, end
, list2 (Qt
, val
),
4518 /* If the variable `buffer-file-coding-system' is set locally,
4519 it means that the file was read with some kind of code
4520 conversion or the variable is explicitly set by users. We
4521 had better write it out with the same coding system even if
4522 `enable-multibyte-characters' is nil.
4524 If it is not set locally, we anyway have to convert EOL
4525 format if the default value of `buffer-file-coding-system'
4526 tells that it is not Unix-like (LF only) format. */
4527 bool using_default_coding
= 0;
4528 bool force_raw_text
= 0;
4530 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4532 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4535 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4541 /* Check file-coding-system-alist. */
4542 Lisp_Object args
[7], coding_systems
;
4544 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4545 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4547 coding_systems
= Ffind_operation_coding_system (7, args
);
4548 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4549 val
= XCDR (coding_systems
);
4554 /* If we still have not decided a coding system, use the
4555 default value of buffer-file-coding-system. */
4556 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4557 using_default_coding
= 1;
4560 if (! NILP (val
) && ! force_raw_text
)
4562 Lisp_Object spec
, attrs
;
4564 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4565 attrs
= AREF (spec
, 0);
4566 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4571 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4572 /* Confirm that VAL can surely encode the current region. */
4573 val
= call5 (Vselect_safe_coding_system_function
,
4574 start
, end
, val
, Qnil
, filename
);
4576 /* If the decided coding-system doesn't specify end-of-line
4577 format, we use that of
4578 `default-buffer-file-coding-system'. */
4579 if (! using_default_coding
4580 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4581 val
= (coding_inherit_eol_type
4582 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4584 /* If we decide not to encode text, use `raw-text' or one of its
4587 val
= raw_text_coding_system (val
);
4590 val
= coding_inherit_eol_type (val
, eol_parent
);
4594 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4595 "r\nFWrite region to file: \ni\ni\ni\np",
4596 doc
: /* Write current region into specified file.
4597 When called from a program, requires three arguments:
4598 START, END and FILENAME. START and END are normally buffer positions
4599 specifying the part of the buffer to write.
4600 If START is nil, that means to use the entire buffer contents.
4601 If START is a string, then output that string to the file
4602 instead of any buffer contents; END is ignored.
4604 Optional fourth argument APPEND if non-nil means
4605 append to existing file contents (if any). If it is a number,
4606 seek to that offset in the file before writing.
4607 Optional fifth argument VISIT, if t or a string, means
4608 set the last-save-file-modtime of buffer to this file's modtime
4609 and mark buffer not modified.
4610 If VISIT is a string, it is a second file name;
4611 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4612 VISIT is also the file name to lock and unlock for clash detection.
4613 If VISIT is neither t nor nil nor a string,
4614 that means do not display the \"Wrote file\" message.
4615 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4616 use for locking and unlocking, overriding FILENAME and VISIT.
4617 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4618 for an existing file with the same name. If MUSTBENEW is `excl',
4619 that means to get an error if the file already exists; never overwrite.
4620 If MUSTBENEW is neither nil nor `excl', that means ask for
4621 confirmation before overwriting, but do go ahead and overwrite the file
4622 if the user confirms.
4624 This does code conversion according to the value of
4625 `coding-system-for-write', `buffer-file-coding-system', or
4626 `file-coding-system-alist', and sets the variable
4627 `last-coding-system-used' to the coding system actually used.
4629 This calls `write-region-annotate-functions' at the start, and
4630 `write-region-post-annotation-function' at the end. */)
4631 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4632 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4634 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4638 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4639 descriptor for FILENAME, so do not open or close FILENAME. */
4642 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4643 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4644 Lisp_Object mustbenew
, int desc
)
4648 off_t offset
IF_LINT (= 0);
4649 bool open_and_close_file
= desc
< 0;
4654 struct timespec modtime
;
4655 ptrdiff_t count
= SPECPDL_INDEX ();
4656 ptrdiff_t count1
IF_LINT (= 0);
4657 Lisp_Object handler
;
4658 Lisp_Object visit_file
;
4659 Lisp_Object annotations
;
4660 Lisp_Object encoded_filename
;
4661 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4662 bool quietly
= !NILP (visit
);
4663 bool file_locked
= 0;
4664 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4665 struct buffer
*given_buffer
;
4666 struct coding_system coding
;
4668 if (current_buffer
->base_buffer
&& visiting
)
4669 error ("Cannot do file visiting in an indirect buffer");
4671 if (!NILP (start
) && !STRINGP (start
))
4672 validate_region (&start
, &end
);
4675 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4677 filename
= Fexpand_file_name (filename
, Qnil
);
4679 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4680 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4682 if (STRINGP (visit
))
4683 visit_file
= Fexpand_file_name (visit
, Qnil
);
4685 visit_file
= filename
;
4687 if (NILP (lockname
))
4688 lockname
= visit_file
;
4692 /* If the file name has special constructs in it,
4693 call the corresponding file handler. */
4694 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4695 /* If FILENAME has no handler, see if VISIT has one. */
4696 if (NILP (handler
) && STRINGP (visit
))
4697 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4699 if (!NILP (handler
))
4702 val
= call6 (handler
, Qwrite_region
, start
, end
,
4703 filename
, append
, visit
);
4707 SAVE_MODIFF
= MODIFF
;
4708 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4709 bset_filename (current_buffer
, visit_file
);
4715 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4717 /* Special kludge to simplify auto-saving. */
4720 /* Do it later, so write-region-annotate-function can work differently
4721 if we save "the buffer" vs "a region".
4722 This is useful in tar-mode. --Stef
4723 XSETFASTINT (start, BEG);
4724 XSETFASTINT (end, Z); */
4728 record_unwind_protect (build_annotations_unwind
,
4729 Vwrite_region_annotation_buffers
);
4730 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4732 given_buffer
= current_buffer
;
4734 if (!STRINGP (start
))
4736 annotations
= build_annotations (start
, end
);
4738 if (current_buffer
!= given_buffer
)
4740 XSETFASTINT (start
, BEGV
);
4741 XSETFASTINT (end
, ZV
);
4747 XSETFASTINT (start
, BEGV
);
4748 XSETFASTINT (end
, ZV
);
4753 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4755 /* Decide the coding-system to encode the data with.
4756 We used to make this choice before calling build_annotations, but that
4757 leads to problems when a write-annotate-function takes care of
4758 unsavable chars (as was the case with X-Symbol). */
4759 Vlast_coding_system_used
=
4760 Fchoose_write_coding_system (start
, end
, filename
,
4761 append
, visit
, lockname
);
4763 setup_coding_system (Vlast_coding_system_used
, &coding
);
4765 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4766 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4768 #ifdef CLASH_DETECTION
4769 if (open_and_close_file
&& !auto_saving
)
4771 lock_file (lockname
);
4774 #endif /* CLASH_DETECTION */
4776 encoded_filename
= ENCODE_FILE (filename
);
4777 fn
= SSDATA (encoded_filename
);
4778 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4779 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4780 if (NUMBERP (append
))
4781 offset
= file_offset (append
);
4782 else if (!NILP (append
))
4783 open_flags
|= O_APPEND
;
4785 mode
= S_IREAD
| S_IWRITE
;
4787 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4790 if (open_and_close_file
)
4792 desc
= emacs_open (fn
, open_flags
, mode
);
4795 int open_errno
= errno
;
4796 #ifdef CLASH_DETECTION
4798 unlock_file (lockname
);
4799 #endif /* CLASH_DETECTION */
4801 report_file_errno ("Opening output file", filename
, open_errno
);
4804 count1
= SPECPDL_INDEX ();
4805 record_unwind_protect_int (close_file_unwind
, desc
);
4808 if (NUMBERP (append
))
4810 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4813 int lseek_errno
= errno
;
4814 #ifdef CLASH_DETECTION
4816 unlock_file (lockname
);
4817 #endif /* CLASH_DETECTION */
4819 report_file_errno ("Lseek error", filename
, lseek_errno
);
4827 if (STRINGP (start
))
4828 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4829 else if (XINT (start
) != XINT (end
))
4830 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4831 &annotations
, &coding
);
4834 /* If file was empty, still need to write the annotations. */
4835 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4836 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4840 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4841 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4843 /* We have to flush out a data. */
4844 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4845 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4851 /* fsync is not crucial for temporary files. Nor for auto-save
4852 files, since they might lose some work anyway. */
4853 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4855 /* Transfer data and metadata to disk, retrying if interrupted.
4856 fsync can report a write failure here, e.g., due to disk full
4857 under NFS. But ignore EINVAL, which means fsync is not
4858 supported on this file. */
4859 while (fsync (desc
) != 0)
4862 if (errno
!= EINVAL
)
4863 ok
= 0, save_errno
= errno
;
4868 modtime
= invalid_timespec ();
4871 if (fstat (desc
, &st
) == 0)
4872 modtime
= get_stat_mtime (&st
);
4874 ok
= 0, save_errno
= errno
;
4877 if (open_and_close_file
)
4879 /* NFS can report a write failure now. */
4880 if (emacs_close (desc
) < 0)
4881 ok
= 0, save_errno
= errno
;
4883 /* Discard the unwind protect for close_file_unwind. */
4884 specpdl_ptr
= specpdl
+ count1
;
4887 /* Some file systems have a bug where st_mtime is not updated
4888 properly after a write. For example, CIFS might not see the
4889 st_mtime change until after the file is opened again.
4891 Attempt to detect this file system bug, and update MODTIME to the
4892 newer st_mtime if the bug appears to be present. This introduces
4893 a race condition, so to avoid most instances of the race condition
4894 on non-buggy file systems, skip this check if the most recently
4895 encountered non-buggy file system was the current file system.
4897 A race condition can occur if some other process modifies the
4898 file between the fstat above and the fstat below, but the race is
4899 unlikely and a similar race between the last write and the fstat
4900 above cannot possibly be closed anyway. */
4902 if (timespec_valid_p (modtime
)
4903 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4905 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4909 if (fstat (desc1
, &st1
) == 0
4910 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4912 /* Use the heuristic if it appears to be valid. With neither
4913 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4914 file, the time stamp won't change. Also, some non-POSIX
4915 systems don't update an empty file's time stamp when
4916 truncating it. Finally, file systems with 100 ns or worse
4917 resolution sometimes seem to have bugs: on a system with ns
4918 resolution, checking ns % 100 incorrectly avoids the heuristic
4919 1% of the time, but the problem should be temporary as we will
4920 try again on the next time stamp. */
4922 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4924 && modtime
.tv_nsec
% 100 != 0);
4926 struct timespec modtime1
= get_stat_mtime (&st1
);
4928 && timespec_cmp (modtime
, modtime1
) == 0
4929 && st
.st_size
== st1
.st_size
)
4931 timestamp_file_system
= st
.st_dev
;
4932 valid_timestamp_file_system
= 1;
4936 st
.st_size
= st1
.st_size
;
4940 emacs_close (desc1
);
4944 /* Call write-region-post-annotation-function. */
4945 while (CONSP (Vwrite_region_annotation_buffers
))
4947 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4948 if (!NILP (Fbuffer_live_p (buf
)))
4951 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4952 call0 (Vwrite_region_post_annotation_function
);
4954 Vwrite_region_annotation_buffers
4955 = XCDR (Vwrite_region_annotation_buffers
);
4958 unbind_to (count
, Qnil
);
4960 #ifdef CLASH_DETECTION
4962 unlock_file (lockname
);
4963 #endif /* CLASH_DETECTION */
4965 /* Do this before reporting IO error
4966 to avoid a "file has changed on disk" warning on
4967 next attempt to save. */
4968 if (timespec_valid_p (modtime
))
4970 current_buffer
->modtime
= modtime
;
4971 current_buffer
->modtime_size
= st
.st_size
;
4975 report_file_errno ("Write error", filename
, save_errno
);
4979 SAVE_MODIFF
= MODIFF
;
4980 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4981 bset_filename (current_buffer
, visit_file
);
4982 update_mode_lines
++;
4987 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4988 BVAR (current_buffer
, auto_save_file_name
))))
4989 SAVE_MODIFF
= MODIFF
;
4995 message_with_string ((NUMBERP (append
)
5005 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5006 doc
: /* Return t if (car A) is numerically less than (car B). */)
5007 (Lisp_Object a
, Lisp_Object b
)
5009 Lisp_Object args
[2] = { Fcar (a
), Fcar (b
), };
5010 return Flss (2, args
);
5013 /* Build the complete list of annotations appropriate for writing out
5014 the text between START and END, by calling all the functions in
5015 write-region-annotate-functions and merging the lists they return.
5016 If one of these functions switches to a different buffer, we assume
5017 that buffer contains altered text. Therefore, the caller must
5018 make sure to restore the current buffer in all cases,
5019 as save-excursion would do. */
5022 build_annotations (Lisp_Object start
, Lisp_Object end
)
5024 Lisp_Object annotations
;
5026 struct gcpro gcpro1
, gcpro2
;
5027 Lisp_Object original_buffer
;
5029 bool used_global
= 0;
5031 XSETBUFFER (original_buffer
, current_buffer
);
5034 p
= Vwrite_region_annotate_functions
;
5035 GCPRO2 (annotations
, p
);
5038 struct buffer
*given_buffer
= current_buffer
;
5039 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5040 { /* Use the global value of the hook. */
5043 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5045 p
= Fappend (2, arg
);
5048 Vwrite_region_annotations_so_far
= annotations
;
5049 res
= call2 (XCAR (p
), start
, end
);
5050 /* If the function makes a different buffer current,
5051 assume that means this buffer contains altered text to be output.
5052 Reset START and END from the buffer bounds
5053 and discard all previous annotations because they should have
5054 been dealt with by this function. */
5055 if (current_buffer
!= given_buffer
)
5057 Vwrite_region_annotation_buffers
5058 = Fcons (Fcurrent_buffer (),
5059 Vwrite_region_annotation_buffers
);
5060 XSETFASTINT (start
, BEGV
);
5061 XSETFASTINT (end
, ZV
);
5064 Flength (res
); /* Check basic validity of return value */
5065 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5069 /* Now do the same for annotation functions implied by the file-format */
5070 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5071 p
= BVAR (current_buffer
, auto_save_file_format
);
5073 p
= BVAR (current_buffer
, file_format
);
5074 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5076 struct buffer
*given_buffer
= current_buffer
;
5078 Vwrite_region_annotations_so_far
= annotations
;
5080 /* Value is either a list of annotations or nil if the function
5081 has written annotations to a temporary buffer, which is now
5083 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5084 original_buffer
, make_number (i
));
5085 if (current_buffer
!= given_buffer
)
5087 XSETFASTINT (start
, BEGV
);
5088 XSETFASTINT (end
, ZV
);
5093 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5101 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5102 If STRING is nil, POS is the character position in the current buffer.
5103 Intersperse with them the annotations from *ANNOT
5104 which fall within the range of POS to POS + NCHARS,
5105 each at its appropriate position.
5107 We modify *ANNOT by discarding elements as we use them up.
5109 Return true if successful. */
5112 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5113 ptrdiff_t nchars
, Lisp_Object
*annot
,
5114 struct coding_system
*coding
)
5118 ptrdiff_t lastpos
= pos
+ nchars
;
5120 while (NILP (*annot
) || CONSP (*annot
))
5122 tem
= Fcar_safe (Fcar (*annot
));
5125 nextpos
= XFASTINT (tem
);
5127 /* If there are no more annotations in this range,
5128 output the rest of the range all at once. */
5129 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5130 return e_write (desc
, string
, pos
, lastpos
, coding
);
5132 /* Output buffer text up to the next annotation's position. */
5135 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5139 /* Output the annotation. */
5140 tem
= Fcdr (Fcar (*annot
));
5143 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5146 *annot
= Fcdr (*annot
);
5151 /* Maximum number of characters that the next
5152 function encodes per one loop iteration. */
5154 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5156 /* Write text in the range START and END into descriptor DESC,
5157 encoding them with coding system CODING. If STRING is nil, START
5158 and END are character positions of the current buffer, else they
5159 are indexes to the string STRING. Return true if successful. */
5162 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5163 struct coding_system
*coding
)
5165 if (STRINGP (string
))
5168 end
= SCHARS (string
);
5171 /* We used to have a code for handling selective display here. But,
5172 now it is handled within encode_coding. */
5176 if (STRINGP (string
))
5178 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5179 if (CODING_REQUIRE_ENCODING (coding
))
5181 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5183 /* Avoid creating huge Lisp string in encode_coding_object. */
5184 if (nchars
== E_WRITE_MAX
)
5185 coding
->raw_destination
= 1;
5187 encode_coding_object
5188 (coding
, string
, start
, string_char_to_byte (string
, start
),
5189 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5194 coding
->dst_object
= string
;
5195 coding
->consumed_char
= SCHARS (string
);
5196 coding
->produced
= SBYTES (string
);
5201 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5202 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5204 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5205 if (CODING_REQUIRE_ENCODING (coding
))
5207 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5210 if (nchars
== E_WRITE_MAX
)
5211 coding
->raw_destination
= 1;
5213 encode_coding_object
5214 (coding
, Fcurrent_buffer (), start
, start_byte
,
5215 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5219 coding
->dst_object
= Qnil
;
5220 coding
->dst_pos_byte
= start_byte
;
5221 if (start
>= GPT
|| end
<= GPT
)
5223 coding
->consumed_char
= end
- start
;
5224 coding
->produced
= end_byte
- start_byte
;
5228 coding
->consumed_char
= GPT
- start
;
5229 coding
->produced
= GPT_BYTE
- start_byte
;
5234 if (coding
->produced
> 0)
5236 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5237 : (STRINGP (coding
->dst_object
)
5238 ? SSDATA (coding
->dst_object
)
5239 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5240 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5242 if (coding
->raw_destination
)
5244 /* We're responsible for freeing this, see
5245 encode_coding_object to check why. */
5246 xfree (coding
->destination
);
5247 coding
->raw_destination
= 0;
5249 if (coding
->produced
)
5252 start
+= coding
->consumed_char
;
5258 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5259 Sverify_visited_file_modtime
, 0, 1, 0,
5260 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5261 This means that the file has not been changed since it was visited or saved.
5262 If BUF is omitted or nil, it defaults to the current buffer.
5263 See Info node `(elisp)Modification Time' for more details. */)
5268 Lisp_Object handler
;
5269 Lisp_Object filename
;
5270 struct timespec mtime
;
5280 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5281 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5283 /* If the file name has special constructs in it,
5284 call the corresponding file handler. */
5285 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5286 Qverify_visited_file_modtime
);
5287 if (!NILP (handler
))
5288 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5290 filename
= ENCODE_FILE (BVAR (b
, filename
));
5292 mtime
= (stat (SSDATA (filename
), &st
) == 0
5293 ? get_stat_mtime (&st
)
5294 : time_error_value (errno
));
5295 if (timespec_cmp (mtime
, b
->modtime
) == 0
5296 && (b
->modtime_size
< 0
5297 || st
.st_size
== b
->modtime_size
))
5302 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5303 Svisited_file_modtime
, 0, 0, 0,
5304 doc
: /* Return the current buffer's recorded visited file modification time.
5305 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5306 `file-attributes' returns. If the current buffer has no recorded file
5307 modification time, this function returns 0. If the visited file
5308 doesn't exist, return -1.
5309 See Info node `(elisp)Modification Time' for more details. */)
5312 int ns
= current_buffer
->modtime
.tv_nsec
;
5314 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5315 return make_lisp_time (current_buffer
->modtime
);
5318 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5319 Sset_visited_file_modtime
, 0, 1, 0,
5320 doc
: /* Update buffer's recorded modification time from the visited file's time.
5321 Useful if the buffer was not read from the file normally
5322 or if the file itself has been changed for some known benign reason.
5323 An argument specifies the modification time value to use
5324 \(instead of that of the visited file), in the form of a list
5325 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5326 `visited-file-modtime'. */)
5327 (Lisp_Object time_flag
)
5329 if (!NILP (time_flag
))
5331 struct timespec mtime
;
5332 if (INTEGERP (time_flag
))
5334 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5335 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5338 mtime
= lisp_time_argument (time_flag
);
5340 current_buffer
->modtime
= mtime
;
5341 current_buffer
->modtime_size
= -1;
5345 register Lisp_Object filename
;
5347 Lisp_Object handler
;
5349 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5351 /* If the file name has special constructs in it,
5352 call the corresponding file handler. */
5353 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5354 if (!NILP (handler
))
5355 /* The handler can find the file name the same way we did. */
5356 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5358 filename
= ENCODE_FILE (filename
);
5360 if (stat (SSDATA (filename
), &st
) >= 0)
5362 current_buffer
->modtime
= get_stat_mtime (&st
);
5363 current_buffer
->modtime_size
= st
.st_size
;
5371 auto_save_error (Lisp_Object error_val
)
5373 Lisp_Object args
[3], msg
;
5375 struct gcpro gcpro1
;
5377 auto_save_error_occurred
= 1;
5379 ring_bell (XFRAME (selected_frame
));
5381 args
[0] = build_string ("Auto-saving %s: %s");
5382 args
[1] = BVAR (current_buffer
, name
);
5383 args
[2] = Ferror_message_string (error_val
);
5384 msg
= Fformat (3, args
);
5387 for (i
= 0; i
< 3; ++i
)
5392 message3_nolog (msg
);
5393 Fsleep_for (make_number (1), Qnil
);
5406 auto_save_mode_bits
= 0666;
5408 /* Get visited file's mode to become the auto save file's mode. */
5409 if (! NILP (BVAR (current_buffer
, filename
)))
5411 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5412 /* But make sure we can overwrite it later! */
5413 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5414 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5416 /* Remote files don't cooperate with stat. */
5417 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5421 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5422 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5426 struct auto_save_unwind
5433 do_auto_save_unwind (void *arg
)
5435 struct auto_save_unwind
*p
= arg
;
5436 FILE *stream
= p
->stream
;
5437 minibuffer_auto_raise
= p
->auto_raise
;
5448 do_auto_save_make_dir (Lisp_Object dir
)
5452 auto_saving_dir_umask
= 077;
5453 result
= call2 (Qmake_directory
, dir
, Qt
);
5454 auto_saving_dir_umask
= 0;
5459 do_auto_save_eh (Lisp_Object ignore
)
5461 auto_saving_dir_umask
= 0;
5465 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5466 doc
: /* Auto-save all buffers that need it.
5467 This is all buffers that have auto-saving enabled
5468 and are changed since last auto-saved.
5469 Auto-saving writes the buffer into a file
5470 so that your editing is not lost if the system crashes.
5471 This file is not the file you visited; that changes only when you save.
5472 Normally we run the normal hook `auto-save-hook' before saving.
5474 A non-nil NO-MESSAGE argument means do not print any message if successful.
5475 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5476 (Lisp_Object no_message
, Lisp_Object current_only
)
5478 struct buffer
*old
= current_buffer
, *b
;
5479 Lisp_Object tail
, buf
, hook
;
5480 bool auto_saved
= 0;
5481 int do_handled_files
;
5483 FILE *stream
= NULL
;
5484 ptrdiff_t count
= SPECPDL_INDEX ();
5485 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5486 bool old_message_p
= 0;
5487 struct auto_save_unwind auto_save_unwind
;
5488 struct gcpro gcpro1
, gcpro2
;
5490 if (max_specpdl_size
< specpdl_size
+ 40)
5491 max_specpdl_size
= specpdl_size
+ 40;
5496 if (NILP (no_message
))
5498 old_message_p
= push_message ();
5499 record_unwind_protect_void (pop_message_unwind
);
5502 /* Ordinarily don't quit within this function,
5503 but don't make it impossible to quit (in case we get hung in I/O). */
5507 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5508 point to non-strings reached from Vbuffer_alist. */
5510 hook
= intern ("auto-save-hook");
5511 safe_run_hooks (hook
);
5513 if (STRINGP (Vauto_save_list_file_name
))
5515 Lisp_Object listfile
;
5517 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5519 /* Don't try to create the directory when shutting down Emacs,
5520 because creating the directory might signal an error, and
5521 that would leave Emacs in a strange state. */
5522 if (!NILP (Vrun_hooks
))
5526 GCPRO2 (dir
, listfile
);
5527 dir
= Ffile_name_directory (listfile
);
5528 if (NILP (Ffile_directory_p (dir
)))
5529 internal_condition_case_1 (do_auto_save_make_dir
,
5535 stream
= emacs_fopen (SSDATA (listfile
), "w");
5538 auto_save_unwind
.stream
= stream
;
5539 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5540 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5541 minibuffer_auto_raise
= 0;
5543 auto_save_error_occurred
= 0;
5545 /* On first pass, save all files that don't have handlers.
5546 On second pass, save all files that do have handlers.
5548 If Emacs is crashing, the handlers may tweak what is causing
5549 Emacs to crash in the first place, and it would be a shame if
5550 Emacs failed to autosave perfectly ordinary files because it
5551 couldn't handle some ange-ftp'd file. */
5553 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5554 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5558 /* Record all the buffers that have auto save mode
5559 in the special file that lists them. For each of these buffers,
5560 Record visited name (if any) and auto save name. */
5561 if (STRINGP (BVAR (b
, auto_save_file_name
))
5562 && stream
!= NULL
&& do_handled_files
== 0)
5565 if (!NILP (BVAR (b
, filename
)))
5567 fwrite (SDATA (BVAR (b
, filename
)), 1,
5568 SBYTES (BVAR (b
, filename
)), stream
);
5570 putc ('\n', stream
);
5571 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5572 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5573 putc ('\n', stream
);
5577 if (!NILP (current_only
)
5578 && b
!= current_buffer
)
5581 /* Don't auto-save indirect buffers.
5582 The base buffer takes care of it. */
5586 /* Check for auto save enabled
5587 and file changed since last auto save
5588 and file changed since last real save. */
5589 if (STRINGP (BVAR (b
, auto_save_file_name
))
5590 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5591 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5592 /* -1 means we've turned off autosaving for a while--see below. */
5593 && XINT (BVAR (b
, save_length
)) >= 0
5594 && (do_handled_files
5595 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5598 struct timespec before_time
= current_timespec ();
5599 struct timespec after_time
;
5601 /* If we had a failure, don't try again for 20 minutes. */
5602 if (b
->auto_save_failure_time
> 0
5603 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5606 set_buffer_internal (b
);
5607 if (NILP (Vauto_save_include_big_deletions
)
5608 && (XFASTINT (BVAR (b
, save_length
)) * 10
5609 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5610 /* A short file is likely to change a large fraction;
5611 spare the user annoying messages. */
5612 && XFASTINT (BVAR (b
, save_length
)) > 5000
5613 /* These messages are frequent and annoying for `*mail*'. */
5614 && !EQ (BVAR (b
, filename
), Qnil
)
5615 && NILP (no_message
))
5617 /* It has shrunk too much; turn off auto-saving here. */
5618 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5619 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5621 minibuffer_auto_raise
= 0;
5622 /* Turn off auto-saving until there's a real save,
5623 and prevent any more warnings. */
5624 XSETINT (BVAR (b
, save_length
), -1);
5625 Fsleep_for (make_number (1), Qnil
);
5628 if (!auto_saved
&& NILP (no_message
))
5629 message1 ("Auto-saving...");
5630 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5632 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5633 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5634 set_buffer_internal (old
);
5636 after_time
= current_timespec ();
5638 /* If auto-save took more than 60 seconds,
5639 assume it was an NFS failure that got a timeout. */
5640 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5641 b
->auto_save_failure_time
= after_time
.tv_sec
;
5645 /* Prevent another auto save till enough input events come in. */
5646 record_auto_save ();
5648 if (auto_saved
&& NILP (no_message
))
5652 /* If we are going to restore an old message,
5653 give time to read ours. */
5654 sit_for (make_number (1), 0, 0);
5657 else if (!auto_save_error_occurred
)
5658 /* Don't overwrite the error message if an error occurred.
5659 If we displayed a message and then restored a state
5660 with no message, leave a "done" message on the screen. */
5661 message1 ("Auto-saving...done");
5666 /* This restores the message-stack status. */
5667 unbind_to (count
, Qnil
);
5671 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5672 Sset_buffer_auto_saved
, 0, 0, 0,
5673 doc
: /* Mark current buffer as auto-saved with its current text.
5674 No auto-save file will be written until the buffer changes again. */)
5677 /* FIXME: This should not be called in indirect buffers, since
5678 they're not autosaved. */
5679 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5680 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5681 current_buffer
->auto_save_failure_time
= 0;
5685 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5686 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5687 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5690 current_buffer
->auto_save_failure_time
= 0;
5694 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5696 doc
: /* Return t if current buffer has been auto-saved recently.
5697 More precisely, if it has been auto-saved since last read from or saved
5698 in the visited file. If the buffer has no visited file,
5699 then any auto-save counts as "recent". */)
5702 /* FIXME: maybe we should return nil for indirect buffers since
5703 they're never autosaved. */
5704 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5707 /* Reading and completing file names */
5709 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5710 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5711 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5712 The return value is only relevant for a call to `read-file-name' that happens
5713 before any other event (mouse or keypress) is handled. */)
5716 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5717 || defined (HAVE_NS)
5718 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5721 && window_system_available (SELECTED_FRAME ()))
5728 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5730 struct gcpro gcpro1
;
5731 Lisp_Object args
[7];
5733 GCPRO1 (default_filename
);
5734 args
[0] = intern ("read-file-name");
5737 args
[3] = default_filename
;
5738 args
[4] = mustmatch
;
5740 args
[6] = predicate
;
5741 RETURN_UNGCPRO (Ffuncall (7, args
));
5748 valid_timestamp_file_system
= 0;
5752 syms_of_fileio (void)
5754 DEFSYM (Qoperations
, "operations");
5755 DEFSYM (Qexpand_file_name
, "expand-file-name");
5756 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5757 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5758 DEFSYM (Qfile_name_directory
, "file-name-directory");
5759 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5760 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5761 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5762 DEFSYM (Qcopy_file
, "copy-file");
5763 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5764 DEFSYM (Qmake_directory
, "make-directory");
5765 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5766 DEFSYM (Qdelete_file
, "delete-file");
5767 DEFSYM (Qrename_file
, "rename-file");
5768 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5769 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5770 DEFSYM (Qfile_exists_p
, "file-exists-p");
5771 DEFSYM (Qfile_executable_p
, "file-executable-p");
5772 DEFSYM (Qfile_readable_p
, "file-readable-p");
5773 DEFSYM (Qfile_writable_p
, "file-writable-p");
5774 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5775 DEFSYM (Qaccess_file
, "access-file");
5776 DEFSYM (Qfile_directory_p
, "file-directory-p");
5777 DEFSYM (Qfile_regular_p
, "file-regular-p");
5778 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5779 DEFSYM (Qfile_modes
, "file-modes");
5780 DEFSYM (Qset_file_modes
, "set-file-modes");
5781 DEFSYM (Qset_file_times
, "set-file-times");
5782 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5783 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5784 DEFSYM (Qfile_acl
, "file-acl");
5785 DEFSYM (Qset_file_acl
, "set-file-acl");
5786 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5787 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5788 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5789 DEFSYM (Qwrite_region
, "write-region");
5790 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5791 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5792 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5794 DEFSYM (Qfile_name_history
, "file-name-history");
5795 Fset (Qfile_name_history
, Qnil
);
5797 DEFSYM (Qfile_error
, "file-error");
5798 DEFSYM (Qfile_already_exists
, "file-already-exists");
5799 DEFSYM (Qfile_date_error
, "file-date-error");
5800 DEFSYM (Qfile_notify_error
, "file-notify-error");
5801 DEFSYM (Qexcl
, "excl");
5803 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5804 doc
: /* Coding system for encoding file names.
5805 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5806 Vfile_name_coding_system
= Qnil
;
5808 DEFVAR_LISP ("default-file-name-coding-system",
5809 Vdefault_file_name_coding_system
,
5810 doc
: /* Default coding system for encoding file names.
5811 This variable is used only when `file-name-coding-system' is nil.
5813 This variable is set/changed by the command `set-language-environment'.
5814 User should not set this variable manually,
5815 instead use `file-name-coding-system' to get a constant encoding
5816 of file names regardless of the current language environment. */);
5817 Vdefault_file_name_coding_system
= Qnil
;
5819 DEFSYM (Qformat_decode
, "format-decode");
5820 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5821 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5822 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5824 Fput (Qfile_error
, Qerror_conditions
,
5825 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5826 Fput (Qfile_error
, Qerror_message
,
5827 build_pure_c_string ("File error"));
5829 Fput (Qfile_already_exists
, Qerror_conditions
,
5830 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5831 Fput (Qfile_already_exists
, Qerror_message
,
5832 build_pure_c_string ("File already exists"));
5834 Fput (Qfile_date_error
, Qerror_conditions
,
5835 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5836 Fput (Qfile_date_error
, Qerror_message
,
5837 build_pure_c_string ("Cannot set file date"));
5839 Fput (Qfile_notify_error
, Qerror_conditions
,
5840 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5841 Fput (Qfile_notify_error
, Qerror_message
,
5842 build_pure_c_string ("File notification error"));
5844 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5845 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5846 If a file name matches REGEXP, all I/O on that file is done by calling
5847 HANDLER. If a file name matches more than one handler, the handler
5848 whose match starts last in the file name gets precedence. The
5849 function `find-file-name-handler' checks this list for a handler for
5852 HANDLER should be a function. The first argument given to it is the
5853 name of the I/O primitive to be handled; the remaining arguments are
5854 the arguments that were passed to that primitive. For example, if you
5855 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5856 HANDLER is called like this:
5858 (funcall HANDLER 'file-exists-p FILENAME)
5860 Note that HANDLER must be able to handle all I/O primitives; if it has
5861 nothing special to do for a primitive, it should reinvoke the
5862 primitive to handle the operation \"the usual way\".
5863 See Info node `(elisp)Magic File Names' for more details. */);
5864 Vfile_name_handler_alist
= Qnil
;
5866 DEFVAR_LISP ("set-auto-coding-function",
5867 Vset_auto_coding_function
,
5868 doc
: /* If non-nil, a function to call to decide a coding system of file.
5869 Two arguments are passed to this function: the file name
5870 and the length of a file contents following the point.
5871 This function should return a coding system to decode the file contents.
5872 It should check the file name against `auto-coding-alist'.
5873 If no coding system is decided, it should check a coding system
5874 specified in the heading lines with the format:
5875 -*- ... coding: CODING-SYSTEM; ... -*-
5876 or local variable spec of the tailing lines with `coding:' tag. */);
5877 Vset_auto_coding_function
= Qnil
;
5879 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5880 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5881 Each is passed one argument, the number of characters inserted,
5882 with point at the start of the inserted text. Each function
5883 should leave point the same, and return the new character count.
5884 If `insert-file-contents' is intercepted by a handler from
5885 `file-name-handler-alist', that handler is responsible for calling the
5886 functions in `after-insert-file-functions' if appropriate. */);
5887 Vafter_insert_file_functions
= Qnil
;
5889 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5890 doc
: /* A list of functions to be called at the start of `write-region'.
5891 Each is passed two arguments, START and END as for `write-region'.
5892 These are usually two numbers but not always; see the documentation
5893 for `write-region'. The function should return a list of pairs
5894 of the form (POSITION . STRING), consisting of strings to be effectively
5895 inserted at the specified positions of the file being written (1 means to
5896 insert before the first byte written). The POSITIONs must be sorted into
5899 If there are several annotation functions, the lists returned by these
5900 functions are merged destructively. As each annotation function runs,
5901 the variable `write-region-annotations-so-far' contains a list of all
5902 annotations returned by previous annotation functions.
5904 An annotation function can return with a different buffer current.
5905 Doing so removes the annotations returned by previous functions, and
5906 resets START and END to `point-min' and `point-max' of the new buffer.
5908 After `write-region' completes, Emacs calls the function stored in
5909 `write-region-post-annotation-function', once for each buffer that was
5910 current when building the annotations (i.e., at least once), with that
5911 buffer current. */);
5912 Vwrite_region_annotate_functions
= Qnil
;
5913 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5915 DEFVAR_LISP ("write-region-post-annotation-function",
5916 Vwrite_region_post_annotation_function
,
5917 doc
: /* Function to call after `write-region' completes.
5918 The function is called with no arguments. If one or more of the
5919 annotation functions in `write-region-annotate-functions' changed the
5920 current buffer, the function stored in this variable is called for
5921 each of those additional buffers as well, in addition to the original
5922 buffer. The relevant buffer is current during each function call. */);
5923 Vwrite_region_post_annotation_function
= Qnil
;
5924 staticpro (&Vwrite_region_annotation_buffers
);
5926 DEFVAR_LISP ("write-region-annotations-so-far",
5927 Vwrite_region_annotations_so_far
,
5928 doc
: /* When an annotation function is called, this holds the previous annotations.
5929 These are the annotations made by other annotation functions
5930 that were already called. See also `write-region-annotate-functions'. */);
5931 Vwrite_region_annotations_so_far
= Qnil
;
5933 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5934 doc
: /* A list of file name handlers that temporarily should not be used.
5935 This applies only to the operation `inhibit-file-name-operation'. */);
5936 Vinhibit_file_name_handlers
= Qnil
;
5938 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5939 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5940 Vinhibit_file_name_operation
= Qnil
;
5942 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5943 doc
: /* File name in which we write a list of all auto save file names.
5944 This variable is initialized automatically from `auto-save-list-file-prefix'
5945 shortly after Emacs reads your init file, if you have not yet given it
5946 a non-nil value. */);
5947 Vauto_save_list_file_name
= Qnil
;
5949 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5950 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5951 Normally auto-save files are written under other names. */);
5952 Vauto_save_visited_file_name
= Qnil
;
5954 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5955 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5956 If nil, deleting a substantial portion of the text disables auto-save
5957 in the buffer; this is the default behavior, because the auto-save
5958 file is usually more useful if it contains the deleted text. */);
5959 Vauto_save_include_big_deletions
= Qnil
;
5961 /* fsync can be a significant performance hit. Often it doesn't
5962 suffice to make the file-save operation survive a crash. For
5963 batch scripts, which are typically part of larger shell commands
5964 that don't fsync other files, its effect on performance can be
5965 significant so its utility is particularly questionable.
5966 Hence, for now by default fsync is used only when interactive.
5968 For more on why fsync often fails to work on today's hardware, see:
5969 Zheng M et al. Understanding the robustness of SSDs under power fault.
5970 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5971 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5973 For more on why fsync does not suffice even if it works properly, see:
5974 Roche X. Necessary step(s) to synchronize filename operations on disk.
5975 Austin Group Defect 672, 2013-03-19
5976 http://austingroupbugs.net/view.php?id=672 */
5977 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5978 doc
: /* Non-nil means don't call fsync in `write-region'.
5979 This variable affects calls to `write-region' as well as save commands.
5980 Setting this to nil may avoid data loss if the system loses power or
5981 the operating system crashes. */);
5982 write_region_inhibit_fsync
= noninteractive
;
5984 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5985 doc
: /* Specifies whether to use the system's trash can.
5986 When non-nil, certain file deletion commands use the function
5987 `move-file-to-trash' instead of deleting files outright.
5988 This includes interactive calls to `delete-file' and
5989 `delete-directory' and the Dired deletion commands. */);
5990 delete_by_moving_to_trash
= 0;
5991 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5993 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5994 DEFSYM (Qcopy_directory
, "copy-directory");
5995 DEFSYM (Qdelete_directory
, "delete-directory");
5996 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");
5998 defsubr (&Sfind_file_name_handler
);
5999 defsubr (&Sfile_name_directory
);
6000 defsubr (&Sfile_name_nondirectory
);
6001 defsubr (&Sunhandled_file_name_directory
);
6002 defsubr (&Sfile_name_as_directory
);
6003 defsubr (&Sdirectory_file_name
);
6004 defsubr (&Smake_temp_name
);
6005 defsubr (&Sexpand_file_name
);
6006 defsubr (&Ssubstitute_in_file_name
);
6007 defsubr (&Scopy_file
);
6008 defsubr (&Smake_directory_internal
);
6009 defsubr (&Sdelete_directory_internal
);
6010 defsubr (&Sdelete_file
);
6011 defsubr (&Srename_file
);
6012 defsubr (&Sadd_name_to_file
);
6013 defsubr (&Smake_symbolic_link
);
6014 defsubr (&Sfile_name_absolute_p
);
6015 defsubr (&Sfile_exists_p
);
6016 defsubr (&Sfile_executable_p
);
6017 defsubr (&Sfile_readable_p
);
6018 defsubr (&Sfile_writable_p
);
6019 defsubr (&Saccess_file
);
6020 defsubr (&Sfile_symlink_p
);
6021 defsubr (&Sfile_directory_p
);
6022 defsubr (&Sfile_accessible_directory_p
);
6023 defsubr (&Sfile_regular_p
);
6024 defsubr (&Sfile_modes
);
6025 defsubr (&Sset_file_modes
);
6026 defsubr (&Sset_file_times
);
6027 defsubr (&Sfile_selinux_context
);
6028 defsubr (&Sfile_acl
);
6029 defsubr (&Sset_file_acl
);
6030 defsubr (&Sset_file_selinux_context
);
6031 defsubr (&Sset_default_file_modes
);
6032 defsubr (&Sdefault_file_modes
);
6033 defsubr (&Sfile_newer_than_file_p
);
6034 defsubr (&Sinsert_file_contents
);
6035 defsubr (&Schoose_write_coding_system
);
6036 defsubr (&Swrite_region
);
6037 defsubr (&Scar_less_than_car
);
6038 defsubr (&Sverify_visited_file_modtime
);
6039 defsubr (&Svisited_file_modtime
);
6040 defsubr (&Sset_visited_file_modtime
);
6041 defsubr (&Sdo_auto_save
);
6042 defsubr (&Sset_buffer_auto_saved
);
6043 defsubr (&Sclear_buffer_auto_save_failure
);
6044 defsubr (&Srecent_auto_save_p
);
6046 defsubr (&Snext_read_file_uses_dialog_p
);
6049 defsubr (&Sunix_sync
);