1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2017 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 (at
10 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>
38 #ifdef HAVE_LIBSELINUX
39 #include <selinux/selinux.h>
40 #include <selinux/context.h>
43 #if USE_ACL && defined HAVE_ACL_SET_FILE
50 #include "composite.h"
51 #include "character.h"
55 #include "blockinput.h"
56 #include "region-cache.h"
59 #ifdef HAVE_LINUX_FS_H
60 # include <sys/ioctl.h>
61 # include <linux/fs.h>
67 /* The redundant #ifdef is to avoid compiler warning about unused macro. */
73 #endif /* not WINDOWSNT */
77 #include <sys/param.h>
81 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
82 redirector allows the six letters between 'Z' and 'a' as well. */
84 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
87 #define IS_DRIVE(x) c_isalpha (x)
89 /* Need to lower-case the drive letter, or else expanded
90 filenames will sometimes compare unequal, because
91 `expand-file-name' doesn't always down-case the drive letter. */
92 #define DRIVE_LETTER(x) c_tolower (x)
97 #include <allocator.h>
98 #include <careadlinkat.h>
99 #include <stat-time.h>
101 #include <binary-io.h>
107 #include "commands.h"
109 /* True during writing of auto-save files. */
110 static bool auto_saving
;
112 /* Emacs's real umask. */
113 static mode_t realmask
;
115 /* Nonzero umask during creation of auto-save directories. */
116 static mode_t auto_saving_dir_umask
;
118 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
119 a new file with the same mode as the original. */
120 static mode_t auto_save_mode_bits
;
122 /* Set by auto_save_1 if an error occurred during the last auto-save. */
123 static bool auto_save_error_occurred
;
125 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
126 number of a file system where time stamps were observed to to work. */
127 static bool valid_timestamp_file_system
;
128 static dev_t timestamp_file_system
;
130 /* Each time an annotation function changes the buffer, the new buffer
132 static Lisp_Object Vwrite_region_annotation_buffers
;
134 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
135 Lisp_Object
*, struct coding_system
*);
136 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
137 struct coding_system
*);
140 /* Return true if FILENAME exists. */
143 check_existing (const char *filename
)
145 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
148 /* Return true if file FILENAME exists and can be executed. */
151 check_executable (char *filename
)
153 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
156 /* Return true if file FILENAME exists and can be accessed
157 according to AMODE, which should include W_OK.
158 On failure, return false and set errno. */
161 check_writable (const char *filename
, int amode
)
164 /* FIXME: an faccessat implementation should be added to the
165 DOS/Windows ports and this #ifdef branch should be removed. */
167 if (stat (filename
, &st
) < 0)
170 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
171 #else /* not MSDOS */
172 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
174 /* faccessat may have returned failure because Cygwin couldn't
175 determine the file's UID or GID; if so, we return success. */
178 int faccessat_errno
= errno
;
180 if (stat (filename
, &st
) < 0)
182 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
183 errno
= faccessat_errno
;
187 #endif /* not MSDOS */
190 /* Signal a file-access failure. STRING describes the failure,
191 NAME the file involved, and ERRORNO the errno value.
193 If NAME is neither null nor a pair, package it up as a singleton
194 list before reporting it; this saves report_file_errno's caller the
195 trouble of preserving errno before calling list1. */
198 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
200 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
201 char *str
= emacs_strerror (errorno
);
202 AUTO_STRING (unibyte_str
, str
);
203 Lisp_Object errstring
204 = code_convert_string_norecord (unibyte_str
, Vlocale_coding_system
, 0);
205 Lisp_Object errdata
= Fcons (errstring
, data
);
207 if (errorno
== EEXIST
)
208 xsignal (Qfile_already_exists
, errdata
);
210 xsignal (errorno
== ENOENT
? Qfile_missing
: Qfile_error
,
211 Fcons (build_string (string
), errdata
));
214 /* Signal a file-access failure that set errno. STRING describes the
215 failure, NAME the file involved. When invoking this function, take
216 care to not use arguments such as build_string ("foo") that involve
217 side effects that may set errno. */
220 report_file_error (char const *string
, Lisp_Object name
)
222 report_file_errno (string
, name
, errno
);
225 /* Like report_file_error, but reports a file-notify-error instead. */
228 report_file_notify_error (const char *string
, Lisp_Object name
)
230 char *str
= emacs_strerror (errno
);
231 AUTO_STRING (unibyte_str
, str
);
232 Lisp_Object errstring
233 = code_convert_string_norecord (unibyte_str
, Vlocale_coding_system
, 0);
234 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
235 Lisp_Object errdata
= Fcons (errstring
, data
);
237 xsignal (Qfile_notify_error
, Fcons (build_string (string
), errdata
));
241 close_file_unwind (int fd
)
247 fclose_unwind (void *arg
)
253 /* Restore point, having saved it as a marker. */
256 restore_point_unwind (Lisp_Object location
)
258 Fgoto_char (location
);
259 unchain_marker (XMARKER (location
));
263 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
264 Sfind_file_name_handler
, 2, 2, 0,
265 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
266 Otherwise, return nil.
267 A file name is handled if one of the regular expressions in
268 `file-name-handler-alist' matches it.
270 If OPERATION equals `inhibit-file-name-operation', then we ignore
271 any handlers that are members of `inhibit-file-name-handlers',
272 but we still do run any other handlers. This lets handlers
273 use the standard functions without calling themselves recursively. */)
274 (Lisp_Object filename
, Lisp_Object operation
)
276 /* This function must not munge the match data. */
277 Lisp_Object chain
, inhibited_handlers
, result
;
281 CHECK_STRING (filename
);
283 if (EQ (operation
, Vinhibit_file_name_operation
))
284 inhibited_handlers
= Vinhibit_file_name_handlers
;
286 inhibited_handlers
= Qnil
;
288 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
289 chain
= XCDR (chain
))
295 Lisp_Object string
= XCAR (elt
);
297 Lisp_Object handler
= XCDR (elt
);
298 Lisp_Object operations
= Qnil
;
300 if (SYMBOLP (handler
))
301 operations
= Fget (handler
, Qoperations
);
304 && (match_pos
= fast_string_match (string
, filename
)) > pos
305 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
309 handler
= XCDR (elt
);
310 tem
= Fmemq (handler
, inhibited_handlers
);
324 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
326 doc
: /* Return the directory component in file name FILENAME.
327 Return nil if FILENAME does not include a directory.
328 Otherwise return a directory name.
329 Given a Unix syntax file name, returns a string ending in slash. */)
330 (Lisp_Object filename
)
334 CHECK_STRING (filename
);
336 /* If the file name has special constructs in it,
337 call the corresponding file handler. */
338 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
341 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
343 return STRINGP (handled_name
) ? handled_name
: Qnil
;
346 char *beg
= SSDATA (filename
);
347 char const *p
= beg
+ SBYTES (filename
);
349 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
351 /* only recognize drive specifier at the beginning */
353 /* handle the "/:d:foo" and "/:foo" cases correctly */
354 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
355 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
362 /* Expansion of "c:" to drive and default directory. */
365 SAFE_ALLOCA_STRING (beg
, filename
);
366 p
= beg
+ (p
- SSDATA (filename
));
370 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
371 char *res
= alloca (MAXPATHLEN
+ 1);
374 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
376 memcpy (res
, beg
, 2);
381 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
383 size_t l
= strlen (res
);
385 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
388 p
= beg
+ strlen (beg
);
389 dostounix_filename (beg
);
390 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
391 STRING_MULTIBYTE (filename
));
394 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
395 STRING_MULTIBYTE (filename
));
397 else if (STRING_MULTIBYTE (filename
))
399 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
400 dostounix_filename (SSDATA (tem_fn
));
402 if (!NILP (Vw32_downcase_file_names
))
403 tem_fn
= Fdowncase (tem_fn
);
408 dostounix_filename (beg
);
409 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
414 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
418 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
419 Sfile_name_nondirectory
, 1, 1, 0,
420 doc
: /* Return file name FILENAME sans its directory.
421 For example, in a Unix-syntax file name,
422 this is everything after the last slash,
423 or the entire name if it contains no slash. */)
424 (Lisp_Object filename
)
426 register const char *beg
, *p
, *end
;
429 CHECK_STRING (filename
);
431 /* If the file name has special constructs in it,
432 call the corresponding file handler. */
433 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
436 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
438 if (STRINGP (handled_name
))
440 error ("Invalid handler in `file-name-handler-alist'");
443 beg
= SSDATA (filename
);
444 end
= p
= beg
+ SBYTES (filename
);
446 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
448 /* only recognize drive specifier at beginning */
450 /* handle the "/:d:foo" case correctly */
451 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
456 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
459 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
460 Sunhandled_file_name_directory
, 1, 1, 0,
461 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
462 A `directly usable' directory name is one that may be used without the
463 intervention of any file handler.
464 If FILENAME is a directly usable file itself, return
465 \(file-name-as-directory FILENAME).
466 If FILENAME refers to a file which is not accessible from a local process,
467 then this should return nil.
468 The `call-process' and `start-process' functions use this function to
469 get a current directory to run processes in. */)
470 (Lisp_Object filename
)
474 /* If the file name has special constructs in it,
475 call the corresponding file handler. */
476 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
479 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
481 return STRINGP (handled_name
) ? handled_name
: Qnil
;
484 return Ffile_name_as_directory (filename
);
487 /* Maximum number of bytes that DST will be longer than SRC
488 in file_name_as_directory. This occurs when SRCLEN == 0. */
489 enum { file_name_as_directory_slop
= 2 };
491 /* Convert from file name SRC of length SRCLEN to directory name in
492 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
493 string. On UNIX, just make sure there is a terminating /. Return
494 the length of DST in bytes. */
497 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
508 memcpy (dst
, src
, srclen
);
509 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
510 dst
[srclen
++] = DIRECTORY_SEP
;
513 dostounix_filename (dst
);
518 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
519 Sfile_name_as_directory
, 1, 1, 0,
520 doc
: /* Return a string representing the file name FILE interpreted as a directory.
521 This operation exists because a directory is also a file, but its name as
522 a directory is different from its name as a file.
523 The result can be used as the value of `default-directory'
524 or passed as second argument to `expand-file-name'.
525 For a Unix-syntax file name, just appends a slash unless a trailing slash
526 is already present. */)
531 Lisp_Object handler
, val
;
536 /* If the file name has special constructs in it,
537 call the corresponding file handler. */
538 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
541 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
543 if (STRINGP (handled_name
))
545 error ("Invalid handler in `file-name-handler-alist'");
549 if (!NILP (Vw32_downcase_file_names
))
550 file
= Fdowncase (file
);
552 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
553 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
554 STRING_MULTIBYTE (file
));
555 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
560 /* Convert from directory name SRC of length SRCLEN to file name in
561 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
562 string. On UNIX, just make sure there isn't a terminating /.
563 Return the length of DST in bytes. */
566 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
568 /* Process as Unix format: just remove any final slash.
569 But leave "/" and "//" unchanged. */
572 && !IS_ANY_SEP (src
[srclen
- 2])
574 && IS_DIRECTORY_SEP (src
[srclen
- 1])
575 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
578 memcpy (dst
, src
, srclen
);
581 dostounix_filename (dst
);
586 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
588 doc
: /* Returns the file name of the directory named DIRECTORY.
589 This is the name of the file that holds the data for the directory DIRECTORY.
590 This operation exists because a directory is also a file, but its name as
591 a directory is different from its name as a file.
592 In Unix-syntax, this function just removes the final slash. */)
593 (Lisp_Object directory
)
597 Lisp_Object handler
, val
;
600 CHECK_STRING (directory
);
602 /* If the file name has special constructs in it,
603 call the corresponding file handler. */
604 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
607 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
609 if (STRINGP (handled_name
))
611 error ("Invalid handler in `file-name-handler-alist'");
615 if (!NILP (Vw32_downcase_file_names
))
616 directory
= Fdowncase (directory
);
618 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
619 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
620 STRING_MULTIBYTE (directory
));
621 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
626 static const char make_temp_name_tbl
[64] =
628 'A','B','C','D','E','F','G','H',
629 'I','J','K','L','M','N','O','P',
630 'Q','R','S','T','U','V','W','X',
631 'Y','Z','a','b','c','d','e','f',
632 'g','h','i','j','k','l','m','n',
633 'o','p','q','r','s','t','u','v',
634 'w','x','y','z','0','1','2','3',
635 '4','5','6','7','8','9','-','_'
638 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
640 /* Value is a temporary file name starting with PREFIX, a string.
642 The Emacs process number forms part of the result, so there is
643 no danger of generating a name being used by another process.
644 In addition, this function makes an attempt to choose a name
645 which has no existing file. To make this work, PREFIX should be
646 an absolute file name.
648 BASE64_P means add the pid as 3 characters in base64
649 encoding. In this case, 6 characters will be added to PREFIX to
650 form the file name. Otherwise, if Emacs is running on a system
651 with long file names, add the pid as a decimal number.
653 This function signals an error if no unique file name could be
657 make_temp_name (Lisp_Object prefix
, bool base64_p
)
659 Lisp_Object val
, encoded_prefix
;
663 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
666 CHECK_STRING (prefix
);
668 /* VAL is created by adding 6 characters to PREFIX. The first
669 three are the PID of this process, in base 64, and the second
670 three are incremented if the file already exists. This ensures
671 262144 unique file names per PID per PREFIX. */
677 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
678 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
679 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
684 #ifdef HAVE_LONG_FILE_NAMES
685 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
687 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
688 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
689 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
694 encoded_prefix
= ENCODE_FILE (prefix
);
695 len
= SBYTES (encoded_prefix
);
696 val
= make_uninit_string (len
+ 3 + pidlen
);
698 memcpy (data
, SSDATA (encoded_prefix
), len
);
701 memcpy (p
, pidbuf
, pidlen
);
704 /* Here we try to minimize useless stat'ing when this function is
705 invoked many times successively with the same PREFIX. We achieve
706 this by initializing count to a random value, and incrementing it
709 We don't want make-temp-name to be called while dumping,
710 because then make_temp_name_count_initialized_p would get set
711 and then make_temp_name_count would not be set when Emacs starts. */
713 if (!make_temp_name_count_initialized_p
)
715 make_temp_name_count
= time (NULL
);
716 make_temp_name_count_initialized_p
= 1;
721 unsigned num
= make_temp_name_count
;
723 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
724 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
725 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
727 /* Poor man's congruential RN generator. Replace with
728 ++make_temp_name_count for debugging. */
729 make_temp_name_count
+= 25229;
730 make_temp_name_count
%= 225307;
732 if (!check_existing (data
))
734 /* We want to return only if errno is ENOENT. */
736 return DECODE_FILE (val
);
738 /* The error here is dubious, but there is little else we
739 can do. The alternatives are to return nil, which is
740 as bad as (and in many cases worse than) throwing the
741 error, or to ignore the error, which will likely result
742 in looping through 225307 stat's, which is not only
743 dog-slow, but also useless since eventually nil would
744 have to be returned anyway. */
745 report_file_error ("Cannot create temporary name for prefix",
753 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
754 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
755 The Emacs process number forms part of the result, so there is no
756 danger of generating a name being used by another Emacs process
757 \(so long as only a single host can access the containing directory...).
759 This function tries to choose a name that has no existing file.
760 For this to work, PREFIX should be an absolute file name.
762 There is a race condition between calling `make-temp-name' and creating the
763 file, which opens all kinds of security holes. For that reason, you should
764 normally use `make-temp-file' instead. */)
767 return make_temp_name (prefix
, 0);
770 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
771 doc
: /* Convert filename NAME to absolute, and canonicalize it.
772 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
773 \(does not start with slash or tilde); both the directory name and
774 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
775 missing, the current buffer's value of `default-directory' is used.
776 NAME should be a string that is a valid file name for the underlying
778 File name components that are `.' are removed, and
779 so are file name components followed by `..', along with the `..' itself;
780 note that these simplifications are done without checking the resulting
781 file names in the file system.
782 Multiple consecutive slashes are collapsed into a single slash,
783 except at the beginning of the file name when they are significant (e.g.,
784 UNC file names on MS-Windows.)
785 An initial `~/' expands to your home directory.
786 An initial `~USER/' expands to USER's home directory.
787 See also the function `substitute-in-file-name'.
789 For technical reasons, this function can return correct but
790 non-intuitive results for the root directory; for instance,
791 \(expand-file-name ".." "/") returns "/..". For this reason, use
792 \(directory-file-name (file-name-directory dirname)) to traverse a
793 filesystem tree, not (expand-file-name ".." dirname). */)
794 (Lisp_Object name
, Lisp_Object default_directory
)
796 /* These point to SDATA and need to be careful with string-relocation
797 during GC (via DECODE_FILE). */
801 const char *newdirlim
;
802 /* This should only point to alloca'd data. */
809 bool collapse_newdir
= true;
812 ptrdiff_t length
, nbytes
;
813 Lisp_Object handler
, result
, handled_name
;
820 /* If the file name has special constructs in it,
821 call the corresponding file handler. */
822 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
825 handled_name
= call3 (handler
, Qexpand_file_name
,
826 name
, default_directory
);
827 if (STRINGP (handled_name
))
829 error ("Invalid handler in `file-name-handler-alist'");
833 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
834 if (NILP (default_directory
))
835 default_directory
= BVAR (current_buffer
, directory
);
836 if (! STRINGP (default_directory
))
839 /* "/" is not considered a root directory on DOS_NT, so using "/"
840 here causes an infinite recursion in, e.g., the following:
842 (let (default-directory)
843 (expand-file-name "a"))
845 To avoid this, we set default_directory to the root of the
847 default_directory
= build_string (emacs_root_dir ());
849 default_directory
= build_string ("/");
853 if (!NILP (default_directory
))
855 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
858 handled_name
= call3 (handler
, Qexpand_file_name
,
859 name
, default_directory
);
860 if (STRINGP (handled_name
))
862 error ("Invalid handler in `file-name-handler-alist'");
867 char *o
= SSDATA (default_directory
);
869 /* Make sure DEFAULT_DIRECTORY is properly expanded.
870 It would be better to do this down below where we actually use
871 default_directory. Unfortunately, calling Fexpand_file_name recursively
872 could invoke GC, and the strings might be relocated. This would
873 be annoying because we have pointers into strings lying around
874 that would need adjusting, and people would add new pointers to
875 the code and forget to adjust them, resulting in intermittent bugs.
876 Putting this call here avoids all that crud.
878 The EQ test avoids infinite recursion. */
879 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
880 /* Save time in some common cases - as long as default_directory
881 is not relative, it can be canonicalized with name below (if it
882 is needed at all) without requiring it to be expanded now. */
884 /* Detect MSDOS file names with drive specifiers. */
885 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
886 && IS_DIRECTORY_SEP (o
[2]))
887 /* Detect escaped file names without drive spec after "/:".
888 These should not be recursively expanded, to avoid
889 including the default directory twice in the expanded
891 && ! (o
[0] == '/' && o
[1] == ':')
893 /* Detect Windows file names in UNC format. */
894 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
896 #else /* not DOS_NT */
897 /* Detect Unix absolute file names (/... alone is not absolute on
899 && ! (IS_DIRECTORY_SEP (o
[0]))
900 #endif /* not DOS_NT */
903 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
906 multibyte
= STRING_MULTIBYTE (name
);
907 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
911 unsigned char *p
= SDATA (name
);
913 while (*p
&& ASCII_CHAR_P (*p
))
917 /* NAME is a pure ASCII string, and DEFAULT_DIRECTORY is
918 unibyte. Do not convert DEFAULT_DIRECTORY to
919 multibyte; instead, convert NAME to a unibyte string,
920 so that the result of this function is also a unibyte
921 string. This is needed during bootstrapping and
922 dumping, when Emacs cannot decode file names, because
923 the locale environment is not set up. */
924 name
= make_unibyte_string (SSDATA (name
), SBYTES (name
));
928 default_directory
= string_to_multibyte (default_directory
);
932 name
= string_to_multibyte (name
);
938 if (!NILP (Vw32_downcase_file_names
))
939 default_directory
= Fdowncase (default_directory
);
942 /* Make a local copy of NAME to protect it from GC in DECODE_FILE below. */
943 SAFE_ALLOCA_STRING (nm
, name
);
944 nmlim
= nm
+ SBYTES (name
);
947 /* Note if special escape prefix is present, but remove for now. */
948 if (nm
[0] == '/' && nm
[1] == ':')
954 /* Find and remove drive specifier if present; this makes nm absolute
955 even if the rest of the name appears to be relative. Only look for
956 drive specifier at the beginning. */
957 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
959 drive
= (unsigned char) nm
[0];
964 /* If we see "c://somedir", we want to strip the first slash after the
965 colon when stripping the drive letter. Otherwise, this expands to
967 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
970 /* Discard any previous drive specifier if nm is now in UNC format. */
971 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
972 && !IS_DIRECTORY_SEP (nm
[2]))
974 #endif /* WINDOWSNT */
977 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
978 none are found, we can probably return right away. We will avoid
979 allocating a new string if name is already fully expanded. */
981 IS_DIRECTORY_SEP (nm
[0])
983 && drive
&& !is_escaped
986 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
990 /* If it turns out that the filename we want to return is just a
991 suffix of FILENAME, we don't need to go through and edit
992 things; we just need to construct a new string using data
993 starting at the middle of FILENAME. If we set LOSE, that
994 means we've discovered that we can't do that cool trick. */
1000 /* Since we know the name is absolute, we can assume that each
1001 element starts with a "/". */
1003 /* "." and ".." are hairy. */
1004 if (IS_DIRECTORY_SEP (p
[0])
1006 && (IS_DIRECTORY_SEP (p
[2])
1008 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1011 /* Replace multiple slashes with a single one, except
1012 leave leading "//" alone. */
1013 else if (IS_DIRECTORY_SEP (p
[0])
1014 && IS_DIRECTORY_SEP (p
[1])
1015 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1022 /* Make sure directories are all separated with /, but
1023 avoid allocation of a new string when not required. */
1024 dostounix_filename (nm
);
1026 if (IS_DIRECTORY_SEP (nm
[1]))
1028 if (strcmp (nm
, SSDATA (name
)) != 0)
1029 name
= make_specified_string (nm
, -1, nmlim
- nm
, multibyte
);
1033 /* Drive must be set, so this is okay. */
1034 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1036 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1037 char temp
[] = { DRIVE_LETTER (drive
), ':', 0 };
1038 AUTO_STRING_WITH_LEN (drive_prefix
, temp
, 2);
1039 name
= concat2 (drive_prefix
, name
);
1042 if (!NILP (Vw32_downcase_file_names
))
1043 name
= Fdowncase (name
);
1045 #else /* not DOS_NT */
1046 if (strcmp (nm
, SSDATA (name
)) != 0)
1047 name
= make_specified_string (nm
, -1, nmlim
- nm
, multibyte
);
1048 #endif /* not DOS_NT */
1054 /* At this point, nm might or might not be an absolute file name. We
1055 need to expand ~ or ~user if present, otherwise prefix nm with
1056 default_directory if nm is not absolute, and finally collapse /./
1057 and /foo/../ sequences.
1059 We set newdir to be the appropriate prefix if one is needed:
1060 - the relevant user directory if nm starts with ~ or ~user
1061 - the specified drive's working dir (DOS/NT only) if nm does not
1063 - the value of default_directory.
1065 Note that these prefixes are not guaranteed to be absolute (except
1066 for the working dir of a drive). Therefore, to ensure we always
1067 return an absolute name, if the final prefix is not absolute we
1068 append it to the current working directory. */
1070 newdir
= newdirlim
= 0;
1072 if (nm
[0] == '~' /* prefix ~ */
1074 && !is_escaped
/* don't expand ~ in escaped file names */
1078 if (IS_DIRECTORY_SEP (nm
[1])
1079 || nm
[1] == 0) /* ~ by itself */
1083 if (!(newdir
= egetenv ("HOME")))
1084 newdir
= newdirlim
= "";
1089 char newdir_utf8
[MAX_UTF8_PATH
];
1091 filename_from_ansi (newdir
, newdir_utf8
);
1092 tem
= make_unibyte_string (newdir_utf8
, strlen (newdir_utf8
));
1093 newdir
= SSDATA (tem
);
1097 tem
= build_string (newdir
);
1098 newdirlim
= newdir
+ SBYTES (tem
);
1099 /* `egetenv' may return a unibyte string, which will bite us
1100 if we expect the directory to be multibyte. */
1101 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1103 hdir
= DECODE_FILE (tem
);
1104 newdir
= SSDATA (hdir
);
1105 newdirlim
= newdir
+ SBYTES (hdir
);
1108 collapse_newdir
= false;
1111 else /* ~user/filename */
1114 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1116 o
= SAFE_ALLOCA (p
- nm
+ 1);
1117 memcpy (o
, nm
, p
- nm
);
1121 pw
= getpwnam (o
+ 1);
1127 newdir
= pw
->pw_dir
;
1128 /* `getpwnam' may return a unibyte string, which will
1129 bite us when we expect the directory to be multibyte. */
1130 tem
= make_unibyte_string (newdir
, strlen (newdir
));
1131 newdirlim
= newdir
+ SBYTES (tem
);
1132 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1134 hdir
= DECODE_FILE (tem
);
1135 newdir
= SSDATA (hdir
);
1136 newdirlim
= newdir
+ SBYTES (hdir
);
1140 collapse_newdir
= false;
1144 /* If we don't find a user of that name, leave the name
1145 unchanged; don't move nm forward to p. */
1150 /* On DOS and Windows, nm is absolute if a drive name was specified;
1151 use the drive's current directory as the prefix if needed. */
1152 if (!newdir
&& drive
)
1154 /* Get default directory if needed to make nm absolute. */
1156 if (!IS_DIRECTORY_SEP (nm
[0]))
1158 adir
= alloca (MAXPATHLEN
+ 1);
1159 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1163 Lisp_Object tem
= build_string (adir
);
1165 tem
= DECODE_FILE (tem
);
1166 newdirlim
= adir
+ SBYTES (tem
);
1167 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1170 newdirlim
= adir
+ strlen (adir
);
1174 /* Either nm starts with /, or drive isn't mounted. */
1176 adir
[0] = DRIVE_LETTER (drive
);
1180 newdirlim
= adir
+ 3;
1186 /* Finally, if no prefix has been specified and nm is not absolute,
1187 then it must be expanded relative to default_directory. */
1191 /* /... alone is not absolute on DOS and Windows. */
1192 && !IS_DIRECTORY_SEP (nm
[0])
1195 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1196 && !IS_DIRECTORY_SEP (nm
[2]))
1200 newdir
= SSDATA (default_directory
);
1201 newdirlim
= newdir
+ SBYTES (default_directory
);
1203 /* Note if special escape prefix is present, but remove for now. */
1204 if (newdir
[0] == '/' && newdir
[1] == ':')
1215 /* First ensure newdir is an absolute name. */
1217 /* Detect MSDOS file names with drive specifiers. */
1218 ! (IS_DRIVE (newdir
[0])
1219 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1221 /* Detect Windows file names in UNC format. */
1222 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1223 && !IS_DIRECTORY_SEP (newdir
[2]))
1227 /* Effectively, let newdir be (expand-file-name newdir cwd).
1228 Because of the admonition against calling expand-file-name
1229 when we have pointers into lisp strings, we accomplish this
1230 indirectly by prepending newdir to nm if necessary, and using
1231 cwd (or the wd of newdir's drive) as the new newdir. */
1234 const int adir_size
= MAX_UTF8_PATH
;
1236 const int adir_size
= MAXPATHLEN
+ 1;
1239 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1241 drive
= (unsigned char) newdir
[0];
1244 if (!IS_DIRECTORY_SEP (nm
[0]))
1246 ptrdiff_t nmlen
= nmlim
- nm
;
1247 ptrdiff_t newdirlen
= newdirlim
- newdir
;
1248 char *tmp
= alloca (newdirlen
+ file_name_as_directory_slop
1250 ptrdiff_t dlen
= file_name_as_directory (tmp
, newdir
, newdirlen
,
1252 memcpy (tmp
+ dlen
, nm
, nmlen
+ 1);
1254 nmlim
= nm
+ dlen
+ nmlen
;
1256 adir
= alloca (adir_size
);
1259 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1263 getcwd (adir
, adir_size
);
1266 Lisp_Object tem
= build_string (adir
);
1268 tem
= DECODE_FILE (tem
);
1269 newdirlim
= adir
+ SBYTES (tem
);
1270 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1273 newdirlim
= adir
+ strlen (adir
);
1277 /* Strip off drive name from prefix, if present. */
1278 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1284 /* Keep only a prefix from newdir if nm starts with slash
1285 (//server/share for UNC, nothing otherwise). */
1286 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1289 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1290 && !IS_DIRECTORY_SEP (newdir
[2]))
1292 char *adir
= strcpy (alloca (newdirlim
- newdir
+ 1), newdir
);
1294 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1296 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1299 newdirlim
= newdir
+ strlen (adir
);
1303 newdir
= newdirlim
= "";
1308 /* Ignore any slash at the end of newdir, unless newdir is
1309 just "/" or "//". */
1310 length
= newdirlim
- newdir
;
1311 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1312 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1315 /* Now concatenate the directory and name to new space in the stack frame. */
1316 tlen
= length
+ file_name_as_directory_slop
+ (nmlim
- nm
) + 1;
1317 eassert (tlen
> file_name_as_directory_slop
+ 1);
1319 /* Reserve space for drive specifier and escape prefix, since either
1320 or both may need to be inserted. (The Microsoft x86 compiler
1321 produces incorrect code if the following two lines are combined.) */
1322 target
= alloca (tlen
+ 4);
1324 #else /* not DOS_NT */
1325 target
= SAFE_ALLOCA (tlen
);
1326 #endif /* not DOS_NT */
1332 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1335 /* If newdir is effectively "C:/", then the drive letter will have
1336 been stripped and newdir will be "/". Concatenating with an
1337 absolute directory in nm produces "//", which will then be
1338 incorrectly treated as a network share. Ignore newdir in
1339 this case (keeping the drive letter). */
1340 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1341 && newdir
[1] == '\0'))
1344 memcpy (target
, newdir
, length
);
1350 nbytes
= file_name_as_directory (target
, newdir
, length
, multibyte
);
1353 memcpy (target
+ nbytes
, nm
, nmlim
- nm
+ 1);
1355 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1363 if (!IS_DIRECTORY_SEP (*p
))
1367 else if (p
[1] == '.'
1368 && (IS_DIRECTORY_SEP (p
[2])
1371 /* If "/." is the entire filename, keep the "/". Otherwise,
1372 just delete the whole "/.". */
1373 if (o
== target
&& p
[2] == '\0')
1377 else if (p
[1] == '.' && p
[2] == '.'
1378 /* `/../' is the "superroot" on certain file systems.
1379 Turned off on DOS_NT systems because they have no
1380 "superroot" and because this causes us to produce
1381 file names like "d:/../foo" which fail file-related
1382 functions of the underlying OS. (To reproduce, try a
1383 long series of "../../" in default_directory, longer
1384 than the number of levels from the root.) */
1388 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1393 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1396 /* Don't go below server level in UNC filenames. */
1397 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1398 && IS_DIRECTORY_SEP (*target
))
1402 /* Keep initial / only if this is the whole name. */
1403 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1407 else if (IS_DIRECTORY_SEP (p
[1])
1408 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1409 /* Collapse multiple "/", except leave leading "//" alone. */
1418 /* At last, set drive name. */
1420 /* Except for network file name. */
1421 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1422 #endif /* WINDOWSNT */
1424 if (!drive
) emacs_abort ();
1426 target
[0] = DRIVE_LETTER (drive
);
1429 /* Reinsert the escape prefix if required. */
1436 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1437 dostounix_filename (SSDATA (result
));
1439 if (!NILP (Vw32_downcase_file_names
))
1440 result
= Fdowncase (result
);
1443 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1444 #endif /* !DOS_NT */
1447 /* Again look to see if the file name has special constructs in it
1448 and perhaps call the corresponding file handler. This is needed
1449 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1450 the ".." component gives us "/user@host:/bar/../baz" which needs
1451 to be expanded again. */
1452 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1453 if (!NILP (handler
))
1455 handled_name
= call3 (handler
, Qexpand_file_name
,
1456 result
, default_directory
);
1457 if (! STRINGP (handled_name
))
1458 error ("Invalid handler in `file-name-handler-alist'");
1459 result
= handled_name
;
1467 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1468 This is the old version of expand-file-name, before it was thoroughly
1469 rewritten for Emacs 10.31. We leave this version here commented-out,
1470 because the code is very complex and likely to have subtle bugs. If
1471 bugs _are_ found, it might be of interest to look at the old code and
1472 see what did it do in the relevant situation.
1474 Don't remove this code: it's true that it will be accessible
1475 from the repository, but a few years from deletion, people will
1476 forget it is there. */
1478 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1479 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1480 "Convert FILENAME to absolute, and canonicalize it.\n\
1481 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1482 \(does not start with slash); if DEFAULT is nil or missing,\n\
1483 the current buffer's value of default-directory is used.\n\
1484 Filenames containing `.' or `..' as components are simplified;\n\
1485 initial `~/' expands to your home directory.\n\
1486 See also the function `substitute-in-file-name'.")
1488 Lisp_Object name
, defalt
;
1492 register unsigned char *newdir
, *p
, *o
;
1494 unsigned char *target
;
1497 CHECK_STRING (name
);
1500 /* If nm is absolute, flush ...// and detect /./ and /../.
1501 If no /./ or /../ we can return right away. */
1508 if (p
[0] == '/' && p
[1] == '/')
1510 if (p
[0] == '/' && p
[1] == '~')
1511 nm
= p
+ 1, lose
= 1;
1512 if (p
[0] == '/' && p
[1] == '.'
1513 && (p
[2] == '/' || p
[2] == 0
1514 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1520 if (nm
== SDATA (name
))
1522 return build_string (nm
);
1526 /* Now determine directory to start with and put it in NEWDIR. */
1530 if (nm
[0] == '~') /* prefix ~ */
1531 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1533 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1534 newdir
= (unsigned char *) "";
1537 else /* ~user/filename */
1539 /* Get past ~ to user. */
1540 unsigned char *user
= nm
+ 1;
1541 /* Find end of name. */
1542 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1543 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1544 /* Copy the user name into temp storage. */
1545 o
= alloca (len
+ 1);
1546 memcpy (o
, user
, len
);
1549 /* Look up the user name. */
1551 pw
= (struct passwd
*) getpwnam (o
+ 1);
1554 error ("\"%s\" isn't a registered user", o
+ 1);
1556 newdir
= (unsigned char *) pw
->pw_dir
;
1558 /* Discard the user name from NM. */
1562 if (nm
[0] != '/' && !newdir
)
1565 defalt
= current_buffer
->directory
;
1566 CHECK_STRING (defalt
);
1567 newdir
= SDATA (defalt
);
1570 /* Now concatenate the directory and name to new space in the stack frame. */
1572 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1573 target
= alloca (tlen
);
1578 if (nm
[0] == 0 || nm
[0] == '/')
1579 strcpy (target
, newdir
);
1581 file_name_as_directory (target
, newdir
);
1584 strcat (target
, nm
);
1586 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1597 else if (!strncmp (p
, "//", 2)
1603 else if (p
[0] == '/' && p
[1] == '.'
1604 && (p
[2] == '/' || p
[2] == 0))
1606 else if (!strncmp (p
, "/..", 3)
1607 /* `/../' is the "superroot" on certain file systems. */
1609 && (p
[3] == '/' || p
[3] == 0))
1611 while (o
!= target
&& *--o
!= '/')
1613 if (o
== target
&& *o
== '/')
1623 return make_string (target
, o
- target
);
1627 /* If /~ or // appears, discard everything through first slash. */
1629 file_name_absolute_p (const char *filename
)
1632 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1634 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1635 && IS_DIRECTORY_SEP (filename
[2]))
1641 search_embedded_absfilename (char *nm
, char *endp
)
1645 for (p
= nm
+ 1; p
< endp
; p
++)
1647 if (IS_DIRECTORY_SEP (p
[-1])
1648 && file_name_absolute_p (p
)
1649 #if defined (WINDOWSNT) || defined (CYGWIN)
1650 /* // at start of file name is meaningful in Apollo,
1651 WindowsNT and Cygwin systems. */
1652 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1653 #endif /* not (WINDOWSNT || CYGWIN) */
1656 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1657 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1660 char *o
= SAFE_ALLOCA (s
- p
+ 1);
1662 memcpy (o
, p
, s
- p
);
1665 /* If we have ~user and `user' exists, discard
1666 everything up to ~. But if `user' does not exist, leave
1667 ~user alone, it might be a literal file name. */
1669 pw
= getpwnam (o
+ 1);
1682 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1683 Ssubstitute_in_file_name
, 1, 1, 0,
1684 doc
: /* Substitute environment variables referred to in FILENAME.
1685 `$FOO' where FOO is an environment variable name means to substitute
1686 the value of that variable. The variable name should be terminated
1687 with a character not a letter, digit or underscore; otherwise, enclose
1688 the entire variable name in braces.
1690 If `/~' appears, all of FILENAME through that `/' is discarded.
1691 If `//' appears, everything up to and including the first of
1692 those `/' is discarded. */)
1693 (Lisp_Object filename
)
1695 char *nm
, *p
, *x
, *endp
;
1696 bool substituted
= false;
1699 Lisp_Object handler
;
1701 CHECK_STRING (filename
);
1703 multibyte
= STRING_MULTIBYTE (filename
);
1705 /* If the file name has special constructs in it,
1706 call the corresponding file handler. */
1707 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1708 if (!NILP (handler
))
1710 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1712 if (STRINGP (handled_name
))
1713 return handled_name
;
1714 error ("Invalid handler in `file-name-handler-alist'");
1717 /* Always work on a copy of the string, in case GC happens during
1718 decode of environment variables, causing the original Lisp_String
1719 data to be relocated. */
1721 SAFE_ALLOCA_STRING (nm
, filename
);
1724 dostounix_filename (nm
);
1725 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1727 endp
= nm
+ SBYTES (filename
);
1729 /* If /~ or // appears, discard everything through first slash. */
1730 p
= search_embedded_absfilename (nm
, endp
);
1732 /* Start over with the new string, so we check the file-name-handler
1733 again. Important with filenames like "/home/foo//:/hello///there"
1734 which would substitute to "/:/hello///there" rather than "/there". */
1737 = (Fsubstitute_in_file_name
1738 (make_specified_string (p
, -1, endp
- p
, multibyte
)));
1743 /* See if any variables are substituted into the string. */
1745 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1748 = (!substituted
? filename
1749 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1750 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1752 if (!EQ (tmp
, name
))
1760 if (!NILP (Vw32_downcase_file_names
))
1761 filename
= Fdowncase (filename
);
1767 xnm
= SSDATA (filename
);
1768 x
= xnm
+ SBYTES (filename
);
1770 /* If /~ or // appears, discard everything through first slash. */
1771 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1772 /* This time we do not start over because we've already expanded envvars
1773 and replaced $$ with $. Maybe we should start over as well, but we'd
1774 need to quote some $ to $$ first. */
1778 if (!NILP (Vw32_downcase_file_names
))
1780 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1782 filename
= Fdowncase (xname
);
1786 if (xnm
!= SSDATA (filename
))
1787 filename
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1792 /* A slightly faster and more convenient way to get
1793 (directory-file-name (expand-file-name FOO)). */
1796 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1798 register Lisp_Object absname
;
1800 absname
= Fexpand_file_name (filename
, defdir
);
1802 /* Remove final slash, if any (unless this is the root dir).
1803 stat behaves differently depending! */
1804 if (SCHARS (absname
) > 1
1805 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1806 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1807 /* We cannot take shortcuts; they might be wrong for magic file names. */
1808 absname
= Fdirectory_file_name (absname
);
1812 /* Signal an error if the file ABSNAME already exists.
1813 If KNOWN_TO_EXIST, the file is known to exist.
1814 QUERYSTRING is a name for the action that is being considered
1816 If INTERACTIVE, ask the user whether to proceed,
1817 and bypass the error if the user says to go ahead.
1818 If QUICK, ask for y or n, not yes or no. */
1821 barf_or_query_if_file_exists (Lisp_Object absname
, bool known_to_exist
,
1822 const char *querystring
, bool interactive
,
1825 Lisp_Object tem
, encoded_filename
;
1826 struct stat statbuf
;
1828 encoded_filename
= ENCODE_FILE (absname
);
1830 if (! known_to_exist
&& lstat (SSDATA (encoded_filename
), &statbuf
) == 0)
1832 if (S_ISDIR (statbuf
.st_mode
))
1833 xsignal2 (Qfile_error
,
1834 build_string ("File is a directory"), absname
);
1835 known_to_exist
= true;
1841 xsignal2 (Qfile_already_exists
,
1842 build_string ("File already exists"), absname
);
1843 AUTO_STRING (format
, "File %s already exists; %s anyway? ");
1844 tem
= CALLN (Fformat
, format
, absname
, build_string (querystring
));
1846 tem
= call1 (intern ("y-or-n-p"), tem
);
1848 tem
= do_yes_or_no_p (tem
);
1850 xsignal2 (Qfile_already_exists
,
1851 build_string ("File already exists"), absname
);
1856 /* Copy data to DEST from SOURCE if possible. Return true if OK. */
1858 clone_file (int dest
, int source
)
1861 return ioctl (dest
, FICLONE
, source
) == 0;
1867 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1868 "fCopy file: \nGCopy %s to file: \np\nP",
1869 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1870 If NEWNAME names a directory, copy FILE there.
1872 This function always sets the file modes of the output file to match
1875 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1876 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1877 signal a `file-already-exists' error without overwriting. If
1878 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1879 about overwriting; this is what happens in interactive use with M-x.
1880 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1883 Fourth arg KEEP-TIME non-nil means give the output file the same
1884 last-modified time as the old one. (This works on only some systems.)
1886 A prefix arg makes KEEP-TIME non-nil.
1888 If PRESERVE-UID-GID is non-nil, we try to transfer the
1889 uid and gid of FILE to NEWNAME.
1891 If PRESERVE-PERMISSIONS is non-nil, copy permissions of FILE to NEWNAME;
1892 this includes the file modes, along with ACL entries and SELinux
1893 context if present. Otherwise, if NEWNAME is created its file
1894 permission bits are those of FILE, masked by the default file
1896 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
,
1897 Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
,
1898 Lisp_Object preserve_permissions
)
1900 Lisp_Object handler
;
1901 ptrdiff_t count
= SPECPDL_INDEX ();
1902 Lisp_Object encoded_file
, encoded_newname
;
1904 security_context_t con
;
1910 bool already_exists
= false;
1916 encoded_file
= encoded_newname
= Qnil
;
1917 CHECK_STRING (file
);
1918 CHECK_STRING (newname
);
1920 if (!NILP (Ffile_directory_p (newname
)))
1921 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1923 newname
= Fexpand_file_name (newname
, Qnil
);
1925 file
= Fexpand_file_name (file
, Qnil
);
1927 /* If the input file name has special constructs in it,
1928 call the corresponding file handler. */
1929 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1930 /* Likewise for output file name. */
1932 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1933 if (!NILP (handler
))
1934 return call7 (handler
, Qcopy_file
, file
, newname
,
1935 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1936 preserve_permissions
);
1938 encoded_file
= ENCODE_FILE (file
);
1939 encoded_newname
= ENCODE_FILE (newname
);
1942 if (NILP (ok_if_already_exists
)
1943 || INTEGERP (ok_if_already_exists
))
1944 barf_or_query_if_file_exists (newname
, false, "copy to it",
1945 INTEGERP (ok_if_already_exists
), false);
1947 result
= w32_copy_file (SSDATA (encoded_file
), SSDATA (encoded_newname
),
1948 !NILP (keep_time
), !NILP (preserve_uid_gid
),
1949 !NILP (preserve_permissions
));
1953 report_file_error ("Copying file", list2 (file
, newname
));
1955 report_file_error ("Copying permissions from", file
);
1957 xsignal2 (Qfile_date_error
,
1958 build_string ("Resetting file times"), newname
);
1960 report_file_error ("Copying permissions to", newname
);
1962 #else /* not WINDOWSNT */
1963 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1966 report_file_error ("Opening input file", file
);
1968 record_unwind_protect_int (close_file_unwind
, ifd
);
1970 if (fstat (ifd
, &st
) != 0)
1971 report_file_error ("Input file status", file
);
1973 if (!NILP (preserve_permissions
))
1976 if (is_selinux_enabled ())
1978 conlength
= fgetfilecon (ifd
, &con
);
1979 if (conlength
== -1)
1980 report_file_error ("Doing fgetfilecon", file
);
1985 /* We can copy only regular files. */
1986 if (!S_ISREG (st
.st_mode
))
1987 report_file_errno ("Non-regular file", file
,
1988 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
1991 new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0700 : 0777);
1993 new_mask
= S_IREAD
| S_IWRITE
;
1996 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
| O_CREAT
| O_EXCL
,
1998 if (ofd
< 0 && errno
== EEXIST
)
2000 if (NILP (ok_if_already_exists
) || INTEGERP (ok_if_already_exists
))
2001 barf_or_query_if_file_exists (newname
, true, "copy to it",
2002 INTEGERP (ok_if_already_exists
), false);
2003 already_exists
= true;
2004 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
, 0);
2007 report_file_error ("Opening output file", newname
);
2009 record_unwind_protect_int (close_file_unwind
, ofd
);
2011 off_t oldsize
= 0, newsize
;
2016 if (fstat (ofd
, &out_st
) != 0)
2017 report_file_error ("Output file status", newname
);
2018 if (st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2019 report_file_errno ("Input and output files are the same",
2020 list2 (file
, newname
), 0);
2021 if (S_ISREG (out_st
.st_mode
))
2022 oldsize
= out_st
.st_size
;
2027 if (clone_file (ofd
, ifd
))
2028 newsize
= st
.st_size
;
2031 char buf
[MAX_ALLOCA
];
2033 for (newsize
= 0; 0 < (n
= emacs_read_quit (ifd
, buf
, sizeof buf
));
2035 if (emacs_write_quit (ofd
, buf
, n
) != n
)
2036 report_file_error ("Write error", newname
);
2038 report_file_error ("Read error", file
);
2041 /* Truncate any existing output file after writing the data. This
2042 is more likely to work than truncation before writing, if the
2043 file system is out of space or the user is over disk quota. */
2044 if (newsize
< oldsize
&& ftruncate (ofd
, newsize
) != 0)
2045 report_file_error ("Truncating output file", newname
);
2048 /* Preserve the original file permissions, and if requested, also its
2051 mode_t preserved_permissions
= st
.st_mode
& 07777;
2052 mode_t default_permissions
= st
.st_mode
& 0777 & ~realmask
;
2053 if (!NILP (preserve_uid_gid
))
2055 /* Attempt to change owner and group. If that doesn't work
2056 attempt to change just the group, as that is sometimes allowed.
2057 Adjust the mode mask to eliminate setuid or setgid bits
2058 or group permissions bits that are inappropriate if the
2059 owner or group are wrong. */
2060 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2062 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2063 preserved_permissions
&= ~04000;
2066 preserved_permissions
&= ~06000;
2068 /* Copy the other bits to the group bits, since the
2070 preserved_permissions
&= ~070;
2071 preserved_permissions
|= (preserved_permissions
& 7) << 3;
2072 default_permissions
&= ~070;
2073 default_permissions
|= (default_permissions
& 7) << 3;
2078 switch (!NILP (preserve_permissions
)
2079 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2080 SSDATA (encoded_newname
), ofd
,
2081 preserved_permissions
)
2083 || (new_mask
& ~realmask
) == default_permissions
)
2085 : fchmod (ofd
, default_permissions
))
2087 case -2: report_file_error ("Copying permissions from", file
);
2088 case -1: report_file_error ("Copying permissions to", newname
);
2091 #endif /* not MSDOS */
2096 /* Set the modified context back to the file. */
2097 bool fail
= fsetfilecon (ofd
, con
) != 0;
2098 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2099 if (fail
&& errno
!= ENOTSUP
)
2100 report_file_error ("Doing fsetfilecon", newname
);
2106 if (!NILP (keep_time
))
2108 struct timespec atime
= get_stat_atime (&st
);
2109 struct timespec mtime
= get_stat_mtime (&st
);
2110 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
) != 0)
2111 xsignal2 (Qfile_date_error
,
2112 build_string ("Cannot set file date"), newname
);
2115 if (emacs_close (ofd
) < 0)
2116 report_file_error ("Write error", newname
);
2121 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2122 and if it can't, it tells so. Otherwise, under MSDOS we usually
2123 get only the READ bit, which will make the copied file read-only,
2124 so it's better not to chmod at all. */
2125 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2126 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2128 #endif /* not WINDOWSNT */
2130 /* Discard the unwind protects. */
2131 specpdl_ptr
= specpdl
+ count
;
2136 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2137 Smake_directory_internal
, 1, 1, 0,
2138 doc
: /* Create a new directory named DIRECTORY. */)
2139 (Lisp_Object directory
)
2142 Lisp_Object handler
;
2143 Lisp_Object encoded_dir
;
2145 CHECK_STRING (directory
);
2146 directory
= Fexpand_file_name (directory
, Qnil
);
2148 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2149 if (!NILP (handler
))
2150 return call2 (handler
, Qmake_directory_internal
, directory
);
2152 encoded_dir
= ENCODE_FILE (directory
);
2154 dir
= SSDATA (encoded_dir
);
2157 if (mkdir (dir
) != 0)
2159 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2161 report_file_error ("Creating directory", directory
);
2166 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2167 Sdelete_directory_internal
, 1, 1, 0,
2168 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2169 (Lisp_Object directory
)
2172 Lisp_Object encoded_dir
;
2174 CHECK_STRING (directory
);
2175 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2176 encoded_dir
= ENCODE_FILE (directory
);
2177 dir
= SSDATA (encoded_dir
);
2179 if (rmdir (dir
) != 0)
2180 report_file_error ("Removing directory", directory
);
2185 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2186 "(list (read-file-name \
2187 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2188 \"Move file to trash: \" \"Delete file: \") \
2189 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2190 (null current-prefix-arg))",
2191 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2192 If file has multiple names, it continues to exist with the other names.
2193 TRASH non-nil means to trash the file instead of deleting, provided
2194 `delete-by-moving-to-trash' is non-nil.
2196 When called interactively, TRASH is t if no prefix argument is given.
2197 With a prefix argument, TRASH is nil. */)
2198 (Lisp_Object filename
, Lisp_Object trash
)
2200 Lisp_Object handler
;
2201 Lisp_Object encoded_file
;
2203 if (!NILP (Ffile_directory_p (filename
))
2204 && NILP (Ffile_symlink_p (filename
)))
2205 xsignal2 (Qfile_error
,
2206 build_string ("Removing old name: is a directory"),
2208 filename
= Fexpand_file_name (filename
, Qnil
);
2210 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2211 if (!NILP (handler
))
2212 return call3 (handler
, Qdelete_file
, filename
, trash
);
2214 if (delete_by_moving_to_trash
&& !NILP (trash
))
2215 return call1 (Qmove_file_to_trash
, filename
);
2217 encoded_file
= ENCODE_FILE (filename
);
2219 if (unlink (SSDATA (encoded_file
)) != 0 && errno
!= ENOENT
)
2220 report_file_error ("Removing old name", filename
);
2225 internal_delete_file_1 (Lisp_Object ignore
)
2230 /* Delete file FILENAME, returning true if successful.
2231 This ignores `delete-by-moving-to-trash'. */
2234 internal_delete_file (Lisp_Object filename
)
2238 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2239 Qt
, internal_delete_file_1
);
2243 /* Filesystems are case-sensitive on all supported systems except
2244 MS-Windows, MS-DOS, Cygwin, and Mac OS X. They are always
2245 case-insensitive on the first two, but they may or may not be
2246 case-insensitive on Cygwin and OS X. The following function
2247 attempts to provide a runtime test on those two systems. If the
2248 test is not conclusive, we assume case-insensitivity on Cygwin and
2249 case-sensitivity on Mac OS X.
2251 FIXME: Mounted filesystems on Posix hosts, like Samba shares or
2252 NFS-mounted Windows volumes, might be case-insensitive. Can we
2256 file_name_case_insensitive_p (const char *filename
)
2258 /* Use pathconf with _PC_CASE_INSENSITIVE or _PC_CASE_SENSITIVE if
2259 those flags are available. As of this writing (2017-05-20),
2260 Cygwin is the only platform known to support the former (starting
2261 with Cygwin-2.6.1), and macOS is the only platform known to
2262 support the latter. */
2264 #ifdef _PC_CASE_INSENSITIVE
2265 int res
= pathconf (filename
, _PC_CASE_INSENSITIVE
);
2268 #elif defined _PC_CASE_SENSITIVE
2269 int res
= pathconf (filename
, _PC_CASE_SENSITIVE
);
2274 #if defined CYGWIN || defined DOS_NT
2281 DEFUN ("file-name-case-insensitive-p", Ffile_name_case_insensitive_p
,
2282 Sfile_name_case_insensitive_p
, 1, 1, 0,
2283 doc
: /* Return t if file FILENAME is on a case-insensitive filesystem.
2284 The arg must be a string. */)
2285 (Lisp_Object filename
)
2287 Lisp_Object handler
;
2289 CHECK_STRING (filename
);
2290 filename
= Fexpand_file_name (filename
, Qnil
);
2292 /* If the file name has special constructs in it,
2293 call the corresponding file handler. */
2294 handler
= Ffind_file_name_handler (filename
, Qfile_name_case_insensitive_p
);
2295 if (!NILP (handler
))
2296 return call2 (handler
, Qfile_name_case_insensitive_p
, filename
);
2298 filename
= ENCODE_FILE (filename
);
2299 return file_name_case_insensitive_p (SSDATA (filename
)) ? Qt
: Qnil
;
2302 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2303 "fRename file: \nGRename %s to file: \np",
2304 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2305 If file has names other than FILE, it continues to have those names.
2306 Signals a `file-already-exists' error if a file NEWNAME already exists
2307 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2308 A number as third arg means request confirmation if NEWNAME already exists.
2309 This is what happens in interactive use with M-x. */)
2310 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2312 Lisp_Object handler
;
2313 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2315 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2316 CHECK_STRING (file
);
2317 CHECK_STRING (newname
);
2318 file
= Fexpand_file_name (file
, Qnil
);
2320 if ((!NILP (Ffile_directory_p (newname
)))
2321 /* If the filesystem is case-insensitive and the file names are
2322 identical but for the case, don't attempt to move directory
2324 && (NILP (Ffile_name_case_insensitive_p (file
))
2325 || NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
)))))
2327 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2328 ? file
: Fdirectory_file_name (file
));
2329 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2332 newname
= Fexpand_file_name (newname
, Qnil
);
2334 /* If the file name has special constructs in it,
2335 call the corresponding file handler. */
2336 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2338 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2339 if (!NILP (handler
))
2340 return call4 (handler
, Qrename_file
,
2341 file
, newname
, ok_if_already_exists
);
2343 encoded_file
= ENCODE_FILE (file
);
2344 encoded_newname
= ENCODE_FILE (newname
);
2346 /* If the filesystem is case-insensitive and the file names are
2347 identical but for the case, don't ask for confirmation: they
2348 simply want to change the letter-case of the file name. */
2349 if ((!(file_name_case_insensitive_p (SSDATA (encoded_file
)))
2350 || NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2351 && ((NILP (ok_if_already_exists
) || INTEGERP (ok_if_already_exists
))))
2352 barf_or_query_if_file_exists (newname
, false, "rename to it",
2353 INTEGERP (ok_if_already_exists
), false);
2354 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2356 int rename_errno
= errno
;
2357 if (rename_errno
== EXDEV
)
2360 symlink_target
= Ffile_symlink_p (file
);
2361 if (! NILP (symlink_target
))
2362 Fmake_symbolic_link (symlink_target
, newname
,
2363 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2364 else if (!NILP (Ffile_directory_p (file
)))
2365 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2367 /* We have already prompted if it was an integer, so don't
2368 have copy-file prompt again. */
2369 Fcopy_file (file
, newname
,
2370 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2373 count
= SPECPDL_INDEX ();
2374 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2376 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2377 call2 (Qdelete_directory
, file
, Qt
);
2379 Fdelete_file (file
, Qnil
);
2380 unbind_to (count
, Qnil
);
2383 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2389 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2390 "fAdd name to file: \nGName to add to %s: \np",
2391 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2392 Signals a `file-already-exists' error if a file NEWNAME already exists
2393 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2394 A number as third arg means request confirmation if NEWNAME already exists.
2395 This is what happens in interactive use with M-x. */)
2396 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2398 Lisp_Object handler
;
2399 Lisp_Object encoded_file
, encoded_newname
;
2401 encoded_file
= encoded_newname
= Qnil
;
2402 CHECK_STRING (file
);
2403 CHECK_STRING (newname
);
2404 file
= Fexpand_file_name (file
, Qnil
);
2406 if (!NILP (Ffile_directory_p (newname
)))
2407 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2409 newname
= Fexpand_file_name (newname
, Qnil
);
2411 /* If the file name has special constructs in it,
2412 call the corresponding file handler. */
2413 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2414 if (!NILP (handler
))
2415 return call4 (handler
, Qadd_name_to_file
, file
,
2416 newname
, ok_if_already_exists
);
2418 /* If the new name has special constructs in it,
2419 call the corresponding file handler. */
2420 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2421 if (!NILP (handler
))
2422 return call4 (handler
, Qadd_name_to_file
, file
,
2423 newname
, ok_if_already_exists
);
2425 encoded_file
= ENCODE_FILE (file
);
2426 encoded_newname
= ENCODE_FILE (newname
);
2428 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) == 0)
2431 if (errno
== EEXIST
)
2433 if (NILP (ok_if_already_exists
)
2434 || INTEGERP (ok_if_already_exists
))
2435 barf_or_query_if_file_exists (newname
, true, "make it a new name",
2436 INTEGERP (ok_if_already_exists
), false);
2437 unlink (SSDATA (newname
));
2438 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) == 0)
2442 report_file_error ("Adding new name", list2 (file
, newname
));
2445 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2446 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2447 doc
: /* Make a symbolic link to TARGET, named LINKNAME.
2448 Both args must be strings.
2449 Signals a `file-already-exists' error if a file LINKNAME already exists
2450 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2451 A number as third arg means request confirmation if LINKNAME already exists.
2452 This happens for interactive use with M-x. */)
2453 (Lisp_Object target
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2455 Lisp_Object handler
;
2456 Lisp_Object encoded_target
, encoded_linkname
;
2458 encoded_target
= encoded_linkname
= Qnil
;
2459 CHECK_STRING (target
);
2460 CHECK_STRING (linkname
);
2461 /* If the link target has a ~, we must expand it to get
2462 a truly valid file name. Otherwise, do not expand;
2463 we want to permit links to relative file names. */
2464 if (SREF (target
, 0) == '~')
2465 target
= Fexpand_file_name (target
, Qnil
);
2467 if (!NILP (Ffile_directory_p (linkname
)))
2468 linkname
= Fexpand_file_name (Ffile_name_nondirectory (target
), linkname
);
2470 linkname
= Fexpand_file_name (linkname
, Qnil
);
2472 /* If the file name has special constructs in it,
2473 call the corresponding file handler. */
2474 handler
= Ffind_file_name_handler (target
, Qmake_symbolic_link
);
2475 if (!NILP (handler
))
2476 return call4 (handler
, Qmake_symbolic_link
, target
,
2477 linkname
, ok_if_already_exists
);
2479 /* If the new link name has special constructs in it,
2480 call the corresponding file handler. */
2481 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2482 if (!NILP (handler
))
2483 return call4 (handler
, Qmake_symbolic_link
, target
,
2484 linkname
, ok_if_already_exists
);
2486 encoded_target
= ENCODE_FILE (target
);
2487 encoded_linkname
= ENCODE_FILE (linkname
);
2489 if (symlink (SSDATA (encoded_target
), SSDATA (encoded_linkname
)) == 0)
2492 if (errno
== ENOSYS
)
2493 xsignal1 (Qfile_error
,
2494 build_string ("Symbolic links are not supported"));
2496 if (errno
== EEXIST
)
2498 if (NILP (ok_if_already_exists
)
2499 || INTEGERP (ok_if_already_exists
))
2500 barf_or_query_if_file_exists (linkname
, true, "make it a link",
2501 INTEGERP (ok_if_already_exists
), false);
2502 unlink (SSDATA (encoded_linkname
));
2503 if (symlink (SSDATA (encoded_target
), SSDATA (encoded_linkname
)) == 0)
2507 report_file_error ("Making symbolic link", list2 (target
, linkname
));
2511 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2513 doc
: /* Return t if file FILENAME specifies an absolute file name.
2514 On Unix, this is a name starting with a `/' or a `~'. */)
2515 (Lisp_Object filename
)
2517 CHECK_STRING (filename
);
2518 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2521 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2522 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2523 See also `file-readable-p' and `file-attributes'.
2524 This returns nil for a symlink to a nonexistent file.
2525 Use `file-symlink-p' to test for such links. */)
2526 (Lisp_Object filename
)
2528 Lisp_Object absname
;
2529 Lisp_Object handler
;
2531 CHECK_STRING (filename
);
2532 absname
= Fexpand_file_name (filename
, Qnil
);
2534 /* If the file name has special constructs in it,
2535 call the corresponding file handler. */
2536 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2537 if (!NILP (handler
))
2539 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2544 absname
= ENCODE_FILE (absname
);
2546 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2549 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2550 doc
: /* Return t if FILENAME can be executed by you.
2551 For a directory, this means you can access files in that directory.
2552 \(It is generally better to use `file-accessible-directory-p' for that
2553 purpose, though.) */)
2554 (Lisp_Object filename
)
2556 Lisp_Object absname
;
2557 Lisp_Object handler
;
2559 CHECK_STRING (filename
);
2560 absname
= Fexpand_file_name (filename
, Qnil
);
2562 /* If the file name has special constructs in it,
2563 call the corresponding file handler. */
2564 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2565 if (!NILP (handler
))
2566 return call2 (handler
, Qfile_executable_p
, absname
);
2568 absname
= ENCODE_FILE (absname
);
2570 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2573 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2574 doc
: /* Return t if file FILENAME exists and you can read it.
2575 See also `file-exists-p' and `file-attributes'. */)
2576 (Lisp_Object filename
)
2578 Lisp_Object absname
;
2579 Lisp_Object handler
;
2581 CHECK_STRING (filename
);
2582 absname
= Fexpand_file_name (filename
, Qnil
);
2584 /* If the file name has special constructs in it,
2585 call the corresponding file handler. */
2586 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2587 if (!NILP (handler
))
2588 return call2 (handler
, Qfile_readable_p
, absname
);
2590 absname
= ENCODE_FILE (absname
);
2591 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2595 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2596 doc
: /* Return t if file FILENAME can be written or created by you. */)
2597 (Lisp_Object filename
)
2599 Lisp_Object absname
, dir
, encoded
;
2600 Lisp_Object handler
;
2602 CHECK_STRING (filename
);
2603 absname
= Fexpand_file_name (filename
, Qnil
);
2605 /* If the file name has special constructs in it,
2606 call the corresponding file handler. */
2607 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2608 if (!NILP (handler
))
2609 return call2 (handler
, Qfile_writable_p
, absname
);
2611 encoded
= ENCODE_FILE (absname
);
2612 if (check_writable (SSDATA (encoded
), W_OK
))
2614 if (errno
!= ENOENT
)
2617 dir
= Ffile_name_directory (absname
);
2618 eassert (!NILP (dir
));
2620 dir
= Fdirectory_file_name (dir
);
2623 dir
= ENCODE_FILE (dir
);
2625 /* The read-only attribute of the parent directory doesn't affect
2626 whether a file or directory can be created within it. Some day we
2627 should check ACLs though, which do affect this. */
2628 return file_directory_p (SSDATA (dir
)) ? Qt
: Qnil
;
2630 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2634 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2635 doc
: /* Access file FILENAME, and get an error if that does not work.
2636 The second argument STRING is prepended to the error message.
2637 If there is no error, returns nil. */)
2638 (Lisp_Object filename
, Lisp_Object string
)
2640 Lisp_Object handler
, encoded_filename
, absname
;
2642 CHECK_STRING (filename
);
2643 absname
= Fexpand_file_name (filename
, Qnil
);
2645 CHECK_STRING (string
);
2647 /* If the file name has special constructs in it,
2648 call the corresponding file handler. */
2649 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2650 if (!NILP (handler
))
2651 return call3 (handler
, Qaccess_file
, absname
, string
);
2653 encoded_filename
= ENCODE_FILE (absname
);
2655 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2656 report_file_error (SSDATA (string
), filename
);
2661 /* Relative to directory FD, return the symbolic link value of FILENAME.
2662 On failure, return nil. */
2664 emacs_readlinkat (int fd
, char const *filename
)
2666 static struct allocator
const emacs_norealloc_allocator
=
2667 { xmalloc
, NULL
, xfree
, memory_full
};
2669 char readlink_buf
[1024];
2670 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2671 &emacs_norealloc_allocator
, readlinkat
);
2675 val
= build_unibyte_string (buf
);
2676 if (buf
[0] == '/' && strchr (buf
, ':'))
2678 AUTO_STRING (slash_colon
, "/:");
2679 val
= concat2 (slash_colon
, val
);
2681 if (buf
!= readlink_buf
)
2683 val
= DECODE_FILE (val
);
2687 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2688 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2689 The value is the link target, as a string.
2690 Otherwise it returns nil.
2692 This function does not check whether the link target exists. */)
2693 (Lisp_Object filename
)
2695 Lisp_Object handler
;
2697 CHECK_STRING (filename
);
2698 filename
= Fexpand_file_name (filename
, Qnil
);
2700 /* If the file name has special constructs in it,
2701 call the corresponding file handler. */
2702 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2703 if (!NILP (handler
))
2704 return call2 (handler
, Qfile_symlink_p
, filename
);
2706 filename
= ENCODE_FILE (filename
);
2708 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2711 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2712 doc
: /* Return t if FILENAME names an existing directory.
2713 Symbolic links to directories count as directories.
2714 See `file-symlink-p' to distinguish symlinks. */)
2715 (Lisp_Object filename
)
2717 Lisp_Object absname
;
2718 Lisp_Object handler
;
2720 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2722 /* If the file name has special constructs in it,
2723 call the corresponding file handler. */
2724 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2725 if (!NILP (handler
))
2726 return call2 (handler
, Qfile_directory_p
, absname
);
2728 absname
= ENCODE_FILE (absname
);
2730 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2733 /* Return true if FILE is a directory or a symlink to a directory. */
2735 file_directory_p (char const *file
)
2738 /* This is cheaper than 'stat'. */
2739 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2742 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2746 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2747 Sfile_accessible_directory_p
, 1, 1, 0,
2748 doc
: /* Return t if FILENAME names a directory you can open.
2749 For the value to be t, FILENAME must specify the name of a directory
2750 as a file, and the directory must allow you to open files in it. In
2751 order to use a directory as a buffer's current directory, this
2752 predicate must return true. A directory name spec may be given
2753 instead; then the value is t if the directory so specified exists and
2754 really is a readable and searchable directory. */)
2755 (Lisp_Object filename
)
2757 Lisp_Object absname
;
2758 Lisp_Object handler
;
2760 CHECK_STRING (filename
);
2761 absname
= Fexpand_file_name (filename
, Qnil
);
2763 /* If the file name has special constructs in it,
2764 call the corresponding file handler. */
2765 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2766 if (!NILP (handler
))
2768 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2770 /* Set errno in case the handler failed. EACCES might be a lie
2771 (e.g., the directory might not exist, or be a regular file),
2772 but at least it does TRT in the "usual" case of an existing
2773 directory that is not accessible by the current user, and
2774 avoids reporting "Success" for a failed operation. Perhaps
2775 someday we can fix this in a better way, by improving
2776 file-accessible-directory-p's API; see Bug#25419. */
2783 absname
= ENCODE_FILE (absname
);
2784 return file_accessible_directory_p (absname
) ? Qt
: Qnil
;
2787 /* If FILE is a searchable directory or a symlink to a
2788 searchable directory, return true. Otherwise return
2789 false and set errno to an error number. */
2791 file_accessible_directory_p (Lisp_Object file
)
2795 /* We need a special-purpose test because (a) NTFS security data is
2796 not reflected in Posix-style mode bits, and (b) the trick with
2797 accessing "DIR/.", used below on Posix hosts, doesn't work on
2798 Windows, because "DIR/." is normalized to just "DIR" before
2799 hitting the disk. */
2800 return (SBYTES (file
) == 0
2801 || w32_accessible_directory_p (SSDATA (file
), SBYTES (file
)));
2803 return file_directory_p (SSDATA (file
));
2806 /* On POSIXish platforms, use just one system call; this avoids a
2807 race and is typically faster. */
2808 const char *data
= SSDATA (file
);
2809 ptrdiff_t len
= SBYTES (file
);
2815 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2816 There are three exceptions: "", "/", and "//". Leave "" alone,
2817 as it's invalid. Append only "." to the other two exceptions as
2818 "/" and "//" are distinct on some platforms, whereas "/", "///",
2819 "////", etc. are all equivalent. */
2824 /* Just check for trailing '/' when deciding whether to append '/'.
2825 That's simpler than testing the two special cases "/" and "//",
2826 and it's a safe optimization here. */
2827 char *buf
= SAFE_ALLOCA (len
+ 3);
2828 memcpy (buf
, data
, len
);
2829 strcpy (buf
+ len
, &"/."[data
[len
- 1] == '/']);
2833 ok
= check_existing (dir
);
2834 saved_errno
= errno
;
2836 errno
= saved_errno
;
2838 #endif /* !DOS_NT */
2841 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2842 doc
: /* Return t if FILENAME names a regular file.
2843 This is the sort of file that holds an ordinary stream of data bytes.
2844 Symbolic links to regular files count as regular files.
2845 See `file-symlink-p' to distinguish symlinks. */)
2846 (Lisp_Object filename
)
2848 register Lisp_Object absname
;
2850 Lisp_Object handler
;
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_regular_p
);
2857 if (!NILP (handler
))
2858 return call2 (handler
, Qfile_regular_p
, absname
);
2860 absname
= ENCODE_FILE (absname
);
2865 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2867 /* Tell stat to use expensive method to get accurate info. */
2868 Vw32_get_true_file_attributes
= Qt
;
2869 result
= stat (SSDATA (absname
), &st
);
2870 Vw32_get_true_file_attributes
= tem
;
2874 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2877 if (stat (SSDATA (absname
), &st
) < 0)
2879 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2883 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2884 Sfile_selinux_context
, 1, 1, 0,
2885 doc
: /* Return SELinux context of file named FILENAME.
2886 The return value is a list (USER ROLE TYPE RANGE), where the list
2887 elements are strings naming the user, role, type, and range of the
2888 file's SELinux security context.
2890 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2891 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2892 (Lisp_Object filename
)
2894 Lisp_Object absname
;
2895 Lisp_Object user
= Qnil
, role
= Qnil
, type
= Qnil
, range
= Qnil
;
2897 Lisp_Object handler
;
2899 security_context_t con
;
2904 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2906 /* If the file name has special constructs in it,
2907 call the corresponding file handler. */
2908 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2909 if (!NILP (handler
))
2910 return call2 (handler
, Qfile_selinux_context
, absname
);
2912 absname
= ENCODE_FILE (absname
);
2915 if (is_selinux_enabled ())
2917 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2920 context
= context_new (con
);
2921 if (context_user_get (context
))
2922 user
= build_string (context_user_get (context
));
2923 if (context_role_get (context
))
2924 role
= build_string (context_role_get (context
));
2925 if (context_type_get (context
))
2926 type
= build_string (context_type_get (context
));
2927 if (context_range_get (context
))
2928 range
= build_string (context_range_get (context
));
2929 context_free (context
);
2935 return list4 (user
, role
, type
, range
);
2938 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2939 Sset_file_selinux_context
, 2, 2, 0,
2940 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2941 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2942 elements are strings naming the components of a SELinux context.
2944 Value is t if setting of SELinux context was successful, nil otherwise.
2946 This function does nothing and returns nil if SELinux is disabled,
2947 or if Emacs was not compiled with SELinux support. */)
2948 (Lisp_Object filename
, Lisp_Object context
)
2950 Lisp_Object absname
;
2951 Lisp_Object handler
;
2953 Lisp_Object encoded_absname
;
2954 Lisp_Object user
= CAR_SAFE (context
);
2955 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2956 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2957 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2958 security_context_t con
;
2961 context_t parsed_con
;
2964 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2966 /* If the file name has special constructs in it,
2967 call the corresponding file handler. */
2968 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2969 if (!NILP (handler
))
2970 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2973 if (is_selinux_enabled ())
2975 /* Get current file context. */
2976 encoded_absname
= ENCODE_FILE (absname
);
2977 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2980 parsed_con
= context_new (con
);
2981 /* Change the parts defined in the parameter.*/
2984 if (context_user_set (parsed_con
, SSDATA (user
)))
2985 error ("Doing context_user_set");
2989 if (context_role_set (parsed_con
, SSDATA (role
)))
2990 error ("Doing context_role_set");
2994 if (context_type_set (parsed_con
, SSDATA (type
)))
2995 error ("Doing context_type_set");
2997 if (STRINGP (range
))
2999 if (context_range_set (parsed_con
, SSDATA (range
)))
3000 error ("Doing context_range_set");
3003 /* Set the modified context back to the file. */
3004 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3005 context_str (parsed_con
))
3007 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3008 if (fail
&& errno
!= ENOTSUP
)
3009 report_file_error ("Doing lsetfilecon", absname
);
3011 context_free (parsed_con
);
3013 return fail
? Qnil
: Qt
;
3016 report_file_error ("Doing lgetfilecon", absname
);
3023 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3024 doc
: /* Return ACL entries of file named FILENAME.
3025 The entries are returned in a format suitable for use in `set-file-acl'
3026 but is otherwise undocumented and subject to change.
3027 Return nil if file does not exist or is not accessible, or if Emacs
3028 was unable to determine the ACL entries. */)
3029 (Lisp_Object filename
)
3032 Lisp_Object absname
;
3033 Lisp_Object handler
;
3034 # ifdef HAVE_ACL_SET_FILE
3036 Lisp_Object acl_string
;
3038 # ifndef HAVE_ACL_TYPE_EXTENDED
3039 acl_type_t ACL_TYPE_EXTENDED
= ACL_TYPE_ACCESS
;
3043 absname
= expand_and_dir_to_file (filename
,
3044 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
, Qfile_acl
);
3049 if (!NILP (handler
))
3050 return call2 (handler
, Qfile_acl
, absname
);
3052 # ifdef HAVE_ACL_SET_FILE
3053 absname
= ENCODE_FILE (absname
);
3055 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_EXTENDED
);
3059 str
= acl_to_text (acl
, NULL
);
3066 acl_string
= build_string (str
);
3077 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3079 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3080 ACL-STRING should contain the textual representation of the ACL
3081 entries in a format suitable for the platform.
3083 Value is t if setting of ACL was successful, nil otherwise.
3085 Setting ACL for local files requires Emacs to be built with ACL
3087 (Lisp_Object filename
, Lisp_Object acl_string
)
3090 Lisp_Object absname
;
3091 Lisp_Object handler
;
3092 # ifdef HAVE_ACL_SET_FILE
3093 Lisp_Object encoded_absname
;
3098 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3100 /* If the file name has special constructs in it,
3101 call the corresponding file handler. */
3102 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3103 if (!NILP (handler
))
3104 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3106 # ifdef HAVE_ACL_SET_FILE
3107 if (STRINGP (acl_string
))
3109 acl
= acl_from_text (SSDATA (acl_string
));
3112 report_file_error ("Converting ACL", absname
);
3116 encoded_absname
= ENCODE_FILE (absname
);
3118 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3121 if (fail
&& acl_errno_valid (errno
))
3122 report_file_error ("Setting ACL", absname
);
3125 return fail
? Qnil
: Qt
;
3133 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3134 doc
: /* Return mode bits of file named FILENAME, as an integer.
3135 Return nil, if file does not exist or is not accessible. */)
3136 (Lisp_Object filename
)
3138 Lisp_Object absname
;
3140 Lisp_Object handler
;
3142 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3144 /* If the file name has special constructs in it,
3145 call the corresponding file handler. */
3146 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3147 if (!NILP (handler
))
3148 return call2 (handler
, Qfile_modes
, absname
);
3150 absname
= ENCODE_FILE (absname
);
3152 if (stat (SSDATA (absname
), &st
) < 0)
3155 return make_number (st
.st_mode
& 07777);
3158 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3159 "(let ((file (read-file-name \"File: \"))) \
3160 (list file (read-file-modes nil file)))",
3161 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3162 Only the 12 low bits of MODE are used.
3164 Interactively, mode bits are read by `read-file-modes', which accepts
3165 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3166 (Lisp_Object filename
, Lisp_Object mode
)
3168 Lisp_Object absname
, encoded_absname
;
3169 Lisp_Object handler
;
3171 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3172 CHECK_NUMBER (mode
);
3174 /* If the file name has special constructs in it,
3175 call the corresponding file handler. */
3176 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3177 if (!NILP (handler
))
3178 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3180 encoded_absname
= ENCODE_FILE (absname
);
3182 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3183 report_file_error ("Doing chmod", absname
);
3188 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3189 doc
: /* Set the file permission bits for newly created files.
3190 The argument MODE should be an integer; only the low 9 bits are used.
3191 This setting is inherited by subprocesses. */)
3194 mode_t oldrealmask
, oldumask
, newumask
;
3195 CHECK_NUMBER (mode
);
3196 oldrealmask
= realmask
;
3197 newumask
= ~ XINT (mode
) & 0777;
3200 realmask
= newumask
;
3201 oldumask
= umask (newumask
);
3204 eassert (oldumask
== oldrealmask
);
3208 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3209 doc
: /* Return the default file protection for created files.
3210 The value is an integer. */)
3214 XSETINT (value
, (~ realmask
) & 0777);
3219 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3220 doc
: /* Set times of file FILENAME to TIMESTAMP.
3221 Set both access and modification times.
3222 Return t on success, else nil.
3223 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3225 (Lisp_Object filename
, Lisp_Object timestamp
)
3227 Lisp_Object absname
, encoded_absname
;
3228 Lisp_Object handler
;
3229 struct timespec t
= lisp_time_argument (timestamp
);
3231 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3233 /* If the file name has special constructs in it,
3234 call the corresponding file handler. */
3235 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3236 if (!NILP (handler
))
3237 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3239 encoded_absname
= ENCODE_FILE (absname
);
3242 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
) != 0)
3245 /* Setting times on a directory always fails. */
3246 if (file_directory_p (SSDATA (encoded_absname
)))
3249 report_file_error ("Setting file times", absname
);
3257 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3258 doc
: /* Tell Unix to finish all pending disk updates. */)
3265 #endif /* HAVE_SYNC */
3267 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3268 doc
: /* Return t if file FILE1 is newer than file FILE2.
3269 If FILE1 does not exist, the answer is nil;
3270 otherwise, if FILE2 does not exist, the answer is t. */)
3271 (Lisp_Object file1
, Lisp_Object file2
)
3273 Lisp_Object absname1
, absname2
;
3274 struct stat st1
, st2
;
3275 Lisp_Object handler
;
3277 CHECK_STRING (file1
);
3278 CHECK_STRING (file2
);
3281 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3282 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3284 /* If the file name has special constructs in it,
3285 call the corresponding file handler. */
3286 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3288 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3289 if (!NILP (handler
))
3290 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3292 absname1
= ENCODE_FILE (absname1
);
3293 absname2
= ENCODE_FILE (absname2
);
3295 if (stat (SSDATA (absname1
), &st1
) < 0)
3298 if (stat (SSDATA (absname2
), &st2
) < 0)
3301 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3305 enum { READ_BUF_SIZE
= MAX_ALLOCA
};
3307 /* This function is called after Lisp functions to decide a coding
3308 system are called, or when they cause an error. Before they are
3309 called, the current buffer is set unibyte and it contains only a
3310 newly inserted text (thus the buffer was empty before the
3313 The functions may set markers, overlays, text properties, or even
3314 alter the buffer contents, change the current buffer.
3316 Here, we reset all those changes by:
3317 o set back the current buffer.
3318 o move all markers and overlays to BEG.
3319 o remove all text properties.
3320 o set back the buffer multibyteness. */
3323 decide_coding_unwind (Lisp_Object unwind_data
)
3325 Lisp_Object multibyte
, undo_list
, buffer
;
3327 multibyte
= XCAR (unwind_data
);
3328 unwind_data
= XCDR (unwind_data
);
3329 undo_list
= XCAR (unwind_data
);
3330 buffer
= XCDR (unwind_data
);
3332 set_buffer_internal (XBUFFER (buffer
));
3333 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3334 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3335 set_buffer_intervals (current_buffer
, NULL
);
3336 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3338 /* Now we are safe to change the buffer's multibyteness directly. */
3339 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3340 bset_undo_list (current_buffer
, undo_list
);
3343 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3344 object where slot 0 is the file descriptor, slot 1 specifies
3345 an offset to put the read bytes, and slot 2 is the maximum
3346 amount of bytes to read. Value is the number of bytes read. */
3349 read_non_regular (Lisp_Object state
)
3351 int nbytes
= emacs_read_quit (XSAVE_INTEGER (state
, 0),
3352 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3353 + XSAVE_INTEGER (state
, 1)),
3354 XSAVE_INTEGER (state
, 2));
3355 /* Fast recycle this object for the likely next call. */
3357 return make_number (nbytes
);
3361 /* Condition-case handler used when reading from non-regular files
3362 in insert-file-contents. */
3365 read_non_regular_quit (Lisp_Object ignore
)
3370 /* Return the file offset that VAL represents, checking for type
3371 errors and overflow. */
3373 file_offset (Lisp_Object val
)
3375 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3380 double v
= XFLOAT_DATA (val
);
3381 if (0 <= v
&& v
< 1.0 + TYPE_MAXIMUM (off_t
))
3389 wrong_type_argument (intern ("file-offset"), val
);
3392 /* Return a special time value indicating the error number ERRNUM. */
3393 static struct timespec
3394 time_error_value (int errnum
)
3396 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3397 ? NONEXISTENT_MODTIME_NSECS
3398 : UNKNOWN_MODTIME_NSECS
);
3399 return make_timespec (0, ns
);
3403 get_window_points_and_markers (void)
3405 Lisp_Object pt_marker
= Fpoint_marker ();
3407 = call3 (Qget_buffer_window_list
, Fcurrent_buffer (), Qnil
, Qt
);
3408 Lisp_Object window_markers
= windows
;
3409 /* Window markers (and point) are handled specially: rather than move to
3410 just before or just after the modified text, we try to keep the
3411 markers at the same distance (bug#19161).
3412 In general, this is wrong, but for window-markers, this should be harmless
3413 and is convenient for the end user when most of the file is unmodified,
3414 except for a few minor details near the beginning and near the end. */
3415 for (; CONSP (windows
); windows
= XCDR (windows
))
3416 if (WINDOWP (XCAR (windows
)))
3418 Lisp_Object window_marker
= XWINDOW (XCAR (windows
))->pointm
;
3420 Fcons (window_marker
, Fmarker_position (window_marker
)));
3422 return Fcons (Fcons (pt_marker
, Fpoint ()), window_markers
);
3426 restore_window_points (Lisp_Object window_markers
, ptrdiff_t inserted
,
3427 ptrdiff_t same_at_start
, ptrdiff_t same_at_end
)
3429 for (; CONSP (window_markers
); window_markers
= XCDR (window_markers
))
3430 if (CONSP (XCAR (window_markers
)))
3432 Lisp_Object car
= XCAR (window_markers
);
3433 Lisp_Object marker
= XCAR (car
);
3434 Lisp_Object oldpos
= XCDR (car
);
3435 if (MARKERP (marker
) && INTEGERP (oldpos
)
3436 && XINT (oldpos
) > same_at_start
3437 && XINT (oldpos
) < same_at_end
)
3439 ptrdiff_t oldsize
= same_at_end
- same_at_start
;
3440 ptrdiff_t newsize
= inserted
;
3441 double growth
= newsize
/ (double)oldsize
;
3443 = same_at_start
+ growth
* (XINT (oldpos
) - same_at_start
);
3444 Fset_marker (marker
, make_number (newpos
), Qnil
);
3449 /* Make sure the gap is at Z_BYTE. This is required to treat buffer
3450 text as a linear C char array. */
3452 maybe_move_gap (struct buffer
*b
)
3454 if (BUF_GPT_BYTE (b
) != BUF_Z_BYTE (b
))
3456 struct buffer
*cb
= current_buffer
;
3458 set_buffer_internal (b
);
3459 move_gap_both (Z
, Z_BYTE
);
3460 set_buffer_internal (cb
);
3464 /* FIXME: insert-file-contents should be split with the top-level moved to
3465 Elisp and only the core kept in C. */
3467 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3469 doc
: /* Insert contents of file FILENAME after point.
3470 Returns list of absolute file name and number of characters inserted.
3471 If second argument VISIT is non-nil, the buffer's visited filename and
3472 last save file modtime are set, and it is marked unmodified. If
3473 visiting and the file does not exist, visiting is completed before the
3476 The optional third and fourth arguments BEG and END specify what portion
3477 of the file to insert. These arguments count bytes in the file, not
3478 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3480 If optional fifth argument REPLACE is non-nil, replace the current
3481 buffer contents (in the accessible portion) with the file contents.
3482 This is better than simply deleting and inserting the whole thing
3483 because (1) it preserves some marker positions and (2) it puts less data
3484 in the undo list. When REPLACE is non-nil, the second return value is
3485 the number of characters that replace previous buffer contents.
3487 This function does code conversion according to the value of
3488 `coding-system-for-read' or `file-coding-system-alist', and sets the
3489 variable `last-coding-system-used' to the coding system actually used.
3491 In addition, this function decodes the inserted text from known formats
3492 by calling `format-decode', which see. */)
3493 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3496 struct timespec mtime
;
3498 ptrdiff_t inserted
= 0;
3500 off_t beg_offset
, end_offset
;
3502 ptrdiff_t count
= SPECPDL_INDEX ();
3503 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3505 ptrdiff_t total
= 0;
3506 bool not_regular
= 0;
3508 char read_buf
[READ_BUF_SIZE
];
3509 struct coding_system coding
;
3510 bool replace_handled
= false;
3511 bool set_coding_system
= false;
3512 Lisp_Object coding_system
;
3513 bool read_quit
= false;
3514 /* If the undo log only contains the insertion, there's no point
3515 keeping it. It's typically when we first fill a file-buffer. */
3516 bool empty_undo_list_p
3517 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3519 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3520 bool we_locked_file
= false;
3522 Lisp_Object window_markers
= Qnil
;
3523 /* same_at_start and same_at_end count bytes, because file access counts
3524 bytes and BEG and END count bytes. */
3525 ptrdiff_t same_at_start
= BEGV_BYTE
;
3526 ptrdiff_t same_at_end
= ZV_BYTE
;
3527 /* SAME_AT_END_CHARPOS counts characters, because
3528 restore_window_points needs the old character count. */
3529 ptrdiff_t same_at_end_charpos
= ZV
;
3531 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3532 error ("Cannot do file visiting in an indirect buffer");
3534 if (!NILP (BVAR (current_buffer
, read_only
)))
3535 Fbarf_if_buffer_read_only (Qnil
);
3539 orig_filename
= Qnil
;
3542 CHECK_STRING (filename
);
3543 filename
= Fexpand_file_name (filename
, Qnil
);
3545 /* The value Qnil means that the coding system is not yet
3547 coding_system
= Qnil
;
3549 /* If the file name has special constructs in it,
3550 call the corresponding file handler. */
3551 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3552 if (!NILP (handler
))
3554 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3555 visit
, beg
, end
, replace
);
3556 if (CONSP (val
) && CONSP (XCDR (val
))
3557 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3558 inserted
= XINT (XCAR (XCDR (val
)));
3562 orig_filename
= filename
;
3563 filename
= ENCODE_FILE (filename
);
3565 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3570 report_file_error ("Opening input file", orig_filename
);
3571 mtime
= time_error_value (save_errno
);
3573 if (!NILP (Vcoding_system_for_read
))
3575 /* Don't let invalid values into buffer-file-coding-system. */
3576 CHECK_CODING_SYSTEM (Vcoding_system_for_read
);
3577 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3582 fd_index
= SPECPDL_INDEX ();
3583 record_unwind_protect_int (close_file_unwind
, fd
);
3585 /* Replacement should preserve point as it preserves markers. */
3586 if (!NILP (replace
))
3588 window_markers
= get_window_points_and_markers ();
3589 record_unwind_protect (restore_point_unwind
,
3590 XCAR (XCAR (window_markers
)));
3593 if (fstat (fd
, &st
) != 0)
3594 report_file_error ("Input file status", orig_filename
);
3595 mtime
= get_stat_mtime (&st
);
3597 /* This code will need to be changed in order to work on named
3598 pipes, and it's probably just not worth it. So we should at
3599 least signal an error. */
3600 if (!S_ISREG (st
.st_mode
))
3607 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3608 xsignal2 (Qfile_error
,
3609 build_string ("not a regular file"), orig_filename
);
3614 if (!NILP (beg
) || !NILP (end
))
3615 error ("Attempt to visit less than an entire file");
3616 if (BEG
< Z
&& NILP (replace
))
3617 error ("Cannot do file visiting in a non-empty buffer");
3621 beg_offset
= file_offset (beg
);
3626 end_offset
= file_offset (end
);
3630 end_offset
= TYPE_MAXIMUM (off_t
);
3633 end_offset
= st
.st_size
;
3635 /* A negative size can happen on a platform that allows file
3636 sizes greater than the maximum off_t value. */
3640 /* The file size returned from stat may be zero, but data
3641 may be readable nonetheless, for example when this is a
3642 file in the /proc filesystem. */
3643 if (end_offset
== 0)
3644 end_offset
= READ_BUF_SIZE
;
3648 /* Check now whether the buffer will become too large,
3649 in the likely case where the file's length is not changing.
3650 This saves a lot of needless work before a buffer overflow. */
3653 /* The likely offset where we will stop reading. We could read
3654 more (or less), if the file grows (or shrinks) as we read it. */
3655 off_t likely_end
= min (end_offset
, st
.st_size
);
3657 if (beg_offset
< likely_end
)
3660 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3661 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3662 off_t likely_growth
= likely_end
- beg_offset
;
3663 if (buf_growth_max
< likely_growth
)
3668 /* Prevent redisplay optimizations. */
3669 current_buffer
->clip_changed
= true;
3671 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3673 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3674 setup_coding_system (coding_system
, &coding
);
3675 /* Ensure we set Vlast_coding_system_used. */
3676 set_coding_system
= true;
3680 /* Decide the coding system to use for reading the file now
3681 because we can't use an optimized method for handling
3682 `coding:' tag if the current buffer is not empty. */
3683 if (!NILP (Vcoding_system_for_read
))
3684 coding_system
= Vcoding_system_for_read
;
3687 /* Don't try looking inside a file for a coding system
3688 specification if it is not seekable. */
3689 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3691 /* Find a coding system specified in the heading two
3692 lines or in the tailing several lines of the file.
3693 We assume that the 1K-byte and 3K-byte for heading
3694 and tailing respectively are sufficient for this
3698 if (st
.st_size
<= (1024 * 4))
3699 nread
= emacs_read_quit (fd
, read_buf
, 1024 * 4);
3702 nread
= emacs_read_quit (fd
, read_buf
, 1024);
3706 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3707 report_file_error ("Setting file position",
3709 ntail
= emacs_read_quit (fd
, read_buf
+ nread
, 1024 * 3);
3710 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3715 report_file_error ("Read error", orig_filename
);
3718 AUTO_STRING (name
, " *code-converting-work*");
3719 struct buffer
*prev
= current_buffer
;
3720 Lisp_Object workbuf
;
3723 record_unwind_current_buffer ();
3725 workbuf
= Fget_buffer_create (name
);
3726 buf
= XBUFFER (workbuf
);
3728 delete_all_overlays (buf
);
3729 bset_directory (buf
, BVAR (current_buffer
, directory
));
3730 bset_read_only (buf
, Qnil
);
3731 bset_filename (buf
, Qnil
);
3732 bset_undo_list (buf
, Qt
);
3733 eassert (buf
->overlays_before
== NULL
);
3734 eassert (buf
->overlays_after
== NULL
);
3736 set_buffer_internal (buf
);
3738 bset_enable_multibyte_characters (buf
, Qnil
);
3740 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3741 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3742 coding_system
= call2 (Vset_auto_coding_function
,
3743 filename
, make_number (nread
));
3744 set_buffer_internal (prev
);
3746 /* Discard the unwind protect for recovering the
3750 /* Rewind the file for the actual read done later. */
3751 if (lseek (fd
, 0, SEEK_SET
) < 0)
3752 report_file_error ("Setting file position", orig_filename
);
3756 if (NILP (coding_system
))
3758 /* If we have not yet decided a coding system, check
3759 file-coding-system-alist. */
3760 coding_system
= CALLN (Ffind_operation_coding_system
,
3761 Qinsert_file_contents
, orig_filename
,
3762 visit
, beg
, end
, replace
);
3763 if (CONSP (coding_system
))
3764 coding_system
= XCAR (coding_system
);
3768 if (NILP (coding_system
))
3769 coding_system
= Qundecided
;
3771 CHECK_CODING_SYSTEM (coding_system
);
3773 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3774 /* We must suppress all character code conversion except for
3775 end-of-line conversion. */
3776 coding_system
= raw_text_coding_system (coding_system
);
3778 setup_coding_system (coding_system
, &coding
);
3779 /* Ensure we set Vlast_coding_system_used. */
3780 set_coding_system
= true;
3783 /* If requested, replace the accessible part of the buffer
3784 with the file contents. Avoid replacing text at the
3785 beginning or end of the buffer that matches the file contents;
3786 that preserves markers pointing to the unchanged parts.
3788 Here we implement this feature in an optimized way
3789 for the case where code conversion is NOT needed.
3790 The following if-statement handles the case of conversion
3791 in a less optimal way.
3793 If the code conversion is "automatic" then we try using this
3794 method and hope for the best.
3795 But if we discover the need for conversion, we give up on this method
3796 and let the following if-statement handle the replace job. */
3799 && (NILP (coding_system
)
3800 || ! CODING_REQUIRE_DECODING (&coding
)))
3803 /* There is still a possibility we will find the need to do code
3804 conversion. If that happens, set this variable to
3805 give up on handling REPLACE in the optimized way. */
3806 bool giveup_match_end
= false;
3808 if (beg_offset
!= 0)
3810 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3811 report_file_error ("Setting file position", orig_filename
);
3814 /* Count how many chars at the start of the file
3815 match the text at the beginning of the buffer. */
3818 int nread
= emacs_read_quit (fd
, read_buf
, sizeof read_buf
);
3820 report_file_error ("Read error", orig_filename
);
3821 else if (nread
== 0)
3824 if (CODING_REQUIRE_DETECTION (&coding
))
3826 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3829 setup_coding_system (coding_system
, &coding
);
3832 if (CODING_REQUIRE_DECODING (&coding
))
3833 /* We found that the file should be decoded somehow.
3834 Let's give up here. */
3836 giveup_match_end
= true;
3841 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3842 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3843 same_at_start
++, bufpos
++;
3844 /* If we found a discrepancy, stop the scan.
3845 Otherwise loop around and scan the next bufferful. */
3846 if (bufpos
!= nread
)
3849 /* If the file matches the buffer completely,
3850 there's no need to replace anything. */
3851 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3854 clear_unwind_protect (fd_index
);
3856 /* Truncate the buffer to the size of the file. */
3857 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3861 /* Count how many chars at the end of the file
3862 match the text at the end of the buffer. But, if we have
3863 already found that decoding is necessary, don't waste time. */
3864 while (!giveup_match_end
)
3866 int total_read
, nread
, bufpos
, trial
;
3869 /* At what file position are we now scanning? */
3870 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3871 /* If the entire file matches the buffer tail, stop the scan. */
3874 /* How much can we scan in the next step? */
3875 trial
= min (curpos
, sizeof read_buf
);
3876 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3877 report_file_error ("Setting file position", orig_filename
);
3879 total_read
= nread
= 0;
3880 while (total_read
< trial
)
3882 nread
= emacs_read_quit (fd
, read_buf
+ total_read
,
3883 trial
- total_read
);
3885 report_file_error ("Read error", orig_filename
);
3886 else if (nread
== 0)
3888 total_read
+= nread
;
3891 /* Scan this bufferful from the end, comparing with
3892 the Emacs buffer. */
3893 bufpos
= total_read
;
3895 /* Compare with same_at_start to avoid counting some buffer text
3896 as matching both at the file's beginning and at the end. */
3897 while (bufpos
> 0 && same_at_end
> same_at_start
3898 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3899 same_at_end
--, bufpos
--;
3901 /* If we found a discrepancy, stop the scan.
3902 Otherwise loop around and scan the preceding bufferful. */
3905 /* If this discrepancy is because of code conversion,
3906 we cannot use this method; giveup and try the other. */
3907 if (same_at_end
> same_at_start
3908 && FETCH_BYTE (same_at_end
- 1) >= 0200
3909 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3910 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3911 giveup_match_end
= true;
3919 if (! giveup_match_end
)
3922 ptrdiff_t this_count
= SPECPDL_INDEX ();
3924 /* We win! We can handle REPLACE the optimized way. */
3926 /* Extend the start of non-matching text area to multibyte
3927 character boundary. */
3928 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3929 while (same_at_start
> BEGV_BYTE
3930 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3933 /* Extend the end of non-matching text area to multibyte
3934 character boundary. */
3935 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3936 while (same_at_end
< ZV_BYTE
3937 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3940 /* Don't try to reuse the same piece of text twice. */
3941 overlap
= (same_at_start
- BEGV_BYTE
3943 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3945 same_at_end
+= overlap
;
3946 same_at_end_charpos
= BYTE_TO_CHAR (same_at_end
);
3948 /* Arrange to read only the nonmatching middle part of the file. */
3949 beg_offset
+= same_at_start
- BEGV_BYTE
;
3950 end_offset
-= ZV_BYTE
- same_at_end
;
3952 /* This binding is to avoid ask-user-about-supersession-threat
3953 being called in insert_from_buffer or del_range_bytes (via
3954 prepare_to_modify_buffer).
3955 AFAICT we could avoid ask-user-about-supersession-threat by setting
3956 current_buffer->modtime earlier, but we could still end up calling
3957 ask-user-about-supersession-threat if the file is modified while
3958 we read it, so we bind buffer-file-name instead. */
3959 specbind (intern ("buffer-file-name"), Qnil
);
3960 del_range_byte (same_at_start
, same_at_end
);
3961 /* Insert from the file at the proper position. */
3962 temp
= BYTE_TO_CHAR (same_at_start
);
3963 SET_PT_BOTH (temp
, same_at_start
);
3964 unbind_to (this_count
, Qnil
);
3966 /* If display currently starts at beginning of line,
3967 keep it that way. */
3968 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3969 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3971 replace_handled
= true;
3975 /* If requested, replace the accessible part of the buffer
3976 with the file contents. Avoid replacing text at the
3977 beginning or end of the buffer that matches the file contents;
3978 that preserves markers pointing to the unchanged parts.
3980 Here we implement this feature for the case where code conversion
3981 is needed, in a simple way that needs a lot of memory.
3982 The preceding if-statement handles the case of no conversion
3983 in a more optimized way. */
3984 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3986 ptrdiff_t same_at_start_charpos
;
3987 ptrdiff_t inserted_chars
;
3990 unsigned char *decoded
;
3993 ptrdiff_t this_count
= SPECPDL_INDEX ();
3995 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3996 Lisp_Object conversion_buffer
;
3998 conversion_buffer
= code_conversion_save (1, multibyte
);
4000 /* First read the whole file, performing code conversion into
4001 CONVERSION_BUFFER. */
4003 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4004 report_file_error ("Setting file position", orig_filename
);
4006 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4007 unprocessed
= 0; /* Bytes not processed in previous loop. */
4011 /* Read at most READ_BUF_SIZE bytes at a time, to allow
4012 quitting while reading a huge file. */
4014 this = emacs_read_quit (fd
, read_buf
+ unprocessed
,
4015 READ_BUF_SIZE
- unprocessed
);
4019 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
4020 BUF_Z (XBUFFER (conversion_buffer
)));
4021 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4022 unprocessed
+ this, conversion_buffer
);
4023 unprocessed
= coding
.carryover_bytes
;
4024 if (coding
.carryover_bytes
> 0)
4025 memcpy (read_buf
, coding
.carryover
, unprocessed
);
4029 report_file_error ("Read error", orig_filename
);
4031 clear_unwind_protect (fd_index
);
4033 if (unprocessed
> 0)
4035 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4036 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4037 unprocessed
, conversion_buffer
);
4038 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4041 coding_system
= CODING_ID_NAME (coding
.id
);
4042 set_coding_system
= true;
4043 maybe_move_gap (XBUFFER (conversion_buffer
));
4044 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4045 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4046 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4048 /* Compare the beginning of the converted string with the buffer
4052 while (bufpos
< inserted
&& same_at_start
< same_at_end
4053 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4054 same_at_start
++, bufpos
++;
4056 /* If the file matches the head of buffer completely,
4057 there's no need to replace anything. */
4059 if (bufpos
== inserted
)
4061 /* Truncate the buffer to the size of the file. */
4062 if (same_at_start
!= same_at_end
)
4064 /* See previous specbind for the reason behind this. */
4065 specbind (intern ("buffer-file-name"), Qnil
);
4066 del_range_byte (same_at_start
, same_at_end
);
4070 unbind_to (this_count
, Qnil
);
4074 /* Extend the start of non-matching text area to the previous
4075 multibyte character boundary. */
4076 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4077 while (same_at_start
> BEGV_BYTE
4078 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4081 /* Scan this bufferful from the end, comparing with
4082 the Emacs buffer. */
4085 /* Compare with same_at_start to avoid counting some buffer text
4086 as matching both at the file's beginning and at the end. */
4087 while (bufpos
> 0 && same_at_end
> same_at_start
4088 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4089 same_at_end
--, bufpos
--;
4091 /* Extend the end of non-matching text area to the next
4092 multibyte character boundary. */
4093 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4094 while (same_at_end
< ZV_BYTE
4095 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4098 /* Don't try to reuse the same piece of text twice. */
4099 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4101 same_at_end
+= overlap
;
4102 same_at_end_charpos
= BYTE_TO_CHAR (same_at_end
);
4104 /* If display currently starts at beginning of line,
4105 keep it that way. */
4106 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4107 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4109 /* Replace the chars that we need to replace,
4110 and update INSERTED to equal the number of bytes
4111 we are taking from the decoded string. */
4112 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4114 /* See previous specbind for the reason behind this. */
4115 specbind (intern ("buffer-file-name"), Qnil
);
4116 if (same_at_end
!= same_at_start
)
4118 del_range_byte (same_at_start
, same_at_end
);
4120 eassert (same_at_start
== GPT_BYTE
);
4121 same_at_start
= GPT_BYTE
;
4125 temp
= same_at_end_charpos
;
4127 /* Insert from the file at the proper position. */
4128 SET_PT_BOTH (temp
, same_at_start
);
4129 same_at_start_charpos
4130 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4131 same_at_start
- BEGV_BYTE
4132 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4133 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4135 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4136 same_at_start
+ inserted
- BEGV_BYTE
4137 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4138 - same_at_start_charpos
);
4139 insert_from_buffer (XBUFFER (conversion_buffer
),
4140 same_at_start_charpos
, inserted_chars
, 0);
4141 /* Set `inserted' to the number of inserted characters. */
4142 inserted
= PT
- temp
;
4143 /* Set point before the inserted characters. */
4144 SET_PT_BOTH (temp
, same_at_start
);
4146 unbind_to (this_count
, Qnil
);
4152 total
= end_offset
- beg_offset
;
4154 /* For a special file, all we can do is guess. */
4155 total
= READ_BUF_SIZE
;
4157 if (NILP (visit
) && total
> 0)
4159 if (!NILP (BVAR (current_buffer
, file_truename
))
4160 /* Make binding buffer-file-name to nil effective. */
4161 && !NILP (BVAR (current_buffer
, filename
))
4162 && SAVE_MODIFF
>= MODIFF
)
4163 we_locked_file
= true;
4164 prepare_to_modify_buffer (PT
, PT
, NULL
);
4167 move_gap_both (PT
, PT_BYTE
);
4168 if (GAP_SIZE
< total
)
4169 make_gap (total
- GAP_SIZE
);
4171 if (beg_offset
!= 0 || !NILP (replace
))
4173 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4174 report_file_error ("Setting file position", orig_filename
);
4177 /* In the following loop, HOW_MUCH contains the total bytes read so
4178 far for a regular file, and not changed for a special file. But,
4179 before exiting the loop, it is set to a negative value if I/O
4183 /* Total bytes inserted. */
4186 /* Here, we don't do code conversion in the loop. It is done by
4187 decode_coding_gap after all data are read into the buffer. */
4189 ptrdiff_t gap_size
= GAP_SIZE
;
4191 while (how_much
< total
)
4193 /* `try' is reserved in some compilers (Microsoft C). */
4194 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4201 /* Maybe make more room. */
4202 if (gap_size
< trytry
)
4204 make_gap (trytry
- gap_size
);
4205 gap_size
= GAP_SIZE
- inserted
;
4208 /* Read from the file, capturing `quit'. When an
4209 error occurs, end the loop, and arrange for a quit
4210 to be signaled after decoding the text we read. */
4211 nbytes
= internal_condition_case_1
4213 make_save_int_int_int (fd
, inserted
, trytry
),
4214 Qerror
, read_non_regular_quit
);
4222 this = XINT (nbytes
);
4226 /* Allow quitting out of the actual I/O. We don't make text
4227 part of the buffer until all the reading is done, so a C-g
4228 here doesn't do any harm. */
4229 this = emacs_read_quit (fd
,
4230 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4243 /* For a regular file, where TOTAL is the real size,
4244 count HOW_MUCH to compare with it.
4245 For a special file, where TOTAL is just a buffer size,
4246 so don't bother counting in HOW_MUCH.
4247 (INSERTED is where we count the number of characters inserted.) */
4254 /* Now we have either read all the file data into the gap,
4255 or stop reading on I/O error or quit. If nothing was
4256 read, undo marking the buffer modified. */
4261 unlock_file (BVAR (current_buffer
, file_truename
));
4262 Vdeactivate_mark
= old_Vdeactivate_mark
;
4265 Fset (Qdeactivate_mark
, Qt
);
4268 clear_unwind_protect (fd_index
);
4271 report_file_error ("Read error", orig_filename
);
4273 /* Make the text read part of the buffer. */
4274 GAP_SIZE
-= inserted
;
4276 GPT_BYTE
+= inserted
;
4278 ZV_BYTE
+= inserted
;
4283 /* Put an anchor to ensure multi-byte form ends at gap. */
4288 if (NILP (coding_system
))
4290 /* The coding system is not yet decided. Decide it by an
4291 optimized method for handling `coding:' tag.
4293 Note that we can get here only if the buffer was empty
4294 before the insertion. */
4296 if (!NILP (Vcoding_system_for_read
))
4297 coding_system
= Vcoding_system_for_read
;
4300 /* Since we are sure that the current buffer was empty
4301 before the insertion, we can toggle
4302 enable-multibyte-characters directly here without taking
4303 care of marker adjustment. By this way, we can run Lisp
4304 program safely before decoding the inserted text. */
4305 Lisp_Object unwind_data
;
4306 ptrdiff_t count1
= SPECPDL_INDEX ();
4308 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4309 Fcons (BVAR (current_buffer
, undo_list
),
4310 Fcurrent_buffer ()));
4311 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4312 bset_undo_list (current_buffer
, Qt
);
4313 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4315 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4317 coding_system
= call2 (Vset_auto_coding_function
,
4318 filename
, make_number (inserted
));
4321 if (NILP (coding_system
))
4323 /* If the coding system is not yet decided, check
4324 file-coding-system-alist. */
4325 coding_system
= CALLN (Ffind_operation_coding_system
,
4326 Qinsert_file_contents
, orig_filename
,
4327 visit
, beg
, end
, Qnil
);
4328 if (CONSP (coding_system
))
4329 coding_system
= XCAR (coding_system
);
4331 unbind_to (count1
, Qnil
);
4332 inserted
= Z_BYTE
- BEG_BYTE
;
4335 if (NILP (coding_system
))
4336 coding_system
= Qundecided
;
4338 CHECK_CODING_SYSTEM (coding_system
);
4340 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4341 /* We must suppress all character code conversion except for
4342 end-of-line conversion. */
4343 coding_system
= raw_text_coding_system (coding_system
);
4344 setup_coding_system (coding_system
, &coding
);
4345 /* Ensure we set Vlast_coding_system_used. */
4346 set_coding_system
= true;
4351 /* When we visit a file by raw-text, we change the buffer to
4353 if (CODING_FOR_UNIBYTE (&coding
)
4354 /* Can't do this if part of the buffer might be preserved. */
4357 /* Visiting a file with these coding system makes the buffer
4360 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4362 Fset_buffer_multibyte (Qnil
);
4366 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4367 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4368 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4370 move_gap_both (PT
, PT_BYTE
);
4371 GAP_SIZE
+= inserted
;
4372 ZV_BYTE
-= inserted
;
4376 decode_coding_gap (&coding
, inserted
, inserted
);
4377 inserted
= coding
.produced_char
;
4378 coding_system
= CODING_ID_NAME (coding
.id
);
4380 else if (inserted
> 0)
4382 invalidate_buffer_caches (current_buffer
, PT
, PT
+ inserted
);
4383 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4387 /* Call after-change hooks for the inserted text, aside from the case
4388 of normal visiting (not with REPLACE), which is done in a new buffer
4389 "before" the buffer is changed. */
4390 if (inserted
> 0 && total
> 0
4391 && (NILP (visit
) || !NILP (replace
)))
4393 signal_after_change (PT
, 0, inserted
);
4394 update_compositions (PT
, PT
, CHECK_BORDER
);
4397 /* Now INSERTED is measured in characters. */
4402 restore_window_points (window_markers
, inserted
,
4403 BYTE_TO_CHAR (same_at_start
),
4404 same_at_end_charpos
);
4408 if (empty_undo_list_p
)
4409 bset_undo_list (current_buffer
, Qnil
);
4413 current_buffer
->modtime
= mtime
;
4414 current_buffer
->modtime_size
= st
.st_size
;
4415 bset_filename (current_buffer
, orig_filename
);
4418 SAVE_MODIFF
= MODIFF
;
4419 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4420 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4423 if (!NILP (BVAR (current_buffer
, file_truename
)))
4424 unlock_file (BVAR (current_buffer
, file_truename
));
4425 unlock_file (filename
);
4428 xsignal2 (Qfile_error
,
4429 build_string ("not a regular file"), orig_filename
);
4432 if (set_coding_system
)
4433 Vlast_coding_system_used
= coding_system
;
4435 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4437 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4439 if (! NILP (insval
))
4441 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4442 wrong_type_argument (intern ("inserted-chars"), insval
);
4443 inserted
= XFASTINT (insval
);
4447 /* Decode file format. */
4450 /* Don't run point motion or modification hooks when decoding. */
4451 ptrdiff_t count1
= SPECPDL_INDEX ();
4452 ptrdiff_t old_inserted
= inserted
;
4453 specbind (Qinhibit_point_motion_hooks
, Qt
);
4454 specbind (Qinhibit_modification_hooks
, Qt
);
4456 /* Save old undo list and don't record undo for decoding. */
4457 old_undo
= BVAR (current_buffer
, undo_list
);
4458 bset_undo_list (current_buffer
, Qt
);
4462 insval
= call3 (Qformat_decode
,
4463 Qnil
, make_number (inserted
), visit
);
4464 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4465 wrong_type_argument (intern ("inserted-chars"), insval
);
4466 inserted
= XFASTINT (insval
);
4470 /* If REPLACE is non-nil and we succeeded in not replacing the
4471 beginning or end of the buffer text with the file's contents,
4472 call format-decode with `point' positioned at the beginning
4473 of the buffer and `inserted' equaling the number of
4474 characters in the buffer. Otherwise, format-decode might
4475 fail to correctly analyze the beginning or end of the buffer.
4476 Hence we temporarily save `point' and `inserted' here and
4477 restore `point' iff format-decode did not insert or delete
4478 any text. Otherwise we leave `point' at point-min. */
4479 ptrdiff_t opoint
= PT
;
4480 ptrdiff_t opoint_byte
= PT_BYTE
;
4481 ptrdiff_t oinserted
= ZV
- BEGV
;
4482 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4484 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4485 insval
= call3 (Qformat_decode
,
4486 Qnil
, make_number (oinserted
), visit
);
4487 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4488 wrong_type_argument (intern ("inserted-chars"), insval
);
4489 if (ochars_modiff
== CHARS_MODIFF
)
4490 /* format_decode didn't modify buffer's characters => move
4491 point back to position before inserted text and leave
4492 value of inserted alone. */
4493 SET_PT_BOTH (opoint
, opoint_byte
);
4495 /* format_decode modified buffer's characters => consider
4496 entire buffer changed and leave point at point-min. */
4497 inserted
= XFASTINT (insval
);
4500 /* For consistency with format-decode call these now iff inserted > 0
4501 (martin 2007-06-28). */
4502 p
= Vafter_insert_file_functions
;
4507 insval
= call1 (XCAR (p
), make_number (inserted
));
4510 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4511 wrong_type_argument (intern ("inserted-chars"), insval
);
4512 inserted
= XFASTINT (insval
);
4517 /* For the rationale of this see the comment on
4518 format-decode above. */
4519 ptrdiff_t opoint
= PT
;
4520 ptrdiff_t opoint_byte
= PT_BYTE
;
4521 ptrdiff_t oinserted
= ZV
- BEGV
;
4522 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4524 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4525 insval
= call1 (XCAR (p
), make_number (oinserted
));
4528 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4529 wrong_type_argument (intern ("inserted-chars"), insval
);
4530 if (ochars_modiff
== CHARS_MODIFF
)
4531 /* after_insert_file_functions didn't modify
4532 buffer's characters => move point back to
4533 position before inserted text and leave value of
4535 SET_PT_BOTH (opoint
, opoint_byte
);
4537 /* after_insert_file_functions did modify buffer's
4538 characters => consider entire buffer changed and
4539 leave point at point-min. */
4540 inserted
= XFASTINT (insval
);
4548 if (!empty_undo_list_p
)
4550 bset_undo_list (current_buffer
, old_undo
);
4551 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4553 /* Adjust the last undo record for the size change during
4554 the format conversion. */
4555 Lisp_Object tem
= XCAR (old_undo
);
4556 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4557 && INTEGERP (XCDR (tem
))
4558 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4559 XSETCDR (tem
, make_number (PT
+ inserted
));
4563 /* If undo_list was Qt before, keep it that way.
4564 Otherwise start with an empty undo_list. */
4565 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4567 unbind_to (count1
, Qnil
);
4571 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4573 /* If visiting nonexistent file, return nil. */
4574 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4577 /* We made a lot of deletions and insertions above, so invalidate
4578 the newline cache for the entire region of the inserted
4580 if (current_buffer
->base_buffer
&& current_buffer
->base_buffer
->newline_cache
)
4581 invalidate_region_cache (current_buffer
->base_buffer
,
4582 current_buffer
->base_buffer
->newline_cache
,
4583 PT
- BEG
, Z
- PT
- inserted
);
4584 else if (current_buffer
->newline_cache
)
4585 invalidate_region_cache (current_buffer
,
4586 current_buffer
->newline_cache
,
4587 PT
- BEG
, Z
- PT
- inserted
);
4592 /* Retval needs to be dealt with in all cases consistently. */
4594 val
= list2 (orig_filename
, make_number (inserted
));
4596 return unbind_to (count
, val
);
4599 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4602 build_annotations_unwind (Lisp_Object arg
)
4604 Vwrite_region_annotation_buffers
= arg
;
4607 /* Decide the coding-system to encode the data with. */
4610 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4611 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4612 struct coding_system
*coding
)
4615 Lisp_Object eol_parent
= Qnil
;
4618 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4619 BVAR (current_buffer
, auto_save_file_name
))))
4624 else if (!NILP (Vcoding_system_for_write
))
4626 val
= Vcoding_system_for_write
;
4627 if (coding_system_require_warning
4628 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4629 /* Confirm that VAL can surely encode the current region. */
4630 val
= call5 (Vselect_safe_coding_system_function
,
4631 start
, end
, list2 (Qt
, val
),
4636 /* If the variable `buffer-file-coding-system' is set locally,
4637 it means that the file was read with some kind of code
4638 conversion or the variable is explicitly set by users. We
4639 had better write it out with the same coding system even if
4640 `enable-multibyte-characters' is nil.
4642 If it is not set locally, we anyway have to convert EOL
4643 format if the default value of `buffer-file-coding-system'
4644 tells that it is not Unix-like (LF only) format. */
4645 bool using_default_coding
= 0;
4646 bool force_raw_text
= 0;
4648 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4650 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4653 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4659 /* Check file-coding-system-alist. */
4660 Lisp_Object coding_systems
4661 = CALLN (Ffind_operation_coding_system
, Qwrite_region
, start
, end
,
4662 filename
, append
, visit
, lockname
);
4663 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4664 val
= XCDR (coding_systems
);
4669 /* If we still have not decided a coding system, use the
4670 current buffer's value of buffer-file-coding-system. */
4671 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4672 using_default_coding
= 1;
4675 if (! NILP (val
) && ! force_raw_text
)
4677 Lisp_Object spec
, attrs
;
4679 CHECK_CODING_SYSTEM (val
);
4680 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4681 attrs
= AREF (spec
, 0);
4682 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4687 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4689 /* Confirm that VAL can surely encode the current region. */
4690 val
= call5 (Vselect_safe_coding_system_function
,
4691 start
, end
, val
, Qnil
, filename
);
4692 /* As the function specified by select-safe-coding-system-function
4693 is out of our control, make sure we are not fed by bogus
4696 CHECK_CODING_SYSTEM (val
);
4699 /* If the decided coding-system doesn't specify end-of-line
4700 format, we use that of `buffer-file-coding-system'. */
4701 if (! using_default_coding
)
4703 Lisp_Object dflt
= BVAR (&buffer_defaults
, buffer_file_coding_system
);
4706 val
= coding_inherit_eol_type (val
, dflt
);
4709 /* If we decide not to encode text, use `raw-text' or one of its
4712 val
= raw_text_coding_system (val
);
4715 val
= coding_inherit_eol_type (val
, eol_parent
);
4716 setup_coding_system (val
, coding
);
4718 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4719 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4723 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4724 "r\nFWrite region to file: \ni\ni\ni\np",
4725 doc
: /* Write current region into specified file.
4726 When called from a program, requires three arguments:
4727 START, END and FILENAME. START and END are normally buffer positions
4728 specifying the part of the buffer to write.
4729 If START is nil, that means to use the entire buffer contents; END is
4731 If START is a string, then output that string to the file
4732 instead of any buffer contents; END is ignored.
4734 Optional fourth argument APPEND if non-nil means
4735 append to existing file contents (if any). If it is a number,
4736 seek to that offset in the file before writing.
4737 Optional fifth argument VISIT, if t or a string, means
4738 set the last-save-file-modtime of buffer to this file's modtime
4739 and mark buffer not modified.
4740 If VISIT is a string, it is a second file name;
4741 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4742 VISIT is also the file name to lock and unlock for clash detection.
4743 If VISIT is neither t nor nil nor a string, or if Emacs is in batch mode,
4744 do not display the \"Wrote file\" message.
4745 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4746 use for locking and unlocking, overriding FILENAME and VISIT.
4747 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4748 for an existing file with the same name. If MUSTBENEW is `excl',
4749 that means to get an error if the file already exists; never overwrite.
4750 If MUSTBENEW is neither nil nor `excl', that means ask for
4751 confirmation before overwriting, but do go ahead and overwrite the file
4752 if the user confirms.
4754 This does code conversion according to the value of
4755 `coding-system-for-write', `buffer-file-coding-system', or
4756 `file-coding-system-alist', and sets the variable
4757 `last-coding-system-used' to the coding system actually used.
4759 This calls `write-region-annotate-functions' at the start, and
4760 `write-region-post-annotation-function' at the end. */)
4761 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4762 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4764 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4768 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4769 descriptor for FILENAME, so do not open or close FILENAME. */
4772 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4773 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4774 Lisp_Object mustbenew
, int desc
)
4778 off_t offset UNINIT
;
4779 bool open_and_close_file
= desc
< 0;
4784 struct timespec modtime
;
4785 ptrdiff_t count
= SPECPDL_INDEX ();
4786 ptrdiff_t count1 UNINIT
;
4787 Lisp_Object handler
;
4788 Lisp_Object visit_file
;
4789 Lisp_Object annotations
;
4790 Lisp_Object encoded_filename
;
4791 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4792 bool quietly
= !NILP (visit
);
4793 bool file_locked
= 0;
4794 struct buffer
*given_buffer
;
4795 struct coding_system coding
;
4797 if (current_buffer
->base_buffer
&& visiting
)
4798 error ("Cannot do file visiting in an indirect buffer");
4800 if (!NILP (start
) && !STRINGP (start
))
4801 validate_region (&start
, &end
);
4805 filename
= Fexpand_file_name (filename
, Qnil
);
4807 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4808 barf_or_query_if_file_exists (filename
, false, "overwrite", true, true);
4810 if (STRINGP (visit
))
4811 visit_file
= Fexpand_file_name (visit
, Qnil
);
4813 visit_file
= filename
;
4815 if (NILP (lockname
))
4816 lockname
= visit_file
;
4820 /* If the file name has special constructs in it,
4821 call the corresponding file handler. */
4822 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4823 /* If FILENAME has no handler, see if VISIT has one. */
4824 if (NILP (handler
) && STRINGP (visit
))
4825 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4827 if (!NILP (handler
))
4830 val
= call6 (handler
, Qwrite_region
, start
, end
,
4831 filename
, append
, visit
);
4835 SAVE_MODIFF
= MODIFF
;
4836 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4837 bset_filename (current_buffer
, visit_file
);
4843 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4845 /* Special kludge to simplify auto-saving. */
4848 /* Do it later, so write-region-annotate-function can work differently
4849 if we save "the buffer" vs "a region".
4850 This is useful in tar-mode. --Stef
4851 XSETFASTINT (start, BEG);
4852 XSETFASTINT (end, Z); */
4856 record_unwind_protect (build_annotations_unwind
,
4857 Vwrite_region_annotation_buffers
);
4858 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4860 given_buffer
= current_buffer
;
4862 if (!STRINGP (start
))
4864 annotations
= build_annotations (start
, end
);
4866 if (current_buffer
!= given_buffer
)
4868 XSETFASTINT (start
, BEGV
);
4869 XSETFASTINT (end
, ZV
);
4875 XSETFASTINT (start
, BEGV
);
4876 XSETFASTINT (end
, ZV
);
4879 /* Decide the coding-system to encode the data with.
4880 We used to make this choice before calling build_annotations, but that
4881 leads to problems when a write-annotate-function takes care of
4882 unsavable chars (as was the case with X-Symbol). */
4883 Vlast_coding_system_used
4884 = choose_write_coding_system (start
, end
, filename
,
4885 append
, visit
, lockname
, &coding
);
4887 if (open_and_close_file
&& !auto_saving
)
4889 lock_file (lockname
);
4893 encoded_filename
= ENCODE_FILE (filename
);
4894 fn
= SSDATA (encoded_filename
);
4895 open_flags
= O_WRONLY
| O_CREAT
;
4896 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4897 if (NUMBERP (append
))
4898 offset
= file_offset (append
);
4899 else if (!NILP (append
))
4900 open_flags
|= O_APPEND
;
4902 mode
= S_IREAD
| S_IWRITE
;
4904 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4907 if (open_and_close_file
)
4909 desc
= emacs_open (fn
, open_flags
, mode
);
4912 int open_errno
= errno
;
4914 unlock_file (lockname
);
4915 report_file_errno ("Opening output file", filename
, open_errno
);
4918 count1
= SPECPDL_INDEX ();
4919 record_unwind_protect_int (close_file_unwind
, desc
);
4922 if (NUMBERP (append
))
4924 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4927 int lseek_errno
= errno
;
4929 unlock_file (lockname
);
4930 report_file_errno ("Lseek error", filename
, lseek_errno
);
4934 if (STRINGP (start
))
4935 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4936 else if (XINT (start
) != XINT (end
))
4937 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4938 &annotations
, &coding
);
4941 /* If file was empty, still need to write the annotations. */
4942 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4943 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4947 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4948 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4950 /* We have to flush out a data. */
4951 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4952 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4956 /* fsync is not crucial for temporary files. Nor for auto-save
4957 files, since they might lose some work anyway. */
4958 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4960 /* Transfer data and metadata to disk, retrying if interrupted.
4961 fsync can report a write failure here, e.g., due to disk full
4962 under NFS. But ignore EINVAL, which means fsync is not
4963 supported on this file. */
4964 while (fsync (desc
) != 0)
4967 if (errno
!= EINVAL
)
4968 ok
= 0, save_errno
= errno
;
4973 modtime
= invalid_timespec ();
4976 if (fstat (desc
, &st
) == 0)
4977 modtime
= get_stat_mtime (&st
);
4979 ok
= 0, save_errno
= errno
;
4982 if (open_and_close_file
)
4984 /* NFS can report a write failure now. */
4985 if (emacs_close (desc
) < 0)
4986 ok
= 0, save_errno
= errno
;
4988 /* Discard the unwind protect for close_file_unwind. */
4989 specpdl_ptr
= specpdl
+ count1
;
4992 /* Some file systems have a bug where st_mtime is not updated
4993 properly after a write. For example, CIFS might not see the
4994 st_mtime change until after the file is opened again.
4996 Attempt to detect this file system bug, and update MODTIME to the
4997 newer st_mtime if the bug appears to be present. This introduces
4998 a race condition, so to avoid most instances of the race condition
4999 on non-buggy file systems, skip this check if the most recently
5000 encountered non-buggy file system was the current file system.
5002 A race condition can occur if some other process modifies the
5003 file between the fstat above and the fstat below, but the race is
5004 unlikely and a similar race between the last write and the fstat
5005 above cannot possibly be closed anyway. */
5007 if (timespec_valid_p (modtime
)
5008 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
5010 int desc1
= emacs_open (fn
, O_WRONLY
, 0);
5014 if (fstat (desc1
, &st1
) == 0
5015 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
5017 /* Use the heuristic if it appears to be valid. With neither
5018 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
5019 file, the time stamp won't change. Also, some non-POSIX
5020 systems don't update an empty file's time stamp when
5021 truncating it. Finally, file systems with 100 ns or worse
5022 resolution sometimes seem to have bugs: on a system with ns
5023 resolution, checking ns % 100 incorrectly avoids the heuristic
5024 1% of the time, but the problem should be temporary as we will
5025 try again on the next time stamp. */
5027 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
5029 && modtime
.tv_nsec
% 100 != 0);
5031 struct timespec modtime1
= get_stat_mtime (&st1
);
5033 && timespec_cmp (modtime
, modtime1
) == 0
5034 && st
.st_size
== st1
.st_size
)
5036 timestamp_file_system
= st
.st_dev
;
5037 valid_timestamp_file_system
= 1;
5041 st
.st_size
= st1
.st_size
;
5045 emacs_close (desc1
);
5049 /* Call write-region-post-annotation-function. */
5050 while (CONSP (Vwrite_region_annotation_buffers
))
5052 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5053 if (!NILP (Fbuffer_live_p (buf
)))
5056 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5057 call0 (Vwrite_region_post_annotation_function
);
5059 Vwrite_region_annotation_buffers
5060 = XCDR (Vwrite_region_annotation_buffers
);
5063 unbind_to (count
, Qnil
);
5066 unlock_file (lockname
);
5068 /* Do this before reporting IO error
5069 to avoid a "file has changed on disk" warning on
5070 next attempt to save. */
5071 if (timespec_valid_p (modtime
))
5073 current_buffer
->modtime
= modtime
;
5074 current_buffer
->modtime_size
= st
.st_size
;
5078 report_file_errno ("Write error", filename
, save_errno
);
5080 bool auto_saving_into_visited_file
=
5082 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5083 BVAR (current_buffer
, auto_save_file_name
)));
5086 SAVE_MODIFF
= MODIFF
;
5087 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5088 bset_filename (current_buffer
, visit_file
);
5089 update_mode_lines
= 14;
5090 if (auto_saving_into_visited_file
)
5091 unlock_file (lockname
);
5095 if (auto_saving_into_visited_file
)
5097 SAVE_MODIFF
= MODIFF
;
5098 unlock_file (lockname
);
5104 if (!auto_saving
&& !noninteractive
)
5105 message_with_string ((NUMBERP (append
)
5115 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5116 doc
: /* Return t if (car A) is numerically less than (car B). */)
5117 (Lisp_Object a
, Lisp_Object b
)
5119 return arithcompare (Fcar (a
), Fcar (b
), ARITH_LESS
);
5122 /* Build the complete list of annotations appropriate for writing out
5123 the text between START and END, by calling all the functions in
5124 write-region-annotate-functions and merging the lists they return.
5125 If one of these functions switches to a different buffer, we assume
5126 that buffer contains altered text. Therefore, the caller must
5127 make sure to restore the current buffer in all cases,
5128 as save-excursion would do. */
5131 build_annotations (Lisp_Object start
, Lisp_Object end
)
5133 Lisp_Object annotations
;
5135 Lisp_Object original_buffer
;
5137 bool used_global
= false;
5139 XSETBUFFER (original_buffer
, current_buffer
);
5142 p
= Vwrite_region_annotate_functions
;
5145 struct buffer
*given_buffer
= current_buffer
;
5146 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5147 { /* Use the global value of the hook. */
5150 Fdefault_value (Qwrite_region_annotate_functions
),
5154 Vwrite_region_annotations_so_far
= annotations
;
5155 res
= call2 (XCAR (p
), start
, end
);
5156 /* If the function makes a different buffer current,
5157 assume that means this buffer contains altered text to be output.
5158 Reset START and END from the buffer bounds
5159 and discard all previous annotations because they should have
5160 been dealt with by this function. */
5161 if (current_buffer
!= given_buffer
)
5163 Vwrite_region_annotation_buffers
5164 = Fcons (Fcurrent_buffer (),
5165 Vwrite_region_annotation_buffers
);
5166 XSETFASTINT (start
, BEGV
);
5167 XSETFASTINT (end
, ZV
);
5170 Flength (res
); /* Check basic validity of return value */
5171 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5175 /* Now do the same for annotation functions implied by the file-format */
5176 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5177 p
= BVAR (current_buffer
, auto_save_file_format
);
5179 p
= BVAR (current_buffer
, file_format
);
5180 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5182 struct buffer
*given_buffer
= current_buffer
;
5184 Vwrite_region_annotations_so_far
= annotations
;
5186 /* Value is either a list of annotations or nil if the function
5187 has written annotations to a temporary buffer, which is now
5189 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5190 original_buffer
, make_number (i
));
5191 if (current_buffer
!= given_buffer
)
5193 XSETFASTINT (start
, BEGV
);
5194 XSETFASTINT (end
, ZV
);
5199 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5206 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5207 If STRING is nil, POS is the character position in the current buffer.
5208 Intersperse with them the annotations from *ANNOT
5209 which fall within the range of POS to POS + NCHARS,
5210 each at its appropriate position.
5212 We modify *ANNOT by discarding elements as we use them up.
5214 Return true if successful. */
5217 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5218 ptrdiff_t nchars
, Lisp_Object
*annot
,
5219 struct coding_system
*coding
)
5223 ptrdiff_t lastpos
= pos
+ nchars
;
5225 while (NILP (*annot
) || CONSP (*annot
))
5227 tem
= Fcar_safe (Fcar (*annot
));
5230 nextpos
= XFASTINT (tem
);
5232 /* If there are no more annotations in this range,
5233 output the rest of the range all at once. */
5234 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5235 return e_write (desc
, string
, pos
, lastpos
, coding
);
5237 /* Output buffer text up to the next annotation's position. */
5240 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5244 /* Output the annotation. */
5245 tem
= Fcdr (Fcar (*annot
));
5248 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5251 *annot
= Fcdr (*annot
);
5256 /* Maximum number of characters that the next
5257 function encodes per one loop iteration. */
5259 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5261 /* Write text in the range START and END into descriptor DESC,
5262 encoding them with coding system CODING. If STRING is nil, START
5263 and END are character positions of the current buffer, else they
5264 are indexes to the string STRING. Return true if successful. */
5267 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5268 struct coding_system
*coding
)
5270 if (STRINGP (string
))
5273 end
= SCHARS (string
);
5276 /* We used to have a code for handling selective display here. But,
5277 now it is handled within encode_coding. */
5281 if (STRINGP (string
))
5283 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5284 if (CODING_REQUIRE_ENCODING (coding
))
5286 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5288 /* Avoid creating huge Lisp string in encode_coding_object. */
5289 if (nchars
== E_WRITE_MAX
)
5290 coding
->raw_destination
= 1;
5292 encode_coding_object
5293 (coding
, string
, start
, string_char_to_byte (string
, start
),
5294 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5299 coding
->dst_object
= string
;
5300 coding
->consumed_char
= SCHARS (string
);
5301 coding
->produced
= SBYTES (string
);
5306 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5307 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5309 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5310 if (CODING_REQUIRE_ENCODING (coding
))
5312 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5315 if (nchars
== E_WRITE_MAX
)
5316 coding
->raw_destination
= 1;
5318 encode_coding_object
5319 (coding
, Fcurrent_buffer (), start
, start_byte
,
5320 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5324 coding
->dst_object
= Qnil
;
5325 coding
->dst_pos_byte
= start_byte
;
5326 if (start
>= GPT
|| end
<= GPT
)
5328 coding
->consumed_char
= end
- start
;
5329 coding
->produced
= end_byte
- start_byte
;
5333 coding
->consumed_char
= GPT
- start
;
5334 coding
->produced
= GPT_BYTE
- start_byte
;
5339 if (coding
->produced
> 0)
5341 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5342 : (STRINGP (coding
->dst_object
)
5343 ? SSDATA (coding
->dst_object
)
5344 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5345 coding
->produced
-= emacs_write_quit (desc
, buf
, coding
->produced
);
5347 if (coding
->raw_destination
)
5349 /* We're responsible for freeing this, see
5350 encode_coding_object to check why. */
5351 xfree (coding
->destination
);
5352 coding
->raw_destination
= 0;
5354 if (coding
->produced
)
5357 start
+= coding
->consumed_char
;
5363 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5364 Sverify_visited_file_modtime
, 0, 1, 0,
5365 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5366 This means that the file has not been changed since it was visited or saved.
5367 If BUF is omitted or nil, it defaults to the current buffer.
5368 See Info node `(elisp)Modification Time' for more details. */)
5371 struct buffer
*b
= decode_buffer (buf
);
5373 Lisp_Object handler
;
5374 Lisp_Object filename
;
5375 struct timespec mtime
;
5377 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5378 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5380 /* If the file name has special constructs in it,
5381 call the corresponding file handler. */
5382 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5383 Qverify_visited_file_modtime
);
5384 if (!NILP (handler
))
5385 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5387 filename
= ENCODE_FILE (BVAR (b
, filename
));
5389 mtime
= (stat (SSDATA (filename
), &st
) == 0
5390 ? get_stat_mtime (&st
)
5391 : time_error_value (errno
));
5392 if (timespec_cmp (mtime
, b
->modtime
) == 0
5393 && (b
->modtime_size
< 0
5394 || st
.st_size
== b
->modtime_size
))
5399 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5400 Svisited_file_modtime
, 0, 0, 0,
5401 doc
: /* Return the current buffer's recorded visited file modification time.
5402 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5403 `file-attributes' returns. If the current buffer has no recorded file
5404 modification time, this function returns 0. If the visited file
5405 doesn't exist, return -1.
5406 See Info node `(elisp)Modification Time' for more details. */)
5409 int ns
= current_buffer
->modtime
.tv_nsec
;
5411 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5412 return make_lisp_time (current_buffer
->modtime
);
5415 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5416 Sset_visited_file_modtime
, 0, 1, 0,
5417 doc
: /* Update buffer's recorded modification time from the visited file's time.
5418 Useful if the buffer was not read from the file normally
5419 or if the file itself has been changed for some known benign reason.
5420 An argument specifies the modification time value to use
5421 \(instead of that of the visited file), in the form of a list
5422 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5423 `visited-file-modtime'. */)
5424 (Lisp_Object time_flag
)
5426 if (!NILP (time_flag
))
5428 struct timespec mtime
;
5429 if (INTEGERP (time_flag
))
5431 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5432 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5435 mtime
= lisp_time_argument (time_flag
);
5437 current_buffer
->modtime
= mtime
;
5438 current_buffer
->modtime_size
= -1;
5442 register Lisp_Object filename
;
5444 Lisp_Object handler
;
5446 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5448 /* If the file name has special constructs in it,
5449 call the corresponding file handler. */
5450 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5451 if (!NILP (handler
))
5452 /* The handler can find the file name the same way we did. */
5453 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5455 filename
= ENCODE_FILE (filename
);
5457 if (stat (SSDATA (filename
), &st
) >= 0)
5459 current_buffer
->modtime
= get_stat_mtime (&st
);
5460 current_buffer
->modtime_size
= st
.st_size
;
5468 auto_save_error (Lisp_Object error_val
)
5470 auto_save_error_occurred
= 1;
5472 ring_bell (XFRAME (selected_frame
));
5474 AUTO_STRING (format
, "Auto-saving %s: %s");
5475 Lisp_Object msg
= CALLN (Fformat
, format
, BVAR (current_buffer
, name
),
5476 Ferror_message_string (error_val
));
5477 call3 (intern ("display-warning"),
5478 intern ("auto-save"), msg
, intern ("error"));
5489 auto_save_mode_bits
= 0666;
5491 /* Get visited file's mode to become the auto save file's mode. */
5492 if (! NILP (BVAR (current_buffer
, filename
)))
5494 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5495 /* But make sure we can overwrite it later! */
5496 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5497 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5499 /* Remote files don't cooperate with stat. */
5500 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5504 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5505 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5509 struct auto_save_unwind
5516 do_auto_save_unwind (void *arg
)
5518 struct auto_save_unwind
*p
= arg
;
5519 FILE *stream
= p
->stream
;
5520 minibuffer_auto_raise
= p
->auto_raise
;
5531 do_auto_save_make_dir (Lisp_Object dir
)
5535 auto_saving_dir_umask
= 077;
5536 result
= call2 (Qmake_directory
, dir
, Qt
);
5537 auto_saving_dir_umask
= 0;
5542 do_auto_save_eh (Lisp_Object ignore
)
5544 auto_saving_dir_umask
= 0;
5548 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5549 doc
: /* Auto-save all buffers that need it.
5550 This is all buffers that have auto-saving enabled
5551 and are changed since last auto-saved.
5552 Auto-saving writes the buffer into a file
5553 so that your editing is not lost if the system crashes.
5554 This file is not the file you visited; that changes only when you save.
5555 Normally we run the normal hook `auto-save-hook' before saving.
5557 A non-nil NO-MESSAGE argument means do not print any message if successful.
5558 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5559 (Lisp_Object no_message
, Lisp_Object current_only
)
5561 struct buffer
*old
= current_buffer
, *b
;
5562 Lisp_Object tail
, buf
, hook
;
5563 bool auto_saved
= 0;
5564 int do_handled_files
;
5566 FILE *stream
= NULL
;
5567 ptrdiff_t count
= SPECPDL_INDEX ();
5568 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5569 bool old_message_p
= 0;
5570 struct auto_save_unwind auto_save_unwind
;
5572 if (max_specpdl_size
< specpdl_size
+ 40)
5573 max_specpdl_size
= specpdl_size
+ 40;
5578 if (NILP (no_message
))
5580 old_message_p
= push_message ();
5581 record_unwind_protect_void (pop_message_unwind
);
5584 /* Ordinarily don't quit within this function,
5585 but don't make it impossible to quit (in case we get hung in I/O). */
5589 hook
= intern ("auto-save-hook");
5590 safe_run_hooks (hook
);
5592 if (STRINGP (Vauto_save_list_file_name
))
5594 Lisp_Object listfile
;
5596 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5598 /* Don't try to create the directory when shutting down Emacs,
5599 because creating the directory might signal an error, and
5600 that would leave Emacs in a strange state. */
5601 if (!NILP (Vrun_hooks
))
5604 dir
= Ffile_name_directory (listfile
);
5605 if (NILP (Ffile_directory_p (dir
)))
5606 internal_condition_case_1 (do_auto_save_make_dir
,
5611 stream
= emacs_fopen (SSDATA (listfile
), "w");
5614 auto_save_unwind
.stream
= stream
;
5615 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5616 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5617 minibuffer_auto_raise
= 0;
5619 auto_save_error_occurred
= 0;
5621 /* On first pass, save all files that don't have handlers.
5622 On second pass, save all files that do have handlers.
5624 If Emacs is crashing, the handlers may tweak what is causing
5625 Emacs to crash in the first place, and it would be a shame if
5626 Emacs failed to autosave perfectly ordinary files because it
5627 couldn't handle some ange-ftp'd file. */
5629 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5630 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5634 /* Record all the buffers that have auto save mode
5635 in the special file that lists them. For each of these buffers,
5636 Record visited name (if any) and auto save name. */
5637 if (STRINGP (BVAR (b
, auto_save_file_name
))
5638 && stream
!= NULL
&& do_handled_files
== 0)
5641 if (!NILP (BVAR (b
, filename
)))
5642 fwrite_unlocked (SDATA (BVAR (b
, filename
)), 1,
5643 SBYTES (BVAR (b
, filename
)), stream
);
5644 putc_unlocked ('\n', stream
);
5645 fwrite_unlocked (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5646 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5647 putc_unlocked ('\n', stream
);
5651 if (!NILP (current_only
)
5652 && b
!= current_buffer
)
5655 /* Don't auto-save indirect buffers.
5656 The base buffer takes care of it. */
5660 /* Check for auto save enabled
5661 and file changed since last auto save
5662 and file changed since last real save. */
5663 if (STRINGP (BVAR (b
, auto_save_file_name
))
5664 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5665 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5666 /* -1 means we've turned off autosaving for a while--see below. */
5667 && XINT (BVAR (b
, save_length
)) >= 0
5668 && (do_handled_files
5669 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5672 struct timespec before_time
= current_timespec ();
5673 struct timespec after_time
;
5675 /* If we had a failure, don't try again for 20 minutes. */
5676 if (b
->auto_save_failure_time
> 0
5677 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5680 set_buffer_internal (b
);
5681 if (NILP (Vauto_save_include_big_deletions
)
5682 && (XFASTINT (BVAR (b
, save_length
)) * 10
5683 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5684 /* A short file is likely to change a large fraction;
5685 spare the user annoying messages. */
5686 && XFASTINT (BVAR (b
, save_length
)) > 5000
5687 /* These messages are frequent and annoying for `*mail*'. */
5688 && !EQ (BVAR (b
, filename
), Qnil
)
5689 && NILP (no_message
))
5691 /* It has shrunk too much; turn off auto-saving here. */
5692 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5693 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5695 minibuffer_auto_raise
= 0;
5696 /* Turn off auto-saving until there's a real save,
5697 and prevent any more warnings. */
5698 XSETINT (BVAR (b
, save_length
), -1);
5699 Fsleep_for (make_number (1), Qnil
);
5702 if (!auto_saved
&& NILP (no_message
))
5703 message1 ("Auto-saving...");
5704 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5706 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5707 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5708 set_buffer_internal (old
);
5710 after_time
= current_timespec ();
5712 /* If auto-save took more than 60 seconds,
5713 assume it was an NFS failure that got a timeout. */
5714 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5715 b
->auto_save_failure_time
= after_time
.tv_sec
;
5719 /* Prevent another auto save till enough input events come in. */
5720 record_auto_save ();
5722 if (auto_saved
&& NILP (no_message
))
5726 /* If we are going to restore an old message,
5727 give time to read ours. */
5728 sit_for (make_number (1), 0, 0);
5731 else if (!auto_save_error_occurred
)
5732 /* Don't overwrite the error message if an error occurred.
5733 If we displayed a message and then restored a state
5734 with no message, leave a "done" message on the screen. */
5735 message1 ("Auto-saving...done");
5740 /* This restores the message-stack status. */
5741 unbind_to (count
, Qnil
);
5745 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5746 Sset_buffer_auto_saved
, 0, 0, 0,
5747 doc
: /* Mark current buffer as auto-saved with its current text.
5748 No auto-save file will be written until the buffer changes again. */)
5751 /* FIXME: This should not be called in indirect buffers, since
5752 they're not autosaved. */
5753 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5754 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5755 current_buffer
->auto_save_failure_time
= 0;
5759 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5760 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5761 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5764 current_buffer
->auto_save_failure_time
= 0;
5768 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5770 doc
: /* Return t if current buffer has been auto-saved recently.
5771 More precisely, if it has been auto-saved since last read from or saved
5772 in the visited file. If the buffer has no visited file,
5773 then any auto-save counts as "recent". */)
5776 /* FIXME: maybe we should return nil for indirect buffers since
5777 they're never autosaved. */
5778 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5781 /* Reading and completing file names. */
5783 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5784 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5785 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5786 The return value is only relevant for a call to `read-file-name' that happens
5787 before any other event (mouse or keypress) is handled. */)
5790 #if (defined USE_GTK || defined USE_MOTIF \
5791 || defined HAVE_NS || defined HAVE_NTGUI)
5792 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5795 && window_system_available (SELECTED_FRAME ()))
5802 DEFUN ("set-binary-mode", Fset_binary_mode
, Sset_binary_mode
, 2, 2, 0,
5803 doc
: /* Switch STREAM to binary I/O mode or text I/O mode.
5804 STREAM can be one of the symbols `stdin', `stdout', or `stderr'.
5805 If MODE is non-nil, switch STREAM to binary mode, otherwise switch
5808 As a side effect, this function flushes any pending STREAM's data.
5810 Value is the previous value of STREAM's I/O mode, nil for text mode,
5811 non-nil for binary mode.
5813 On MS-Windows and MS-DOS, binary mode is needed to read or write
5814 arbitrary binary data, and for disabling translation between CR-LF
5815 pairs and a single newline character. Examples include generation
5816 of text files with Unix-style end-of-line format using `princ' in
5817 batch mode, with standard output redirected to a file.
5819 On Posix systems, this function always returns non-nil, and has no
5820 effect except for flushing STREAM's data. */)
5821 (Lisp_Object stream
, Lisp_Object mode
)
5826 CHECK_SYMBOL (stream
);
5827 if (EQ (stream
, Qstdin
))
5829 else if (EQ (stream
, Qstdout
))
5831 else if (EQ (stream
, Qstderr
))
5834 xsignal2 (Qerror
, build_string ("unsupported stream"), stream
);
5836 binmode
= NILP (mode
) ? O_TEXT
: O_BINARY
;
5838 fflush_unlocked (fp
);
5840 return (set_binary_mode (fileno (fp
), binmode
) == O_BINARY
) ? Qt
: Qnil
;
5846 realmask
= umask (0);
5849 valid_timestamp_file_system
= 0;
5851 /* fsync can be a significant performance hit. Often it doesn't
5852 suffice to make the file-save operation survive a crash. For
5853 batch scripts, which are typically part of larger shell commands
5854 that don't fsync other files, its effect on performance can be
5855 significant so its utility is particularly questionable.
5856 Hence, for now by default fsync is used only when interactive.
5858 For more on why fsync often fails to work on today's hardware, see:
5859 Zheng M et al. Understanding the robustness of SSDs under power fault.
5860 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5861 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5863 For more on why fsync does not suffice even if it works properly, see:
5864 Roche X. Necessary step(s) to synchronize filename operations on disk.
5865 Austin Group Defect 672, 2013-03-19
5866 http://austingroupbugs.net/view.php?id=672 */
5867 write_region_inhibit_fsync
= noninteractive
;
5871 syms_of_fileio (void)
5873 /* Property name of a file name handler,
5874 which gives a list of operations it handles. */
5875 DEFSYM (Qoperations
, "operations");
5877 DEFSYM (Qexpand_file_name
, "expand-file-name");
5878 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5879 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5880 DEFSYM (Qfile_name_directory
, "file-name-directory");
5881 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5882 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5883 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5884 DEFSYM (Qcopy_file
, "copy-file");
5885 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5886 DEFSYM (Qmake_directory
, "make-directory");
5887 DEFSYM (Qdelete_file
, "delete-file");
5888 DEFSYM (Qfile_name_case_insensitive_p
, "file-name-case-insensitive-p");
5889 DEFSYM (Qrename_file
, "rename-file");
5890 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5891 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5892 DEFSYM (Qfile_exists_p
, "file-exists-p");
5893 DEFSYM (Qfile_executable_p
, "file-executable-p");
5894 DEFSYM (Qfile_readable_p
, "file-readable-p");
5895 DEFSYM (Qfile_writable_p
, "file-writable-p");
5896 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5897 DEFSYM (Qaccess_file
, "access-file");
5898 DEFSYM (Qfile_directory_p
, "file-directory-p");
5899 DEFSYM (Qfile_regular_p
, "file-regular-p");
5900 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5901 DEFSYM (Qfile_modes
, "file-modes");
5902 DEFSYM (Qset_file_modes
, "set-file-modes");
5903 DEFSYM (Qset_file_times
, "set-file-times");
5904 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5905 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5906 DEFSYM (Qfile_acl
, "file-acl");
5907 DEFSYM (Qset_file_acl
, "set-file-acl");
5908 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5909 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5910 DEFSYM (Qwrite_region
, "write-region");
5911 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5912 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5914 /* The symbol bound to coding-system-for-read when
5915 insert-file-contents is called for recovering a file. This is not
5916 an actual coding system name, but just an indicator to tell
5917 insert-file-contents to use `emacs-mule' with a special flag for
5918 auto saving and recovering a file. */
5919 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5921 DEFSYM (Qfile_name_history
, "file-name-history");
5922 Fset (Qfile_name_history
, Qnil
);
5924 DEFSYM (Qfile_error
, "file-error");
5925 DEFSYM (Qfile_already_exists
, "file-already-exists");
5926 DEFSYM (Qfile_date_error
, "file-date-error");
5927 DEFSYM (Qfile_missing
, "file-missing");
5928 DEFSYM (Qfile_notify_error
, "file-notify-error");
5929 DEFSYM (Qexcl
, "excl");
5931 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5932 doc
: /* Coding system for encoding file names.
5933 If it is nil, `default-file-name-coding-system' (which see) is used.
5935 On MS-Windows, the value of this variable is largely ignored if
5936 `w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5937 behaves as if file names were encoded in `utf-8'. */);
5938 Vfile_name_coding_system
= Qnil
;
5940 DEFVAR_LISP ("default-file-name-coding-system",
5941 Vdefault_file_name_coding_system
,
5942 doc
: /* Default coding system for encoding file names.
5943 This variable is used only when `file-name-coding-system' is nil.
5945 This variable is set/changed by the command `set-language-environment'.
5946 User should not set this variable manually,
5947 instead use `file-name-coding-system' to get a constant encoding
5948 of file names regardless of the current language environment.
5950 On MS-Windows, the value of this variable is largely ignored if
5951 `w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5952 behaves as if file names were encoded in `utf-8'. */);
5953 Vdefault_file_name_coding_system
= Qnil
;
5955 /* Lisp functions for translating file formats. */
5956 DEFSYM (Qformat_decode
, "format-decode");
5957 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5959 /* Lisp function for setting buffer-file-coding-system and the
5960 multibyteness of the current buffer after inserting a file. */
5961 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5963 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5965 Fput (Qfile_error
, Qerror_conditions
,
5966 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5967 Fput (Qfile_error
, Qerror_message
,
5968 build_pure_c_string ("File error"));
5970 Fput (Qfile_already_exists
, Qerror_conditions
,
5971 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5972 Fput (Qfile_already_exists
, Qerror_message
,
5973 build_pure_c_string ("File already exists"));
5975 Fput (Qfile_date_error
, Qerror_conditions
,
5976 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5977 Fput (Qfile_date_error
, Qerror_message
,
5978 build_pure_c_string ("Cannot set file date"));
5980 Fput (Qfile_missing
, Qerror_conditions
,
5981 Fpurecopy (list3 (Qfile_missing
, Qfile_error
, Qerror
)));
5982 Fput (Qfile_missing
, Qerror_message
,
5983 build_pure_c_string ("File is missing"));
5985 Fput (Qfile_notify_error
, Qerror_conditions
,
5986 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5987 Fput (Qfile_notify_error
, Qerror_message
,
5988 build_pure_c_string ("File notification error"));
5990 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5991 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5992 If a file name matches REGEXP, all I/O on that file is done by calling
5993 HANDLER. If a file name matches more than one handler, the handler
5994 whose match starts last in the file name gets precedence. The
5995 function `find-file-name-handler' checks this list for a handler for
5998 HANDLER should be a function. The first argument given to it is the
5999 name of the I/O primitive to be handled; the remaining arguments are
6000 the arguments that were passed to that primitive. For example, if you
6001 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
6002 HANDLER is called like this:
6004 (funcall HANDLER \\='file-exists-p FILENAME)
6006 Note that HANDLER must be able to handle all I/O primitives; if it has
6007 nothing special to do for a primitive, it should reinvoke the
6008 primitive to handle the operation \"the usual way\".
6009 See Info node `(elisp)Magic File Names' for more details. */);
6010 Vfile_name_handler_alist
= Qnil
;
6012 DEFVAR_LISP ("set-auto-coding-function",
6013 Vset_auto_coding_function
,
6014 doc
: /* If non-nil, a function to call to decide a coding system of file.
6015 Two arguments are passed to this function: the file name
6016 and the length of a file contents following the point.
6017 This function should return a coding system to decode the file contents.
6018 It should check the file name against `auto-coding-alist'.
6019 If no coding system is decided, it should check a coding system
6020 specified in the heading lines with the format:
6021 -*- ... coding: CODING-SYSTEM; ... -*-
6022 or local variable spec of the tailing lines with `coding:' tag. */);
6023 Vset_auto_coding_function
= Qnil
;
6025 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
6026 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
6027 Each is passed one argument, the number of characters inserted,
6028 with point at the start of the inserted text. Each function
6029 should leave point the same, and return the new character count.
6030 If `insert-file-contents' is intercepted by a handler from
6031 `file-name-handler-alist', that handler is responsible for calling the
6032 functions in `after-insert-file-functions' if appropriate. */);
6033 Vafter_insert_file_functions
= Qnil
;
6035 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
6036 doc
: /* A list of functions to be called at the start of `write-region'.
6037 Each is passed two arguments, START and END as for `write-region'.
6038 These are usually two numbers but not always; see the documentation
6039 for `write-region'. The function should return a list of pairs
6040 of the form (POSITION . STRING), consisting of strings to be effectively
6041 inserted at the specified positions of the file being written (1 means to
6042 insert before the first byte written). The POSITIONs must be sorted into
6045 If there are several annotation functions, the lists returned by these
6046 functions are merged destructively. As each annotation function runs,
6047 the variable `write-region-annotations-so-far' contains a list of all
6048 annotations returned by previous annotation functions.
6050 An annotation function can return with a different buffer current.
6051 Doing so removes the annotations returned by previous functions, and
6052 resets START and END to `point-min' and `point-max' of the new buffer.
6054 After `write-region' completes, Emacs calls the function stored in
6055 `write-region-post-annotation-function', once for each buffer that was
6056 current when building the annotations (i.e., at least once), with that
6057 buffer current. */);
6058 Vwrite_region_annotate_functions
= Qnil
;
6059 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
6061 DEFVAR_LISP ("write-region-post-annotation-function",
6062 Vwrite_region_post_annotation_function
,
6063 doc
: /* Function to call after `write-region' completes.
6064 The function is called with no arguments. If one or more of the
6065 annotation functions in `write-region-annotate-functions' changed the
6066 current buffer, the function stored in this variable is called for
6067 each of those additional buffers as well, in addition to the original
6068 buffer. The relevant buffer is current during each function call. */);
6069 Vwrite_region_post_annotation_function
= Qnil
;
6070 staticpro (&Vwrite_region_annotation_buffers
);
6072 DEFVAR_LISP ("write-region-annotations-so-far",
6073 Vwrite_region_annotations_so_far
,
6074 doc
: /* When an annotation function is called, this holds the previous annotations.
6075 These are the annotations made by other annotation functions
6076 that were already called. See also `write-region-annotate-functions'. */);
6077 Vwrite_region_annotations_so_far
= Qnil
;
6079 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6080 doc
: /* A list of file name handlers that temporarily should not be used.
6081 This applies only to the operation `inhibit-file-name-operation'. */);
6082 Vinhibit_file_name_handlers
= Qnil
;
6084 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6085 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6086 Vinhibit_file_name_operation
= Qnil
;
6088 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6089 doc
: /* File name in which we write a list of all auto save file names.
6090 This variable is initialized automatically from `auto-save-list-file-prefix'
6091 shortly after Emacs reads your init file, if you have not yet given it
6092 a non-nil value. */);
6093 Vauto_save_list_file_name
= Qnil
;
6095 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6096 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6097 Normally auto-save files are written under other names. */);
6098 Vauto_save_visited_file_name
= Qnil
;
6100 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6101 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6102 If nil, deleting a substantial portion of the text disables auto-save
6103 in the buffer; this is the default behavior, because the auto-save
6104 file is usually more useful if it contains the deleted text. */);
6105 Vauto_save_include_big_deletions
= Qnil
;
6107 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6108 doc
: /* Non-nil means don't call fsync in `write-region'.
6109 This variable affects calls to `write-region' as well as save commands.
6110 Setting this to nil may avoid data loss if the system loses power or
6111 the operating system crashes. By default, it is non-nil in batch mode. */);
6112 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6114 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6115 doc
: /* Specifies whether to use the system's trash can.
6116 When non-nil, certain file deletion commands use the function
6117 `move-file-to-trash' instead of deleting files outright.
6118 This includes interactive calls to `delete-file' and
6119 `delete-directory' and the Dired deletion commands. */);
6120 delete_by_moving_to_trash
= 0;
6121 DEFSYM (Qdelete_by_moving_to_trash
, "delete-by-moving-to-trash");
6123 /* Lisp function for moving files to trash. */
6124 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6126 /* Lisp function for recursively copying directories. */
6127 DEFSYM (Qcopy_directory
, "copy-directory");
6129 /* Lisp function for recursively deleting directories. */
6130 DEFSYM (Qdelete_directory
, "delete-directory");
6132 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");
6133 DEFSYM (Qget_buffer_window_list
, "get-buffer-window-list");
6135 DEFSYM (Qstdin
, "stdin");
6136 DEFSYM (Qstdout
, "stdout");
6137 DEFSYM (Qstderr
, "stderr");
6139 defsubr (&Sfind_file_name_handler
);
6140 defsubr (&Sfile_name_directory
);
6141 defsubr (&Sfile_name_nondirectory
);
6142 defsubr (&Sunhandled_file_name_directory
);
6143 defsubr (&Sfile_name_as_directory
);
6144 defsubr (&Sdirectory_file_name
);
6145 defsubr (&Smake_temp_name
);
6146 defsubr (&Sexpand_file_name
);
6147 defsubr (&Ssubstitute_in_file_name
);
6148 defsubr (&Scopy_file
);
6149 defsubr (&Smake_directory_internal
);
6150 defsubr (&Sdelete_directory_internal
);
6151 defsubr (&Sdelete_file
);
6152 defsubr (&Sfile_name_case_insensitive_p
);
6153 defsubr (&Srename_file
);
6154 defsubr (&Sadd_name_to_file
);
6155 defsubr (&Smake_symbolic_link
);
6156 defsubr (&Sfile_name_absolute_p
);
6157 defsubr (&Sfile_exists_p
);
6158 defsubr (&Sfile_executable_p
);
6159 defsubr (&Sfile_readable_p
);
6160 defsubr (&Sfile_writable_p
);
6161 defsubr (&Saccess_file
);
6162 defsubr (&Sfile_symlink_p
);
6163 defsubr (&Sfile_directory_p
);
6164 defsubr (&Sfile_accessible_directory_p
);
6165 defsubr (&Sfile_regular_p
);
6166 defsubr (&Sfile_modes
);
6167 defsubr (&Sset_file_modes
);
6168 defsubr (&Sset_file_times
);
6169 defsubr (&Sfile_selinux_context
);
6170 defsubr (&Sfile_acl
);
6171 defsubr (&Sset_file_acl
);
6172 defsubr (&Sset_file_selinux_context
);
6173 defsubr (&Sset_default_file_modes
);
6174 defsubr (&Sdefault_file_modes
);
6175 defsubr (&Sfile_newer_than_file_p
);
6176 defsubr (&Sinsert_file_contents
);
6177 defsubr (&Swrite_region
);
6178 defsubr (&Scar_less_than_car
);
6179 defsubr (&Sverify_visited_file_modtime
);
6180 defsubr (&Svisited_file_modtime
);
6181 defsubr (&Sset_visited_file_modtime
);
6182 defsubr (&Sdo_auto_save
);
6183 defsubr (&Sset_buffer_auto_saved
);
6184 defsubr (&Sclear_buffer_auto_save_failure
);
6185 defsubr (&Srecent_auto_save_p
);
6187 defsubr (&Snext_read_file_uses_dialog_p
);
6189 defsubr (&Sset_binary_mode
);
6192 defsubr (&Sunix_sync
);