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>
100 #include <tempname.h>
102 #include <binary-io.h>
108 #include "commands.h"
110 /* True during writing of auto-save files. */
111 static bool auto_saving
;
113 /* Emacs's real umask. */
114 static mode_t realmask
;
116 /* Nonzero umask during creation of auto-save directories. */
117 static mode_t auto_saving_dir_umask
;
119 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
120 a new file with the same mode as the original. */
121 static mode_t auto_save_mode_bits
;
123 /* Set by auto_save_1 if an error occurred during the last auto-save. */
124 static bool auto_save_error_occurred
;
126 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
127 number of a file system where time stamps were observed to to work. */
128 static bool valid_timestamp_file_system
;
129 static dev_t timestamp_file_system
;
131 /* Each time an annotation function changes the buffer, the new buffer
133 static Lisp_Object Vwrite_region_annotation_buffers
;
135 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
136 Lisp_Object
*, struct coding_system
*);
137 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
138 struct coding_system
*);
141 /* Return true if FILENAME exists. */
144 check_existing (const char *filename
)
146 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
149 /* Return true if file FILENAME exists and can be executed. */
152 check_executable (char *filename
)
154 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
157 /* Return true if file FILENAME exists and can be accessed
158 according to AMODE, which should include W_OK.
159 On failure, return false and set errno. */
162 check_writable (const char *filename
, int amode
)
165 /* FIXME: an faccessat implementation should be added to the
166 DOS/Windows ports and this #ifdef branch should be removed. */
168 if (stat (filename
, &st
) < 0)
171 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
172 #else /* not MSDOS */
173 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
175 /* faccessat may have returned failure because Cygwin couldn't
176 determine the file's UID or GID; if so, we return success. */
179 int faccessat_errno
= errno
;
181 if (stat (filename
, &st
) < 0)
183 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
184 errno
= faccessat_errno
;
188 #endif /* not MSDOS */
191 /* Signal a file-access failure. STRING describes the failure,
192 NAME the file involved, and ERRORNO the errno value.
194 If NAME is neither null nor a pair, package it up as a singleton
195 list before reporting it; this saves report_file_errno's caller the
196 trouble of preserving errno before calling list1. */
199 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
201 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
202 char *str
= emacs_strerror (errorno
);
203 AUTO_STRING (unibyte_str
, str
);
204 Lisp_Object errstring
205 = code_convert_string_norecord (unibyte_str
, Vlocale_coding_system
, 0);
206 Lisp_Object errdata
= Fcons (errstring
, data
);
208 if (errorno
== EEXIST
)
209 xsignal (Qfile_already_exists
, errdata
);
211 xsignal (errorno
== ENOENT
? Qfile_missing
: Qfile_error
,
212 Fcons (build_string (string
), errdata
));
215 /* Signal a file-access failure that set errno. STRING describes the
216 failure, NAME the file involved. When invoking this function, take
217 care to not use arguments such as build_string ("foo") that involve
218 side effects that may set errno. */
221 report_file_error (char const *string
, Lisp_Object name
)
223 report_file_errno (string
, name
, errno
);
226 /* Like report_file_error, but reports a file-notify-error instead. */
229 report_file_notify_error (const char *string
, Lisp_Object name
)
231 char *str
= emacs_strerror (errno
);
232 AUTO_STRING (unibyte_str
, str
);
233 Lisp_Object errstring
234 = code_convert_string_norecord (unibyte_str
, Vlocale_coding_system
, 0);
235 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
236 Lisp_Object errdata
= Fcons (errstring
, data
);
238 xsignal (Qfile_notify_error
, Fcons (build_string (string
), errdata
));
242 close_file_unwind (int fd
)
248 fclose_unwind (void *arg
)
254 /* Restore point, having saved it as a marker. */
257 restore_point_unwind (Lisp_Object location
)
259 Fgoto_char (location
);
260 unchain_marker (XMARKER (location
));
264 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
265 Sfind_file_name_handler
, 2, 2, 0,
266 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
267 Otherwise, return nil.
268 A file name is handled if one of the regular expressions in
269 `file-name-handler-alist' matches it.
271 If OPERATION equals `inhibit-file-name-operation', then ignore
272 any handlers that are members of `inhibit-file-name-handlers',
273 but still do run any other handlers. This lets handlers
274 use the standard functions without calling themselves recursively. */)
275 (Lisp_Object filename
, Lisp_Object operation
)
277 /* This function must not munge the match data. */
278 Lisp_Object chain
, inhibited_handlers
, result
;
282 CHECK_STRING (filename
);
284 if (EQ (operation
, Vinhibit_file_name_operation
))
285 inhibited_handlers
= Vinhibit_file_name_handlers
;
287 inhibited_handlers
= Qnil
;
289 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
290 chain
= XCDR (chain
))
296 Lisp_Object string
= XCAR (elt
);
298 Lisp_Object handler
= XCDR (elt
);
299 Lisp_Object operations
= Qnil
;
301 if (SYMBOLP (handler
))
302 operations
= Fget (handler
, Qoperations
);
305 && (match_pos
= fast_string_match (string
, filename
)) > pos
306 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
310 handler
= XCDR (elt
);
311 tem
= Fmemq (handler
, inhibited_handlers
);
325 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
327 doc
: /* Return the directory component in file name FILENAME.
328 Return nil if FILENAME does not include a directory.
329 Otherwise return a directory name.
330 Given a Unix syntax file name, returns a string ending in slash. */)
331 (Lisp_Object filename
)
335 CHECK_STRING (filename
);
337 /* If the file name has special constructs in it,
338 call the corresponding file handler. */
339 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
342 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
344 return STRINGP (handled_name
) ? handled_name
: Qnil
;
347 char *beg
= SSDATA (filename
);
348 char const *p
= beg
+ SBYTES (filename
);
350 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
352 /* only recognize drive specifier at the beginning */
354 /* handle the "/:d:foo" and "/:foo" cases correctly */
355 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
356 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
363 /* Expansion of "c:" to drive and default directory. */
366 SAFE_ALLOCA_STRING (beg
, filename
);
367 p
= beg
+ (p
- SSDATA (filename
));
371 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
372 char *res
= alloca (MAXPATHLEN
+ 1);
375 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
377 memcpy (res
, beg
, 2);
382 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
384 size_t l
= strlen (res
);
386 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
389 p
= beg
+ strlen (beg
);
390 dostounix_filename (beg
);
391 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
392 STRING_MULTIBYTE (filename
));
395 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
396 STRING_MULTIBYTE (filename
));
398 else if (STRING_MULTIBYTE (filename
))
400 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
401 dostounix_filename (SSDATA (tem_fn
));
403 if (!NILP (Vw32_downcase_file_names
))
404 tem_fn
= Fdowncase (tem_fn
);
409 dostounix_filename (beg
);
410 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
415 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
419 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
420 Sfile_name_nondirectory
, 1, 1, 0,
421 doc
: /* Return file name FILENAME sans its directory.
422 For example, in a Unix-syntax file name,
423 this is everything after the last slash,
424 or the entire name if it contains no slash. */)
425 (Lisp_Object filename
)
427 register const char *beg
, *p
, *end
;
430 CHECK_STRING (filename
);
432 /* If the file name has special constructs in it,
433 call the corresponding file handler. */
434 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
437 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
439 if (STRINGP (handled_name
))
441 error ("Invalid handler in `file-name-handler-alist'");
444 beg
= SSDATA (filename
);
445 end
= p
= beg
+ SBYTES (filename
);
447 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
449 /* only recognize drive specifier at beginning */
451 /* handle the "/:d:foo" case correctly */
452 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
457 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
460 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
461 Sunhandled_file_name_directory
, 1, 1, 0,
462 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
463 A `directly usable' directory name is one that may be used without the
464 intervention of any file handler.
465 If FILENAME is a directly usable file itself, return
466 \(file-name-as-directory FILENAME).
467 If FILENAME refers to a file which is not accessible from a local process,
468 then this should return nil.
469 The `call-process' and `start-process' functions use this function to
470 get a current directory to run processes in. */)
471 (Lisp_Object filename
)
475 /* If the file name has special constructs in it,
476 call the corresponding file handler. */
477 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
480 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
482 return STRINGP (handled_name
) ? handled_name
: Qnil
;
485 return Ffile_name_as_directory (filename
);
488 /* Maximum number of bytes that DST will be longer than SRC
489 in file_name_as_directory. This occurs when SRCLEN == 0. */
490 enum { file_name_as_directory_slop
= 2 };
492 /* Convert from file name SRC of length SRCLEN to directory name in
493 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
494 string. On UNIX, just make sure there is a terminating /. Return
495 the length of DST in bytes. */
498 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
509 memcpy (dst
, src
, srclen
);
510 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
511 dst
[srclen
++] = DIRECTORY_SEP
;
514 dostounix_filename (dst
);
519 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
520 Sfile_name_as_directory
, 1, 1, 0,
521 doc
: /* Return a string representing the file name FILE interpreted as a directory.
522 This operation exists because a directory is also a file, but its name as
523 a directory is different from its name as a file.
524 The result can be used as the value of `default-directory'
525 or passed as second argument to `expand-file-name'.
526 For a Unix-syntax file name, just appends a slash unless a trailing slash
527 is already present. */)
532 Lisp_Object handler
, val
;
537 /* If the file name has special constructs in it,
538 call the corresponding file handler. */
539 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
542 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
544 if (STRINGP (handled_name
))
546 error ("Invalid handler in `file-name-handler-alist'");
550 if (!NILP (Vw32_downcase_file_names
))
551 file
= Fdowncase (file
);
553 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
554 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
555 STRING_MULTIBYTE (file
));
556 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
561 /* Convert from directory name SRC of length SRCLEN to file name in
562 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
563 string. On UNIX, just make sure there isn't a terminating /.
564 Return the length of DST in bytes. */
567 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
569 /* Process as Unix format: just remove any final slash.
570 But leave "/" and "//" unchanged. */
573 && !IS_ANY_SEP (src
[srclen
- 2])
575 && IS_DIRECTORY_SEP (src
[srclen
- 1])
576 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
579 memcpy (dst
, src
, srclen
);
582 dostounix_filename (dst
);
587 DEFUN ("directory-name-p", Fdirectory_name_p
, Sdirectory_name_p
, 1, 1, 0,
588 doc
: /* Return non-nil if NAME ends with a directory separator character. */)
592 ptrdiff_t namelen
= SBYTES (name
);
593 unsigned char c
= namelen
? SREF (name
, namelen
- 1) : 0;
594 return IS_DIRECTORY_SEP (c
) ? Qt
: Qnil
;
597 /* Return true if NAME must be that of a directory if it exists.
598 When NAME is a directory name, this avoids system calls compared to
599 just calling Ffile_directory_p. */
602 directory_like (Lisp_Object name
)
604 return !NILP (Fdirectory_name_p (name
)) || !NILP (Ffile_directory_p (name
));
607 /* Return the expansion of NEWNAME, except that if NEWNAME is like a
608 directory then return the expansion of FILE's basename under
609 NEWNAME. This is like how 'cp FILE NEWNAME' works. */
612 expand_cp_target (Lisp_Object file
, Lisp_Object newname
)
614 return (directory_like (newname
)
615 ? Fexpand_file_name (Ffile_name_nondirectory (file
), newname
)
616 : Fexpand_file_name (newname
, Qnil
));
619 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
621 doc
: /* Returns the file name of the directory named DIRECTORY.
622 This is the name of the file that holds the data for the directory DIRECTORY.
623 This operation exists because a directory is also a file, but its name as
624 a directory is different from its name as a file.
625 In Unix-syntax, this function just removes the final slash. */)
626 (Lisp_Object directory
)
630 Lisp_Object handler
, val
;
633 CHECK_STRING (directory
);
635 /* If the file name has special constructs in it,
636 call the corresponding file handler. */
637 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
640 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
642 if (STRINGP (handled_name
))
644 error ("Invalid handler in `file-name-handler-alist'");
648 if (!NILP (Vw32_downcase_file_names
))
649 directory
= Fdowncase (directory
);
651 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
652 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
653 STRING_MULTIBYTE (directory
));
654 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
659 DEFUN ("make-temp-file-internal", Fmake_temp_file_internal
,
660 Smake_temp_file_internal
, 3, 3, 0,
661 doc
: /* Generate a new file whose name starts with PREFIX, a string.
662 Return the name of the generated file. If DIR-FLAG is zero, do not
663 create the file, just its name. Otherwise, if DIR-FLAG is non-nil,
664 create an empty directory. The file name should end in SUFFIX.
665 Do not expand PREFIX; a non-absolute PREFIX is relative to the Emacs
668 Signal an error if the file could not be created.
670 This function does not grok magic file names. */)
671 (Lisp_Object prefix
, Lisp_Object dir_flag
, Lisp_Object suffix
)
673 CHECK_STRING (prefix
);
674 CHECK_STRING (suffix
);
675 Lisp_Object encoded_prefix
= ENCODE_FILE (prefix
);
676 Lisp_Object encoded_suffix
= ENCODE_FILE (suffix
);
677 ptrdiff_t prefix_len
= SBYTES (encoded_prefix
);
678 ptrdiff_t suffix_len
= SBYTES (encoded_suffix
);
679 if (INT_MAX
< suffix_len
)
680 args_out_of_range (prefix
, suffix
);
682 Lisp_Object val
= make_uninit_string (prefix_len
+ nX
+ suffix_len
);
683 char *data
= SSDATA (val
);
684 memcpy (data
, SSDATA (encoded_prefix
), prefix_len
);
685 memset (data
+ prefix_len
, 'X', nX
);
686 memcpy (data
+ prefix_len
+ nX
, SSDATA (encoded_suffix
), suffix_len
);
687 int kind
= (NILP (dir_flag
) ? GT_FILE
688 : EQ (dir_flag
, make_number (0)) ? GT_NOCREATE
690 int fd
= gen_tempname (data
, suffix_len
, O_BINARY
| O_CLOEXEC
, kind
);
691 if (fd
< 0 || (NILP (dir_flag
) && emacs_close (fd
) != 0))
693 static char const kind_message
[][32] =
695 [GT_FILE
] = "Creating file with prefix",
696 [GT_DIR
] = "Creating directory with prefix",
697 [GT_NOCREATE
] = "Creating file name with prefix"
699 report_file_error (kind_message
[kind
], prefix
);
701 return DECODE_FILE (val
);
705 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
706 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
708 This function tries to choose a name that has no existing file.
709 For this to work, PREFIX should be an absolute file name, and PREFIX
710 and the returned string should both be non-magic.
712 There is a race condition between calling `make-temp-name' and
713 later creating the file, which opens all kinds of security holes.
714 For that reason, you should normally use `make-temp-file' instead. */)
717 return Fmake_temp_file_internal (prefix
, make_number (0),
718 empty_unibyte_string
);
721 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
722 doc
: /* Convert filename NAME to absolute, and canonicalize it.
723 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
724 \(does not start with slash or tilde); both the directory name and
725 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
726 missing, the current buffer's value of `default-directory' is used.
727 NAME should be a string that is a valid file name for the underlying
729 File name components that are `.' are removed, and
730 so are file name components followed by `..', along with the `..' itself;
731 note that these simplifications are done without checking the resulting
732 file names in the file system.
733 Multiple consecutive slashes are collapsed into a single slash,
734 except at the beginning of the file name when they are significant (e.g.,
735 UNC file names on MS-Windows.)
736 An initial `~/' expands to your home directory.
737 An initial `~USER/' expands to USER's home directory.
738 See also the function `substitute-in-file-name'.
740 For technical reasons, this function can return correct but
741 non-intuitive results for the root directory; for instance,
742 \(expand-file-name ".." "/") returns "/..". For this reason, use
743 \(directory-file-name (file-name-directory dirname)) to traverse a
744 filesystem tree, not (expand-file-name ".." dirname). */)
745 (Lisp_Object name
, Lisp_Object default_directory
)
747 /* These point to SDATA and need to be careful with string-relocation
748 during GC (via DECODE_FILE). */
752 const char *newdirlim
;
753 /* This should only point to alloca'd data. */
760 bool collapse_newdir
= true;
763 ptrdiff_t length
, nbytes
;
764 Lisp_Object handler
, result
, handled_name
;
771 /* If the file name has special constructs in it,
772 call the corresponding file handler. */
773 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
776 handled_name
= call3 (handler
, Qexpand_file_name
,
777 name
, default_directory
);
778 if (STRINGP (handled_name
))
780 error ("Invalid handler in `file-name-handler-alist'");
784 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
785 if (NILP (default_directory
))
786 default_directory
= BVAR (current_buffer
, directory
);
787 if (! STRINGP (default_directory
))
790 /* "/" is not considered a root directory on DOS_NT, so using "/"
791 here causes an infinite recursion in, e.g., the following:
793 (let (default-directory)
794 (expand-file-name "a"))
796 To avoid this, we set default_directory to the root of the
798 default_directory
= build_string (emacs_root_dir ());
800 default_directory
= build_string ("/");
804 if (!NILP (default_directory
))
806 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
809 handled_name
= call3 (handler
, Qexpand_file_name
,
810 name
, default_directory
);
811 if (STRINGP (handled_name
))
813 error ("Invalid handler in `file-name-handler-alist'");
818 char *o
= SSDATA (default_directory
);
820 /* Make sure DEFAULT_DIRECTORY is properly expanded.
821 It would be better to do this down below where we actually use
822 default_directory. Unfortunately, calling Fexpand_file_name recursively
823 could invoke GC, and the strings might be relocated. This would
824 be annoying because we have pointers into strings lying around
825 that would need adjusting, and people would add new pointers to
826 the code and forget to adjust them, resulting in intermittent bugs.
827 Putting this call here avoids all that crud.
829 The EQ test avoids infinite recursion. */
830 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
831 /* Save time in some common cases - as long as default_directory
832 is not relative, it can be canonicalized with name below (if it
833 is needed at all) without requiring it to be expanded now. */
835 /* Detect MSDOS file names with drive specifiers. */
836 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
837 && IS_DIRECTORY_SEP (o
[2]))
838 /* Detect escaped file names without drive spec after "/:".
839 These should not be recursively expanded, to avoid
840 including the default directory twice in the expanded
842 && ! (o
[0] == '/' && o
[1] == ':')
844 /* Detect Windows file names in UNC format. */
845 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
847 #else /* not DOS_NT */
848 /* Detect Unix absolute file names (/... alone is not absolute on
850 && ! (IS_DIRECTORY_SEP (o
[0]))
851 #endif /* not DOS_NT */
854 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
857 multibyte
= STRING_MULTIBYTE (name
);
858 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
862 unsigned char *p
= SDATA (name
);
864 while (*p
&& ASCII_CHAR_P (*p
))
868 /* NAME is a pure ASCII string, and DEFAULT_DIRECTORY is
869 unibyte. Do not convert DEFAULT_DIRECTORY to
870 multibyte; instead, convert NAME to a unibyte string,
871 so that the result of this function is also a unibyte
872 string. This is needed during bootstrapping and
873 dumping, when Emacs cannot decode file names, because
874 the locale environment is not set up. */
875 name
= make_unibyte_string (SSDATA (name
), SBYTES (name
));
879 default_directory
= string_to_multibyte (default_directory
);
883 name
= string_to_multibyte (name
);
889 if (!NILP (Vw32_downcase_file_names
))
890 default_directory
= Fdowncase (default_directory
);
893 /* Make a local copy of NAME to protect it from GC in DECODE_FILE below. */
894 SAFE_ALLOCA_STRING (nm
, name
);
895 nmlim
= nm
+ SBYTES (name
);
898 /* Note if special escape prefix is present, but remove for now. */
899 if (nm
[0] == '/' && nm
[1] == ':')
905 /* Find and remove drive specifier if present; this makes nm absolute
906 even if the rest of the name appears to be relative. Only look for
907 drive specifier at the beginning. */
908 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
910 drive
= (unsigned char) nm
[0];
915 /* If we see "c://somedir", we want to strip the first slash after the
916 colon when stripping the drive letter. Otherwise, this expands to
918 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
921 /* Discard any previous drive specifier if nm is now in UNC format. */
922 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
923 && !IS_DIRECTORY_SEP (nm
[2]))
925 #endif /* WINDOWSNT */
928 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
929 none are found, we can probably return right away. We will avoid
930 allocating a new string if name is already fully expanded. */
932 IS_DIRECTORY_SEP (nm
[0])
934 && drive
&& !is_escaped
937 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
941 /* If it turns out that the filename we want to return is just a
942 suffix of FILENAME, we don't need to go through and edit
943 things; we just need to construct a new string using data
944 starting at the middle of FILENAME. If we set LOSE, that
945 means we've discovered that we can't do that cool trick. */
951 /* Since we know the name is absolute, we can assume that each
952 element starts with a "/". */
954 /* "." and ".." are hairy. */
955 if (IS_DIRECTORY_SEP (p
[0])
957 && (IS_DIRECTORY_SEP (p
[2])
959 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
962 /* Replace multiple slashes with a single one, except
963 leave leading "//" alone. */
964 else if (IS_DIRECTORY_SEP (p
[0])
965 && IS_DIRECTORY_SEP (p
[1])
966 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
973 /* Make sure directories are all separated with /, but
974 avoid allocation of a new string when not required. */
975 dostounix_filename (nm
);
977 if (IS_DIRECTORY_SEP (nm
[1]))
979 if (strcmp (nm
, SSDATA (name
)) != 0)
980 name
= make_specified_string (nm
, -1, nmlim
- nm
, multibyte
);
984 /* Drive must be set, so this is okay. */
985 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
987 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
988 char temp
[] = { DRIVE_LETTER (drive
), ':', 0 };
989 AUTO_STRING_WITH_LEN (drive_prefix
, temp
, 2);
990 name
= concat2 (drive_prefix
, name
);
993 if (!NILP (Vw32_downcase_file_names
))
994 name
= Fdowncase (name
);
996 #else /* not DOS_NT */
997 if (strcmp (nm
, SSDATA (name
)) != 0)
998 name
= make_specified_string (nm
, -1, nmlim
- nm
, multibyte
);
999 #endif /* not DOS_NT */
1005 /* At this point, nm might or might not be an absolute file name. We
1006 need to expand ~ or ~user if present, otherwise prefix nm with
1007 default_directory if nm is not absolute, and finally collapse /./
1008 and /foo/../ sequences.
1010 We set newdir to be the appropriate prefix if one is needed:
1011 - the relevant user directory if nm starts with ~ or ~user
1012 - the specified drive's working dir (DOS/NT only) if nm does not
1014 - the value of default_directory.
1016 Note that these prefixes are not guaranteed to be absolute (except
1017 for the working dir of a drive). Therefore, to ensure we always
1018 return an absolute name, if the final prefix is not absolute we
1019 append it to the current working directory. */
1021 newdir
= newdirlim
= 0;
1023 if (nm
[0] == '~' /* prefix ~ */
1025 && !is_escaped
/* don't expand ~ in escaped file names */
1029 if (IS_DIRECTORY_SEP (nm
[1])
1030 || nm
[1] == 0) /* ~ by itself */
1034 if (!(newdir
= egetenv ("HOME")))
1035 newdir
= newdirlim
= "";
1040 char newdir_utf8
[MAX_UTF8_PATH
];
1042 filename_from_ansi (newdir
, newdir_utf8
);
1043 tem
= make_unibyte_string (newdir_utf8
, strlen (newdir_utf8
));
1044 newdir
= SSDATA (tem
);
1048 tem
= build_string (newdir
);
1049 newdirlim
= newdir
+ SBYTES (tem
);
1050 /* `egetenv' may return a unibyte string, which will bite us
1051 if we expect the directory to be multibyte. */
1052 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1054 hdir
= DECODE_FILE (tem
);
1055 newdir
= SSDATA (hdir
);
1056 newdirlim
= newdir
+ SBYTES (hdir
);
1059 collapse_newdir
= false;
1062 else /* ~user/filename */
1065 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1067 o
= SAFE_ALLOCA (p
- nm
+ 1);
1068 memcpy (o
, nm
, p
- nm
);
1072 pw
= getpwnam (o
+ 1);
1078 newdir
= pw
->pw_dir
;
1079 /* `getpwnam' may return a unibyte string, which will
1080 bite us when we expect the directory to be multibyte. */
1081 tem
= make_unibyte_string (newdir
, strlen (newdir
));
1082 newdirlim
= newdir
+ SBYTES (tem
);
1083 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1085 hdir
= DECODE_FILE (tem
);
1086 newdir
= SSDATA (hdir
);
1087 newdirlim
= newdir
+ SBYTES (hdir
);
1091 collapse_newdir
= false;
1095 /* If we don't find a user of that name, leave the name
1096 unchanged; don't move nm forward to p. */
1101 /* On DOS and Windows, nm is absolute if a drive name was specified;
1102 use the drive's current directory as the prefix if needed. */
1103 if (!newdir
&& drive
)
1105 /* Get default directory if needed to make nm absolute. */
1107 if (!IS_DIRECTORY_SEP (nm
[0]))
1109 adir
= alloca (MAXPATHLEN
+ 1);
1110 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1114 Lisp_Object tem
= build_string (adir
);
1116 tem
= DECODE_FILE (tem
);
1117 newdirlim
= adir
+ SBYTES (tem
);
1118 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1121 newdirlim
= adir
+ strlen (adir
);
1125 /* Either nm starts with /, or drive isn't mounted. */
1127 adir
[0] = DRIVE_LETTER (drive
);
1131 newdirlim
= adir
+ 3;
1137 /* Finally, if no prefix has been specified and nm is not absolute,
1138 then it must be expanded relative to default_directory. */
1142 /* /... alone is not absolute on DOS and Windows. */
1143 && !IS_DIRECTORY_SEP (nm
[0])
1146 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1147 && !IS_DIRECTORY_SEP (nm
[2]))
1151 newdir
= SSDATA (default_directory
);
1152 newdirlim
= newdir
+ SBYTES (default_directory
);
1154 /* Note if special escape prefix is present, but remove for now. */
1155 if (newdir
[0] == '/' && newdir
[1] == ':')
1166 /* First ensure newdir is an absolute name. */
1168 /* Detect MSDOS file names with drive specifiers. */
1169 ! (IS_DRIVE (newdir
[0])
1170 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1172 /* Detect Windows file names in UNC format. */
1173 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1174 && !IS_DIRECTORY_SEP (newdir
[2]))
1178 /* Effectively, let newdir be (expand-file-name newdir cwd).
1179 Because of the admonition against calling expand-file-name
1180 when we have pointers into lisp strings, we accomplish this
1181 indirectly by prepending newdir to nm if necessary, and using
1182 cwd (or the wd of newdir's drive) as the new newdir. */
1185 const int adir_size
= MAX_UTF8_PATH
;
1187 const int adir_size
= MAXPATHLEN
+ 1;
1190 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1192 drive
= (unsigned char) newdir
[0];
1195 if (!IS_DIRECTORY_SEP (nm
[0]))
1197 ptrdiff_t nmlen
= nmlim
- nm
;
1198 ptrdiff_t newdirlen
= newdirlim
- newdir
;
1199 char *tmp
= alloca (newdirlen
+ file_name_as_directory_slop
1201 ptrdiff_t dlen
= file_name_as_directory (tmp
, newdir
, newdirlen
,
1203 memcpy (tmp
+ dlen
, nm
, nmlen
+ 1);
1205 nmlim
= nm
+ dlen
+ nmlen
;
1207 adir
= alloca (adir_size
);
1210 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1214 getcwd (adir
, adir_size
);
1217 Lisp_Object tem
= build_string (adir
);
1219 tem
= DECODE_FILE (tem
);
1220 newdirlim
= adir
+ SBYTES (tem
);
1221 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1224 newdirlim
= adir
+ strlen (adir
);
1228 /* Strip off drive name from prefix, if present. */
1229 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1235 /* Keep only a prefix from newdir if nm starts with slash
1236 (//server/share for UNC, nothing otherwise). */
1237 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1240 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1241 && !IS_DIRECTORY_SEP (newdir
[2]))
1243 char *adir
= strcpy (alloca (newdirlim
- newdir
+ 1), newdir
);
1245 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1247 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1250 newdirlim
= newdir
+ strlen (adir
);
1254 newdir
= newdirlim
= "";
1259 /* Ignore any slash at the end of newdir, unless newdir is
1260 just "/" or "//". */
1261 length
= newdirlim
- newdir
;
1262 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1263 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1266 /* Now concatenate the directory and name to new space in the stack frame. */
1267 tlen
= length
+ file_name_as_directory_slop
+ (nmlim
- nm
) + 1;
1268 eassert (tlen
> file_name_as_directory_slop
+ 1);
1270 /* Reserve space for drive specifier and escape prefix, since either
1271 or both may need to be inserted. (The Microsoft x86 compiler
1272 produces incorrect code if the following two lines are combined.) */
1273 target
= alloca (tlen
+ 4);
1275 #else /* not DOS_NT */
1276 target
= SAFE_ALLOCA (tlen
);
1277 #endif /* not DOS_NT */
1283 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1286 /* If newdir is effectively "C:/", then the drive letter will have
1287 been stripped and newdir will be "/". Concatenating with an
1288 absolute directory in nm produces "//", which will then be
1289 incorrectly treated as a network share. Ignore newdir in
1290 this case (keeping the drive letter). */
1291 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1292 && newdir
[1] == '\0'))
1295 memcpy (target
, newdir
, length
);
1301 nbytes
= file_name_as_directory (target
, newdir
, length
, multibyte
);
1304 memcpy (target
+ nbytes
, nm
, nmlim
- nm
+ 1);
1306 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1314 if (!IS_DIRECTORY_SEP (*p
))
1318 else if (p
[1] == '.'
1319 && (IS_DIRECTORY_SEP (p
[2])
1322 /* If "/." is the entire filename, keep the "/". Otherwise,
1323 just delete the whole "/.". */
1324 if (o
== target
&& p
[2] == '\0')
1328 else if (p
[1] == '.' && p
[2] == '.'
1329 /* `/../' is the "superroot" on certain file systems.
1330 Turned off on DOS_NT systems because they have no
1331 "superroot" and because this causes us to produce
1332 file names like "d:/../foo" which fail file-related
1333 functions of the underlying OS. (To reproduce, try a
1334 long series of "../../" in default_directory, longer
1335 than the number of levels from the root.) */
1339 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1344 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1347 /* Don't go below server level in UNC filenames. */
1348 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1349 && IS_DIRECTORY_SEP (*target
))
1353 /* Keep initial / only if this is the whole name. */
1354 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1358 else if (IS_DIRECTORY_SEP (p
[1])
1359 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1360 /* Collapse multiple "/", except leave leading "//" alone. */
1369 /* At last, set drive name. */
1371 /* Except for network file name. */
1372 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1373 #endif /* WINDOWSNT */
1375 if (!drive
) emacs_abort ();
1377 target
[0] = DRIVE_LETTER (drive
);
1380 /* Reinsert the escape prefix if required. */
1387 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1388 dostounix_filename (SSDATA (result
));
1390 if (!NILP (Vw32_downcase_file_names
))
1391 result
= Fdowncase (result
);
1394 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1395 #endif /* !DOS_NT */
1398 /* Again look to see if the file name has special constructs in it
1399 and perhaps call the corresponding file handler. This is needed
1400 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1401 the ".." component gives us "/user@host:/bar/../baz" which needs
1402 to be expanded again. */
1403 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1404 if (!NILP (handler
))
1406 handled_name
= call3 (handler
, Qexpand_file_name
,
1407 result
, default_directory
);
1408 if (! STRINGP (handled_name
))
1409 error ("Invalid handler in `file-name-handler-alist'");
1410 result
= handled_name
;
1418 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1419 This is the old version of expand-file-name, before it was thoroughly
1420 rewritten for Emacs 10.31. We leave this version here commented-out,
1421 because the code is very complex and likely to have subtle bugs. If
1422 bugs _are_ found, it might be of interest to look at the old code and
1423 see what did it do in the relevant situation.
1425 Don't remove this code: it's true that it will be accessible
1426 from the repository, but a few years from deletion, people will
1427 forget it is there. */
1429 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1430 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1431 "Convert FILENAME to absolute, and canonicalize it.\n\
1432 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1433 \(does not start with slash); if DEFAULT is nil or missing,\n\
1434 the current buffer's value of default-directory is used.\n\
1435 Filenames containing `.' or `..' as components are simplified;\n\
1436 initial `~/' expands to your home directory.\n\
1437 See also the function `substitute-in-file-name'.")
1439 Lisp_Object name
, defalt
;
1443 register unsigned char *newdir
, *p
, *o
;
1445 unsigned char *target
;
1448 CHECK_STRING (name
);
1451 /* If nm is absolute, flush ...// and detect /./ and /../.
1452 If no /./ or /../ we can return right away. */
1459 if (p
[0] == '/' && p
[1] == '/')
1461 if (p
[0] == '/' && p
[1] == '~')
1462 nm
= p
+ 1, lose
= 1;
1463 if (p
[0] == '/' && p
[1] == '.'
1464 && (p
[2] == '/' || p
[2] == 0
1465 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1471 if (nm
== SDATA (name
))
1473 return build_string (nm
);
1477 /* Now determine directory to start with and put it in NEWDIR. */
1481 if (nm
[0] == '~') /* prefix ~ */
1482 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1484 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1485 newdir
= (unsigned char *) "";
1488 else /* ~user/filename */
1490 /* Get past ~ to user. */
1491 unsigned char *user
= nm
+ 1;
1492 /* Find end of name. */
1493 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1494 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1495 /* Copy the user name into temp storage. */
1496 o
= alloca (len
+ 1);
1497 memcpy (o
, user
, len
);
1500 /* Look up the user name. */
1502 pw
= (struct passwd
*) getpwnam (o
+ 1);
1505 error ("\"%s\" isn't a registered user", o
+ 1);
1507 newdir
= (unsigned char *) pw
->pw_dir
;
1509 /* Discard the user name from NM. */
1513 if (nm
[0] != '/' && !newdir
)
1516 defalt
= current_buffer
->directory
;
1517 CHECK_STRING (defalt
);
1518 newdir
= SDATA (defalt
);
1521 /* Now concatenate the directory and name to new space in the stack frame. */
1523 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1524 target
= alloca (tlen
);
1529 if (nm
[0] == 0 || nm
[0] == '/')
1530 strcpy (target
, newdir
);
1532 file_name_as_directory (target
, newdir
);
1535 strcat (target
, nm
);
1537 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1548 else if (!strncmp (p
, "//", 2)
1554 else if (p
[0] == '/' && p
[1] == '.'
1555 && (p
[2] == '/' || p
[2] == 0))
1557 else if (!strncmp (p
, "/..", 3)
1558 /* `/../' is the "superroot" on certain file systems. */
1560 && (p
[3] == '/' || p
[3] == 0))
1562 while (o
!= target
&& *--o
!= '/')
1564 if (o
== target
&& *o
== '/')
1574 return make_string (target
, o
- target
);
1578 /* If /~ or // appears, discard everything through first slash. */
1580 file_name_absolute_p (const char *filename
)
1583 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1585 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1586 && IS_DIRECTORY_SEP (filename
[2]))
1592 search_embedded_absfilename (char *nm
, char *endp
)
1596 for (p
= nm
+ 1; p
< endp
; p
++)
1598 if (IS_DIRECTORY_SEP (p
[-1])
1599 && file_name_absolute_p (p
)
1600 #if defined (WINDOWSNT) || defined (CYGWIN)
1601 /* // at start of file name is meaningful in Apollo,
1602 WindowsNT and Cygwin systems. */
1603 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1604 #endif /* not (WINDOWSNT || CYGWIN) */
1607 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1608 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1611 char *o
= SAFE_ALLOCA (s
- p
+ 1);
1613 memcpy (o
, p
, s
- p
);
1616 /* If we have ~user and `user' exists, discard
1617 everything up to ~. But if `user' does not exist, leave
1618 ~user alone, it might be a literal file name. */
1620 pw
= getpwnam (o
+ 1);
1633 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1634 Ssubstitute_in_file_name
, 1, 1, 0,
1635 doc
: /* Substitute environment variables referred to in FILENAME.
1636 `$FOO' where FOO is an environment variable name means to substitute
1637 the value of that variable. The variable name should be terminated
1638 with a character not a letter, digit or underscore; otherwise, enclose
1639 the entire variable name in braces.
1641 If `/~' appears, all of FILENAME through that `/' is discarded.
1642 If `//' appears, everything up to and including the first of
1643 those `/' is discarded. */)
1644 (Lisp_Object filename
)
1646 char *nm
, *p
, *x
, *endp
;
1647 bool substituted
= false;
1650 Lisp_Object handler
;
1652 CHECK_STRING (filename
);
1654 multibyte
= STRING_MULTIBYTE (filename
);
1656 /* If the file name has special constructs in it,
1657 call the corresponding file handler. */
1658 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1659 if (!NILP (handler
))
1661 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1663 if (STRINGP (handled_name
))
1664 return handled_name
;
1665 error ("Invalid handler in `file-name-handler-alist'");
1668 /* Always work on a copy of the string, in case GC happens during
1669 decode of environment variables, causing the original Lisp_String
1670 data to be relocated. */
1672 SAFE_ALLOCA_STRING (nm
, filename
);
1675 dostounix_filename (nm
);
1676 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1678 endp
= nm
+ SBYTES (filename
);
1680 /* If /~ or // appears, discard everything through first slash. */
1681 p
= search_embedded_absfilename (nm
, endp
);
1683 /* Start over with the new string, so we check the file-name-handler
1684 again. Important with filenames like "/home/foo//:/hello///there"
1685 which would substitute to "/:/hello///there" rather than "/there". */
1688 = (Fsubstitute_in_file_name
1689 (make_specified_string (p
, -1, endp
- p
, multibyte
)));
1694 /* See if any variables are substituted into the string. */
1696 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1699 = (!substituted
? filename
1700 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1701 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1703 if (!EQ (tmp
, name
))
1711 if (!NILP (Vw32_downcase_file_names
))
1712 filename
= Fdowncase (filename
);
1718 xnm
= SSDATA (filename
);
1719 x
= xnm
+ SBYTES (filename
);
1721 /* If /~ or // appears, discard everything through first slash. */
1722 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1723 /* This time we do not start over because we've already expanded envvars
1724 and replaced $$ with $. Maybe we should start over as well, but we'd
1725 need to quote some $ to $$ first. */
1729 if (!NILP (Vw32_downcase_file_names
))
1731 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1733 filename
= Fdowncase (xname
);
1737 if (xnm
!= SSDATA (filename
))
1738 filename
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1743 /* A slightly faster and more convenient way to get
1744 (directory-file-name (expand-file-name FOO)). */
1747 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1749 register Lisp_Object absname
;
1751 absname
= Fexpand_file_name (filename
, defdir
);
1753 /* Remove final slash, if any (unless this is the root dir).
1754 stat behaves differently depending! */
1755 if (SCHARS (absname
) > 1
1756 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1757 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1758 /* We cannot take shortcuts; they might be wrong for magic file names. */
1759 absname
= Fdirectory_file_name (absname
);
1763 /* Signal an error if the file ABSNAME already exists.
1764 If KNOWN_TO_EXIST, the file is known to exist.
1765 QUERYSTRING is a name for the action that is being considered
1767 If INTERACTIVE, ask the user whether to proceed,
1768 and bypass the error if the user says to go ahead.
1769 If QUICK, ask for y or n, not yes or no. */
1772 barf_or_query_if_file_exists (Lisp_Object absname
, bool known_to_exist
,
1773 const char *querystring
, bool interactive
,
1776 Lisp_Object tem
, encoded_filename
;
1777 struct stat statbuf
;
1779 encoded_filename
= ENCODE_FILE (absname
);
1781 if (! known_to_exist
&& lstat (SSDATA (encoded_filename
), &statbuf
) == 0)
1783 if (S_ISDIR (statbuf
.st_mode
))
1784 xsignal2 (Qfile_error
,
1785 build_string ("File is a directory"), absname
);
1786 known_to_exist
= true;
1792 xsignal2 (Qfile_already_exists
,
1793 build_string ("File already exists"), absname
);
1794 AUTO_STRING (format
, "File %s already exists; %s anyway? ");
1795 tem
= CALLN (Fformat
, format
, absname
, build_string (querystring
));
1797 tem
= call1 (intern ("y-or-n-p"), tem
);
1799 tem
= do_yes_or_no_p (tem
);
1801 xsignal2 (Qfile_already_exists
,
1802 build_string ("File already exists"), absname
);
1807 /* Copy data to DEST from SOURCE if possible. Return true if OK. */
1809 clone_file (int dest
, int source
)
1812 return ioctl (dest
, FICLONE
, source
) == 0;
1818 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1819 "fCopy file: \nGCopy %s to file: \np\nP",
1820 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1821 If NEWNAME names a directory, copy FILE there.
1823 This function always sets the file modes of the output file to match
1826 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1827 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil,
1828 signal a `file-already-exists' error without overwriting. If
1829 OK-IF-ALREADY-EXISTS is an integer, request confirmation from the user
1830 about overwriting; this is what happens in interactive use with M-x.
1831 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1834 Fourth arg KEEP-TIME non-nil means give the output file the same
1835 last-modified time as the old one. (This works on only some systems.)
1837 A prefix arg makes KEEP-TIME non-nil.
1839 If PRESERVE-UID-GID is non-nil, try to transfer the uid and gid of
1842 If PRESERVE-PERMISSIONS is non-nil, copy permissions of FILE to NEWNAME;
1843 this includes the file modes, along with ACL entries and SELinux
1844 context if present. Otherwise, if NEWNAME is created its file
1845 permission bits are those of FILE, masked by the default file
1847 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
,
1848 Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
,
1849 Lisp_Object preserve_permissions
)
1851 Lisp_Object handler
;
1852 ptrdiff_t count
= SPECPDL_INDEX ();
1853 Lisp_Object encoded_file
, encoded_newname
;
1855 security_context_t con
;
1861 bool already_exists
= false;
1867 file
= Fexpand_file_name (file
, Qnil
);
1868 newname
= expand_cp_target (file
, newname
);
1870 /* If the input file name has special constructs in it,
1871 call the corresponding file handler. */
1872 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1873 /* Likewise for output file name. */
1875 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1876 if (!NILP (handler
))
1877 return call7 (handler
, Qcopy_file
, file
, newname
,
1878 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1879 preserve_permissions
);
1881 encoded_file
= ENCODE_FILE (file
);
1882 encoded_newname
= ENCODE_FILE (newname
);
1885 if (NILP (ok_if_already_exists
)
1886 || INTEGERP (ok_if_already_exists
))
1887 barf_or_query_if_file_exists (newname
, false, "copy to it",
1888 INTEGERP (ok_if_already_exists
), false);
1890 result
= w32_copy_file (SSDATA (encoded_file
), SSDATA (encoded_newname
),
1891 !NILP (keep_time
), !NILP (preserve_uid_gid
),
1892 !NILP (preserve_permissions
));
1896 report_file_error ("Copying file", list2 (file
, newname
));
1898 report_file_error ("Copying permissions from", file
);
1900 xsignal2 (Qfile_date_error
,
1901 build_string ("Resetting file times"), newname
);
1903 report_file_error ("Copying permissions to", newname
);
1905 #else /* not WINDOWSNT */
1906 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1909 report_file_error ("Opening input file", file
);
1911 record_unwind_protect_int (close_file_unwind
, ifd
);
1913 if (fstat (ifd
, &st
) != 0)
1914 report_file_error ("Input file status", file
);
1916 if (!NILP (preserve_permissions
))
1919 if (is_selinux_enabled ())
1921 conlength
= fgetfilecon (ifd
, &con
);
1922 if (conlength
== -1)
1923 report_file_error ("Doing fgetfilecon", file
);
1928 /* We can copy only regular files. */
1929 if (!S_ISREG (st
.st_mode
))
1930 report_file_errno ("Non-regular file", file
,
1931 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
1934 new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0700 : 0777);
1936 new_mask
= S_IREAD
| S_IWRITE
;
1939 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
| O_CREAT
| O_EXCL
,
1941 if (ofd
< 0 && errno
== EEXIST
)
1943 if (NILP (ok_if_already_exists
) || INTEGERP (ok_if_already_exists
))
1944 barf_or_query_if_file_exists (newname
, true, "copy to it",
1945 INTEGERP (ok_if_already_exists
), false);
1946 already_exists
= true;
1947 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
, 0);
1950 report_file_error ("Opening output file", newname
);
1952 record_unwind_protect_int (close_file_unwind
, ofd
);
1954 off_t oldsize
= 0, newsize
;
1959 if (fstat (ofd
, &out_st
) != 0)
1960 report_file_error ("Output file status", newname
);
1961 if (st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1962 report_file_errno ("Input and output files are the same",
1963 list2 (file
, newname
), 0);
1964 if (S_ISREG (out_st
.st_mode
))
1965 oldsize
= out_st
.st_size
;
1970 if (clone_file (ofd
, ifd
))
1971 newsize
= st
.st_size
;
1974 char buf
[MAX_ALLOCA
];
1976 for (newsize
= 0; 0 < (n
= emacs_read_quit (ifd
, buf
, sizeof buf
));
1978 if (emacs_write_quit (ofd
, buf
, n
) != n
)
1979 report_file_error ("Write error", newname
);
1981 report_file_error ("Read error", file
);
1984 /* Truncate any existing output file after writing the data. This
1985 is more likely to work than truncation before writing, if the
1986 file system is out of space or the user is over disk quota. */
1987 if (newsize
< oldsize
&& ftruncate (ofd
, newsize
) != 0)
1988 report_file_error ("Truncating output file", newname
);
1991 /* Preserve the original file permissions, and if requested, also its
1994 mode_t preserved_permissions
= st
.st_mode
& 07777;
1995 mode_t default_permissions
= st
.st_mode
& 0777 & ~realmask
;
1996 if (!NILP (preserve_uid_gid
))
1998 /* Attempt to change owner and group. If that doesn't work
1999 attempt to change just the group, as that is sometimes allowed.
2000 Adjust the mode mask to eliminate setuid or setgid bits
2001 or group permissions bits that are inappropriate if the
2002 owner or group are wrong. */
2003 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2005 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2006 preserved_permissions
&= ~04000;
2009 preserved_permissions
&= ~06000;
2011 /* Copy the other bits to the group bits, since the
2013 preserved_permissions
&= ~070;
2014 preserved_permissions
|= (preserved_permissions
& 7) << 3;
2015 default_permissions
&= ~070;
2016 default_permissions
|= (default_permissions
& 7) << 3;
2021 switch (!NILP (preserve_permissions
)
2022 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2023 SSDATA (encoded_newname
), ofd
,
2024 preserved_permissions
)
2026 || (new_mask
& ~realmask
) == default_permissions
)
2028 : fchmod (ofd
, default_permissions
))
2030 case -2: report_file_error ("Copying permissions from", file
);
2031 case -1: report_file_error ("Copying permissions to", newname
);
2034 #endif /* not MSDOS */
2039 /* Set the modified context back to the file. */
2040 bool fail
= fsetfilecon (ofd
, con
) != 0;
2041 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2042 if (fail
&& errno
!= ENOTSUP
)
2043 report_file_error ("Doing fsetfilecon", newname
);
2049 if (!NILP (keep_time
))
2051 struct timespec atime
= get_stat_atime (&st
);
2052 struct timespec mtime
= get_stat_mtime (&st
);
2053 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
) != 0)
2054 xsignal2 (Qfile_date_error
,
2055 build_string ("Cannot set file date"), newname
);
2058 if (emacs_close (ofd
) < 0)
2059 report_file_error ("Write error", newname
);
2064 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2065 and if it can't, it tells so. Otherwise, under MSDOS we usually
2066 get only the READ bit, which will make the copied file read-only,
2067 so it's better not to chmod at all. */
2068 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2069 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2071 #endif /* not WINDOWSNT */
2073 /* Discard the unwind protects. */
2074 specpdl_ptr
= specpdl
+ count
;
2079 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2080 Smake_directory_internal
, 1, 1, 0,
2081 doc
: /* Create a new directory named DIRECTORY. */)
2082 (Lisp_Object directory
)
2085 Lisp_Object handler
;
2086 Lisp_Object encoded_dir
;
2088 CHECK_STRING (directory
);
2089 directory
= Fexpand_file_name (directory
, Qnil
);
2091 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2092 if (!NILP (handler
))
2093 return call2 (handler
, Qmake_directory_internal
, directory
);
2095 encoded_dir
= ENCODE_FILE (directory
);
2097 dir
= SSDATA (encoded_dir
);
2099 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2100 report_file_error ("Creating directory", directory
);
2105 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2106 Sdelete_directory_internal
, 1, 1, 0,
2107 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2108 (Lisp_Object directory
)
2111 Lisp_Object encoded_dir
;
2113 CHECK_STRING (directory
);
2114 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2115 encoded_dir
= ENCODE_FILE (directory
);
2116 dir
= SSDATA (encoded_dir
);
2118 if (rmdir (dir
) != 0)
2119 report_file_error ("Removing directory", directory
);
2124 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2125 "(list (read-file-name \
2126 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2127 \"Move file to trash: \" \"Delete file: \") \
2128 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2129 (null current-prefix-arg))",
2130 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2131 If file has multiple names, it continues to exist with the other names.
2132 TRASH non-nil means to trash the file instead of deleting, provided
2133 `delete-by-moving-to-trash' is non-nil.
2135 When called interactively, TRASH is t if no prefix argument is given.
2136 With a prefix argument, TRASH is nil. */)
2137 (Lisp_Object filename
, Lisp_Object trash
)
2139 Lisp_Object handler
;
2140 Lisp_Object encoded_file
;
2142 if (!NILP (Ffile_directory_p (filename
))
2143 && NILP (Ffile_symlink_p (filename
)))
2144 xsignal2 (Qfile_error
,
2145 build_string ("Removing old name: is a directory"),
2147 filename
= Fexpand_file_name (filename
, Qnil
);
2149 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2150 if (!NILP (handler
))
2151 return call3 (handler
, Qdelete_file
, filename
, trash
);
2153 if (delete_by_moving_to_trash
&& !NILP (trash
))
2154 return call1 (Qmove_file_to_trash
, filename
);
2156 encoded_file
= ENCODE_FILE (filename
);
2158 if (unlink (SSDATA (encoded_file
)) != 0 && errno
!= ENOENT
)
2159 report_file_error ("Removing old name", filename
);
2164 internal_delete_file_1 (Lisp_Object ignore
)
2169 /* Delete file FILENAME, returning true if successful.
2170 This ignores `delete-by-moving-to-trash'. */
2173 internal_delete_file (Lisp_Object filename
)
2177 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2178 Qt
, internal_delete_file_1
);
2182 /* Filesystems are case-sensitive on all supported systems except
2183 MS-Windows, MS-DOS, Cygwin, and Mac OS X. They are always
2184 case-insensitive on the first two, but they may or may not be
2185 case-insensitive on Cygwin and OS X. The following function
2186 attempts to provide a runtime test on those two systems. If the
2187 test is not conclusive, we assume case-insensitivity on Cygwin and
2188 case-sensitivity on Mac OS X.
2190 FIXME: Mounted filesystems on Posix hosts, like Samba shares or
2191 NFS-mounted Windows volumes, might be case-insensitive. Can we
2195 file_name_case_insensitive_p (const char *filename
)
2197 /* Use pathconf with _PC_CASE_INSENSITIVE or _PC_CASE_SENSITIVE if
2198 those flags are available. As of this writing (2017-05-20),
2199 Cygwin is the only platform known to support the former (starting
2200 with Cygwin-2.6.1), and macOS is the only platform known to
2201 support the latter. */
2203 #ifdef _PC_CASE_INSENSITIVE
2204 int res
= pathconf (filename
, _PC_CASE_INSENSITIVE
);
2207 #elif defined _PC_CASE_SENSITIVE
2208 int res
= pathconf (filename
, _PC_CASE_SENSITIVE
);
2213 #if defined CYGWIN || defined DOS_NT
2220 DEFUN ("file-name-case-insensitive-p", Ffile_name_case_insensitive_p
,
2221 Sfile_name_case_insensitive_p
, 1, 1, 0,
2222 doc
: /* Return t if file FILENAME is on a case-insensitive filesystem.
2223 The arg must be a string. */)
2224 (Lisp_Object filename
)
2226 Lisp_Object handler
;
2228 CHECK_STRING (filename
);
2229 filename
= Fexpand_file_name (filename
, Qnil
);
2231 /* If the file name has special constructs in it,
2232 call the corresponding file handler. */
2233 handler
= Ffind_file_name_handler (filename
, Qfile_name_case_insensitive_p
);
2234 if (!NILP (handler
))
2235 return call2 (handler
, Qfile_name_case_insensitive_p
, filename
);
2237 filename
= ENCODE_FILE (filename
);
2238 return file_name_case_insensitive_p (SSDATA (filename
)) ? Qt
: Qnil
;
2241 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2242 "fRename file: \nGRename %s to file: \np",
2243 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2244 If file has names other than FILE, it continues to have those names.
2245 Signal a `file-already-exists' error if a file NEWNAME already exists
2246 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2247 An integer third arg means request confirmation if NEWNAME already exists.
2248 This is what happens in interactive use with M-x. */)
2249 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2251 Lisp_Object handler
;
2252 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2255 file
= Fexpand_file_name (file
, Qnil
);
2257 /* If the filesystem is case-insensitive and the file names are
2258 identical but for case, treat it as a change-case request, and do
2259 not worry whether NEWNAME exists or whether it is a directory, as
2260 it is already another name for FILE. */
2261 bool case_only_rename
= false;
2262 #if defined CYGWIN || defined DOS_NT
2263 if (!NILP (Ffile_name_case_insensitive_p (file
)))
2265 newname
= Fexpand_file_name (newname
, Qnil
);
2266 case_only_rename
= !NILP (Fstring_equal (Fdowncase (file
),
2267 Fdowncase (newname
)));
2271 if (!case_only_rename
)
2272 newname
= expand_cp_target (Fdirectory_file_name (file
), newname
);
2274 /* If the file name has special constructs in it,
2275 call the corresponding file handler. */
2276 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2278 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2279 if (!NILP (handler
))
2280 return call4 (handler
, Qrename_file
,
2281 file
, newname
, ok_if_already_exists
);
2283 encoded_file
= ENCODE_FILE (file
);
2284 encoded_newname
= ENCODE_FILE (newname
);
2286 bool plain_rename
= (case_only_rename
2287 || (!NILP (ok_if_already_exists
)
2288 && !INTEGERP (ok_if_already_exists
)));
2292 if (renameat_noreplace (AT_FDCWD
, SSDATA (encoded_file
),
2293 AT_FDCWD
, SSDATA (encoded_newname
))
2297 rename_errno
= errno
;
2298 switch (rename_errno
)
2300 case EEXIST
: case EINVAL
: case ENOSYS
:
2301 barf_or_query_if_file_exists (newname
, rename_errno
== EEXIST
,
2303 INTEGERP (ok_if_already_exists
),
2305 plain_rename
= true;
2312 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) == 0)
2314 rename_errno
= errno
;
2315 /* Don't prompt again. */
2316 ok_if_already_exists
= Qt
;
2318 else if (!NILP (ok_if_already_exists
))
2319 ok_if_already_exists
= Qt
;
2321 if (rename_errno
!= EXDEV
)
2322 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2324 symlink_target
= Ffile_symlink_p (file
);
2325 if (!NILP (symlink_target
))
2326 Fmake_symbolic_link (symlink_target
, newname
, ok_if_already_exists
);
2330 dirp
= directory_like (file
);
2332 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2334 Fcopy_file (file
, newname
, ok_if_already_exists
, Qt
, Qt
, Qt
);
2337 ptrdiff_t count
= SPECPDL_INDEX ();
2338 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2339 if (dirp
&& NILP (symlink_target
))
2340 call2 (Qdelete_directory
, file
, Qt
);
2342 Fdelete_file (file
, Qnil
);
2343 return unbind_to (count
, Qnil
);
2346 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2347 "fAdd name to file: \nGName to add to %s: \np",
2348 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2349 Signal a `file-already-exists' error if a file NEWNAME already exists
2350 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2351 An integer third arg means request confirmation if NEWNAME already exists.
2352 This is what happens in interactive use with M-x. */)
2353 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2355 Lisp_Object handler
;
2356 Lisp_Object encoded_file
, encoded_newname
;
2358 file
= Fexpand_file_name (file
, Qnil
);
2359 newname
= expand_cp_target (file
, newname
);
2361 /* If the file name has special constructs in it,
2362 call the corresponding file handler. */
2363 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2364 if (!NILP (handler
))
2365 return call4 (handler
, Qadd_name_to_file
, file
,
2366 newname
, ok_if_already_exists
);
2368 /* If the new name has special constructs in it,
2369 call the corresponding file handler. */
2370 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2371 if (!NILP (handler
))
2372 return call4 (handler
, Qadd_name_to_file
, file
,
2373 newname
, ok_if_already_exists
);
2375 encoded_file
= ENCODE_FILE (file
);
2376 encoded_newname
= ENCODE_FILE (newname
);
2378 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) == 0)
2381 if (errno
== EEXIST
)
2383 if (NILP (ok_if_already_exists
)
2384 || INTEGERP (ok_if_already_exists
))
2385 barf_or_query_if_file_exists (newname
, true, "make it a new name",
2386 INTEGERP (ok_if_already_exists
), false);
2387 unlink (SSDATA (newname
));
2388 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) == 0)
2392 report_file_error ("Adding new name", list2 (file
, newname
));
2395 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2396 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2397 doc
: /* Make a symbolic link to TARGET, named LINKNAME.
2398 Both args must be strings.
2399 Signal a `file-already-exists' error if a file LINKNAME already exists
2400 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2401 An integer third arg means request confirmation if LINKNAME already exists.
2402 This happens for interactive use with M-x. */)
2403 (Lisp_Object target
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2405 Lisp_Object handler
;
2406 Lisp_Object encoded_target
, encoded_linkname
;
2408 CHECK_STRING (target
);
2409 /* If the link target has a ~, we must expand it to get
2410 a truly valid file name. Otherwise, do not expand;
2411 we want to permit links to relative file names. */
2412 if (SREF (target
, 0) == '~')
2413 target
= Fexpand_file_name (target
, Qnil
);
2415 linkname
= expand_cp_target (target
, linkname
);
2417 /* If the file name has special constructs in it,
2418 call the corresponding file handler. */
2419 handler
= Ffind_file_name_handler (target
, Qmake_symbolic_link
);
2420 if (!NILP (handler
))
2421 return call4 (handler
, Qmake_symbolic_link
, target
,
2422 linkname
, ok_if_already_exists
);
2424 /* If the new link name has special constructs in it,
2425 call the corresponding file handler. */
2426 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2427 if (!NILP (handler
))
2428 return call4 (handler
, Qmake_symbolic_link
, target
,
2429 linkname
, ok_if_already_exists
);
2431 encoded_target
= ENCODE_FILE (target
);
2432 encoded_linkname
= ENCODE_FILE (linkname
);
2434 if (symlink (SSDATA (encoded_target
), SSDATA (encoded_linkname
)) == 0)
2437 if (errno
== ENOSYS
)
2438 xsignal1 (Qfile_error
,
2439 build_string ("Symbolic links are not supported"));
2441 if (errno
== EEXIST
)
2443 if (NILP (ok_if_already_exists
)
2444 || INTEGERP (ok_if_already_exists
))
2445 barf_or_query_if_file_exists (linkname
, true, "make it a link",
2446 INTEGERP (ok_if_already_exists
), false);
2447 unlink (SSDATA (encoded_linkname
));
2448 if (symlink (SSDATA (encoded_target
), SSDATA (encoded_linkname
)) == 0)
2452 report_file_error ("Making symbolic link", list2 (target
, linkname
));
2456 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2458 doc
: /* Return t if file FILENAME specifies an absolute file name.
2459 On Unix, this is a name starting with a `/' or a `~'. */)
2460 (Lisp_Object filename
)
2462 CHECK_STRING (filename
);
2463 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2466 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2467 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2468 See also `file-readable-p' and `file-attributes'.
2469 This returns nil for a symlink to a nonexistent file.
2470 Use `file-symlink-p' to test for such links. */)
2471 (Lisp_Object filename
)
2473 Lisp_Object absname
;
2474 Lisp_Object handler
;
2476 CHECK_STRING (filename
);
2477 absname
= Fexpand_file_name (filename
, Qnil
);
2479 /* If the file name has special constructs in it,
2480 call the corresponding file handler. */
2481 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2482 if (!NILP (handler
))
2484 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2489 absname
= ENCODE_FILE (absname
);
2491 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2494 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2495 doc
: /* Return t if FILENAME can be executed by you.
2496 For a directory, this means you can access files in that directory.
2497 \(It is generally better to use `file-accessible-directory-p' for that
2498 purpose, though.) */)
2499 (Lisp_Object filename
)
2501 Lisp_Object absname
;
2502 Lisp_Object handler
;
2504 CHECK_STRING (filename
);
2505 absname
= Fexpand_file_name (filename
, Qnil
);
2507 /* If the file name has special constructs in it,
2508 call the corresponding file handler. */
2509 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2510 if (!NILP (handler
))
2511 return call2 (handler
, Qfile_executable_p
, absname
);
2513 absname
= ENCODE_FILE (absname
);
2515 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2518 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2519 doc
: /* Return t if file FILENAME exists and you can read it.
2520 See also `file-exists-p' and `file-attributes'. */)
2521 (Lisp_Object filename
)
2523 Lisp_Object absname
;
2524 Lisp_Object handler
;
2526 CHECK_STRING (filename
);
2527 absname
= Fexpand_file_name (filename
, Qnil
);
2529 /* If the file name has special constructs in it,
2530 call the corresponding file handler. */
2531 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2532 if (!NILP (handler
))
2533 return call2 (handler
, Qfile_readable_p
, absname
);
2535 absname
= ENCODE_FILE (absname
);
2536 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2540 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2541 doc
: /* Return t if file FILENAME can be written or created by you. */)
2542 (Lisp_Object filename
)
2544 Lisp_Object absname
, dir
, encoded
;
2545 Lisp_Object handler
;
2547 CHECK_STRING (filename
);
2548 absname
= Fexpand_file_name (filename
, Qnil
);
2550 /* If the file name has special constructs in it,
2551 call the corresponding file handler. */
2552 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2553 if (!NILP (handler
))
2554 return call2 (handler
, Qfile_writable_p
, absname
);
2556 encoded
= ENCODE_FILE (absname
);
2557 if (check_writable (SSDATA (encoded
), W_OK
))
2559 if (errno
!= ENOENT
)
2562 dir
= Ffile_name_directory (absname
);
2563 eassert (!NILP (dir
));
2565 dir
= Fdirectory_file_name (dir
);
2568 dir
= ENCODE_FILE (dir
);
2570 /* The read-only attribute of the parent directory doesn't affect
2571 whether a file or directory can be created within it. Some day we
2572 should check ACLs though, which do affect this. */
2573 return file_directory_p (SSDATA (dir
)) ? Qt
: Qnil
;
2575 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2579 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2580 doc
: /* Access file FILENAME, and get an error if that does not work.
2581 The second argument STRING is prepended to the error message.
2582 If there is no error, returns nil. */)
2583 (Lisp_Object filename
, Lisp_Object string
)
2585 Lisp_Object handler
, encoded_filename
, absname
;
2587 CHECK_STRING (filename
);
2588 absname
= Fexpand_file_name (filename
, Qnil
);
2590 CHECK_STRING (string
);
2592 /* If the file name has special constructs in it,
2593 call the corresponding file handler. */
2594 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2595 if (!NILP (handler
))
2596 return call3 (handler
, Qaccess_file
, absname
, string
);
2598 encoded_filename
= ENCODE_FILE (absname
);
2600 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2601 report_file_error (SSDATA (string
), filename
);
2606 /* Relative to directory FD, return the symbolic link value of FILENAME.
2607 On failure, return nil. */
2609 emacs_readlinkat (int fd
, char const *filename
)
2611 static struct allocator
const emacs_norealloc_allocator
=
2612 { xmalloc
, NULL
, xfree
, memory_full
};
2614 char readlink_buf
[1024];
2615 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2616 &emacs_norealloc_allocator
, readlinkat
);
2620 val
= build_unibyte_string (buf
);
2621 if (buf
[0] == '/' && strchr (buf
, ':'))
2623 AUTO_STRING (slash_colon
, "/:");
2624 val
= concat2 (slash_colon
, val
);
2626 if (buf
!= readlink_buf
)
2628 val
= DECODE_FILE (val
);
2632 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2633 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2634 The value is the link target, as a string.
2635 Otherwise it returns nil.
2637 This function does not check whether the link target exists. */)
2638 (Lisp_Object filename
)
2640 Lisp_Object handler
;
2642 CHECK_STRING (filename
);
2643 filename
= Fexpand_file_name (filename
, Qnil
);
2645 /* If the file name has special constructs in it,
2646 call the corresponding file handler. */
2647 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2648 if (!NILP (handler
))
2649 return call2 (handler
, Qfile_symlink_p
, filename
);
2651 filename
= ENCODE_FILE (filename
);
2653 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2656 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2657 doc
: /* Return t if FILENAME names an existing directory.
2658 Symbolic links to directories count as directories.
2659 See `file-symlink-p' to distinguish symlinks. */)
2660 (Lisp_Object filename
)
2662 Lisp_Object absname
;
2663 Lisp_Object handler
;
2665 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2667 /* If the file name has special constructs in it,
2668 call the corresponding file handler. */
2669 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2670 if (!NILP (handler
))
2671 return call2 (handler
, Qfile_directory_p
, absname
);
2673 absname
= ENCODE_FILE (absname
);
2675 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2678 /* Return true if FILE is a directory or a symlink to a directory. */
2680 file_directory_p (char const *file
)
2683 /* This is cheaper than 'stat'. */
2684 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2687 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2691 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2692 Sfile_accessible_directory_p
, 1, 1, 0,
2693 doc
: /* Return t if FILENAME names a directory you can open.
2694 For the value to be t, FILENAME must specify the name of a directory
2695 as a file, and the directory must allow you to open files in it. In
2696 order to use a directory as a buffer's current directory, this
2697 predicate must return true. A directory name spec may be given
2698 instead; then the value is t if the directory so specified exists and
2699 really is a readable and searchable directory. */)
2700 (Lisp_Object filename
)
2702 Lisp_Object absname
;
2703 Lisp_Object handler
;
2705 CHECK_STRING (filename
);
2706 absname
= Fexpand_file_name (filename
, Qnil
);
2708 /* If the file name has special constructs in it,
2709 call the corresponding file handler. */
2710 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2711 if (!NILP (handler
))
2713 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2715 /* Set errno in case the handler failed. EACCES might be a lie
2716 (e.g., the directory might not exist, or be a regular file),
2717 but at least it does TRT in the "usual" case of an existing
2718 directory that is not accessible by the current user, and
2719 avoids reporting "Success" for a failed operation. Perhaps
2720 someday we can fix this in a better way, by improving
2721 file-accessible-directory-p's API; see Bug#25419. */
2728 absname
= ENCODE_FILE (absname
);
2729 return file_accessible_directory_p (absname
) ? Qt
: Qnil
;
2732 /* If FILE is a searchable directory or a symlink to a
2733 searchable directory, return true. Otherwise return
2734 false and set errno to an error number. */
2736 file_accessible_directory_p (Lisp_Object file
)
2740 /* We need a special-purpose test because (a) NTFS security data is
2741 not reflected in Posix-style mode bits, and (b) the trick with
2742 accessing "DIR/.", used below on Posix hosts, doesn't work on
2743 Windows, because "DIR/." is normalized to just "DIR" before
2744 hitting the disk. */
2745 return (SBYTES (file
) == 0
2746 || w32_accessible_directory_p (SSDATA (file
), SBYTES (file
)));
2748 return file_directory_p (SSDATA (file
));
2751 /* On POSIXish platforms, use just one system call; this avoids a
2752 race and is typically faster. */
2753 const char *data
= SSDATA (file
);
2754 ptrdiff_t len
= SBYTES (file
);
2760 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2761 There are three exceptions: "", "/", and "//". Leave "" alone,
2762 as it's invalid. Append only "." to the other two exceptions as
2763 "/" and "//" are distinct on some platforms, whereas "/", "///",
2764 "////", etc. are all equivalent. */
2769 /* Just check for trailing '/' when deciding whether to append '/'.
2770 That's simpler than testing the two special cases "/" and "//",
2771 and it's a safe optimization here. */
2772 char *buf
= SAFE_ALLOCA (len
+ 3);
2773 memcpy (buf
, data
, len
);
2774 strcpy (buf
+ len
, &"/."[data
[len
- 1] == '/']);
2778 ok
= check_existing (dir
);
2779 saved_errno
= errno
;
2781 errno
= saved_errno
;
2783 #endif /* !DOS_NT */
2786 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2787 doc
: /* Return t if FILENAME names a regular file.
2788 This is the sort of file that holds an ordinary stream of data bytes.
2789 Symbolic links to regular files count as regular files.
2790 See `file-symlink-p' to distinguish symlinks. */)
2791 (Lisp_Object filename
)
2793 register Lisp_Object absname
;
2795 Lisp_Object handler
;
2797 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2799 /* If the file name has special constructs in it,
2800 call the corresponding file handler. */
2801 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2802 if (!NILP (handler
))
2803 return call2 (handler
, Qfile_regular_p
, absname
);
2805 absname
= ENCODE_FILE (absname
);
2810 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2812 /* Tell stat to use expensive method to get accurate info. */
2813 Vw32_get_true_file_attributes
= Qt
;
2814 result
= stat (SSDATA (absname
), &st
);
2815 Vw32_get_true_file_attributes
= tem
;
2819 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2822 if (stat (SSDATA (absname
), &st
) < 0)
2824 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2828 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2829 Sfile_selinux_context
, 1, 1, 0,
2830 doc
: /* Return SELinux context of file named FILENAME.
2831 The return value is a list (USER ROLE TYPE RANGE), where the list
2832 elements are strings naming the user, role, type, and range of the
2833 file's SELinux security context.
2835 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2836 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2837 (Lisp_Object filename
)
2839 Lisp_Object absname
;
2840 Lisp_Object user
= Qnil
, role
= Qnil
, type
= Qnil
, range
= Qnil
;
2842 Lisp_Object handler
;
2844 security_context_t con
;
2849 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2851 /* If the file name has special constructs in it,
2852 call the corresponding file handler. */
2853 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2854 if (!NILP (handler
))
2855 return call2 (handler
, Qfile_selinux_context
, absname
);
2857 absname
= ENCODE_FILE (absname
);
2860 if (is_selinux_enabled ())
2862 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2865 context
= context_new (con
);
2866 if (context_user_get (context
))
2867 user
= build_string (context_user_get (context
));
2868 if (context_role_get (context
))
2869 role
= build_string (context_role_get (context
));
2870 if (context_type_get (context
))
2871 type
= build_string (context_type_get (context
));
2872 if (context_range_get (context
))
2873 range
= build_string (context_range_get (context
));
2874 context_free (context
);
2880 return list4 (user
, role
, type
, range
);
2883 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2884 Sset_file_selinux_context
, 2, 2, 0,
2885 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2886 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2887 elements are strings naming the components of a SELinux context.
2889 Value is t if setting of SELinux context was successful, nil otherwise.
2891 This function does nothing and returns nil if SELinux is disabled,
2892 or if Emacs was not compiled with SELinux support. */)
2893 (Lisp_Object filename
, Lisp_Object context
)
2895 Lisp_Object absname
;
2896 Lisp_Object handler
;
2898 Lisp_Object encoded_absname
;
2899 Lisp_Object user
= CAR_SAFE (context
);
2900 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2901 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2902 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2903 security_context_t con
;
2906 context_t parsed_con
;
2909 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2911 /* If the file name has special constructs in it,
2912 call the corresponding file handler. */
2913 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2914 if (!NILP (handler
))
2915 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2918 if (is_selinux_enabled ())
2920 /* Get current file context. */
2921 encoded_absname
= ENCODE_FILE (absname
);
2922 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2925 parsed_con
= context_new (con
);
2926 /* Change the parts defined in the parameter.*/
2929 if (context_user_set (parsed_con
, SSDATA (user
)))
2930 error ("Doing context_user_set");
2934 if (context_role_set (parsed_con
, SSDATA (role
)))
2935 error ("Doing context_role_set");
2939 if (context_type_set (parsed_con
, SSDATA (type
)))
2940 error ("Doing context_type_set");
2942 if (STRINGP (range
))
2944 if (context_range_set (parsed_con
, SSDATA (range
)))
2945 error ("Doing context_range_set");
2948 /* Set the modified context back to the file. */
2949 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2950 context_str (parsed_con
))
2952 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2953 if (fail
&& errno
!= ENOTSUP
)
2954 report_file_error ("Doing lsetfilecon", absname
);
2956 context_free (parsed_con
);
2958 return fail
? Qnil
: Qt
;
2961 report_file_error ("Doing lgetfilecon", absname
);
2968 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
2969 doc
: /* Return ACL entries of file named FILENAME.
2970 The entries are returned in a format suitable for use in `set-file-acl'
2971 but is otherwise undocumented and subject to change.
2972 Return nil if file does not exist or is not accessible, or if Emacs
2973 was unable to determine the ACL entries. */)
2974 (Lisp_Object filename
)
2977 Lisp_Object absname
;
2978 Lisp_Object handler
;
2979 # ifdef HAVE_ACL_SET_FILE
2981 Lisp_Object acl_string
;
2983 # ifndef HAVE_ACL_TYPE_EXTENDED
2984 acl_type_t ACL_TYPE_EXTENDED
= ACL_TYPE_ACCESS
;
2988 absname
= expand_and_dir_to_file (filename
,
2989 BVAR (current_buffer
, directory
));
2991 /* If the file name has special constructs in it,
2992 call the corresponding file handler. */
2993 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
2994 if (!NILP (handler
))
2995 return call2 (handler
, Qfile_acl
, absname
);
2997 # ifdef HAVE_ACL_SET_FILE
2998 absname
= ENCODE_FILE (absname
);
3000 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_EXTENDED
);
3004 str
= acl_to_text (acl
, NULL
);
3011 acl_string
= build_string (str
);
3022 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3024 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3025 ACL-STRING should contain the textual representation of the ACL
3026 entries in a format suitable for the platform.
3028 Value is t if setting of ACL was successful, nil otherwise.
3030 Setting ACL for local files requires Emacs to be built with ACL
3032 (Lisp_Object filename
, Lisp_Object acl_string
)
3035 Lisp_Object absname
;
3036 Lisp_Object handler
;
3037 # ifdef HAVE_ACL_SET_FILE
3038 Lisp_Object encoded_absname
;
3043 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3045 /* If the file name has special constructs in it,
3046 call the corresponding file handler. */
3047 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3048 if (!NILP (handler
))
3049 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3051 # ifdef HAVE_ACL_SET_FILE
3052 if (STRINGP (acl_string
))
3054 acl
= acl_from_text (SSDATA (acl_string
));
3057 report_file_error ("Converting ACL", absname
);
3061 encoded_absname
= ENCODE_FILE (absname
);
3063 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3066 if (fail
&& acl_errno_valid (errno
))
3067 report_file_error ("Setting ACL", absname
);
3070 return fail
? Qnil
: Qt
;
3078 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3079 doc
: /* Return mode bits of file named FILENAME, as an integer.
3080 Return nil, if file does not exist or is not accessible. */)
3081 (Lisp_Object filename
)
3083 Lisp_Object absname
;
3085 Lisp_Object handler
;
3087 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3089 /* If the file name has special constructs in it,
3090 call the corresponding file handler. */
3091 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3092 if (!NILP (handler
))
3093 return call2 (handler
, Qfile_modes
, absname
);
3095 absname
= ENCODE_FILE (absname
);
3097 if (stat (SSDATA (absname
), &st
) < 0)
3100 return make_number (st
.st_mode
& 07777);
3103 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3104 "(let ((file (read-file-name \"File: \"))) \
3105 (list file (read-file-modes nil file)))",
3106 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3107 Only the 12 low bits of MODE are used.
3109 Interactively, mode bits are read by `read-file-modes', which accepts
3110 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3111 (Lisp_Object filename
, Lisp_Object mode
)
3113 Lisp_Object absname
, encoded_absname
;
3114 Lisp_Object handler
;
3116 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3117 CHECK_NUMBER (mode
);
3119 /* If the file name has special constructs in it,
3120 call the corresponding file handler. */
3121 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3122 if (!NILP (handler
))
3123 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3125 encoded_absname
= ENCODE_FILE (absname
);
3127 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3128 report_file_error ("Doing chmod", absname
);
3133 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3134 doc
: /* Set the file permission bits for newly created files.
3135 The argument MODE should be an integer; only the low 9 bits are used.
3136 This setting is inherited by subprocesses. */)
3139 mode_t oldrealmask
, oldumask
, newumask
;
3140 CHECK_NUMBER (mode
);
3141 oldrealmask
= realmask
;
3142 newumask
= ~ XINT (mode
) & 0777;
3145 realmask
= newumask
;
3146 oldumask
= umask (newumask
);
3149 eassert (oldumask
== oldrealmask
);
3153 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3154 doc
: /* Return the default file protection for created files.
3155 The value is an integer. */)
3159 XSETINT (value
, (~ realmask
) & 0777);
3164 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3165 doc
: /* Set times of file FILENAME to TIMESTAMP.
3166 Set both access and modification times.
3167 Return t on success, else nil.
3168 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3170 (Lisp_Object filename
, Lisp_Object timestamp
)
3172 Lisp_Object absname
, encoded_absname
;
3173 Lisp_Object handler
;
3174 struct timespec t
= lisp_time_argument (timestamp
);
3176 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3178 /* If the file name has special constructs in it,
3179 call the corresponding file handler. */
3180 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3181 if (!NILP (handler
))
3182 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3184 encoded_absname
= ENCODE_FILE (absname
);
3187 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
) != 0)
3190 /* Setting times on a directory always fails. */
3191 if (file_directory_p (SSDATA (encoded_absname
)))
3194 report_file_error ("Setting file times", absname
);
3202 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3203 doc
: /* Tell Unix to finish all pending disk updates. */)
3210 #endif /* HAVE_SYNC */
3212 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3213 doc
: /* Return t if file FILE1 is newer than file FILE2.
3214 If FILE1 does not exist, the answer is nil;
3215 otherwise, if FILE2 does not exist, the answer is t. */)
3216 (Lisp_Object file1
, Lisp_Object file2
)
3218 Lisp_Object absname1
, absname2
;
3219 struct stat st1
, st2
;
3220 Lisp_Object handler
;
3222 CHECK_STRING (file1
);
3223 CHECK_STRING (file2
);
3226 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3227 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3229 /* If the file name has special constructs in it,
3230 call the corresponding file handler. */
3231 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3233 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3234 if (!NILP (handler
))
3235 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3237 absname1
= ENCODE_FILE (absname1
);
3238 absname2
= ENCODE_FILE (absname2
);
3240 if (stat (SSDATA (absname1
), &st1
) < 0)
3243 if (stat (SSDATA (absname2
), &st2
) < 0)
3246 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3250 enum { READ_BUF_SIZE
= MAX_ALLOCA
};
3252 /* This function is called after Lisp functions to decide a coding
3253 system are called, or when they cause an error. Before they are
3254 called, the current buffer is set unibyte and it contains only a
3255 newly inserted text (thus the buffer was empty before the
3258 The functions may set markers, overlays, text properties, or even
3259 alter the buffer contents, change the current buffer.
3261 Here, we reset all those changes by:
3262 o set back the current buffer.
3263 o move all markers and overlays to BEG.
3264 o remove all text properties.
3265 o set back the buffer multibyteness. */
3268 decide_coding_unwind (Lisp_Object unwind_data
)
3270 Lisp_Object multibyte
, undo_list
, buffer
;
3272 multibyte
= XCAR (unwind_data
);
3273 unwind_data
= XCDR (unwind_data
);
3274 undo_list
= XCAR (unwind_data
);
3275 buffer
= XCDR (unwind_data
);
3277 set_buffer_internal (XBUFFER (buffer
));
3278 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3279 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3280 set_buffer_intervals (current_buffer
, NULL
);
3281 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3283 /* Now we are safe to change the buffer's multibyteness directly. */
3284 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3285 bset_undo_list (current_buffer
, undo_list
);
3288 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3289 object where slot 0 is the file descriptor, slot 1 specifies
3290 an offset to put the read bytes, and slot 2 is the maximum
3291 amount of bytes to read. Value is the number of bytes read. */
3294 read_non_regular (Lisp_Object state
)
3296 int nbytes
= emacs_read_quit (XSAVE_INTEGER (state
, 0),
3297 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3298 + XSAVE_INTEGER (state
, 1)),
3299 XSAVE_INTEGER (state
, 2));
3300 /* Fast recycle this object for the likely next call. */
3302 return make_number (nbytes
);
3306 /* Condition-case handler used when reading from non-regular files
3307 in insert-file-contents. */
3310 read_non_regular_quit (Lisp_Object ignore
)
3315 /* Return the file offset that VAL represents, checking for type
3316 errors and overflow. */
3318 file_offset (Lisp_Object val
)
3320 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3325 double v
= XFLOAT_DATA (val
);
3326 if (0 <= v
&& v
< 1.0 + TYPE_MAXIMUM (off_t
))
3334 wrong_type_argument (intern ("file-offset"), val
);
3337 /* Return a special time value indicating the error number ERRNUM. */
3338 static struct timespec
3339 time_error_value (int errnum
)
3341 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3342 ? NONEXISTENT_MODTIME_NSECS
3343 : UNKNOWN_MODTIME_NSECS
);
3344 return make_timespec (0, ns
);
3348 get_window_points_and_markers (void)
3350 Lisp_Object pt_marker
= Fpoint_marker ();
3352 = call3 (Qget_buffer_window_list
, Fcurrent_buffer (), Qnil
, Qt
);
3353 Lisp_Object window_markers
= windows
;
3354 /* Window markers (and point) are handled specially: rather than move to
3355 just before or just after the modified text, we try to keep the
3356 markers at the same distance (bug#19161).
3357 In general, this is wrong, but for window-markers, this should be harmless
3358 and is convenient for the end user when most of the file is unmodified,
3359 except for a few minor details near the beginning and near the end. */
3360 for (; CONSP (windows
); windows
= XCDR (windows
))
3361 if (WINDOWP (XCAR (windows
)))
3363 Lisp_Object window_marker
= XWINDOW (XCAR (windows
))->pointm
;
3365 Fcons (window_marker
, Fmarker_position (window_marker
)));
3367 return Fcons (Fcons (pt_marker
, Fpoint ()), window_markers
);
3371 restore_window_points (Lisp_Object window_markers
, ptrdiff_t inserted
,
3372 ptrdiff_t same_at_start
, ptrdiff_t same_at_end
)
3374 for (; CONSP (window_markers
); window_markers
= XCDR (window_markers
))
3375 if (CONSP (XCAR (window_markers
)))
3377 Lisp_Object car
= XCAR (window_markers
);
3378 Lisp_Object marker
= XCAR (car
);
3379 Lisp_Object oldpos
= XCDR (car
);
3380 if (MARKERP (marker
) && INTEGERP (oldpos
)
3381 && XINT (oldpos
) > same_at_start
3382 && XINT (oldpos
) < same_at_end
)
3384 ptrdiff_t oldsize
= same_at_end
- same_at_start
;
3385 ptrdiff_t newsize
= inserted
;
3386 double growth
= newsize
/ (double)oldsize
;
3388 = same_at_start
+ growth
* (XINT (oldpos
) - same_at_start
);
3389 Fset_marker (marker
, make_number (newpos
), Qnil
);
3394 /* Make sure the gap is at Z_BYTE. This is required to treat buffer
3395 text as a linear C char array. */
3397 maybe_move_gap (struct buffer
*b
)
3399 if (BUF_GPT_BYTE (b
) != BUF_Z_BYTE (b
))
3401 struct buffer
*cb
= current_buffer
;
3403 set_buffer_internal (b
);
3404 move_gap_both (Z
, Z_BYTE
);
3405 set_buffer_internal (cb
);
3409 /* FIXME: insert-file-contents should be split with the top-level moved to
3410 Elisp and only the core kept in C. */
3412 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3414 doc
: /* Insert contents of file FILENAME after point.
3415 Returns list of absolute file name and number of characters inserted.
3416 If second argument VISIT is non-nil, the buffer's visited filename and
3417 last save file modtime are set, and it is marked unmodified. If
3418 visiting and the file does not exist, visiting is completed before the
3421 The optional third and fourth arguments BEG and END specify what portion
3422 of the file to insert. These arguments count bytes in the file, not
3423 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3425 If optional fifth argument REPLACE is non-nil, replace the current
3426 buffer contents (in the accessible portion) with the file contents.
3427 This is better than simply deleting and inserting the whole thing
3428 because (1) it preserves some marker positions and (2) it puts less data
3429 in the undo list. When REPLACE is non-nil, the second return value is
3430 the number of characters that replace previous buffer contents.
3432 This function does code conversion according to the value of
3433 `coding-system-for-read' or `file-coding-system-alist', and sets the
3434 variable `last-coding-system-used' to the coding system actually used.
3436 In addition, this function decodes the inserted text from known formats
3437 by calling `format-decode', which see. */)
3438 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3441 struct timespec mtime
;
3443 ptrdiff_t inserted
= 0;
3445 off_t beg_offset
, end_offset
;
3447 ptrdiff_t count
= SPECPDL_INDEX ();
3448 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3450 ptrdiff_t total
= 0;
3451 bool not_regular
= 0;
3453 char read_buf
[READ_BUF_SIZE
];
3454 struct coding_system coding
;
3455 bool replace_handled
= false;
3456 bool set_coding_system
= false;
3457 Lisp_Object coding_system
;
3458 bool read_quit
= false;
3459 /* If the undo log only contains the insertion, there's no point
3460 keeping it. It's typically when we first fill a file-buffer. */
3461 bool empty_undo_list_p
3462 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3464 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3465 bool we_locked_file
= false;
3467 Lisp_Object window_markers
= Qnil
;
3468 /* same_at_start and same_at_end count bytes, because file access counts
3469 bytes and BEG and END count bytes. */
3470 ptrdiff_t same_at_start
= BEGV_BYTE
;
3471 ptrdiff_t same_at_end
= ZV_BYTE
;
3472 /* SAME_AT_END_CHARPOS counts characters, because
3473 restore_window_points needs the old character count. */
3474 ptrdiff_t same_at_end_charpos
= ZV
;
3476 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3477 error ("Cannot do file visiting in an indirect buffer");
3479 if (!NILP (BVAR (current_buffer
, read_only
)))
3480 Fbarf_if_buffer_read_only (Qnil
);
3484 orig_filename
= Qnil
;
3487 CHECK_STRING (filename
);
3488 filename
= Fexpand_file_name (filename
, Qnil
);
3490 /* The value Qnil means that the coding system is not yet
3492 coding_system
= Qnil
;
3494 /* If the file name has special constructs in it,
3495 call the corresponding file handler. */
3496 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3497 if (!NILP (handler
))
3499 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3500 visit
, beg
, end
, replace
);
3501 if (CONSP (val
) && CONSP (XCDR (val
))
3502 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3503 inserted
= XINT (XCAR (XCDR (val
)));
3507 orig_filename
= filename
;
3508 filename
= ENCODE_FILE (filename
);
3510 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3515 report_file_error ("Opening input file", orig_filename
);
3516 mtime
= time_error_value (save_errno
);
3518 if (!NILP (Vcoding_system_for_read
))
3520 /* Don't let invalid values into buffer-file-coding-system. */
3521 CHECK_CODING_SYSTEM (Vcoding_system_for_read
);
3522 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3527 fd_index
= SPECPDL_INDEX ();
3528 record_unwind_protect_int (close_file_unwind
, fd
);
3530 /* Replacement should preserve point as it preserves markers. */
3531 if (!NILP (replace
))
3533 window_markers
= get_window_points_and_markers ();
3534 record_unwind_protect (restore_point_unwind
,
3535 XCAR (XCAR (window_markers
)));
3538 if (fstat (fd
, &st
) != 0)
3539 report_file_error ("Input file status", orig_filename
);
3540 mtime
= get_stat_mtime (&st
);
3542 /* This code will need to be changed in order to work on named
3543 pipes, and it's probably just not worth it. So we should at
3544 least signal an error. */
3545 if (!S_ISREG (st
.st_mode
))
3552 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3553 xsignal2 (Qfile_error
,
3554 build_string ("not a regular file"), orig_filename
);
3559 if (!NILP (beg
) || !NILP (end
))
3560 error ("Attempt to visit less than an entire file");
3561 if (BEG
< Z
&& NILP (replace
))
3562 error ("Cannot do file visiting in a non-empty buffer");
3566 beg_offset
= file_offset (beg
);
3571 end_offset
= file_offset (end
);
3575 end_offset
= TYPE_MAXIMUM (off_t
);
3578 end_offset
= st
.st_size
;
3580 /* A negative size can happen on a platform that allows file
3581 sizes greater than the maximum off_t value. */
3585 /* The file size returned from stat may be zero, but data
3586 may be readable nonetheless, for example when this is a
3587 file in the /proc filesystem. */
3588 if (end_offset
== 0)
3589 end_offset
= READ_BUF_SIZE
;
3593 /* Check now whether the buffer will become too large,
3594 in the likely case where the file's length is not changing.
3595 This saves a lot of needless work before a buffer overflow. */
3598 /* The likely offset where we will stop reading. We could read
3599 more (or less), if the file grows (or shrinks) as we read it. */
3600 off_t likely_end
= min (end_offset
, st
.st_size
);
3602 if (beg_offset
< likely_end
)
3605 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3606 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3607 off_t likely_growth
= likely_end
- beg_offset
;
3608 if (buf_growth_max
< likely_growth
)
3613 /* Prevent redisplay optimizations. */
3614 current_buffer
->clip_changed
= true;
3616 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3618 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3619 setup_coding_system (coding_system
, &coding
);
3620 /* Ensure we set Vlast_coding_system_used. */
3621 set_coding_system
= true;
3625 /* Decide the coding system to use for reading the file now
3626 because we can't use an optimized method for handling
3627 `coding:' tag if the current buffer is not empty. */
3628 if (!NILP (Vcoding_system_for_read
))
3629 coding_system
= Vcoding_system_for_read
;
3632 /* Don't try looking inside a file for a coding system
3633 specification if it is not seekable. */
3634 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3636 /* Find a coding system specified in the heading two
3637 lines or in the tailing several lines of the file.
3638 We assume that the 1K-byte and 3K-byte for heading
3639 and tailing respectively are sufficient for this
3643 if (st
.st_size
<= (1024 * 4))
3644 nread
= emacs_read_quit (fd
, read_buf
, 1024 * 4);
3647 nread
= emacs_read_quit (fd
, read_buf
, 1024);
3651 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3652 report_file_error ("Setting file position",
3654 ntail
= emacs_read_quit (fd
, read_buf
+ nread
, 1024 * 3);
3655 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3660 report_file_error ("Read error", orig_filename
);
3663 AUTO_STRING (name
, " *code-converting-work*");
3664 struct buffer
*prev
= current_buffer
;
3665 Lisp_Object workbuf
;
3668 record_unwind_current_buffer ();
3670 workbuf
= Fget_buffer_create (name
);
3671 buf
= XBUFFER (workbuf
);
3673 delete_all_overlays (buf
);
3674 bset_directory (buf
, BVAR (current_buffer
, directory
));
3675 bset_read_only (buf
, Qnil
);
3676 bset_filename (buf
, Qnil
);
3677 bset_undo_list (buf
, Qt
);
3678 eassert (buf
->overlays_before
== NULL
);
3679 eassert (buf
->overlays_after
== NULL
);
3681 set_buffer_internal (buf
);
3683 bset_enable_multibyte_characters (buf
, Qnil
);
3685 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3686 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3687 coding_system
= call2 (Vset_auto_coding_function
,
3688 filename
, make_number (nread
));
3689 set_buffer_internal (prev
);
3691 /* Discard the unwind protect for recovering the
3695 /* Rewind the file for the actual read done later. */
3696 if (lseek (fd
, 0, SEEK_SET
) < 0)
3697 report_file_error ("Setting file position", orig_filename
);
3701 if (NILP (coding_system
))
3703 /* If we have not yet decided a coding system, check
3704 file-coding-system-alist. */
3705 coding_system
= CALLN (Ffind_operation_coding_system
,
3706 Qinsert_file_contents
, orig_filename
,
3707 visit
, beg
, end
, replace
);
3708 if (CONSP (coding_system
))
3709 coding_system
= XCAR (coding_system
);
3713 if (NILP (coding_system
))
3714 coding_system
= Qundecided
;
3716 CHECK_CODING_SYSTEM (coding_system
);
3718 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3719 /* We must suppress all character code conversion except for
3720 end-of-line conversion. */
3721 coding_system
= raw_text_coding_system (coding_system
);
3723 setup_coding_system (coding_system
, &coding
);
3724 /* Ensure we set Vlast_coding_system_used. */
3725 set_coding_system
= true;
3728 /* If requested, replace the accessible part of the buffer
3729 with the file contents. Avoid replacing text at the
3730 beginning or end of the buffer that matches the file contents;
3731 that preserves markers pointing to the unchanged parts.
3733 Here we implement this feature in an optimized way
3734 for the case where code conversion is NOT needed.
3735 The following if-statement handles the case of conversion
3736 in a less optimal way.
3738 If the code conversion is "automatic" then we try using this
3739 method and hope for the best.
3740 But if we discover the need for conversion, we give up on this method
3741 and let the following if-statement handle the replace job. */
3744 && (NILP (coding_system
)
3745 || ! CODING_REQUIRE_DECODING (&coding
)))
3748 /* There is still a possibility we will find the need to do code
3749 conversion. If that happens, set this variable to
3750 give up on handling REPLACE in the optimized way. */
3751 bool giveup_match_end
= false;
3753 if (beg_offset
!= 0)
3755 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3756 report_file_error ("Setting file position", orig_filename
);
3759 /* Count how many chars at the start of the file
3760 match the text at the beginning of the buffer. */
3763 int nread
= emacs_read_quit (fd
, read_buf
, sizeof read_buf
);
3765 report_file_error ("Read error", orig_filename
);
3766 else if (nread
== 0)
3769 if (CODING_REQUIRE_DETECTION (&coding
))
3771 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3774 setup_coding_system (coding_system
, &coding
);
3777 if (CODING_REQUIRE_DECODING (&coding
))
3778 /* We found that the file should be decoded somehow.
3779 Let's give up here. */
3781 giveup_match_end
= true;
3786 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3787 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3788 same_at_start
++, bufpos
++;
3789 /* If we found a discrepancy, stop the scan.
3790 Otherwise loop around and scan the next bufferful. */
3791 if (bufpos
!= nread
)
3794 /* If the file matches the buffer completely,
3795 there's no need to replace anything. */
3796 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3799 clear_unwind_protect (fd_index
);
3801 /* Truncate the buffer to the size of the file. */
3802 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3806 /* Count how many chars at the end of the file
3807 match the text at the end of the buffer. But, if we have
3808 already found that decoding is necessary, don't waste time. */
3809 while (!giveup_match_end
)
3811 int total_read
, nread
, bufpos
, trial
;
3814 /* At what file position are we now scanning? */
3815 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3816 /* If the entire file matches the buffer tail, stop the scan. */
3819 /* How much can we scan in the next step? */
3820 trial
= min (curpos
, sizeof read_buf
);
3821 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3822 report_file_error ("Setting file position", orig_filename
);
3824 total_read
= nread
= 0;
3825 while (total_read
< trial
)
3827 nread
= emacs_read_quit (fd
, read_buf
+ total_read
,
3828 trial
- total_read
);
3830 report_file_error ("Read error", orig_filename
);
3831 else if (nread
== 0)
3833 total_read
+= nread
;
3836 /* Scan this bufferful from the end, comparing with
3837 the Emacs buffer. */
3838 bufpos
= total_read
;
3840 /* Compare with same_at_start to avoid counting some buffer text
3841 as matching both at the file's beginning and at the end. */
3842 while (bufpos
> 0 && same_at_end
> same_at_start
3843 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3844 same_at_end
--, bufpos
--;
3846 /* If we found a discrepancy, stop the scan.
3847 Otherwise loop around and scan the preceding bufferful. */
3850 /* If this discrepancy is because of code conversion,
3851 we cannot use this method; giveup and try the other. */
3852 if (same_at_end
> same_at_start
3853 && FETCH_BYTE (same_at_end
- 1) >= 0200
3854 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3855 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3856 giveup_match_end
= true;
3864 if (! giveup_match_end
)
3867 ptrdiff_t this_count
= SPECPDL_INDEX ();
3869 /* We win! We can handle REPLACE the optimized way. */
3871 /* Extend the start of non-matching text area to multibyte
3872 character boundary. */
3873 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3874 while (same_at_start
> BEGV_BYTE
3875 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3878 /* Extend the end of non-matching text area to multibyte
3879 character boundary. */
3880 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3881 while (same_at_end
< ZV_BYTE
3882 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3885 /* Don't try to reuse the same piece of text twice. */
3886 overlap
= (same_at_start
- BEGV_BYTE
3888 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3890 same_at_end
+= overlap
;
3891 same_at_end_charpos
= BYTE_TO_CHAR (same_at_end
);
3893 /* Arrange to read only the nonmatching middle part of the file. */
3894 beg_offset
+= same_at_start
- BEGV_BYTE
;
3895 end_offset
-= ZV_BYTE
- same_at_end
;
3897 /* This binding is to avoid ask-user-about-supersession-threat
3898 being called in insert_from_buffer or del_range_bytes (via
3899 prepare_to_modify_buffer).
3900 AFAICT we could avoid ask-user-about-supersession-threat by setting
3901 current_buffer->modtime earlier, but we could still end up calling
3902 ask-user-about-supersession-threat if the file is modified while
3903 we read it, so we bind buffer-file-name instead. */
3904 specbind (intern ("buffer-file-name"), Qnil
);
3905 del_range_byte (same_at_start
, same_at_end
);
3906 /* Insert from the file at the proper position. */
3907 temp
= BYTE_TO_CHAR (same_at_start
);
3908 SET_PT_BOTH (temp
, same_at_start
);
3909 unbind_to (this_count
, Qnil
);
3911 /* If display currently starts at beginning of line,
3912 keep it that way. */
3913 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3914 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3916 replace_handled
= true;
3920 /* If requested, replace the accessible part of the buffer
3921 with the file contents. Avoid replacing text at the
3922 beginning or end of the buffer that matches the file contents;
3923 that preserves markers pointing to the unchanged parts.
3925 Here we implement this feature for the case where code conversion
3926 is needed, in a simple way that needs a lot of memory.
3927 The preceding if-statement handles the case of no conversion
3928 in a more optimized way. */
3929 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3931 ptrdiff_t same_at_start_charpos
;
3932 ptrdiff_t inserted_chars
;
3935 unsigned char *decoded
;
3938 ptrdiff_t this_count
= SPECPDL_INDEX ();
3940 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3941 Lisp_Object conversion_buffer
;
3943 conversion_buffer
= code_conversion_save (1, multibyte
);
3945 /* First read the whole file, performing code conversion into
3946 CONVERSION_BUFFER. */
3948 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3949 report_file_error ("Setting file position", orig_filename
);
3951 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3952 unprocessed
= 0; /* Bytes not processed in previous loop. */
3956 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3957 quitting while reading a huge file. */
3959 this = emacs_read_quit (fd
, read_buf
+ unprocessed
,
3960 READ_BUF_SIZE
- unprocessed
);
3964 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3965 BUF_Z (XBUFFER (conversion_buffer
)));
3966 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3967 unprocessed
+ this, conversion_buffer
);
3968 unprocessed
= coding
.carryover_bytes
;
3969 if (coding
.carryover_bytes
> 0)
3970 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3974 report_file_error ("Read error", orig_filename
);
3976 clear_unwind_protect (fd_index
);
3978 if (unprocessed
> 0)
3980 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3981 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3982 unprocessed
, conversion_buffer
);
3983 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3986 coding_system
= CODING_ID_NAME (coding
.id
);
3987 set_coding_system
= true;
3988 maybe_move_gap (XBUFFER (conversion_buffer
));
3989 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3990 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3991 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3993 /* Compare the beginning of the converted string with the buffer
3997 while (bufpos
< inserted
&& same_at_start
< same_at_end
3998 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3999 same_at_start
++, bufpos
++;
4001 /* If the file matches the head of buffer completely,
4002 there's no need to replace anything. */
4004 if (bufpos
== inserted
)
4006 /* Truncate the buffer to the size of the file. */
4007 if (same_at_start
!= same_at_end
)
4009 /* See previous specbind for the reason behind this. */
4010 specbind (intern ("buffer-file-name"), Qnil
);
4011 del_range_byte (same_at_start
, same_at_end
);
4015 unbind_to (this_count
, Qnil
);
4019 /* Extend the start of non-matching text area to the previous
4020 multibyte character boundary. */
4021 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4022 while (same_at_start
> BEGV_BYTE
4023 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4026 /* Scan this bufferful from the end, comparing with
4027 the Emacs buffer. */
4030 /* Compare with same_at_start to avoid counting some buffer text
4031 as matching both at the file's beginning and at the end. */
4032 while (bufpos
> 0 && same_at_end
> same_at_start
4033 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4034 same_at_end
--, bufpos
--;
4036 /* Extend the end of non-matching text area to the next
4037 multibyte character boundary. */
4038 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4039 while (same_at_end
< ZV_BYTE
4040 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4043 /* Don't try to reuse the same piece of text twice. */
4044 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4046 same_at_end
+= overlap
;
4047 same_at_end_charpos
= BYTE_TO_CHAR (same_at_end
);
4049 /* If display currently starts at beginning of line,
4050 keep it that way. */
4051 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4052 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4054 /* Replace the chars that we need to replace,
4055 and update INSERTED to equal the number of bytes
4056 we are taking from the decoded string. */
4057 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4059 /* See previous specbind for the reason behind this. */
4060 specbind (intern ("buffer-file-name"), Qnil
);
4061 if (same_at_end
!= same_at_start
)
4063 del_range_byte (same_at_start
, same_at_end
);
4065 eassert (same_at_start
== GPT_BYTE
);
4066 same_at_start
= GPT_BYTE
;
4070 temp
= same_at_end_charpos
;
4072 /* Insert from the file at the proper position. */
4073 SET_PT_BOTH (temp
, same_at_start
);
4074 same_at_start_charpos
4075 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4076 same_at_start
- BEGV_BYTE
4077 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4078 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4080 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4081 same_at_start
+ inserted
- BEGV_BYTE
4082 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4083 - same_at_start_charpos
);
4084 insert_from_buffer (XBUFFER (conversion_buffer
),
4085 same_at_start_charpos
, inserted_chars
, 0);
4086 /* Set `inserted' to the number of inserted characters. */
4087 inserted
= PT
- temp
;
4088 /* Set point before the inserted characters. */
4089 SET_PT_BOTH (temp
, same_at_start
);
4091 unbind_to (this_count
, Qnil
);
4097 total
= end_offset
- beg_offset
;
4099 /* For a special file, all we can do is guess. */
4100 total
= READ_BUF_SIZE
;
4102 if (NILP (visit
) && total
> 0)
4104 if (!NILP (BVAR (current_buffer
, file_truename
))
4105 /* Make binding buffer-file-name to nil effective. */
4106 && !NILP (BVAR (current_buffer
, filename
))
4107 && SAVE_MODIFF
>= MODIFF
)
4108 we_locked_file
= true;
4109 prepare_to_modify_buffer (PT
, PT
, NULL
);
4112 move_gap_both (PT
, PT_BYTE
);
4113 if (GAP_SIZE
< total
)
4114 make_gap (total
- GAP_SIZE
);
4116 if (beg_offset
!= 0 || !NILP (replace
))
4118 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4119 report_file_error ("Setting file position", orig_filename
);
4122 /* In the following loop, HOW_MUCH contains the total bytes read so
4123 far for a regular file, and not changed for a special file. But,
4124 before exiting the loop, it is set to a negative value if I/O
4128 /* Total bytes inserted. */
4131 /* Here, we don't do code conversion in the loop. It is done by
4132 decode_coding_gap after all data are read into the buffer. */
4134 ptrdiff_t gap_size
= GAP_SIZE
;
4136 while (how_much
< total
)
4138 /* `try' is reserved in some compilers (Microsoft C). */
4139 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4146 /* Maybe make more room. */
4147 if (gap_size
< trytry
)
4149 make_gap (trytry
- gap_size
);
4150 gap_size
= GAP_SIZE
- inserted
;
4153 /* Read from the file, capturing `quit'. When an
4154 error occurs, end the loop, and arrange for a quit
4155 to be signaled after decoding the text we read. */
4156 nbytes
= internal_condition_case_1
4158 make_save_int_int_int (fd
, inserted
, trytry
),
4159 Qerror
, read_non_regular_quit
);
4167 this = XINT (nbytes
);
4171 /* Allow quitting out of the actual I/O. We don't make text
4172 part of the buffer until all the reading is done, so a C-g
4173 here doesn't do any harm. */
4174 this = emacs_read_quit (fd
,
4175 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4188 /* For a regular file, where TOTAL is the real size,
4189 count HOW_MUCH to compare with it.
4190 For a special file, where TOTAL is just a buffer size,
4191 so don't bother counting in HOW_MUCH.
4192 (INSERTED is where we count the number of characters inserted.) */
4199 /* Now we have either read all the file data into the gap,
4200 or stop reading on I/O error or quit. If nothing was
4201 read, undo marking the buffer modified. */
4206 unlock_file (BVAR (current_buffer
, file_truename
));
4207 Vdeactivate_mark
= old_Vdeactivate_mark
;
4210 Fset (Qdeactivate_mark
, Qt
);
4213 clear_unwind_protect (fd_index
);
4216 report_file_error ("Read error", orig_filename
);
4218 /* Make the text read part of the buffer. */
4219 GAP_SIZE
-= inserted
;
4221 GPT_BYTE
+= inserted
;
4223 ZV_BYTE
+= inserted
;
4228 /* Put an anchor to ensure multi-byte form ends at gap. */
4233 if (NILP (coding_system
))
4235 /* The coding system is not yet decided. Decide it by an
4236 optimized method for handling `coding:' tag.
4238 Note that we can get here only if the buffer was empty
4239 before the insertion. */
4241 if (!NILP (Vcoding_system_for_read
))
4242 coding_system
= Vcoding_system_for_read
;
4245 /* Since we are sure that the current buffer was empty
4246 before the insertion, we can toggle
4247 enable-multibyte-characters directly here without taking
4248 care of marker adjustment. By this way, we can run Lisp
4249 program safely before decoding the inserted text. */
4250 Lisp_Object unwind_data
;
4251 ptrdiff_t count1
= SPECPDL_INDEX ();
4253 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4254 Fcons (BVAR (current_buffer
, undo_list
),
4255 Fcurrent_buffer ()));
4256 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4257 bset_undo_list (current_buffer
, Qt
);
4258 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4260 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4262 coding_system
= call2 (Vset_auto_coding_function
,
4263 filename
, make_number (inserted
));
4266 if (NILP (coding_system
))
4268 /* If the coding system is not yet decided, check
4269 file-coding-system-alist. */
4270 coding_system
= CALLN (Ffind_operation_coding_system
,
4271 Qinsert_file_contents
, orig_filename
,
4272 visit
, beg
, end
, Qnil
);
4273 if (CONSP (coding_system
))
4274 coding_system
= XCAR (coding_system
);
4276 unbind_to (count1
, Qnil
);
4277 inserted
= Z_BYTE
- BEG_BYTE
;
4280 if (NILP (coding_system
))
4281 coding_system
= Qundecided
;
4283 CHECK_CODING_SYSTEM (coding_system
);
4285 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4286 /* We must suppress all character code conversion except for
4287 end-of-line conversion. */
4288 coding_system
= raw_text_coding_system (coding_system
);
4289 setup_coding_system (coding_system
, &coding
);
4290 /* Ensure we set Vlast_coding_system_used. */
4291 set_coding_system
= true;
4296 /* When we visit a file by raw-text, we change the buffer to
4298 if (CODING_FOR_UNIBYTE (&coding
)
4299 /* Can't do this if part of the buffer might be preserved. */
4302 /* Visiting a file with these coding system makes the buffer
4305 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4307 Fset_buffer_multibyte (Qnil
);
4311 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4312 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4313 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4315 move_gap_both (PT
, PT_BYTE
);
4316 GAP_SIZE
+= inserted
;
4317 ZV_BYTE
-= inserted
;
4321 decode_coding_gap (&coding
, inserted
, inserted
);
4322 inserted
= coding
.produced_char
;
4323 coding_system
= CODING_ID_NAME (coding
.id
);
4325 else if (inserted
> 0)
4327 invalidate_buffer_caches (current_buffer
, PT
, PT
+ inserted
);
4328 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4332 /* Call after-change hooks for the inserted text, aside from the case
4333 of normal visiting (not with REPLACE), which is done in a new buffer
4334 "before" the buffer is changed. */
4335 if (inserted
> 0 && total
> 0
4336 && (NILP (visit
) || !NILP (replace
)))
4338 signal_after_change (PT
, 0, inserted
);
4339 update_compositions (PT
, PT
, CHECK_BORDER
);
4342 /* Now INSERTED is measured in characters. */
4347 restore_window_points (window_markers
, inserted
,
4348 BYTE_TO_CHAR (same_at_start
),
4349 same_at_end_charpos
);
4353 if (empty_undo_list_p
)
4354 bset_undo_list (current_buffer
, Qnil
);
4358 current_buffer
->modtime
= mtime
;
4359 current_buffer
->modtime_size
= st
.st_size
;
4360 bset_filename (current_buffer
, orig_filename
);
4363 SAVE_MODIFF
= MODIFF
;
4364 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4365 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4368 if (!NILP (BVAR (current_buffer
, file_truename
)))
4369 unlock_file (BVAR (current_buffer
, file_truename
));
4370 unlock_file (filename
);
4373 xsignal2 (Qfile_error
,
4374 build_string ("not a regular file"), orig_filename
);
4377 if (set_coding_system
)
4378 Vlast_coding_system_used
= coding_system
;
4380 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4382 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4384 if (! NILP (insval
))
4386 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4387 wrong_type_argument (intern ("inserted-chars"), insval
);
4388 inserted
= XFASTINT (insval
);
4392 /* Decode file format. */
4395 /* Don't run point motion or modification hooks when decoding. */
4396 ptrdiff_t count1
= SPECPDL_INDEX ();
4397 ptrdiff_t old_inserted
= inserted
;
4398 specbind (Qinhibit_point_motion_hooks
, Qt
);
4399 specbind (Qinhibit_modification_hooks
, Qt
);
4401 /* Save old undo list and don't record undo for decoding. */
4402 old_undo
= BVAR (current_buffer
, undo_list
);
4403 bset_undo_list (current_buffer
, Qt
);
4407 insval
= call3 (Qformat_decode
,
4408 Qnil
, make_number (inserted
), visit
);
4409 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4410 wrong_type_argument (intern ("inserted-chars"), insval
);
4411 inserted
= XFASTINT (insval
);
4415 /* If REPLACE is non-nil and we succeeded in not replacing the
4416 beginning or end of the buffer text with the file's contents,
4417 call format-decode with `point' positioned at the beginning
4418 of the buffer and `inserted' equaling the number of
4419 characters in the buffer. Otherwise, format-decode might
4420 fail to correctly analyze the beginning or end of the buffer.
4421 Hence we temporarily save `point' and `inserted' here and
4422 restore `point' iff format-decode did not insert or delete
4423 any text. Otherwise we leave `point' at point-min. */
4424 ptrdiff_t opoint
= PT
;
4425 ptrdiff_t opoint_byte
= PT_BYTE
;
4426 ptrdiff_t oinserted
= ZV
- BEGV
;
4427 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4429 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4430 insval
= call3 (Qformat_decode
,
4431 Qnil
, make_number (oinserted
), visit
);
4432 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4433 wrong_type_argument (intern ("inserted-chars"), insval
);
4434 if (ochars_modiff
== CHARS_MODIFF
)
4435 /* format_decode didn't modify buffer's characters => move
4436 point back to position before inserted text and leave
4437 value of inserted alone. */
4438 SET_PT_BOTH (opoint
, opoint_byte
);
4440 /* format_decode modified buffer's characters => consider
4441 entire buffer changed and leave point at point-min. */
4442 inserted
= XFASTINT (insval
);
4445 /* For consistency with format-decode call these now iff inserted > 0
4446 (martin 2007-06-28). */
4447 p
= Vafter_insert_file_functions
;
4452 insval
= call1 (XCAR (p
), make_number (inserted
));
4455 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4456 wrong_type_argument (intern ("inserted-chars"), insval
);
4457 inserted
= XFASTINT (insval
);
4462 /* For the rationale of this see the comment on
4463 format-decode above. */
4464 ptrdiff_t opoint
= PT
;
4465 ptrdiff_t opoint_byte
= PT_BYTE
;
4466 ptrdiff_t oinserted
= ZV
- BEGV
;
4467 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4469 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4470 insval
= call1 (XCAR (p
), make_number (oinserted
));
4473 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4474 wrong_type_argument (intern ("inserted-chars"), insval
);
4475 if (ochars_modiff
== CHARS_MODIFF
)
4476 /* after_insert_file_functions didn't modify
4477 buffer's characters => move point back to
4478 position before inserted text and leave value of
4480 SET_PT_BOTH (opoint
, opoint_byte
);
4482 /* after_insert_file_functions did modify buffer's
4483 characters => consider entire buffer changed and
4484 leave point at point-min. */
4485 inserted
= XFASTINT (insval
);
4493 if (!empty_undo_list_p
)
4495 bset_undo_list (current_buffer
, old_undo
);
4496 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4498 /* Adjust the last undo record for the size change during
4499 the format conversion. */
4500 Lisp_Object tem
= XCAR (old_undo
);
4501 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4502 && INTEGERP (XCDR (tem
))
4503 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4504 XSETCDR (tem
, make_number (PT
+ inserted
));
4508 /* If undo_list was Qt before, keep it that way.
4509 Otherwise start with an empty undo_list. */
4510 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4512 unbind_to (count1
, Qnil
);
4516 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4518 /* If visiting nonexistent file, return nil. */
4519 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4522 /* We made a lot of deletions and insertions above, so invalidate
4523 the newline cache for the entire region of the inserted
4525 if (current_buffer
->base_buffer
&& current_buffer
->base_buffer
->newline_cache
)
4526 invalidate_region_cache (current_buffer
->base_buffer
,
4527 current_buffer
->base_buffer
->newline_cache
,
4528 PT
- BEG
, Z
- PT
- inserted
);
4529 else if (current_buffer
->newline_cache
)
4530 invalidate_region_cache (current_buffer
,
4531 current_buffer
->newline_cache
,
4532 PT
- BEG
, Z
- PT
- inserted
);
4537 /* Retval needs to be dealt with in all cases consistently. */
4539 val
= list2 (orig_filename
, make_number (inserted
));
4541 return unbind_to (count
, val
);
4544 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4547 build_annotations_unwind (Lisp_Object arg
)
4549 Vwrite_region_annotation_buffers
= arg
;
4552 /* Decide the coding-system to encode the data with. */
4555 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4556 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4557 struct coding_system
*coding
)
4560 Lisp_Object eol_parent
= Qnil
;
4563 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4564 BVAR (current_buffer
, auto_save_file_name
))))
4569 else if (!NILP (Vcoding_system_for_write
))
4571 val
= Vcoding_system_for_write
;
4572 if (coding_system_require_warning
4573 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4574 /* Confirm that VAL can surely encode the current region. */
4575 val
= call5 (Vselect_safe_coding_system_function
,
4576 start
, end
, list2 (Qt
, val
),
4581 /* If the variable `buffer-file-coding-system' is set locally,
4582 it means that the file was read with some kind of code
4583 conversion or the variable is explicitly set by users. We
4584 had better write it out with the same coding system even if
4585 `enable-multibyte-characters' is nil.
4587 If it is not set locally, we anyway have to convert EOL
4588 format if the default value of `buffer-file-coding-system'
4589 tells that it is not Unix-like (LF only) format. */
4590 bool using_default_coding
= 0;
4591 bool force_raw_text
= 0;
4593 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4595 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4598 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4604 /* Check file-coding-system-alist. */
4605 Lisp_Object coding_systems
4606 = CALLN (Ffind_operation_coding_system
, Qwrite_region
, start
, end
,
4607 filename
, append
, visit
, lockname
);
4608 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4609 val
= XCDR (coding_systems
);
4614 /* If we still have not decided a coding system, use the
4615 current buffer's value of buffer-file-coding-system. */
4616 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4617 using_default_coding
= 1;
4620 if (! NILP (val
) && ! force_raw_text
)
4622 Lisp_Object spec
, attrs
;
4624 CHECK_CODING_SYSTEM (val
);
4625 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4626 attrs
= AREF (spec
, 0);
4627 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4632 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4634 /* Confirm that VAL can surely encode the current region. */
4635 val
= call5 (Vselect_safe_coding_system_function
,
4636 start
, end
, val
, Qnil
, filename
);
4637 /* As the function specified by select-safe-coding-system-function
4638 is out of our control, make sure we are not fed by bogus
4641 CHECK_CODING_SYSTEM (val
);
4644 /* If the decided coding-system doesn't specify end-of-line
4645 format, we use that of `buffer-file-coding-system'. */
4646 if (! using_default_coding
)
4648 Lisp_Object dflt
= BVAR (&buffer_defaults
, buffer_file_coding_system
);
4651 val
= coding_inherit_eol_type (val
, dflt
);
4654 /* If we decide not to encode text, use `raw-text' or one of its
4657 val
= raw_text_coding_system (val
);
4660 val
= coding_inherit_eol_type (val
, eol_parent
);
4661 setup_coding_system (val
, coding
);
4663 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4664 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4668 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4669 "r\nFWrite region to file: \ni\ni\ni\np",
4670 doc
: /* Write current region into specified file.
4671 When called from a program, requires three arguments:
4672 START, END and FILENAME. START and END are normally buffer positions
4673 specifying the part of the buffer to write.
4674 If START is nil, that means to use the entire buffer contents; END is
4676 If START is a string, then output that string to the file
4677 instead of any buffer contents; END is ignored.
4679 Optional fourth argument APPEND if non-nil means
4680 append to existing file contents (if any). If it is a number,
4681 seek to that offset in the file before writing.
4682 Optional fifth argument VISIT, if t or a string, means
4683 set the last-save-file-modtime of buffer to this file's modtime
4684 and mark buffer not modified.
4685 If VISIT is a string, it is a second file name;
4686 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4687 VISIT is also the file name to lock and unlock for clash detection.
4688 If VISIT is neither t nor nil nor a string, or if Emacs is in batch mode,
4689 do not display the \"Wrote file\" message.
4690 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4691 use for locking and unlocking, overriding FILENAME and VISIT.
4692 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4693 for an existing file with the same name. If MUSTBENEW is `excl',
4694 that means to get an error if the file already exists; never overwrite.
4695 If MUSTBENEW is neither nil nor `excl', that means ask for
4696 confirmation before overwriting, but do go ahead and overwrite the file
4697 if the user confirms.
4699 This does code conversion according to the value of
4700 `coding-system-for-write', `buffer-file-coding-system', or
4701 `file-coding-system-alist', and sets the variable
4702 `last-coding-system-used' to the coding system actually used.
4704 This calls `write-region-annotate-functions' at the start, and
4705 `write-region-post-annotation-function' at the end. */)
4706 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4707 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4709 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4713 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4714 descriptor for FILENAME, so do not open or close FILENAME. */
4717 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4718 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4719 Lisp_Object mustbenew
, int desc
)
4723 off_t offset UNINIT
;
4724 bool open_and_close_file
= desc
< 0;
4729 struct timespec modtime
;
4730 ptrdiff_t count
= SPECPDL_INDEX ();
4731 ptrdiff_t count1 UNINIT
;
4732 Lisp_Object handler
;
4733 Lisp_Object visit_file
;
4734 Lisp_Object annotations
;
4735 Lisp_Object encoded_filename
;
4736 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4737 bool quietly
= !NILP (visit
);
4738 bool file_locked
= 0;
4739 struct buffer
*given_buffer
;
4740 struct coding_system coding
;
4742 if (current_buffer
->base_buffer
&& visiting
)
4743 error ("Cannot do file visiting in an indirect buffer");
4745 if (!NILP (start
) && !STRINGP (start
))
4746 validate_region (&start
, &end
);
4750 filename
= Fexpand_file_name (filename
, Qnil
);
4752 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4753 barf_or_query_if_file_exists (filename
, false, "overwrite", true, true);
4755 if (STRINGP (visit
))
4756 visit_file
= Fexpand_file_name (visit
, Qnil
);
4758 visit_file
= filename
;
4760 if (NILP (lockname
))
4761 lockname
= visit_file
;
4765 /* If the file name has special constructs in it,
4766 call the corresponding file handler. */
4767 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4768 /* If FILENAME has no handler, see if VISIT has one. */
4769 if (NILP (handler
) && STRINGP (visit
))
4770 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4772 if (!NILP (handler
))
4775 val
= call8 (handler
, Qwrite_region
, start
, end
,
4776 filename
, append
, visit
, lockname
, mustbenew
);
4780 SAVE_MODIFF
= MODIFF
;
4781 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4782 bset_filename (current_buffer
, visit_file
);
4788 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4790 /* Special kludge to simplify auto-saving. */
4793 /* Do it later, so write-region-annotate-function can work differently
4794 if we save "the buffer" vs "a region".
4795 This is useful in tar-mode. --Stef
4796 XSETFASTINT (start, BEG);
4797 XSETFASTINT (end, Z); */
4801 record_unwind_protect (build_annotations_unwind
,
4802 Vwrite_region_annotation_buffers
);
4803 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4805 given_buffer
= current_buffer
;
4807 if (!STRINGP (start
))
4809 annotations
= build_annotations (start
, end
);
4811 if (current_buffer
!= given_buffer
)
4813 XSETFASTINT (start
, BEGV
);
4814 XSETFASTINT (end
, ZV
);
4820 XSETFASTINT (start
, BEGV
);
4821 XSETFASTINT (end
, ZV
);
4824 /* Decide the coding-system to encode the data with.
4825 We used to make this choice before calling build_annotations, but that
4826 leads to problems when a write-annotate-function takes care of
4827 unsavable chars (as was the case with X-Symbol). */
4828 Vlast_coding_system_used
4829 = choose_write_coding_system (start
, end
, filename
,
4830 append
, visit
, lockname
, &coding
);
4832 if (open_and_close_file
&& !auto_saving
)
4834 lock_file (lockname
);
4838 encoded_filename
= ENCODE_FILE (filename
);
4839 fn
= SSDATA (encoded_filename
);
4840 open_flags
= O_WRONLY
| O_CREAT
;
4841 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4842 if (NUMBERP (append
))
4843 offset
= file_offset (append
);
4844 else if (!NILP (append
))
4845 open_flags
|= O_APPEND
;
4847 mode
= S_IREAD
| S_IWRITE
;
4849 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4852 if (open_and_close_file
)
4854 desc
= emacs_open (fn
, open_flags
, mode
);
4857 int open_errno
= errno
;
4859 unlock_file (lockname
);
4860 report_file_errno ("Opening output file", filename
, open_errno
);
4863 count1
= SPECPDL_INDEX ();
4864 record_unwind_protect_int (close_file_unwind
, desc
);
4867 if (NUMBERP (append
))
4869 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4872 int lseek_errno
= errno
;
4874 unlock_file (lockname
);
4875 report_file_errno ("Lseek error", filename
, lseek_errno
);
4879 if (STRINGP (start
))
4880 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4881 else if (XINT (start
) != XINT (end
))
4882 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4883 &annotations
, &coding
);
4886 /* If file was empty, still need to write the annotations. */
4887 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4888 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4892 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4893 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4895 /* We have to flush out a data. */
4896 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4897 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4901 /* fsync is not crucial for temporary files. Nor for auto-save
4902 files, since they might lose some work anyway. */
4903 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4905 /* Transfer data and metadata to disk, retrying if interrupted.
4906 fsync can report a write failure here, e.g., due to disk full
4907 under NFS. But ignore EINVAL, which means fsync is not
4908 supported on this file. */
4909 while (fsync (desc
) != 0)
4912 if (errno
!= EINVAL
)
4913 ok
= 0, save_errno
= errno
;
4918 modtime
= invalid_timespec ();
4921 if (fstat (desc
, &st
) == 0)
4922 modtime
= get_stat_mtime (&st
);
4924 ok
= 0, save_errno
= errno
;
4927 if (open_and_close_file
)
4929 /* NFS can report a write failure now. */
4930 if (emacs_close (desc
) < 0)
4931 ok
= 0, save_errno
= errno
;
4933 /* Discard the unwind protect for close_file_unwind. */
4934 specpdl_ptr
= specpdl
+ count1
;
4937 /* Some file systems have a bug where st_mtime is not updated
4938 properly after a write. For example, CIFS might not see the
4939 st_mtime change until after the file is opened again.
4941 Attempt to detect this file system bug, and update MODTIME to the
4942 newer st_mtime if the bug appears to be present. This introduces
4943 a race condition, so to avoid most instances of the race condition
4944 on non-buggy file systems, skip this check if the most recently
4945 encountered non-buggy file system was the current file system.
4947 A race condition can occur if some other process modifies the
4948 file between the fstat above and the fstat below, but the race is
4949 unlikely and a similar race between the last write and the fstat
4950 above cannot possibly be closed anyway. */
4952 if (timespec_valid_p (modtime
)
4953 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4955 int desc1
= emacs_open (fn
, O_WRONLY
, 0);
4959 if (fstat (desc1
, &st1
) == 0
4960 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4962 /* Use the heuristic if it appears to be valid. With neither
4963 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4964 file, the time stamp won't change. Also, some non-POSIX
4965 systems don't update an empty file's time stamp when
4966 truncating it. Finally, file systems with 100 ns or worse
4967 resolution sometimes seem to have bugs: on a system with ns
4968 resolution, checking ns % 100 incorrectly avoids the heuristic
4969 1% of the time, but the problem should be temporary as we will
4970 try again on the next time stamp. */
4972 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4974 && modtime
.tv_nsec
% 100 != 0);
4976 struct timespec modtime1
= get_stat_mtime (&st1
);
4978 && timespec_cmp (modtime
, modtime1
) == 0
4979 && st
.st_size
== st1
.st_size
)
4981 timestamp_file_system
= st
.st_dev
;
4982 valid_timestamp_file_system
= 1;
4986 st
.st_size
= st1
.st_size
;
4990 emacs_close (desc1
);
4994 /* Call write-region-post-annotation-function. */
4995 while (CONSP (Vwrite_region_annotation_buffers
))
4997 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4998 if (!NILP (Fbuffer_live_p (buf
)))
5001 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5002 call0 (Vwrite_region_post_annotation_function
);
5004 Vwrite_region_annotation_buffers
5005 = XCDR (Vwrite_region_annotation_buffers
);
5008 unbind_to (count
, Qnil
);
5011 unlock_file (lockname
);
5013 /* Do this before reporting IO error
5014 to avoid a "file has changed on disk" warning on
5015 next attempt to save. */
5016 if (timespec_valid_p (modtime
))
5018 current_buffer
->modtime
= modtime
;
5019 current_buffer
->modtime_size
= st
.st_size
;
5023 report_file_errno ("Write error", filename
, save_errno
);
5025 bool auto_saving_into_visited_file
=
5027 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5028 BVAR (current_buffer
, auto_save_file_name
)));
5031 SAVE_MODIFF
= MODIFF
;
5032 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5033 bset_filename (current_buffer
, visit_file
);
5034 update_mode_lines
= 14;
5035 if (auto_saving_into_visited_file
)
5036 unlock_file (lockname
);
5040 if (auto_saving_into_visited_file
)
5042 SAVE_MODIFF
= MODIFF
;
5043 unlock_file (lockname
);
5049 if (!auto_saving
&& !noninteractive
)
5050 message_with_string ((NUMBERP (append
)
5060 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5061 doc
: /* Return t if (car A) is numerically less than (car B). */)
5062 (Lisp_Object a
, Lisp_Object b
)
5064 return arithcompare (Fcar (a
), Fcar (b
), ARITH_LESS
);
5067 /* Build the complete list of annotations appropriate for writing out
5068 the text between START and END, by calling all the functions in
5069 write-region-annotate-functions and merging the lists they return.
5070 If one of these functions switches to a different buffer, we assume
5071 that buffer contains altered text. Therefore, the caller must
5072 make sure to restore the current buffer in all cases,
5073 as save-excursion would do. */
5076 build_annotations (Lisp_Object start
, Lisp_Object end
)
5078 Lisp_Object annotations
;
5080 Lisp_Object original_buffer
;
5082 bool used_global
= false;
5084 XSETBUFFER (original_buffer
, current_buffer
);
5087 p
= Vwrite_region_annotate_functions
;
5090 struct buffer
*given_buffer
= current_buffer
;
5091 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5092 { /* Use the global value of the hook. */
5095 Fdefault_value (Qwrite_region_annotate_functions
),
5099 Vwrite_region_annotations_so_far
= annotations
;
5100 res
= call2 (XCAR (p
), start
, end
);
5101 /* If the function makes a different buffer current,
5102 assume that means this buffer contains altered text to be output.
5103 Reset START and END from the buffer bounds
5104 and discard all previous annotations because they should have
5105 been dealt with by this function. */
5106 if (current_buffer
!= given_buffer
)
5108 Vwrite_region_annotation_buffers
5109 = Fcons (Fcurrent_buffer (),
5110 Vwrite_region_annotation_buffers
);
5111 XSETFASTINT (start
, BEGV
);
5112 XSETFASTINT (end
, ZV
);
5115 Flength (res
); /* Check basic validity of return value */
5116 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5120 /* Now do the same for annotation functions implied by the file-format */
5121 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5122 p
= BVAR (current_buffer
, auto_save_file_format
);
5124 p
= BVAR (current_buffer
, file_format
);
5125 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5127 struct buffer
*given_buffer
= current_buffer
;
5129 Vwrite_region_annotations_so_far
= annotations
;
5131 /* Value is either a list of annotations or nil if the function
5132 has written annotations to a temporary buffer, which is now
5134 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5135 original_buffer
, make_number (i
));
5136 if (current_buffer
!= given_buffer
)
5138 XSETFASTINT (start
, BEGV
);
5139 XSETFASTINT (end
, ZV
);
5144 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5151 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5152 If STRING is nil, POS is the character position in the current buffer.
5153 Intersperse with them the annotations from *ANNOT
5154 which fall within the range of POS to POS + NCHARS,
5155 each at its appropriate position.
5157 We modify *ANNOT by discarding elements as we use them up.
5159 Return true if successful. */
5162 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5163 ptrdiff_t nchars
, Lisp_Object
*annot
,
5164 struct coding_system
*coding
)
5168 ptrdiff_t lastpos
= pos
+ nchars
;
5170 while (NILP (*annot
) || CONSP (*annot
))
5172 tem
= Fcar_safe (Fcar (*annot
));
5175 nextpos
= XFASTINT (tem
);
5177 /* If there are no more annotations in this range,
5178 output the rest of the range all at once. */
5179 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5180 return e_write (desc
, string
, pos
, lastpos
, coding
);
5182 /* Output buffer text up to the next annotation's position. */
5185 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5189 /* Output the annotation. */
5190 tem
= Fcdr (Fcar (*annot
));
5193 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5196 *annot
= Fcdr (*annot
);
5201 /* Maximum number of characters that the next
5202 function encodes per one loop iteration. */
5204 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5206 /* Write text in the range START and END into descriptor DESC,
5207 encoding them with coding system CODING. If STRING is nil, START
5208 and END are character positions of the current buffer, else they
5209 are indexes to the string STRING. Return true if successful. */
5212 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5213 struct coding_system
*coding
)
5215 if (STRINGP (string
))
5218 end
= SCHARS (string
);
5221 /* We used to have a code for handling selective display here. But,
5222 now it is handled within encode_coding. */
5226 if (STRINGP (string
))
5228 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5229 if (CODING_REQUIRE_ENCODING (coding
))
5231 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5233 /* Avoid creating huge Lisp string in encode_coding_object. */
5234 if (nchars
== E_WRITE_MAX
)
5235 coding
->raw_destination
= 1;
5237 encode_coding_object
5238 (coding
, string
, start
, string_char_to_byte (string
, start
),
5239 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5244 coding
->dst_object
= string
;
5245 coding
->consumed_char
= SCHARS (string
);
5246 coding
->produced
= SBYTES (string
);
5251 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5252 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5254 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5255 if (CODING_REQUIRE_ENCODING (coding
))
5257 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5260 if (nchars
== E_WRITE_MAX
)
5261 coding
->raw_destination
= 1;
5263 encode_coding_object
5264 (coding
, Fcurrent_buffer (), start
, start_byte
,
5265 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5269 coding
->dst_object
= Qnil
;
5270 coding
->dst_pos_byte
= start_byte
;
5271 if (start
>= GPT
|| end
<= GPT
)
5273 coding
->consumed_char
= end
- start
;
5274 coding
->produced
= end_byte
- start_byte
;
5278 coding
->consumed_char
= GPT
- start
;
5279 coding
->produced
= GPT_BYTE
- start_byte
;
5284 if (coding
->produced
> 0)
5286 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5287 : (STRINGP (coding
->dst_object
)
5288 ? SSDATA (coding
->dst_object
)
5289 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5290 coding
->produced
-= emacs_write_quit (desc
, buf
, coding
->produced
);
5292 if (coding
->raw_destination
)
5294 /* We're responsible for freeing this, see
5295 encode_coding_object to check why. */
5296 xfree (coding
->destination
);
5297 coding
->raw_destination
= 0;
5299 if (coding
->produced
)
5302 start
+= coding
->consumed_char
;
5308 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5309 Sverify_visited_file_modtime
, 0, 1, 0,
5310 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5311 This means that the file has not been changed since it was visited or saved.
5312 If BUF is omitted or nil, it defaults to the current buffer.
5313 See Info node `(elisp)Modification Time' for more details. */)
5316 struct buffer
*b
= decode_buffer (buf
);
5318 Lisp_Object handler
;
5319 Lisp_Object filename
;
5320 struct timespec mtime
;
5322 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5323 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5325 /* If the file name has special constructs in it,
5326 call the corresponding file handler. */
5327 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5328 Qverify_visited_file_modtime
);
5329 if (!NILP (handler
))
5330 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5332 filename
= ENCODE_FILE (BVAR (b
, filename
));
5334 mtime
= (stat (SSDATA (filename
), &st
) == 0
5335 ? get_stat_mtime (&st
)
5336 : time_error_value (errno
));
5337 if (timespec_cmp (mtime
, b
->modtime
) == 0
5338 && (b
->modtime_size
< 0
5339 || st
.st_size
== b
->modtime_size
))
5344 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5345 Svisited_file_modtime
, 0, 0, 0,
5346 doc
: /* Return the current buffer's recorded visited file modification time.
5347 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5348 `file-attributes' returns. If the current buffer has no recorded file
5349 modification time, this function returns 0. If the visited file
5350 doesn't exist, return -1.
5351 See Info node `(elisp)Modification Time' for more details. */)
5354 int ns
= current_buffer
->modtime
.tv_nsec
;
5356 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5357 return make_lisp_time (current_buffer
->modtime
);
5360 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5361 Sset_visited_file_modtime
, 0, 1, 0,
5362 doc
: /* Update buffer's recorded modification time from the visited file's time.
5363 Useful if the buffer was not read from the file normally
5364 or if the file itself has been changed for some known benign reason.
5365 An argument specifies the modification time value to use
5366 \(instead of that of the visited file), in the form of a list
5367 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5368 `visited-file-modtime'. */)
5369 (Lisp_Object time_flag
)
5371 if (!NILP (time_flag
))
5373 struct timespec mtime
;
5374 if (INTEGERP (time_flag
))
5376 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5377 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5380 mtime
= lisp_time_argument (time_flag
);
5382 current_buffer
->modtime
= mtime
;
5383 current_buffer
->modtime_size
= -1;
5387 register Lisp_Object filename
;
5389 Lisp_Object handler
;
5391 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5393 /* If the file name has special constructs in it,
5394 call the corresponding file handler. */
5395 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5396 if (!NILP (handler
))
5397 /* The handler can find the file name the same way we did. */
5398 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5400 filename
= ENCODE_FILE (filename
);
5402 if (stat (SSDATA (filename
), &st
) >= 0)
5404 current_buffer
->modtime
= get_stat_mtime (&st
);
5405 current_buffer
->modtime_size
= st
.st_size
;
5413 auto_save_error (Lisp_Object error_val
)
5415 auto_save_error_occurred
= 1;
5417 ring_bell (XFRAME (selected_frame
));
5419 AUTO_STRING (format
, "Auto-saving %s: %s");
5420 Lisp_Object msg
= CALLN (Fformat
, format
, BVAR (current_buffer
, name
),
5421 Ferror_message_string (error_val
));
5422 call3 (intern ("display-warning"),
5423 intern ("auto-save"), msg
, intern ("error"));
5434 auto_save_mode_bits
= 0666;
5436 /* Get visited file's mode to become the auto save file's mode. */
5437 if (! NILP (BVAR (current_buffer
, filename
)))
5439 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5440 /* But make sure we can overwrite it later! */
5441 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5442 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5444 /* Remote files don't cooperate with stat. */
5445 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5449 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5450 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5454 struct auto_save_unwind
5461 do_auto_save_unwind (void *arg
)
5463 struct auto_save_unwind
*p
= arg
;
5464 FILE *stream
= p
->stream
;
5465 minibuffer_auto_raise
= p
->auto_raise
;
5476 do_auto_save_make_dir (Lisp_Object dir
)
5480 auto_saving_dir_umask
= 077;
5481 result
= call2 (Qmake_directory
, dir
, Qt
);
5482 auto_saving_dir_umask
= 0;
5487 do_auto_save_eh (Lisp_Object ignore
)
5489 auto_saving_dir_umask
= 0;
5493 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5494 doc
: /* Auto-save all buffers that need it.
5495 This is all buffers that have auto-saving enabled
5496 and are changed since last auto-saved.
5497 Auto-saving writes the buffer into a file
5498 so that your editing is not lost if the system crashes.
5499 This file is not the file you visited; that changes only when you save.
5500 Normally, run the normal hook `auto-save-hook' before saving.
5502 A non-nil NO-MESSAGE argument means do not print any message if successful.
5503 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5504 (Lisp_Object no_message
, Lisp_Object current_only
)
5506 struct buffer
*old
= current_buffer
, *b
;
5507 Lisp_Object tail
, buf
, hook
;
5508 bool auto_saved
= 0;
5509 int do_handled_files
;
5511 FILE *stream
= NULL
;
5512 ptrdiff_t count
= SPECPDL_INDEX ();
5513 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5514 bool old_message_p
= 0;
5515 struct auto_save_unwind auto_save_unwind
;
5517 if (max_specpdl_size
< specpdl_size
+ 40)
5518 max_specpdl_size
= specpdl_size
+ 40;
5523 if (NILP (no_message
))
5525 old_message_p
= push_message ();
5526 record_unwind_protect_void (pop_message_unwind
);
5529 /* Ordinarily don't quit within this function,
5530 but don't make it impossible to quit (in case we get hung in I/O). */
5534 hook
= intern ("auto-save-hook");
5535 safe_run_hooks (hook
);
5537 if (STRINGP (Vauto_save_list_file_name
))
5539 Lisp_Object listfile
;
5541 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5543 /* Don't try to create the directory when shutting down Emacs,
5544 because creating the directory might signal an error, and
5545 that would leave Emacs in a strange state. */
5546 if (!NILP (Vrun_hooks
))
5549 dir
= Ffile_name_directory (listfile
);
5550 if (NILP (Ffile_directory_p (dir
)))
5551 internal_condition_case_1 (do_auto_save_make_dir
,
5556 stream
= emacs_fopen (SSDATA (listfile
), "w");
5559 auto_save_unwind
.stream
= stream
;
5560 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5561 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5562 minibuffer_auto_raise
= 0;
5564 auto_save_error_occurred
= 0;
5566 /* On first pass, save all files that don't have handlers.
5567 On second pass, save all files that do have handlers.
5569 If Emacs is crashing, the handlers may tweak what is causing
5570 Emacs to crash in the first place, and it would be a shame if
5571 Emacs failed to autosave perfectly ordinary files because it
5572 couldn't handle some ange-ftp'd file. */
5574 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5575 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5579 /* Record all the buffers that have auto save mode
5580 in the special file that lists them. For each of these buffers,
5581 Record visited name (if any) and auto save name. */
5582 if (STRINGP (BVAR (b
, auto_save_file_name
))
5583 && stream
!= NULL
&& do_handled_files
== 0)
5586 if (!NILP (BVAR (b
, filename
)))
5587 fwrite_unlocked (SDATA (BVAR (b
, filename
)), 1,
5588 SBYTES (BVAR (b
, filename
)), stream
);
5589 putc_unlocked ('\n', stream
);
5590 fwrite_unlocked (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5591 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5592 putc_unlocked ('\n', stream
);
5596 if (!NILP (current_only
)
5597 && b
!= current_buffer
)
5600 /* Don't auto-save indirect buffers.
5601 The base buffer takes care of it. */
5605 /* Check for auto save enabled
5606 and file changed since last auto save
5607 and file changed since last real save. */
5608 if (STRINGP (BVAR (b
, auto_save_file_name
))
5609 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5610 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5611 /* -1 means we've turned off autosaving for a while--see below. */
5612 && XINT (BVAR (b
, save_length
)) >= 0
5613 && (do_handled_files
5614 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5617 struct timespec before_time
= current_timespec ();
5618 struct timespec after_time
;
5620 /* If we had a failure, don't try again for 20 minutes. */
5621 if (b
->auto_save_failure_time
> 0
5622 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5625 set_buffer_internal (b
);
5626 if (NILP (Vauto_save_include_big_deletions
)
5627 && (XFASTINT (BVAR (b
, save_length
)) * 10
5628 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5629 /* A short file is likely to change a large fraction;
5630 spare the user annoying messages. */
5631 && XFASTINT (BVAR (b
, save_length
)) > 5000
5632 /* These messages are frequent and annoying for `*mail*'. */
5633 && !EQ (BVAR (b
, filename
), Qnil
)
5634 && NILP (no_message
))
5636 /* It has shrunk too much; turn off auto-saving here. */
5637 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5638 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5640 minibuffer_auto_raise
= 0;
5641 /* Turn off auto-saving until there's a real save,
5642 and prevent any more warnings. */
5643 XSETINT (BVAR (b
, save_length
), -1);
5644 Fsleep_for (make_number (1), Qnil
);
5647 if (!auto_saved
&& NILP (no_message
))
5648 message1 ("Auto-saving...");
5649 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5651 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5652 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5653 set_buffer_internal (old
);
5655 after_time
= current_timespec ();
5657 /* If auto-save took more than 60 seconds,
5658 assume it was an NFS failure that got a timeout. */
5659 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5660 b
->auto_save_failure_time
= after_time
.tv_sec
;
5664 /* Prevent another auto save till enough input events come in. */
5665 record_auto_save ();
5667 if (auto_saved
&& NILP (no_message
))
5671 /* If we are going to restore an old message,
5672 give time to read ours. */
5673 sit_for (make_number (1), 0, 0);
5676 else if (!auto_save_error_occurred
)
5677 /* Don't overwrite the error message if an error occurred.
5678 If we displayed a message and then restored a state
5679 with no message, leave a "done" message on the screen. */
5680 message1 ("Auto-saving...done");
5685 /* This restores the message-stack status. */
5686 unbind_to (count
, Qnil
);
5690 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5691 Sset_buffer_auto_saved
, 0, 0, 0,
5692 doc
: /* Mark current buffer as auto-saved with its current text.
5693 No auto-save file will be written until the buffer changes again. */)
5696 /* FIXME: This should not be called in indirect buffers, since
5697 they're not autosaved. */
5698 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5699 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5700 current_buffer
->auto_save_failure_time
= 0;
5704 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5705 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5706 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5709 current_buffer
->auto_save_failure_time
= 0;
5713 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5715 doc
: /* Return t if current buffer has been auto-saved recently.
5716 More precisely, if it has been auto-saved since last read from or saved
5717 in the visited file. If the buffer has no visited file,
5718 then any auto-save counts as "recent". */)
5721 /* FIXME: maybe we should return nil for indirect buffers since
5722 they're never autosaved. */
5723 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5726 /* Reading and completing file names. */
5728 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5729 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5730 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5731 The return value is only relevant for a call to `read-file-name' that happens
5732 before any other event (mouse or keypress) is handled. */)
5735 #if (defined USE_GTK || defined USE_MOTIF \
5736 || defined HAVE_NS || defined HAVE_NTGUI)
5737 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5740 && window_system_available (SELECTED_FRAME ()))
5747 DEFUN ("set-binary-mode", Fset_binary_mode
, Sset_binary_mode
, 2, 2, 0,
5748 doc
: /* Switch STREAM to binary I/O mode or text I/O mode.
5749 STREAM can be one of the symbols `stdin', `stdout', or `stderr'.
5750 If MODE is non-nil, switch STREAM to binary mode, otherwise switch
5753 As a side effect, this function flushes any pending STREAM's data.
5755 Value is the previous value of STREAM's I/O mode, nil for text mode,
5756 non-nil for binary mode.
5758 On MS-Windows and MS-DOS, binary mode is needed to read or write
5759 arbitrary binary data, and for disabling translation between CR-LF
5760 pairs and a single newline character. Examples include generation
5761 of text files with Unix-style end-of-line format using `princ' in
5762 batch mode, with standard output redirected to a file.
5764 On Posix systems, this function always returns non-nil, and has no
5765 effect except for flushing STREAM's data. */)
5766 (Lisp_Object stream
, Lisp_Object mode
)
5771 CHECK_SYMBOL (stream
);
5772 if (EQ (stream
, Qstdin
))
5774 else if (EQ (stream
, Qstdout
))
5776 else if (EQ (stream
, Qstderr
))
5779 xsignal2 (Qerror
, build_string ("unsupported stream"), stream
);
5781 binmode
= NILP (mode
) ? O_TEXT
: O_BINARY
;
5783 fflush_unlocked (fp
);
5785 return (set_binary_mode (fileno (fp
), binmode
) == O_BINARY
) ? Qt
: Qnil
;
5791 realmask
= umask (0);
5794 valid_timestamp_file_system
= 0;
5796 /* fsync can be a significant performance hit. Often it doesn't
5797 suffice to make the file-save operation survive a crash. For
5798 batch scripts, which are typically part of larger shell commands
5799 that don't fsync other files, its effect on performance can be
5800 significant so its utility is particularly questionable.
5801 Hence, for now by default fsync is used only when interactive.
5803 For more on why fsync often fails to work on today's hardware, see:
5804 Zheng M et al. Understanding the robustness of SSDs under power fault.
5805 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5806 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5808 For more on why fsync does not suffice even if it works properly, see:
5809 Roche X. Necessary step(s) to synchronize filename operations on disk.
5810 Austin Group Defect 672, 2013-03-19
5811 http://austingroupbugs.net/view.php?id=672 */
5812 write_region_inhibit_fsync
= noninteractive
;
5816 syms_of_fileio (void)
5818 /* Property name of a file name handler,
5819 which gives a list of operations it handles. */
5820 DEFSYM (Qoperations
, "operations");
5822 DEFSYM (Qexpand_file_name
, "expand-file-name");
5823 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5824 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5825 DEFSYM (Qfile_name_directory
, "file-name-directory");
5826 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5827 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5828 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5829 DEFSYM (Qcopy_file
, "copy-file");
5830 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5831 DEFSYM (Qmake_directory
, "make-directory");
5832 DEFSYM (Qdelete_file
, "delete-file");
5833 DEFSYM (Qfile_name_case_insensitive_p
, "file-name-case-insensitive-p");
5834 DEFSYM (Qrename_file
, "rename-file");
5835 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5836 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5837 DEFSYM (Qfile_exists_p
, "file-exists-p");
5838 DEFSYM (Qfile_executable_p
, "file-executable-p");
5839 DEFSYM (Qfile_readable_p
, "file-readable-p");
5840 DEFSYM (Qfile_writable_p
, "file-writable-p");
5841 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5842 DEFSYM (Qaccess_file
, "access-file");
5843 DEFSYM (Qfile_directory_p
, "file-directory-p");
5844 DEFSYM (Qfile_regular_p
, "file-regular-p");
5845 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5846 DEFSYM (Qfile_modes
, "file-modes");
5847 DEFSYM (Qset_file_modes
, "set-file-modes");
5848 DEFSYM (Qset_file_times
, "set-file-times");
5849 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5850 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5851 DEFSYM (Qfile_acl
, "file-acl");
5852 DEFSYM (Qset_file_acl
, "set-file-acl");
5853 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5854 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5855 DEFSYM (Qwrite_region
, "write-region");
5856 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5857 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5859 /* The symbol bound to coding-system-for-read when
5860 insert-file-contents is called for recovering a file. This is not
5861 an actual coding system name, but just an indicator to tell
5862 insert-file-contents to use `emacs-mule' with a special flag for
5863 auto saving and recovering a file. */
5864 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5866 DEFSYM (Qfile_name_history
, "file-name-history");
5867 Fset (Qfile_name_history
, Qnil
);
5869 DEFSYM (Qfile_error
, "file-error");
5870 DEFSYM (Qfile_already_exists
, "file-already-exists");
5871 DEFSYM (Qfile_date_error
, "file-date-error");
5872 DEFSYM (Qfile_missing
, "file-missing");
5873 DEFSYM (Qfile_notify_error
, "file-notify-error");
5874 DEFSYM (Qexcl
, "excl");
5876 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5877 doc
: /* Coding system for encoding file names.
5878 If it is nil, `default-file-name-coding-system' (which see) is used.
5880 On MS-Windows, the value of this variable is largely ignored if
5881 `w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5882 behaves as if file names were encoded in `utf-8'. */);
5883 Vfile_name_coding_system
= Qnil
;
5885 DEFVAR_LISP ("default-file-name-coding-system",
5886 Vdefault_file_name_coding_system
,
5887 doc
: /* Default coding system for encoding file names.
5888 This variable is used only when `file-name-coding-system' is nil.
5890 This variable is set/changed by the command `set-language-environment'.
5891 User should not set this variable manually,
5892 instead use `file-name-coding-system' to get a constant encoding
5893 of file names regardless of the current language environment.
5895 On MS-Windows, the value of this variable is largely ignored if
5896 `w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5897 behaves as if file names were encoded in `utf-8'. */);
5898 Vdefault_file_name_coding_system
= Qnil
;
5900 /* Lisp functions for translating file formats. */
5901 DEFSYM (Qformat_decode
, "format-decode");
5902 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5904 /* Lisp function for setting buffer-file-coding-system and the
5905 multibyteness of the current buffer after inserting a file. */
5906 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5908 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5910 Fput (Qfile_error
, Qerror_conditions
,
5911 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5912 Fput (Qfile_error
, Qerror_message
,
5913 build_pure_c_string ("File error"));
5915 Fput (Qfile_already_exists
, Qerror_conditions
,
5916 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5917 Fput (Qfile_already_exists
, Qerror_message
,
5918 build_pure_c_string ("File already exists"));
5920 Fput (Qfile_date_error
, Qerror_conditions
,
5921 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5922 Fput (Qfile_date_error
, Qerror_message
,
5923 build_pure_c_string ("Cannot set file date"));
5925 Fput (Qfile_missing
, Qerror_conditions
,
5926 Fpurecopy (list3 (Qfile_missing
, Qfile_error
, Qerror
)));
5927 Fput (Qfile_missing
, Qerror_message
,
5928 build_pure_c_string ("File is missing"));
5930 Fput (Qfile_notify_error
, Qerror_conditions
,
5931 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5932 Fput (Qfile_notify_error
, Qerror_message
,
5933 build_pure_c_string ("File notification error"));
5935 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5936 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5937 If a file name matches REGEXP, all I/O on that file is done by calling
5938 HANDLER. If a file name matches more than one handler, the handler
5939 whose match starts last in the file name gets precedence. The
5940 function `find-file-name-handler' checks this list for a handler for
5943 HANDLER should be a function. The first argument given to it is the
5944 name of the I/O primitive to be handled; the remaining arguments are
5945 the arguments that were passed to that primitive. For example, if you
5946 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5947 HANDLER is called like this:
5949 (funcall HANDLER \\='file-exists-p FILENAME)
5951 Note that HANDLER must be able to handle all I/O primitives; if it has
5952 nothing special to do for a primitive, it should reinvoke the
5953 primitive to handle the operation \"the usual way\".
5954 See Info node `(elisp)Magic File Names' for more details. */);
5955 Vfile_name_handler_alist
= Qnil
;
5957 DEFVAR_LISP ("set-auto-coding-function",
5958 Vset_auto_coding_function
,
5959 doc
: /* If non-nil, a function to call to decide a coding system of file.
5960 Two arguments are passed to this function: the file name
5961 and the length of a file contents following the point.
5962 This function should return a coding system to decode the file contents.
5963 It should check the file name against `auto-coding-alist'.
5964 If no coding system is decided, it should check a coding system
5965 specified in the heading lines with the format:
5966 -*- ... coding: CODING-SYSTEM; ... -*-
5967 or local variable spec of the tailing lines with `coding:' tag. */);
5968 Vset_auto_coding_function
= Qnil
;
5970 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5971 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5972 Each is passed one argument, the number of characters inserted,
5973 with point at the start of the inserted text. Each function
5974 should leave point the same, and return the new character count.
5975 If `insert-file-contents' is intercepted by a handler from
5976 `file-name-handler-alist', that handler is responsible for calling the
5977 functions in `after-insert-file-functions' if appropriate. */);
5978 Vafter_insert_file_functions
= Qnil
;
5980 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5981 doc
: /* A list of functions to be called at the start of `write-region'.
5982 Each is passed two arguments, START and END as for `write-region'.
5983 These are usually two numbers but not always; see the documentation
5984 for `write-region'. The function should return a list of pairs
5985 of the form (POSITION . STRING), consisting of strings to be effectively
5986 inserted at the specified positions of the file being written (1 means to
5987 insert before the first byte written). The POSITIONs must be sorted into
5990 If there are several annotation functions, the lists returned by these
5991 functions are merged destructively. As each annotation function runs,
5992 the variable `write-region-annotations-so-far' contains a list of all
5993 annotations returned by previous annotation functions.
5995 An annotation function can return with a different buffer current.
5996 Doing so removes the annotations returned by previous functions, and
5997 resets START and END to `point-min' and `point-max' of the new buffer.
5999 After `write-region' completes, Emacs calls the function stored in
6000 `write-region-post-annotation-function', once for each buffer that was
6001 current when building the annotations (i.e., at least once), with that
6002 buffer current. */);
6003 Vwrite_region_annotate_functions
= Qnil
;
6004 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
6006 DEFVAR_LISP ("write-region-post-annotation-function",
6007 Vwrite_region_post_annotation_function
,
6008 doc
: /* Function to call after `write-region' completes.
6009 The function is called with no arguments. If one or more of the
6010 annotation functions in `write-region-annotate-functions' changed the
6011 current buffer, the function stored in this variable is called for
6012 each of those additional buffers as well, in addition to the original
6013 buffer. The relevant buffer is current during each function call. */);
6014 Vwrite_region_post_annotation_function
= Qnil
;
6015 staticpro (&Vwrite_region_annotation_buffers
);
6017 DEFVAR_LISP ("write-region-annotations-so-far",
6018 Vwrite_region_annotations_so_far
,
6019 doc
: /* When an annotation function is called, this holds the previous annotations.
6020 These are the annotations made by other annotation functions
6021 that were already called. See also `write-region-annotate-functions'. */);
6022 Vwrite_region_annotations_so_far
= Qnil
;
6024 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6025 doc
: /* A list of file name handlers that temporarily should not be used.
6026 This applies only to the operation `inhibit-file-name-operation'. */);
6027 Vinhibit_file_name_handlers
= Qnil
;
6029 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6030 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6031 Vinhibit_file_name_operation
= Qnil
;
6033 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6034 doc
: /* File name in which to write a list of all auto save file names.
6035 This variable is initialized automatically from `auto-save-list-file-prefix'
6036 shortly after Emacs reads your init file, if you have not yet given it
6037 a non-nil value. */);
6038 Vauto_save_list_file_name
= Qnil
;
6040 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6041 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6042 Normally auto-save files are written under other names. */);
6043 Vauto_save_visited_file_name
= Qnil
;
6045 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6046 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6047 If nil, deleting a substantial portion of the text disables auto-save
6048 in the buffer; this is the default behavior, because the auto-save
6049 file is usually more useful if it contains the deleted text. */);
6050 Vauto_save_include_big_deletions
= Qnil
;
6052 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6053 doc
: /* Non-nil means don't call fsync in `write-region'.
6054 This variable affects calls to `write-region' as well as save commands.
6055 Setting this to nil may avoid data loss if the system loses power or
6056 the operating system crashes. By default, it is non-nil in batch mode. */);
6057 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6059 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6060 doc
: /* Specifies whether to use the system's trash can.
6061 When non-nil, certain file deletion commands use the function
6062 `move-file-to-trash' instead of deleting files outright.
6063 This includes interactive calls to `delete-file' and
6064 `delete-directory' and the Dired deletion commands. */);
6065 delete_by_moving_to_trash
= 0;
6066 DEFSYM (Qdelete_by_moving_to_trash
, "delete-by-moving-to-trash");
6068 /* Lisp function for moving files to trash. */
6069 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6071 /* Lisp function for recursively copying directories. */
6072 DEFSYM (Qcopy_directory
, "copy-directory");
6074 /* Lisp function for recursively deleting directories. */
6075 DEFSYM (Qdelete_directory
, "delete-directory");
6077 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");
6078 DEFSYM (Qget_buffer_window_list
, "get-buffer-window-list");
6080 DEFSYM (Qstdin
, "stdin");
6081 DEFSYM (Qstdout
, "stdout");
6082 DEFSYM (Qstderr
, "stderr");
6084 defsubr (&Sfind_file_name_handler
);
6085 defsubr (&Sfile_name_directory
);
6086 defsubr (&Sfile_name_nondirectory
);
6087 defsubr (&Sunhandled_file_name_directory
);
6088 defsubr (&Sfile_name_as_directory
);
6089 defsubr (&Sdirectory_name_p
);
6090 defsubr (&Sdirectory_file_name
);
6091 defsubr (&Smake_temp_file_internal
);
6092 defsubr (&Smake_temp_name
);
6093 defsubr (&Sexpand_file_name
);
6094 defsubr (&Ssubstitute_in_file_name
);
6095 defsubr (&Scopy_file
);
6096 defsubr (&Smake_directory_internal
);
6097 defsubr (&Sdelete_directory_internal
);
6098 defsubr (&Sdelete_file
);
6099 defsubr (&Sfile_name_case_insensitive_p
);
6100 defsubr (&Srename_file
);
6101 defsubr (&Sadd_name_to_file
);
6102 defsubr (&Smake_symbolic_link
);
6103 defsubr (&Sfile_name_absolute_p
);
6104 defsubr (&Sfile_exists_p
);
6105 defsubr (&Sfile_executable_p
);
6106 defsubr (&Sfile_readable_p
);
6107 defsubr (&Sfile_writable_p
);
6108 defsubr (&Saccess_file
);
6109 defsubr (&Sfile_symlink_p
);
6110 defsubr (&Sfile_directory_p
);
6111 defsubr (&Sfile_accessible_directory_p
);
6112 defsubr (&Sfile_regular_p
);
6113 defsubr (&Sfile_modes
);
6114 defsubr (&Sset_file_modes
);
6115 defsubr (&Sset_file_times
);
6116 defsubr (&Sfile_selinux_context
);
6117 defsubr (&Sfile_acl
);
6118 defsubr (&Sset_file_acl
);
6119 defsubr (&Sset_file_selinux_context
);
6120 defsubr (&Sset_default_file_modes
);
6121 defsubr (&Sdefault_file_modes
);
6122 defsubr (&Sfile_newer_than_file_p
);
6123 defsubr (&Sinsert_file_contents
);
6124 defsubr (&Swrite_region
);
6125 defsubr (&Scar_less_than_car
);
6126 defsubr (&Sverify_visited_file_modtime
);
6127 defsubr (&Svisited_file_modtime
);
6128 defsubr (&Sset_visited_file_modtime
);
6129 defsubr (&Sdo_auto_save
);
6130 defsubr (&Sset_buffer_auto_saved
);
6131 defsubr (&Sclear_buffer_auto_save_failure
);
6132 defsubr (&Srecent_auto_save_p
);
6134 defsubr (&Snext_read_file_uses_dialog_p
);
6136 defsubr (&Sset_binary_mode
);
6139 defsubr (&Sunix_sync
);