1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2015 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
39 #ifdef HAVE_ACL_SET_FILE
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
52 #include "region-cache.h"
54 #include "dispextern.h"
61 #endif /* not WINDOWSNT */
65 #include <sys/param.h>
69 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
70 redirector allows the six letters between 'Z' and 'a' as well. */
72 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
75 #define IS_DRIVE(x) c_isalpha (x)
77 /* Need to lower-case the drive letter, or else expanded
78 filenames will sometimes compare unequal, because
79 `expand-file-name' doesn't always down-case the drive letter. */
80 #define DRIVE_LETTER(x) c_tolower (x)
85 #include <allocator.h>
86 #include <careadlinkat.h>
87 #include <stat-time.h>
89 #include <binary-io.h>
97 /* True during writing of auto-save files. */
98 static bool auto_saving
;
100 /* Emacs's real umask. */
101 static mode_t realmask
;
103 /* Nonzero umask during creation of auto-save directories. */
104 static mode_t auto_saving_dir_umask
;
106 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
107 a new file with the same mode as the original. */
108 static mode_t auto_save_mode_bits
;
110 /* Set by auto_save_1 if an error occurred during the last auto-save. */
111 static bool auto_save_error_occurred
;
113 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
114 number of a file system where time stamps were observed to to work. */
115 static bool valid_timestamp_file_system
;
116 static dev_t timestamp_file_system
;
118 /* Each time an annotation function changes the buffer, the new buffer
120 static Lisp_Object Vwrite_region_annotation_buffers
;
122 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
123 Lisp_Object
*, struct coding_system
*);
124 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
125 struct coding_system
*);
128 /* Return true if FILENAME exists. */
131 check_existing (const char *filename
)
133 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
136 /* Return true if file FILENAME exists and can be executed. */
139 check_executable (char *filename
)
141 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
144 /* Return true if file FILENAME exists and can be accessed
145 according to AMODE, which should include W_OK.
146 On failure, return false and set errno. */
149 check_writable (const char *filename
, int amode
)
152 /* FIXME: an faccessat implementation should be added to the
153 DOS/Windows ports and this #ifdef branch should be removed. */
155 if (stat (filename
, &st
) < 0)
158 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
159 #else /* not MSDOS */
160 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
162 /* faccessat may have returned failure because Cygwin couldn't
163 determine the file's UID or GID; if so, we return success. */
166 int faccessat_errno
= errno
;
168 if (stat (filename
, &st
) < 0)
170 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
171 errno
= faccessat_errno
;
175 #endif /* not MSDOS */
178 /* Signal a file-access failure. STRING describes the failure,
179 NAME the file involved, and ERRORNO the errno value.
181 If NAME is neither null nor a pair, package it up as a singleton
182 list before reporting it; this saves report_file_errno's caller the
183 trouble of preserving errno before calling list1. */
186 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
188 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
189 Lisp_Object errstring
;
192 synchronize_system_messages_locale ();
193 str
= strerror (errorno
);
194 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
195 Vlocale_coding_system
, 0);
201 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
204 /* System error messages are capitalized. Downcase the initial
205 unless it is followed by a slash. (The slash case caters to
206 error messages that begin with "I/O" or, in German, "E/A".) */
207 if (STRING_MULTIBYTE (errstring
)
208 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
212 str
= SSDATA (errstring
);
213 c
= STRING_CHAR ((unsigned char *) str
);
214 Faset (errstring
, make_number (0), make_number (downcase (c
)));
217 xsignal (Qfile_error
,
218 Fcons (build_string (string
), Fcons (errstring
, data
)));
222 /* Signal a file-access failure that set errno. STRING describes the
223 failure, NAME the file involved. When invoking this function, take
224 care to not use arguments such as build_string ("foo") that involve
225 side effects that may set errno. */
228 report_file_error (char const *string
, Lisp_Object name
)
230 report_file_errno (string
, name
, errno
);
234 close_file_unwind (int fd
)
240 fclose_unwind (void *arg
)
246 /* Restore point, having saved it as a marker. */
249 restore_point_unwind (Lisp_Object location
)
251 Fgoto_char (location
);
252 unchain_marker (XMARKER (location
));
256 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
257 Sfind_file_name_handler
, 2, 2, 0,
258 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
259 Otherwise, return nil.
260 A file name is handled if one of the regular expressions in
261 `file-name-handler-alist' matches it.
263 If OPERATION equals `inhibit-file-name-operation', then we ignore
264 any handlers that are members of `inhibit-file-name-handlers',
265 but we still do run any other handlers. This lets handlers
266 use the standard functions without calling themselves recursively. */)
267 (Lisp_Object filename
, Lisp_Object operation
)
269 /* This function must not munge the match data. */
270 Lisp_Object chain
, inhibited_handlers
, result
;
274 CHECK_STRING (filename
);
276 if (EQ (operation
, Vinhibit_file_name_operation
))
277 inhibited_handlers
= Vinhibit_file_name_handlers
;
279 inhibited_handlers
= Qnil
;
281 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
282 chain
= XCDR (chain
))
288 Lisp_Object string
= XCAR (elt
);
290 Lisp_Object handler
= XCDR (elt
);
291 Lisp_Object operations
= Qnil
;
293 if (SYMBOLP (handler
))
294 operations
= Fget (handler
, Qoperations
);
297 && (match_pos
= fast_string_match (string
, filename
)) > pos
298 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
302 handler
= XCDR (elt
);
303 tem
= Fmemq (handler
, inhibited_handlers
);
317 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
319 doc
: /* Return the directory component in file name FILENAME.
320 Return nil if FILENAME does not include a directory.
321 Otherwise return a directory name.
322 Given a Unix syntax file name, returns a string ending in slash. */)
323 (Lisp_Object filename
)
327 CHECK_STRING (filename
);
329 /* If the file name has special constructs in it,
330 call the corresponding file handler. */
331 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
334 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
336 return STRINGP (handled_name
) ? handled_name
: Qnil
;
339 char *beg
= SSDATA (filename
);
340 char const *p
= beg
+ SBYTES (filename
);
342 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
344 /* only recognize drive specifier at the beginning */
346 /* handle the "/:d:foo" and "/:foo" cases correctly */
347 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
348 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
355 /* Expansion of "c:" to drive and default directory. */
358 SAFE_ALLOCA_STRING (beg
, filename
);
359 p
= beg
+ (p
- SSDATA (filename
));
363 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
364 char *res
= alloca (MAXPATHLEN
+ 1);
367 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
369 memcpy (res
, beg
, 2);
374 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
376 size_t l
= strlen (res
);
378 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
381 p
= beg
+ strlen (beg
);
382 dostounix_filename (beg
);
383 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
384 STRING_MULTIBYTE (filename
));
387 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
388 STRING_MULTIBYTE (filename
));
390 else if (STRING_MULTIBYTE (filename
))
392 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
393 dostounix_filename (SSDATA (tem_fn
));
395 if (!NILP (Vw32_downcase_file_names
))
396 tem_fn
= Fdowncase (tem_fn
);
401 dostounix_filename (beg
);
402 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
407 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
411 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
412 Sfile_name_nondirectory
, 1, 1, 0,
413 doc
: /* Return file name FILENAME sans its directory.
414 For example, in a Unix-syntax file name,
415 this is everything after the last slash,
416 or the entire name if it contains no slash. */)
417 (Lisp_Object filename
)
419 register const char *beg
, *p
, *end
;
422 CHECK_STRING (filename
);
424 /* If the file name has special constructs in it,
425 call the corresponding file handler. */
426 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
429 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
431 if (STRINGP (handled_name
))
433 error ("Invalid handler in `file-name-handler-alist'");
436 beg
= SSDATA (filename
);
437 end
= p
= beg
+ SBYTES (filename
);
439 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
441 /* only recognize drive specifier at beginning */
443 /* handle the "/:d:foo" case correctly */
444 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
449 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
452 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
453 Sunhandled_file_name_directory
, 1, 1, 0,
454 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
455 A `directly usable' directory name is one that may be used without the
456 intervention of any file handler.
457 If FILENAME is a directly usable file itself, return
458 \(file-name-directory FILENAME).
459 If FILENAME refers to a file which is not accessible from a local process,
460 then this should return nil.
461 The `call-process' and `start-process' functions use this function to
462 get a current directory to run processes in. */)
463 (Lisp_Object filename
)
467 /* If the file name has special constructs in it,
468 call the corresponding file handler. */
469 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
472 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
474 return STRINGP (handled_name
) ? handled_name
: Qnil
;
477 return Ffile_name_directory (filename
);
480 /* Maximum number of bytes that DST will be longer than SRC
481 in file_name_as_directory. This occurs when SRCLEN == 0. */
482 enum { file_name_as_directory_slop
= 2 };
484 /* Convert from file name SRC of length SRCLEN to directory name in
485 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
486 string. On UNIX, just make sure there is a terminating /. Return
487 the length of DST in bytes. */
490 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
501 memcpy (dst
, src
, srclen
);
502 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
503 dst
[srclen
++] = DIRECTORY_SEP
;
506 dostounix_filename (dst
);
511 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
512 Sfile_name_as_directory
, 1, 1, 0,
513 doc
: /* Return a string representing the file name FILE interpreted as a directory.
514 This operation exists because a directory is also a file, but its name as
515 a directory is different from its name as a file.
516 The result can be used as the value of `default-directory'
517 or passed as second argument to `expand-file-name'.
518 For a Unix-syntax file name, just appends a slash. */)
523 Lisp_Object handler
, val
;
528 /* If the file name has special constructs in it,
529 call the corresponding file handler. */
530 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
533 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
535 if (STRINGP (handled_name
))
537 error ("Invalid handler in `file-name-handler-alist'");
541 if (!NILP (Vw32_downcase_file_names
))
542 file
= Fdowncase (file
);
544 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
545 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
546 STRING_MULTIBYTE (file
));
547 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
552 /* Convert from directory name SRC of length SRCLEN to file name in
553 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
554 string. On UNIX, just make sure there isn't a terminating /.
555 Return the length of DST in bytes. */
558 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
560 /* Process as Unix format: just remove any final slash.
561 But leave "/" and "//" unchanged. */
564 && !IS_ANY_SEP (src
[srclen
- 2])
566 && IS_DIRECTORY_SEP (src
[srclen
- 1])
567 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
570 memcpy (dst
, src
, srclen
);
573 dostounix_filename (dst
);
578 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
580 doc
: /* Returns the file name of the directory named DIRECTORY.
581 This is the name of the file that holds the data for the directory DIRECTORY.
582 This operation exists because a directory is also a file, but its name as
583 a directory is different from its name as a file.
584 In Unix-syntax, this function just removes the final slash. */)
585 (Lisp_Object directory
)
589 Lisp_Object handler
, val
;
592 CHECK_STRING (directory
);
594 /* If the file name has special constructs in it,
595 call the corresponding file handler. */
596 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
599 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
601 if (STRINGP (handled_name
))
603 error ("Invalid handler in `file-name-handler-alist'");
607 if (!NILP (Vw32_downcase_file_names
))
608 directory
= Fdowncase (directory
);
610 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
611 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
612 STRING_MULTIBYTE (directory
));
613 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
618 static const char make_temp_name_tbl
[64] =
620 'A','B','C','D','E','F','G','H',
621 'I','J','K','L','M','N','O','P',
622 'Q','R','S','T','U','V','W','X',
623 'Y','Z','a','b','c','d','e','f',
624 'g','h','i','j','k','l','m','n',
625 'o','p','q','r','s','t','u','v',
626 'w','x','y','z','0','1','2','3',
627 '4','5','6','7','8','9','-','_'
630 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
632 /* Value is a temporary file name starting with PREFIX, a string.
634 The Emacs process number forms part of the result, so there is
635 no danger of generating a name being used by another process.
636 In addition, this function makes an attempt to choose a name
637 which has no existing file. To make this work, PREFIX should be
638 an absolute file name.
640 BASE64_P means add the pid as 3 characters in base64
641 encoding. In this case, 6 characters will be added to PREFIX to
642 form the file name. Otherwise, if Emacs is running on a system
643 with long file names, add the pid as a decimal number.
645 This function signals an error if no unique file name could be
649 make_temp_name (Lisp_Object prefix
, bool base64_p
)
651 Lisp_Object val
, encoded_prefix
;
655 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
658 CHECK_STRING (prefix
);
660 /* VAL is created by adding 6 characters to PREFIX. The first
661 three are the PID of this process, in base 64, and the second
662 three are incremented if the file already exists. This ensures
663 262144 unique file names per PID per PREFIX. */
669 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
670 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
671 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
676 #ifdef HAVE_LONG_FILE_NAMES
677 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
679 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
680 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
681 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
686 encoded_prefix
= ENCODE_FILE (prefix
);
687 len
= SBYTES (encoded_prefix
);
688 val
= make_uninit_string (len
+ 3 + pidlen
);
690 memcpy (data
, SSDATA (encoded_prefix
), len
);
693 memcpy (p
, pidbuf
, pidlen
);
696 /* Here we try to minimize useless stat'ing when this function is
697 invoked many times successively with the same PREFIX. We achieve
698 this by initializing count to a random value, and incrementing it
701 We don't want make-temp-name to be called while dumping,
702 because then make_temp_name_count_initialized_p would get set
703 and then make_temp_name_count would not be set when Emacs starts. */
705 if (!make_temp_name_count_initialized_p
)
707 make_temp_name_count
= time (NULL
);
708 make_temp_name_count_initialized_p
= 1;
713 unsigned num
= make_temp_name_count
;
715 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
716 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
717 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
719 /* Poor man's congruential RN generator. Replace with
720 ++make_temp_name_count for debugging. */
721 make_temp_name_count
+= 25229;
722 make_temp_name_count
%= 225307;
724 if (!check_existing (data
))
726 /* We want to return only if errno is ENOENT. */
728 return DECODE_FILE (val
);
730 /* The error here is dubious, but there is little else we
731 can do. The alternatives are to return nil, which is
732 as bad as (and in many cases worse than) throwing the
733 error, or to ignore the error, which will likely result
734 in looping through 225307 stat's, which is not only
735 dog-slow, but also useless since eventually nil would
736 have to be returned anyway. */
737 report_file_error ("Cannot create temporary name for prefix",
745 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
746 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
747 The Emacs process number forms part of the result,
748 so there is no danger of generating a name being used by another process.
750 In addition, this function makes an attempt to choose a name
751 which has no existing file. To make this work,
752 PREFIX should be an absolute file name.
754 There is a race condition between calling `make-temp-name' and creating the
755 file which opens all kinds of security holes. For that reason, you should
756 probably use `make-temp-file' instead, except in three circumstances:
758 * If you are creating the file in the user's home directory.
759 * If you are creating a directory rather than an ordinary file.
760 * If you are taking special precautions as `make-temp-file' does. */)
763 return make_temp_name (prefix
, 0);
766 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
767 doc
: /* Convert filename NAME to absolute, and canonicalize it.
768 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
769 \(does not start with slash or tilde); both the directory name and
770 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
771 missing, the current buffer's value of `default-directory' is used.
772 NAME should be a string that is a valid file name for the underlying
774 File name components that are `.' are removed, and
775 so are file name components followed by `..', along with the `..' itself;
776 note that these simplifications are done without checking the resulting
777 file names in the file system.
778 Multiple consecutive slashes are collapsed into a single slash,
779 except at the beginning of the file name when they are significant (e.g.,
780 UNC file names on MS-Windows.)
781 An initial `~/' expands to your home directory.
782 An initial `~USER/' expands to USER's home directory.
783 See also the function `substitute-in-file-name'.
785 For technical reasons, this function can return correct but
786 non-intuitive results for the root directory; for instance,
787 \(expand-file-name ".." "/") returns "/..". For this reason, use
788 \(directory-file-name (file-name-directory dirname)) to traverse a
789 filesystem tree, not (expand-file-name ".." dirname). */)
790 (Lisp_Object name
, Lisp_Object default_directory
)
792 /* These point to SDATA and need to be careful with string-relocation
793 during GC (via DECODE_FILE). */
797 const char *newdirlim
;
798 /* This should only point to alloca'd data. */
805 bool collapse_newdir
= true;
808 ptrdiff_t length
, nbytes
;
809 Lisp_Object handler
, result
, handled_name
;
816 /* If the file name has special constructs in it,
817 call the corresponding file handler. */
818 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
821 handled_name
= call3 (handler
, Qexpand_file_name
,
822 name
, default_directory
);
823 if (STRINGP (handled_name
))
825 error ("Invalid handler in `file-name-handler-alist'");
829 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
830 if (NILP (default_directory
))
831 default_directory
= BVAR (current_buffer
, directory
);
832 if (! STRINGP (default_directory
))
835 /* "/" is not considered a root directory on DOS_NT, so using "/"
836 here causes an infinite recursion in, e.g., the following:
838 (let (default-directory)
839 (expand-file-name "a"))
841 To avoid this, we set default_directory to the root of the
843 default_directory
= build_string (emacs_root_dir ());
845 default_directory
= build_string ("/");
849 if (!NILP (default_directory
))
851 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
854 handled_name
= call3 (handler
, Qexpand_file_name
,
855 name
, default_directory
);
856 if (STRINGP (handled_name
))
858 error ("Invalid handler in `file-name-handler-alist'");
863 char *o
= SSDATA (default_directory
);
865 /* Make sure DEFAULT_DIRECTORY is properly expanded.
866 It would be better to do this down below where we actually use
867 default_directory. Unfortunately, calling Fexpand_file_name recursively
868 could invoke GC, and the strings might be relocated. This would
869 be annoying because we have pointers into strings lying around
870 that would need adjusting, and people would add new pointers to
871 the code and forget to adjust them, resulting in intermittent bugs.
872 Putting this call here avoids all that crud.
874 The EQ test avoids infinite recursion. */
875 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
876 /* Save time in some common cases - as long as default_directory
877 is not relative, it can be canonicalized with name below (if it
878 is needed at all) without requiring it to be expanded now. */
880 /* Detect MSDOS file names with drive specifiers. */
881 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
882 && IS_DIRECTORY_SEP (o
[2]))
884 /* Detect Windows file names in UNC format. */
885 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
887 #else /* not DOS_NT */
888 /* Detect Unix absolute file names (/... alone is not absolute on
890 && ! (IS_DIRECTORY_SEP (o
[0]))
891 #endif /* not DOS_NT */
897 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
901 multibyte
= STRING_MULTIBYTE (name
);
902 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
906 unsigned char *p
= SDATA (name
);
908 while (*p
&& ASCII_CHAR_P (*p
))
912 /* NAME is a pure ASCII string, and DEFAULT_DIRECTORY is
913 unibyte. Do not convert DEFAULT_DIRECTORY to
914 multibyte; instead, convert NAME to a unibyte string,
915 so that the result of this function is also a unibyte
916 string. This is needed during bootstrapping and
917 dumping, when Emacs cannot decode file names, because
918 the locale environment is not set up. */
919 name
= make_unibyte_string (SSDATA (name
), SBYTES (name
));
923 default_directory
= string_to_multibyte (default_directory
);
927 name
= string_to_multibyte (name
);
933 if (!NILP (Vw32_downcase_file_names
))
934 default_directory
= Fdowncase (default_directory
);
937 /* Make a local copy of NAME to protect it from GC in DECODE_FILE below. */
938 SAFE_ALLOCA_STRING (nm
, name
);
939 nmlim
= nm
+ SBYTES (name
);
942 /* Note if special escape prefix is present, but remove for now. */
943 if (nm
[0] == '/' && nm
[1] == ':')
949 /* Find and remove drive specifier if present; this makes nm absolute
950 even if the rest of the name appears to be relative. Only look for
951 drive specifier at the beginning. */
952 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
954 drive
= (unsigned char) nm
[0];
959 /* If we see "c://somedir", we want to strip the first slash after the
960 colon when stripping the drive letter. Otherwise, this expands to
962 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
965 /* Discard any previous drive specifier if nm is now in UNC format. */
966 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
967 && !IS_DIRECTORY_SEP (nm
[2]))
969 #endif /* WINDOWSNT */
972 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
973 none are found, we can probably return right away. We will avoid
974 allocating a new string if name is already fully expanded. */
976 IS_DIRECTORY_SEP (nm
[0])
978 && drive
&& !is_escaped
981 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
985 /* If it turns out that the filename we want to return is just a
986 suffix of FILENAME, we don't need to go through and edit
987 things; we just need to construct a new string using data
988 starting at the middle of FILENAME. If we set LOSE, that
989 means we've discovered that we can't do that cool trick. */
995 /* Since we know the name is absolute, we can assume that each
996 element starts with a "/". */
998 /* "." and ".." are hairy. */
999 if (IS_DIRECTORY_SEP (p
[0])
1001 && (IS_DIRECTORY_SEP (p
[2])
1003 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1006 /* Replace multiple slashes with a single one, except
1007 leave leading "//" alone. */
1008 else if (IS_DIRECTORY_SEP (p
[0])
1009 && IS_DIRECTORY_SEP (p
[1])
1010 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1017 /* Make sure directories are all separated with /, but
1018 avoid allocation of a new string when not required. */
1019 dostounix_filename (nm
);
1021 if (IS_DIRECTORY_SEP (nm
[1]))
1023 if (strcmp (nm
, SSDATA (name
)) != 0)
1024 name
= make_specified_string (nm
, -1, nmlim
- nm
, multibyte
);
1028 /* Drive must be set, so this is okay. */
1029 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1033 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1034 temp
[0] = DRIVE_LETTER (drive
);
1035 AUTO_STRING (drive_prefix
, temp
);
1036 name
= concat2 (drive_prefix
, name
);
1039 if (!NILP (Vw32_downcase_file_names
))
1040 name
= Fdowncase (name
);
1042 #else /* not DOS_NT */
1043 if (strcmp (nm
, SSDATA (name
)) != 0)
1044 name
= make_specified_string (nm
, -1, nmlim
- nm
, multibyte
);
1045 #endif /* not DOS_NT */
1051 /* At this point, nm might or might not be an absolute file name. We
1052 need to expand ~ or ~user if present, otherwise prefix nm with
1053 default_directory if nm is not absolute, and finally collapse /./
1054 and /foo/../ sequences.
1056 We set newdir to be the appropriate prefix if one is needed:
1057 - the relevant user directory if nm starts with ~ or ~user
1058 - the specified drive's working dir (DOS/NT only) if nm does not
1060 - the value of default_directory.
1062 Note that these prefixes are not guaranteed to be absolute (except
1063 for the working dir of a drive). Therefore, to ensure we always
1064 return an absolute name, if the final prefix is not absolute we
1065 append it to the current working directory. */
1067 newdir
= newdirlim
= 0;
1069 if (nm
[0] == '~') /* prefix ~ */
1071 if (IS_DIRECTORY_SEP (nm
[1])
1072 || nm
[1] == 0) /* ~ by itself */
1076 if (!(newdir
= egetenv ("HOME")))
1077 newdir
= newdirlim
= "";
1079 /* `egetenv' may return a unibyte string, which will bite us since
1080 we expect the directory to be multibyte. */
1084 char newdir_utf8
[MAX_UTF8_PATH
];
1086 filename_from_ansi (newdir
, newdir_utf8
);
1087 tem
= make_unibyte_string (newdir_utf8
, strlen (newdir_utf8
));
1091 tem
= build_string (newdir
);
1092 newdirlim
= newdir
+ SBYTES (tem
);
1093 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1095 hdir
= DECODE_FILE (tem
);
1096 newdir
= SSDATA (hdir
);
1097 newdirlim
= newdir
+ SBYTES (hdir
);
1100 collapse_newdir
= false;
1103 else /* ~user/filename */
1106 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1108 o
= SAFE_ALLOCA (p
- nm
+ 1);
1109 memcpy (o
, nm
, p
- nm
);
1113 pw
= getpwnam (o
+ 1);
1119 newdir
= pw
->pw_dir
;
1120 /* `getpwnam' may return a unibyte string, which will
1121 bite us since we expect the directory to be
1123 tem
= make_unibyte_string (newdir
, strlen (newdir
));
1124 newdirlim
= newdir
+ SBYTES (tem
);
1125 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1127 hdir
= DECODE_FILE (tem
);
1128 newdir
= SSDATA (hdir
);
1129 newdirlim
= newdir
+ SBYTES (hdir
);
1133 collapse_newdir
= false;
1137 /* If we don't find a user of that name, leave the name
1138 unchanged; don't move nm forward to p. */
1143 /* On DOS and Windows, nm is absolute if a drive name was specified;
1144 use the drive's current directory as the prefix if needed. */
1145 if (!newdir
&& drive
)
1147 /* Get default directory if needed to make nm absolute. */
1149 if (!IS_DIRECTORY_SEP (nm
[0]))
1151 adir
= alloca (MAXPATHLEN
+ 1);
1152 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1156 Lisp_Object tem
= build_string (adir
);
1158 tem
= DECODE_FILE (tem
);
1159 newdirlim
= adir
+ SBYTES (tem
);
1160 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1163 newdirlim
= adir
+ strlen (adir
);
1167 /* Either nm starts with /, or drive isn't mounted. */
1169 adir
[0] = DRIVE_LETTER (drive
);
1173 newdirlim
= adir
+ 3;
1179 /* Finally, if no prefix has been specified and nm is not absolute,
1180 then it must be expanded relative to default_directory. */
1184 /* /... alone is not absolute on DOS and Windows. */
1185 && !IS_DIRECTORY_SEP (nm
[0])
1188 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1189 && !IS_DIRECTORY_SEP (nm
[2]))
1193 newdir
= SSDATA (default_directory
);
1194 newdirlim
= newdir
+ SBYTES (default_directory
);
1196 /* Note if special escape prefix is present, but remove for now. */
1197 if (newdir
[0] == '/' && newdir
[1] == ':')
1208 /* First ensure newdir is an absolute name. */
1210 /* Detect MSDOS file names with drive specifiers. */
1211 ! (IS_DRIVE (newdir
[0])
1212 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1214 /* Detect Windows file names in UNC format. */
1215 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1216 && !IS_DIRECTORY_SEP (newdir
[2]))
1220 /* Effectively, let newdir be (expand-file-name newdir cwd).
1221 Because of the admonition against calling expand-file-name
1222 when we have pointers into lisp strings, we accomplish this
1223 indirectly by prepending newdir to nm if necessary, and using
1224 cwd (or the wd of newdir's drive) as the new newdir. */
1227 const int adir_size
= MAX_UTF8_PATH
;
1229 const int adir_size
= MAXPATHLEN
+ 1;
1232 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1234 drive
= (unsigned char) newdir
[0];
1237 if (!IS_DIRECTORY_SEP (nm
[0]))
1239 ptrdiff_t nmlen
= nmlim
- nm
;
1240 ptrdiff_t newdirlen
= newdirlim
- newdir
;
1241 char *tmp
= alloca (newdirlen
+ file_name_as_directory_slop
1243 ptrdiff_t dlen
= file_name_as_directory (tmp
, newdir
, newdirlen
,
1245 memcpy (tmp
+ dlen
, nm
, nmlen
+ 1);
1247 nmlim
= nm
+ dlen
+ nmlen
;
1249 adir
= alloca (adir_size
);
1252 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1256 getcwd (adir
, adir_size
);
1259 Lisp_Object tem
= build_string (adir
);
1261 tem
= DECODE_FILE (tem
);
1262 newdirlim
= adir
+ SBYTES (tem
);
1263 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1266 newdirlim
= adir
+ strlen (adir
);
1270 /* Strip off drive name from prefix, if present. */
1271 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1277 /* Keep only a prefix from newdir if nm starts with slash
1278 (//server/share for UNC, nothing otherwise). */
1279 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1282 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1283 && !IS_DIRECTORY_SEP (newdir
[2]))
1285 char *adir
= strcpy (alloca (newdirlim
- newdir
+ 1), newdir
);
1287 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1289 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1292 newdirlim
= newdir
+ strlen (adir
);
1296 newdir
= newdirlim
= "";
1301 /* Ignore any slash at the end of newdir, unless newdir is
1302 just "/" or "//". */
1303 length
= newdirlim
- newdir
;
1304 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1305 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1308 /* Now concatenate the directory and name to new space in the stack frame. */
1309 tlen
= length
+ file_name_as_directory_slop
+ (nmlim
- nm
) + 1;
1310 eassert (tlen
> file_name_as_directory_slop
+ 1);
1312 /* Reserve space for drive specifier and escape prefix, since either
1313 or both may need to be inserted. (The Microsoft x86 compiler
1314 produces incorrect code if the following two lines are combined.) */
1315 target
= alloca (tlen
+ 4);
1317 #else /* not DOS_NT */
1318 target
= SAFE_ALLOCA (tlen
);
1319 #endif /* not DOS_NT */
1325 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1328 /* If newdir is effectively "C:/", then the drive letter will have
1329 been stripped and newdir will be "/". Concatenating with an
1330 absolute directory in nm produces "//", which will then be
1331 incorrectly treated as a network share. Ignore newdir in
1332 this case (keeping the drive letter). */
1333 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1334 && newdir
[1] == '\0'))
1337 memcpy (target
, newdir
, length
);
1343 nbytes
= file_name_as_directory (target
, newdir
, length
, multibyte
);
1346 memcpy (target
+ nbytes
, nm
, nmlim
- nm
+ 1);
1348 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1356 if (!IS_DIRECTORY_SEP (*p
))
1360 else if (p
[1] == '.'
1361 && (IS_DIRECTORY_SEP (p
[2])
1364 /* If "/." is the entire filename, keep the "/". Otherwise,
1365 just delete the whole "/.". */
1366 if (o
== target
&& p
[2] == '\0')
1370 else if (p
[1] == '.' && p
[2] == '.'
1371 /* `/../' is the "superroot" on certain file systems.
1372 Turned off on DOS_NT systems because they have no
1373 "superroot" and because this causes us to produce
1374 file names like "d:/../foo" which fail file-related
1375 functions of the underlying OS. (To reproduce, try a
1376 long series of "../../" in default_directory, longer
1377 than the number of levels from the root.) */
1381 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1386 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1389 /* Don't go below server level in UNC filenames. */
1390 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1391 && IS_DIRECTORY_SEP (*target
))
1395 /* Keep initial / only if this is the whole name. */
1396 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1400 else if (IS_DIRECTORY_SEP (p
[1])
1401 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1402 /* Collapse multiple "/", except leave leading "//" alone. */
1411 /* At last, set drive name. */
1413 /* Except for network file name. */
1414 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1415 #endif /* WINDOWSNT */
1417 if (!drive
) emacs_abort ();
1419 target
[0] = DRIVE_LETTER (drive
);
1422 /* Reinsert the escape prefix if required. */
1429 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1430 dostounix_filename (SSDATA (result
));
1432 if (!NILP (Vw32_downcase_file_names
))
1433 result
= Fdowncase (result
);
1436 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1437 #endif /* !DOS_NT */
1440 /* Again look to see if the file name has special constructs in it
1441 and perhaps call the corresponding file handler. This is needed
1442 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1443 the ".." component gives us "/user@host:/bar/../baz" which needs
1444 to be expanded again. */
1445 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1446 if (!NILP (handler
))
1448 handled_name
= call3 (handler
, Qexpand_file_name
,
1449 result
, default_directory
);
1450 if (! STRINGP (handled_name
))
1451 error ("Invalid handler in `file-name-handler-alist'");
1452 result
= handled_name
;
1460 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1461 This is the old version of expand-file-name, before it was thoroughly
1462 rewritten for Emacs 10.31. We leave this version here commented-out,
1463 because the code is very complex and likely to have subtle bugs. If
1464 bugs _are_ found, it might be of interest to look at the old code and
1465 see what did it do in the relevant situation.
1467 Don't remove this code: it's true that it will be accessible
1468 from the repository, but a few years from deletion, people will
1469 forget it is there. */
1471 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1472 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1473 "Convert FILENAME to absolute, and canonicalize it.\n\
1474 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1475 \(does not start with slash); if DEFAULT is nil or missing,\n\
1476 the current buffer's value of default-directory is used.\n\
1477 Filenames containing `.' or `..' as components are simplified;\n\
1478 initial `~/' expands to your home directory.\n\
1479 See also the function `substitute-in-file-name'.")
1481 Lisp_Object name
, defalt
;
1485 register unsigned char *newdir
, *p
, *o
;
1487 unsigned char *target
;
1490 CHECK_STRING (name
);
1493 /* If nm is absolute, flush ...// and detect /./ and /../.
1494 If no /./ or /../ we can return right away. */
1501 if (p
[0] == '/' && p
[1] == '/')
1503 if (p
[0] == '/' && p
[1] == '~')
1504 nm
= p
+ 1, lose
= 1;
1505 if (p
[0] == '/' && p
[1] == '.'
1506 && (p
[2] == '/' || p
[2] == 0
1507 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1513 if (nm
== SDATA (name
))
1515 return build_string (nm
);
1519 /* Now determine directory to start with and put it in NEWDIR. */
1523 if (nm
[0] == '~') /* prefix ~ */
1524 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1526 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1527 newdir
= (unsigned char *) "";
1530 else /* ~user/filename */
1532 /* Get past ~ to user. */
1533 unsigned char *user
= nm
+ 1;
1534 /* Find end of name. */
1535 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1536 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1537 /* Copy the user name into temp storage. */
1538 o
= alloca (len
+ 1);
1539 memcpy (o
, user
, len
);
1542 /* Look up the user name. */
1544 pw
= (struct passwd
*) getpwnam (o
+ 1);
1547 error ("\"%s\" isn't a registered user", o
+ 1);
1549 newdir
= (unsigned char *) pw
->pw_dir
;
1551 /* Discard the user name from NM. */
1555 if (nm
[0] != '/' && !newdir
)
1558 defalt
= current_buffer
->directory
;
1559 CHECK_STRING (defalt
);
1560 newdir
= SDATA (defalt
);
1563 /* Now concatenate the directory and name to new space in the stack frame. */
1565 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1566 target
= alloca (tlen
);
1571 if (nm
[0] == 0 || nm
[0] == '/')
1572 strcpy (target
, newdir
);
1574 file_name_as_directory (target
, newdir
);
1577 strcat (target
, nm
);
1579 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1590 else if (!strncmp (p
, "//", 2)
1596 else if (p
[0] == '/' && p
[1] == '.'
1597 && (p
[2] == '/' || p
[2] == 0))
1599 else if (!strncmp (p
, "/..", 3)
1600 /* `/../' is the "superroot" on certain file systems. */
1602 && (p
[3] == '/' || p
[3] == 0))
1604 while (o
!= target
&& *--o
!= '/')
1606 if (o
== target
&& *o
== '/')
1616 return make_string (target
, o
- target
);
1620 /* If /~ or // appears, discard everything through first slash. */
1622 file_name_absolute_p (const char *filename
)
1625 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1627 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1628 && IS_DIRECTORY_SEP (filename
[2]))
1634 search_embedded_absfilename (char *nm
, char *endp
)
1638 for (p
= nm
+ 1; p
< endp
; p
++)
1640 if (IS_DIRECTORY_SEP (p
[-1])
1641 && file_name_absolute_p (p
)
1642 #if defined (WINDOWSNT) || defined (CYGWIN)
1643 /* // at start of file name is meaningful in Apollo,
1644 WindowsNT and Cygwin systems. */
1645 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1646 #endif /* not (WINDOWSNT || CYGWIN) */
1649 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1650 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1653 char *o
= SAFE_ALLOCA (s
- p
+ 1);
1655 memcpy (o
, p
, s
- p
);
1658 /* If we have ~user and `user' exists, discard
1659 everything up to ~. But if `user' does not exist, leave
1660 ~user alone, it might be a literal file name. */
1662 pw
= getpwnam (o
+ 1);
1675 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1676 Ssubstitute_in_file_name
, 1, 1, 0,
1677 doc
: /* Substitute environment variables referred to in FILENAME.
1678 `$FOO' where FOO is an environment variable name means to substitute
1679 the value of that variable. The variable name should be terminated
1680 with a character not a letter, digit or underscore; otherwise, enclose
1681 the entire variable name in braces.
1683 If `/~' appears, all of FILENAME through that `/' is discarded.
1684 If `//' appears, everything up to and including the first of
1685 those `/' is discarded. */)
1686 (Lisp_Object filename
)
1688 char *nm
, *p
, *x
, *endp
;
1689 bool substituted
= false;
1692 Lisp_Object handler
;
1694 CHECK_STRING (filename
);
1696 multibyte
= STRING_MULTIBYTE (filename
);
1698 /* If the file name has special constructs in it,
1699 call the corresponding file handler. */
1700 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1701 if (!NILP (handler
))
1703 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1705 if (STRINGP (handled_name
))
1706 return handled_name
;
1707 error ("Invalid handler in `file-name-handler-alist'");
1710 /* Always work on a copy of the string, in case GC happens during
1711 decode of environment variables, causing the original Lisp_String
1712 data to be relocated. */
1714 SAFE_ALLOCA_STRING (nm
, filename
);
1717 dostounix_filename (nm
);
1718 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1720 endp
= nm
+ SBYTES (filename
);
1722 /* If /~ or // appears, discard everything through first slash. */
1723 p
= search_embedded_absfilename (nm
, endp
);
1725 /* Start over with the new string, so we check the file-name-handler
1726 again. Important with filenames like "/home/foo//:/hello///there"
1727 which would substitute to "/:/hello///there" rather than "/there". */
1730 = (Fsubstitute_in_file_name
1731 (make_specified_string (p
, -1, endp
- p
, multibyte
)));
1736 /* See if any variables are substituted into the string. */
1738 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1741 = (!substituted
? filename
1742 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1743 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1745 if (!EQ (tmp
, name
))
1753 if (!NILP (Vw32_downcase_file_names
))
1754 filename
= Fdowncase (filename
);
1760 xnm
= SSDATA (filename
);
1761 x
= xnm
+ SBYTES (filename
);
1763 /* If /~ or // appears, discard everything through first slash. */
1764 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1765 /* This time we do not start over because we've already expanded envvars
1766 and replaced $$ with $. Maybe we should start over as well, but we'd
1767 need to quote some $ to $$ first. */
1771 if (!NILP (Vw32_downcase_file_names
))
1773 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1775 filename
= Fdowncase (xname
);
1779 if (xnm
!= SSDATA (filename
))
1780 filename
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1785 /* A slightly faster and more convenient way to get
1786 (directory-file-name (expand-file-name FOO)). */
1789 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1791 register Lisp_Object absname
;
1793 absname
= Fexpand_file_name (filename
, defdir
);
1795 /* Remove final slash, if any (unless this is the root dir).
1796 stat behaves differently depending! */
1797 if (SCHARS (absname
) > 1
1798 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1799 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1800 /* We cannot take shortcuts; they might be wrong for magic file names. */
1801 absname
= Fdirectory_file_name (absname
);
1805 /* Signal an error if the file ABSNAME already exists.
1806 If KNOWN_TO_EXIST, the file is known to exist.
1807 QUERYSTRING is a name for the action that is being considered
1809 If INTERACTIVE, ask the user whether to proceed,
1810 and bypass the error if the user says to go ahead.
1811 If QUICK, ask for y or n, not yes or no. */
1814 barf_or_query_if_file_exists (Lisp_Object absname
, bool known_to_exist
,
1815 const char *querystring
, bool interactive
,
1818 Lisp_Object tem
, encoded_filename
;
1819 struct stat statbuf
;
1820 struct gcpro gcpro1
;
1822 encoded_filename
= ENCODE_FILE (absname
);
1824 if (! known_to_exist
&& lstat (SSDATA (encoded_filename
), &statbuf
) == 0)
1826 if (S_ISDIR (statbuf
.st_mode
))
1827 xsignal2 (Qfile_error
,
1828 build_string ("File is a directory"), absname
);
1829 known_to_exist
= true;
1835 xsignal2 (Qfile_already_exists
,
1836 build_string ("File already exists"), absname
);
1838 tem
= format2 ("File %s already exists; %s anyway? ",
1839 absname
, build_string (querystring
));
1841 tem
= call1 (intern ("y-or-n-p"), tem
);
1843 tem
= do_yes_or_no_p (tem
);
1846 xsignal2 (Qfile_already_exists
,
1847 build_string ("File already exists"), absname
);
1851 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1852 "fCopy file: \nGCopy %s to file: \np\nP",
1853 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1854 If NEWNAME names a directory, copy FILE there.
1856 This function always sets the file modes of the output file to match
1859 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1860 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1861 signal a `file-already-exists' error without overwriting. If
1862 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1863 about overwriting; this is what happens in interactive use with M-x.
1864 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1867 Fourth arg KEEP-TIME non-nil means give the output file the same
1868 last-modified time as the old one. (This works on only some systems.)
1870 A prefix arg makes KEEP-TIME non-nil.
1872 If PRESERVE-UID-GID is non-nil, we try to transfer the
1873 uid and gid of FILE to NEWNAME.
1875 If PRESERVE-PERMISSIONS is non-nil, copy permissions of FILE to NEWNAME;
1876 this includes the file modes, along with ACL entries and SELinux
1877 context if present. Otherwise, if NEWNAME is created its file
1878 permission bits are those of FILE, masked by the default file
1880 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
,
1881 Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
,
1882 Lisp_Object preserve_permissions
)
1884 Lisp_Object handler
;
1885 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1886 ptrdiff_t count
= SPECPDL_INDEX ();
1887 Lisp_Object encoded_file
, encoded_newname
;
1889 security_context_t con
;
1895 bool already_exists
= false;
1899 char buf
[16 * 1024];
1903 encoded_file
= encoded_newname
= Qnil
;
1904 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1905 CHECK_STRING (file
);
1906 CHECK_STRING (newname
);
1908 if (!NILP (Ffile_directory_p (newname
)))
1909 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1911 newname
= Fexpand_file_name (newname
, Qnil
);
1913 file
= Fexpand_file_name (file
, Qnil
);
1915 /* If the input file name has special constructs in it,
1916 call the corresponding file handler. */
1917 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1918 /* Likewise for output file name. */
1920 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1921 if (!NILP (handler
))
1922 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1923 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1924 preserve_permissions
));
1926 encoded_file
= ENCODE_FILE (file
);
1927 encoded_newname
= ENCODE_FILE (newname
);
1930 if (NILP (ok_if_already_exists
)
1931 || INTEGERP (ok_if_already_exists
))
1932 barf_or_query_if_file_exists (newname
, false, "copy to it",
1933 INTEGERP (ok_if_already_exists
), false);
1935 result
= w32_copy_file (SSDATA (encoded_file
), SSDATA (encoded_newname
),
1936 !NILP (keep_time
), !NILP (preserve_uid_gid
),
1937 !NILP (preserve_permissions
));
1941 report_file_error ("Copying file", list2 (file
, newname
));
1943 report_file_error ("Copying permissions from", file
);
1945 xsignal2 (Qfile_date_error
,
1946 build_string ("Resetting file times"), newname
);
1948 report_file_error ("Copying permissions to", newname
);
1950 #else /* not WINDOWSNT */
1952 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1956 report_file_error ("Opening input file", file
);
1958 record_unwind_protect_int (close_file_unwind
, ifd
);
1960 if (fstat (ifd
, &st
) != 0)
1961 report_file_error ("Input file status", file
);
1963 if (!NILP (preserve_permissions
))
1966 if (is_selinux_enabled ())
1968 conlength
= fgetfilecon (ifd
, &con
);
1969 if (conlength
== -1)
1970 report_file_error ("Doing fgetfilecon", file
);
1975 /* We can copy only regular files. */
1976 if (!S_ISREG (st
.st_mode
))
1977 report_file_errno ("Non-regular file", file
,
1978 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
1981 new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0700 : 0777);
1983 new_mask
= S_IREAD
| S_IWRITE
;
1986 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
| O_CREAT
| O_EXCL
,
1988 if (ofd
< 0 && errno
== EEXIST
)
1990 if (NILP (ok_if_already_exists
) || INTEGERP (ok_if_already_exists
))
1991 barf_or_query_if_file_exists (newname
, true, "copy to it",
1992 INTEGERP (ok_if_already_exists
), false);
1993 already_exists
= true;
1994 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
, 0);
1997 report_file_error ("Opening output file", newname
);
1999 record_unwind_protect_int (close_file_unwind
, ofd
);
2004 if (fstat (ofd
, &out_st
) != 0)
2005 report_file_error ("Output file status", newname
);
2006 if (st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2007 report_file_errno ("Input and output files are the same",
2008 list2 (file
, newname
), 0);
2009 if (ftruncate (ofd
, 0) != 0)
2010 report_file_error ("Truncating output file", newname
);
2015 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2016 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2017 report_file_error ("Write error", newname
);
2021 /* Preserve the original file permissions, and if requested, also its
2024 mode_t preserved_permissions
= st
.st_mode
& 07777;
2025 mode_t default_permissions
= st
.st_mode
& 0777 & ~realmask
;
2026 if (!NILP (preserve_uid_gid
))
2028 /* Attempt to change owner and group. If that doesn't work
2029 attempt to change just the group, as that is sometimes allowed.
2030 Adjust the mode mask to eliminate setuid or setgid bits
2031 or group permissions bits that are inappropriate if the
2032 owner or group are wrong. */
2033 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2035 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2036 preserved_permissions
&= ~04000;
2039 preserved_permissions
&= ~06000;
2041 /* Copy the other bits to the group bits, since the
2043 preserved_permissions
&= ~070;
2044 preserved_permissions
|= (preserved_permissions
& 7) << 3;
2045 default_permissions
&= ~070;
2046 default_permissions
|= (default_permissions
& 7) << 3;
2051 switch (!NILP (preserve_permissions
)
2052 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2053 SSDATA (encoded_newname
), ofd
,
2054 preserved_permissions
)
2056 || (new_mask
& ~realmask
) == default_permissions
)
2058 : fchmod (ofd
, default_permissions
))
2060 case -2: report_file_error ("Copying permissions from", file
);
2061 case -1: report_file_error ("Copying permissions to", newname
);
2064 #endif /* not MSDOS */
2069 /* Set the modified context back to the file. */
2070 bool fail
= fsetfilecon (ofd
, con
) != 0;
2071 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2072 if (fail
&& errno
!= ENOTSUP
)
2073 report_file_error ("Doing fsetfilecon", newname
);
2079 if (!NILP (keep_time
))
2081 struct timespec atime
= get_stat_atime (&st
);
2082 struct timespec mtime
= get_stat_mtime (&st
);
2083 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
) != 0)
2084 xsignal2 (Qfile_date_error
,
2085 build_string ("Cannot set file date"), newname
);
2088 if (emacs_close (ofd
) < 0)
2089 report_file_error ("Write error", newname
);
2094 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2095 and if it can't, it tells so. Otherwise, under MSDOS we usually
2096 get only the READ bit, which will make the copied file read-only,
2097 so it's better not to chmod at all. */
2098 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2099 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2101 #endif /* not WINDOWSNT */
2103 /* Discard the unwind protects. */
2104 specpdl_ptr
= specpdl
+ count
;
2110 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2111 Smake_directory_internal
, 1, 1, 0,
2112 doc
: /* Create a new directory named DIRECTORY. */)
2113 (Lisp_Object directory
)
2116 Lisp_Object handler
;
2117 Lisp_Object encoded_dir
;
2119 CHECK_STRING (directory
);
2120 directory
= Fexpand_file_name (directory
, Qnil
);
2122 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2123 if (!NILP (handler
))
2124 return call2 (handler
, Qmake_directory_internal
, directory
);
2126 encoded_dir
= ENCODE_FILE (directory
);
2128 dir
= SSDATA (encoded_dir
);
2131 if (mkdir (dir
) != 0)
2133 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2135 report_file_error ("Creating directory", directory
);
2140 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2141 Sdelete_directory_internal
, 1, 1, 0,
2142 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2143 (Lisp_Object directory
)
2146 Lisp_Object encoded_dir
;
2148 CHECK_STRING (directory
);
2149 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2150 encoded_dir
= ENCODE_FILE (directory
);
2151 dir
= SSDATA (encoded_dir
);
2153 if (rmdir (dir
) != 0)
2154 report_file_error ("Removing directory", directory
);
2159 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2160 "(list (read-file-name \
2161 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2162 \"Move file to trash: \" \"Delete file: \") \
2163 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2164 (null current-prefix-arg))",
2165 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2166 If file has multiple names, it continues to exist with the other names.
2167 TRASH non-nil means to trash the file instead of deleting, provided
2168 `delete-by-moving-to-trash' is non-nil.
2170 When called interactively, TRASH is t if no prefix argument is given.
2171 With a prefix argument, TRASH is nil. */)
2172 (Lisp_Object filename
, Lisp_Object trash
)
2174 Lisp_Object handler
;
2175 Lisp_Object encoded_file
;
2176 struct gcpro gcpro1
;
2179 if (!NILP (Ffile_directory_p (filename
))
2180 && NILP (Ffile_symlink_p (filename
)))
2181 xsignal2 (Qfile_error
,
2182 build_string ("Removing old name: is a directory"),
2185 filename
= Fexpand_file_name (filename
, Qnil
);
2187 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2188 if (!NILP (handler
))
2189 return call3 (handler
, Qdelete_file
, filename
, trash
);
2191 if (delete_by_moving_to_trash
&& !NILP (trash
))
2192 return call1 (Qmove_file_to_trash
, filename
);
2194 encoded_file
= ENCODE_FILE (filename
);
2196 if (unlink (SSDATA (encoded_file
)) < 0)
2197 report_file_error ("Removing old name", filename
);
2202 internal_delete_file_1 (Lisp_Object ignore
)
2207 /* Delete file FILENAME, returning true if successful.
2208 This ignores `delete-by-moving-to-trash'. */
2211 internal_delete_file (Lisp_Object filename
)
2215 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2216 Qt
, internal_delete_file_1
);
2220 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2221 "fRename file: \nGRename %s to file: \np",
2222 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2223 If file has names other than FILE, it continues to have those names.
2224 Signals a `file-already-exists' error if a file NEWNAME already exists
2225 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2226 A number as third arg means request confirmation if NEWNAME already exists.
2227 This is what happens in interactive use with M-x. */)
2228 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2230 Lisp_Object handler
;
2231 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2232 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2234 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2235 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2236 CHECK_STRING (file
);
2237 CHECK_STRING (newname
);
2238 file
= Fexpand_file_name (file
, Qnil
);
2240 if ((!NILP (Ffile_directory_p (newname
)))
2242 /* If the file names are identical but for the case,
2243 don't attempt to move directory to itself. */
2244 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2248 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2249 ? file
: Fdirectory_file_name (file
));
2250 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2253 newname
= Fexpand_file_name (newname
, Qnil
);
2255 /* If the file name has special constructs in it,
2256 call the corresponding file handler. */
2257 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2259 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2260 if (!NILP (handler
))
2261 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2262 file
, newname
, ok_if_already_exists
));
2264 encoded_file
= ENCODE_FILE (file
);
2265 encoded_newname
= ENCODE_FILE (newname
);
2268 /* If the file names are identical but for the case, don't ask for
2269 confirmation: they simply want to change the letter-case of the
2271 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2273 if (NILP (ok_if_already_exists
)
2274 || INTEGERP (ok_if_already_exists
))
2275 barf_or_query_if_file_exists (newname
, false, "rename to it",
2276 INTEGERP (ok_if_already_exists
), false);
2277 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2279 int rename_errno
= errno
;
2280 if (rename_errno
== EXDEV
)
2283 symlink_target
= Ffile_symlink_p (file
);
2284 if (! NILP (symlink_target
))
2285 Fmake_symbolic_link (symlink_target
, newname
,
2286 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2287 else if (!NILP (Ffile_directory_p (file
)))
2288 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2290 /* We have already prompted if it was an integer, so don't
2291 have copy-file prompt again. */
2292 Fcopy_file (file
, newname
,
2293 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2296 count
= SPECPDL_INDEX ();
2297 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2299 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2300 call2 (Qdelete_directory
, file
, Qt
);
2302 Fdelete_file (file
, Qnil
);
2303 unbind_to (count
, Qnil
);
2306 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2312 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2313 "fAdd name to file: \nGName to add to %s: \np",
2314 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2315 Signals a `file-already-exists' error if a file NEWNAME already exists
2316 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2317 A number as third arg means request confirmation if NEWNAME already exists.
2318 This is what happens in interactive use with M-x. */)
2319 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2321 Lisp_Object handler
;
2322 Lisp_Object encoded_file
, encoded_newname
;
2323 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2325 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2326 encoded_file
= encoded_newname
= Qnil
;
2327 CHECK_STRING (file
);
2328 CHECK_STRING (newname
);
2329 file
= Fexpand_file_name (file
, Qnil
);
2331 if (!NILP (Ffile_directory_p (newname
)))
2332 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2334 newname
= Fexpand_file_name (newname
, Qnil
);
2336 /* If the file name has special constructs in it,
2337 call the corresponding file handler. */
2338 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2339 if (!NILP (handler
))
2340 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2341 newname
, ok_if_already_exists
));
2343 /* If the new name has special constructs in it,
2344 call the corresponding file handler. */
2345 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2346 if (!NILP (handler
))
2347 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2348 newname
, ok_if_already_exists
));
2350 encoded_file
= ENCODE_FILE (file
);
2351 encoded_newname
= ENCODE_FILE (newname
);
2353 if (NILP (ok_if_already_exists
)
2354 || INTEGERP (ok_if_already_exists
))
2355 barf_or_query_if_file_exists (newname
, false, "make it a new name",
2356 INTEGERP (ok_if_already_exists
), false);
2358 unlink (SSDATA (newname
));
2359 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2361 int link_errno
= errno
;
2362 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2369 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2370 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2371 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2372 Both args must be strings.
2373 Signals a `file-already-exists' error if a file LINKNAME already exists
2374 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2375 A number as third arg means request confirmation if LINKNAME already exists.
2376 This happens for interactive use with M-x. */)
2377 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2379 Lisp_Object handler
;
2380 Lisp_Object encoded_filename
, encoded_linkname
;
2381 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2383 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2384 encoded_filename
= encoded_linkname
= Qnil
;
2385 CHECK_STRING (filename
);
2386 CHECK_STRING (linkname
);
2387 /* If the link target has a ~, we must expand it to get
2388 a truly valid file name. Otherwise, do not expand;
2389 we want to permit links to relative file names. */
2390 if (SREF (filename
, 0) == '~')
2391 filename
= Fexpand_file_name (filename
, Qnil
);
2393 if (!NILP (Ffile_directory_p (linkname
)))
2394 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2396 linkname
= Fexpand_file_name (linkname
, Qnil
);
2398 /* If the file name has special constructs in it,
2399 call the corresponding file handler. */
2400 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2401 if (!NILP (handler
))
2402 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2403 linkname
, ok_if_already_exists
));
2405 /* If the new link name has special constructs in it,
2406 call the corresponding file handler. */
2407 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2408 if (!NILP (handler
))
2409 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2410 linkname
, ok_if_already_exists
));
2412 encoded_filename
= ENCODE_FILE (filename
);
2413 encoded_linkname
= ENCODE_FILE (linkname
);
2415 if (NILP (ok_if_already_exists
)
2416 || INTEGERP (ok_if_already_exists
))
2417 barf_or_query_if_file_exists (linkname
, false, "make it a link",
2418 INTEGERP (ok_if_already_exists
), false);
2419 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2421 /* If we didn't complain already, silently delete existing file. */
2423 if (errno
== EEXIST
)
2425 unlink (SSDATA (encoded_linkname
));
2426 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2433 if (errno
== ENOSYS
)
2436 xsignal1 (Qfile_error
,
2437 build_string ("Symbolic links are not supported"));
2440 symlink_errno
= errno
;
2441 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2449 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2451 doc
: /* Return t if file FILENAME specifies an absolute file name.
2452 On Unix, this is a name starting with a `/' or a `~'. */)
2453 (Lisp_Object filename
)
2455 CHECK_STRING (filename
);
2456 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2459 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2460 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2461 See also `file-readable-p' and `file-attributes'.
2462 This returns nil for a symlink to a nonexistent file.
2463 Use `file-symlink-p' to test for such links. */)
2464 (Lisp_Object filename
)
2466 Lisp_Object absname
;
2467 Lisp_Object handler
;
2469 CHECK_STRING (filename
);
2470 absname
= Fexpand_file_name (filename
, Qnil
);
2472 /* If the file name has special constructs in it,
2473 call the corresponding file handler. */
2474 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2475 if (!NILP (handler
))
2477 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2482 absname
= ENCODE_FILE (absname
);
2484 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2487 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2488 doc
: /* Return t if FILENAME can be executed by you.
2489 For a directory, this means you can access files in that directory.
2490 \(It is generally better to use `file-accessible-directory-p' for that
2491 purpose, though.) */)
2492 (Lisp_Object filename
)
2494 Lisp_Object absname
;
2495 Lisp_Object handler
;
2497 CHECK_STRING (filename
);
2498 absname
= Fexpand_file_name (filename
, Qnil
);
2500 /* If the file name has special constructs in it,
2501 call the corresponding file handler. */
2502 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2503 if (!NILP (handler
))
2504 return call2 (handler
, Qfile_executable_p
, absname
);
2506 absname
= ENCODE_FILE (absname
);
2508 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2511 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2512 doc
: /* Return t if file FILENAME exists and you can read it.
2513 See also `file-exists-p' and `file-attributes'. */)
2514 (Lisp_Object filename
)
2516 Lisp_Object absname
;
2517 Lisp_Object handler
;
2519 CHECK_STRING (filename
);
2520 absname
= Fexpand_file_name (filename
, Qnil
);
2522 /* If the file name has special constructs in it,
2523 call the corresponding file handler. */
2524 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2525 if (!NILP (handler
))
2526 return call2 (handler
, Qfile_readable_p
, absname
);
2528 absname
= ENCODE_FILE (absname
);
2529 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2533 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2534 doc
: /* Return t if file FILENAME can be written or created by you. */)
2535 (Lisp_Object filename
)
2537 Lisp_Object absname
, dir
, encoded
;
2538 Lisp_Object handler
;
2540 CHECK_STRING (filename
);
2541 absname
= Fexpand_file_name (filename
, Qnil
);
2543 /* If the file name has special constructs in it,
2544 call the corresponding file handler. */
2545 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2546 if (!NILP (handler
))
2547 return call2 (handler
, Qfile_writable_p
, absname
);
2549 encoded
= ENCODE_FILE (absname
);
2550 if (check_writable (SSDATA (encoded
), W_OK
))
2552 if (errno
!= ENOENT
)
2555 dir
= Ffile_name_directory (absname
);
2556 eassert (!NILP (dir
));
2558 dir
= Fdirectory_file_name (dir
);
2561 dir
= ENCODE_FILE (dir
);
2563 /* The read-only attribute of the parent directory doesn't affect
2564 whether a file or directory can be created within it. Some day we
2565 should check ACLs though, which do affect this. */
2566 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2568 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2572 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2573 doc
: /* Access file FILENAME, and get an error if that does not work.
2574 The second argument STRING is used in the error message.
2575 If there is no error, returns nil. */)
2576 (Lisp_Object filename
, Lisp_Object string
)
2578 Lisp_Object handler
, encoded_filename
, absname
;
2580 CHECK_STRING (filename
);
2581 absname
= Fexpand_file_name (filename
, Qnil
);
2583 CHECK_STRING (string
);
2585 /* If the file name has special constructs in it,
2586 call the corresponding file handler. */
2587 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2588 if (!NILP (handler
))
2589 return call3 (handler
, Qaccess_file
, absname
, string
);
2591 encoded_filename
= ENCODE_FILE (absname
);
2593 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2594 report_file_error (SSDATA (string
), filename
);
2599 /* Relative to directory FD, return the symbolic link value of FILENAME.
2600 On failure, return nil. */
2602 emacs_readlinkat (int fd
, char const *filename
)
2604 static struct allocator
const emacs_norealloc_allocator
=
2605 { xmalloc
, NULL
, xfree
, memory_full
};
2607 char readlink_buf
[1024];
2608 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2609 &emacs_norealloc_allocator
, readlinkat
);
2613 val
= build_unibyte_string (buf
);
2614 if (buf
[0] == '/' && strchr (buf
, ':'))
2616 AUTO_STRING (slash_colon
, "/:");
2617 val
= concat2 (slash_colon
, val
);
2619 if (buf
!= readlink_buf
)
2621 val
= DECODE_FILE (val
);
2625 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2626 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2627 The value is the link target, as a string.
2628 Otherwise it returns nil.
2630 This function does not check whether the link target exists. */)
2631 (Lisp_Object filename
)
2633 Lisp_Object handler
;
2635 CHECK_STRING (filename
);
2636 filename
= Fexpand_file_name (filename
, Qnil
);
2638 /* If the file name has special constructs in it,
2639 call the corresponding file handler. */
2640 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2641 if (!NILP (handler
))
2642 return call2 (handler
, Qfile_symlink_p
, filename
);
2644 filename
= ENCODE_FILE (filename
);
2646 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2649 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2650 doc
: /* Return t if FILENAME names an existing directory.
2651 Symbolic links to directories count as directories.
2652 See `file-symlink-p' to distinguish symlinks. */)
2653 (Lisp_Object filename
)
2655 Lisp_Object absname
;
2656 Lisp_Object handler
;
2658 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2660 /* If the file name has special constructs in it,
2661 call the corresponding file handler. */
2662 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2663 if (!NILP (handler
))
2664 return call2 (handler
, Qfile_directory_p
, absname
);
2666 absname
= ENCODE_FILE (absname
);
2668 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2671 /* Return true if FILE is a directory or a symlink to a directory. */
2673 file_directory_p (char const *file
)
2676 /* This is cheaper than 'stat'. */
2677 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2680 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2684 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2685 Sfile_accessible_directory_p
, 1, 1, 0,
2686 doc
: /* Return t if file FILENAME names a directory you can open.
2687 For the value to be t, FILENAME must specify the name of a directory as a file,
2688 and the directory must allow you to open files in it. In order to use a
2689 directory as a buffer's current directory, this predicate must return true.
2690 A directory name spec may be given instead; then the value is t
2691 if the directory so specified exists and really is a readable and
2692 searchable directory. */)
2693 (Lisp_Object filename
)
2695 Lisp_Object absname
;
2696 Lisp_Object handler
;
2698 CHECK_STRING (filename
);
2699 absname
= Fexpand_file_name (filename
, Qnil
);
2701 /* If the file name has special constructs in it,
2702 call the corresponding file handler. */
2703 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2704 if (!NILP (handler
))
2706 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2711 absname
= ENCODE_FILE (absname
);
2712 return file_accessible_directory_p (absname
) ? Qt
: Qnil
;
2715 /* If FILE is a searchable directory or a symlink to a
2716 searchable directory, return true. Otherwise return
2717 false and set errno to an error number. */
2719 file_accessible_directory_p (Lisp_Object file
)
2722 /* There's no need to test whether FILE is searchable, as the
2723 searchable/executable bit is invented on DOS_NT platforms. */
2724 return file_directory_p (SSDATA (file
));
2726 /* On POSIXish platforms, use just one system call; this avoids a
2727 race and is typically faster. */
2728 const char *data
= SSDATA (file
);
2729 ptrdiff_t len
= SBYTES (file
);
2735 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2736 There are three exceptions: "", "/", and "//". Leave "" alone,
2737 as it's invalid. Append only "." to the other two exceptions as
2738 "/" and "//" are distinct on some platforms, whereas "/", "///",
2739 "////", etc. are all equivalent. */
2744 /* Just check for trailing '/' when deciding whether to append '/'.
2745 That's simpler than testing the two special cases "/" and "//",
2746 and it's a safe optimization here. */
2747 char *buf
= SAFE_ALLOCA (len
+ 3);
2748 memcpy (buf
, data
, len
);
2749 strcpy (buf
+ len
, &"/."[data
[len
- 1] == '/']);
2753 ok
= check_existing (dir
);
2754 saved_errno
= errno
;
2756 errno
= saved_errno
;
2761 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2762 doc
: /* Return t if FILENAME names a regular file.
2763 This is the sort of file that holds an ordinary stream of data bytes.
2764 Symbolic links to regular files count as regular files.
2765 See `file-symlink-p' to distinguish symlinks. */)
2766 (Lisp_Object filename
)
2768 register Lisp_Object absname
;
2770 Lisp_Object handler
;
2772 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2774 /* If the file name has special constructs in it,
2775 call the corresponding file handler. */
2776 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2777 if (!NILP (handler
))
2778 return call2 (handler
, Qfile_regular_p
, absname
);
2780 absname
= ENCODE_FILE (absname
);
2785 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2787 /* Tell stat to use expensive method to get accurate info. */
2788 Vw32_get_true_file_attributes
= Qt
;
2789 result
= stat (SDATA (absname
), &st
);
2790 Vw32_get_true_file_attributes
= tem
;
2794 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2797 if (stat (SSDATA (absname
), &st
) < 0)
2799 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2803 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2804 Sfile_selinux_context
, 1, 1, 0,
2805 doc
: /* Return SELinux context of file named FILENAME.
2806 The return value is a list (USER ROLE TYPE RANGE), where the list
2807 elements are strings naming the user, role, type, and range of the
2808 file's SELinux security context.
2810 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2811 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2812 (Lisp_Object filename
)
2814 Lisp_Object absname
;
2815 Lisp_Object values
[4];
2816 Lisp_Object handler
;
2818 security_context_t con
;
2823 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2825 /* If the file name has special constructs in it,
2826 call the corresponding file handler. */
2827 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2828 if (!NILP (handler
))
2829 return call2 (handler
, Qfile_selinux_context
, absname
);
2831 absname
= ENCODE_FILE (absname
);
2838 if (is_selinux_enabled ())
2840 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2843 context
= context_new (con
);
2844 if (context_user_get (context
))
2845 values
[0] = build_string (context_user_get (context
));
2846 if (context_role_get (context
))
2847 values
[1] = build_string (context_role_get (context
));
2848 if (context_type_get (context
))
2849 values
[2] = build_string (context_type_get (context
));
2850 if (context_range_get (context
))
2851 values
[3] = build_string (context_range_get (context
));
2852 context_free (context
);
2858 return Flist (ARRAYELTS (values
), values
);
2861 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2862 Sset_file_selinux_context
, 2, 2, 0,
2863 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2864 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2865 elements are strings naming the components of a SELinux context.
2867 Value is t if setting of SELinux context was successful, nil otherwise.
2869 This function does nothing and returns nil if SELinux is disabled,
2870 or if Emacs was not compiled with SELinux support. */)
2871 (Lisp_Object filename
, Lisp_Object context
)
2873 Lisp_Object absname
;
2874 Lisp_Object handler
;
2876 Lisp_Object encoded_absname
;
2877 Lisp_Object user
= CAR_SAFE (context
);
2878 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2879 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2880 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2881 security_context_t con
;
2884 context_t parsed_con
;
2887 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2889 /* If the file name has special constructs in it,
2890 call the corresponding file handler. */
2891 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2892 if (!NILP (handler
))
2893 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2896 if (is_selinux_enabled ())
2898 /* Get current file context. */
2899 encoded_absname
= ENCODE_FILE (absname
);
2900 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2903 parsed_con
= context_new (con
);
2904 /* Change the parts defined in the parameter.*/
2907 if (context_user_set (parsed_con
, SSDATA (user
)))
2908 error ("Doing context_user_set");
2912 if (context_role_set (parsed_con
, SSDATA (role
)))
2913 error ("Doing context_role_set");
2917 if (context_type_set (parsed_con
, SSDATA (type
)))
2918 error ("Doing context_type_set");
2920 if (STRINGP (range
))
2922 if (context_range_set (parsed_con
, SSDATA (range
)))
2923 error ("Doing context_range_set");
2926 /* Set the modified context back to the file. */
2927 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2928 context_str (parsed_con
))
2930 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2931 if (fail
&& errno
!= ENOTSUP
)
2932 report_file_error ("Doing lsetfilecon", absname
);
2934 context_free (parsed_con
);
2936 return fail
? Qnil
: Qt
;
2939 report_file_error ("Doing lgetfilecon", absname
);
2946 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
2947 doc
: /* Return ACL entries of file named FILENAME.
2948 The entries are returned in a format suitable for use in `set-file-acl'
2949 but is otherwise undocumented and subject to change.
2950 Return nil if file does not exist or is not accessible, or if Emacs
2951 was unable to determine the ACL entries. */)
2952 (Lisp_Object filename
)
2954 Lisp_Object absname
;
2955 Lisp_Object handler
;
2956 #ifdef HAVE_ACL_SET_FILE
2958 Lisp_Object acl_string
;
2960 # ifndef HAVE_ACL_TYPE_EXTENDED
2961 acl_type_t ACL_TYPE_EXTENDED
= ACL_TYPE_ACCESS
;
2965 absname
= expand_and_dir_to_file (filename
,
2966 BVAR (current_buffer
, directory
));
2968 /* If the file name has special constructs in it,
2969 call the corresponding file handler. */
2970 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
2971 if (!NILP (handler
))
2972 return call2 (handler
, Qfile_acl
, absname
);
2974 #ifdef HAVE_ACL_SET_FILE
2975 absname
= ENCODE_FILE (absname
);
2977 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_EXTENDED
);
2981 str
= acl_to_text (acl
, NULL
);
2988 acl_string
= build_string (str
);
2998 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3000 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3001 ACL-STRING should contain the textual representation of the ACL
3002 entries in a format suitable for the platform.
3004 Value is t if setting of ACL was successful, nil otherwise.
3006 Setting ACL for local files requires Emacs to be built with ACL
3008 (Lisp_Object filename
, Lisp_Object acl_string
)
3010 Lisp_Object absname
;
3011 Lisp_Object handler
;
3012 #ifdef HAVE_ACL_SET_FILE
3013 Lisp_Object encoded_absname
;
3018 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3020 /* If the file name has special constructs in it,
3021 call the corresponding file handler. */
3022 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3023 if (!NILP (handler
))
3024 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3026 #ifdef HAVE_ACL_SET_FILE
3027 if (STRINGP (acl_string
))
3029 acl
= acl_from_text (SSDATA (acl_string
));
3032 report_file_error ("Converting ACL", absname
);
3036 encoded_absname
= ENCODE_FILE (absname
);
3038 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3041 if (fail
&& acl_errno_valid (errno
))
3042 report_file_error ("Setting ACL", absname
);
3045 return fail
? Qnil
: Qt
;
3052 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3053 doc
: /* Return mode bits of file named FILENAME, as an integer.
3054 Return nil, if file does not exist or is not accessible. */)
3055 (Lisp_Object filename
)
3057 Lisp_Object absname
;
3059 Lisp_Object handler
;
3061 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3063 /* If the file name has special constructs in it,
3064 call the corresponding file handler. */
3065 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3066 if (!NILP (handler
))
3067 return call2 (handler
, Qfile_modes
, absname
);
3069 absname
= ENCODE_FILE (absname
);
3071 if (stat (SSDATA (absname
), &st
) < 0)
3074 return make_number (st
.st_mode
& 07777);
3077 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3078 "(let ((file (read-file-name \"File: \"))) \
3079 (list file (read-file-modes nil file)))",
3080 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3081 Only the 12 low bits of MODE are used.
3083 Interactively, mode bits are read by `read-file-modes', which accepts
3084 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3085 (Lisp_Object filename
, Lisp_Object mode
)
3087 Lisp_Object absname
, encoded_absname
;
3088 Lisp_Object handler
;
3090 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3091 CHECK_NUMBER (mode
);
3093 /* If the file name has special constructs in it,
3094 call the corresponding file handler. */
3095 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3096 if (!NILP (handler
))
3097 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3099 encoded_absname
= ENCODE_FILE (absname
);
3101 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3102 report_file_error ("Doing chmod", absname
);
3107 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3108 doc
: /* Set the file permission bits for newly created files.
3109 The argument MODE should be an integer; only the low 9 bits are used.
3110 This setting is inherited by subprocesses. */)
3113 mode_t oldrealmask
, oldumask
, newumask
;
3114 CHECK_NUMBER (mode
);
3115 oldrealmask
= realmask
;
3116 newumask
= ~ XINT (mode
) & 0777;
3119 realmask
= newumask
;
3120 oldumask
= umask (newumask
);
3123 eassert (oldumask
== oldrealmask
);
3127 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3128 doc
: /* Return the default file protection for created files.
3129 The value is an integer. */)
3133 XSETINT (value
, (~ realmask
) & 0777);
3138 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3139 doc
: /* Set times of file FILENAME to TIMESTAMP.
3140 Set both access and modification times.
3141 Return t on success, else nil.
3142 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3144 (Lisp_Object filename
, Lisp_Object timestamp
)
3146 Lisp_Object absname
, encoded_absname
;
3147 Lisp_Object handler
;
3148 struct timespec t
= lisp_time_argument (timestamp
);
3150 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3152 /* If the file name has special constructs in it,
3153 call the corresponding file handler. */
3154 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3155 if (!NILP (handler
))
3156 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3158 encoded_absname
= ENCODE_FILE (absname
);
3161 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
) != 0)
3164 /* Setting times on a directory always fails. */
3165 if (file_directory_p (SSDATA (encoded_absname
)))
3168 report_file_error ("Setting file times", absname
);
3176 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3177 doc
: /* Tell Unix to finish all pending disk updates. */)
3184 #endif /* HAVE_SYNC */
3186 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3187 doc
: /* Return t if file FILE1 is newer than file FILE2.
3188 If FILE1 does not exist, the answer is nil;
3189 otherwise, if FILE2 does not exist, the answer is t. */)
3190 (Lisp_Object file1
, Lisp_Object file2
)
3192 Lisp_Object absname1
, absname2
;
3193 struct stat st1
, st2
;
3194 Lisp_Object handler
;
3195 struct gcpro gcpro1
, gcpro2
;
3197 CHECK_STRING (file1
);
3198 CHECK_STRING (file2
);
3201 GCPRO2 (absname1
, file2
);
3202 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3203 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3206 /* If the file name has special constructs in it,
3207 call the corresponding file handler. */
3208 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3210 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3211 if (!NILP (handler
))
3212 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3214 GCPRO2 (absname1
, absname2
);
3215 absname1
= ENCODE_FILE (absname1
);
3216 absname2
= ENCODE_FILE (absname2
);
3219 if (stat (SSDATA (absname1
), &st1
) < 0)
3222 if (stat (SSDATA (absname2
), &st2
) < 0)
3225 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3229 #ifndef READ_BUF_SIZE
3230 #define READ_BUF_SIZE (64 << 10)
3232 /* Some buffer offsets are stored in 'int' variables. */
3233 verify (READ_BUF_SIZE
<= INT_MAX
);
3235 /* This function is called after Lisp functions to decide a coding
3236 system are called, or when they cause an error. Before they are
3237 called, the current buffer is set unibyte and it contains only a
3238 newly inserted text (thus the buffer was empty before the
3241 The functions may set markers, overlays, text properties, or even
3242 alter the buffer contents, change the current buffer.
3244 Here, we reset all those changes by:
3245 o set back the current buffer.
3246 o move all markers and overlays to BEG.
3247 o remove all text properties.
3248 o set back the buffer multibyteness. */
3251 decide_coding_unwind (Lisp_Object unwind_data
)
3253 Lisp_Object multibyte
, undo_list
, buffer
;
3255 multibyte
= XCAR (unwind_data
);
3256 unwind_data
= XCDR (unwind_data
);
3257 undo_list
= XCAR (unwind_data
);
3258 buffer
= XCDR (unwind_data
);
3260 set_buffer_internal (XBUFFER (buffer
));
3261 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3262 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3263 set_buffer_intervals (current_buffer
, NULL
);
3264 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3266 /* Now we are safe to change the buffer's multibyteness directly. */
3267 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3268 bset_undo_list (current_buffer
, undo_list
);
3271 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3272 object where slot 0 is the file descriptor, slot 1 specifies
3273 an offset to put the read bytes, and slot 2 is the maximum
3274 amount of bytes to read. Value is the number of bytes read. */
3277 read_non_regular (Lisp_Object state
)
3283 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3284 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3285 + XSAVE_INTEGER (state
, 1)),
3286 XSAVE_INTEGER (state
, 2));
3288 /* Fast recycle this object for the likely next call. */
3290 return make_number (nbytes
);
3294 /* Condition-case handler used when reading from non-regular files
3295 in insert-file-contents. */
3298 read_non_regular_quit (Lisp_Object ignore
)
3303 /* Return the file offset that VAL represents, checking for type
3304 errors and overflow. */
3306 file_offset (Lisp_Object val
)
3308 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3313 double v
= XFLOAT_DATA (val
);
3315 && (sizeof (off_t
) < sizeof v
3316 ? v
<= TYPE_MAXIMUM (off_t
)
3317 : v
< TYPE_MAXIMUM (off_t
)))
3321 wrong_type_argument (intern ("file-offset"), val
);
3324 /* Return a special time value indicating the error number ERRNUM. */
3325 static struct timespec
3326 time_error_value (int errnum
)
3328 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3329 ? NONEXISTENT_MODTIME_NSECS
3330 : UNKNOWN_MODTIME_NSECS
);
3331 return make_timespec (0, ns
);
3335 get_window_points_and_markers (void)
3337 Lisp_Object pt_marker
= Fpoint_marker ();
3339 = call3 (Qget_buffer_window_list
, Fcurrent_buffer (), Qnil
, Qt
);
3340 Lisp_Object window_markers
= windows
;
3341 /* Window markers (and point) are handled specially: rather than move to
3342 just before or just after the modified text, we try to keep the
3343 markers at the same distance (bug#19161).
3344 In general, this is wrong, but for window-markers, this should be harmless
3345 and is convenient for the end user when most of the file is unmodified,
3346 except for a few minor details near the beginning and near the end. */
3347 for (; CONSP (windows
); windows
= XCDR (windows
))
3348 if (WINDOWP (XCAR (windows
)))
3350 Lisp_Object window_marker
= XWINDOW (XCAR (windows
))->pointm
;
3352 Fcons (window_marker
, Fmarker_position (window_marker
)));
3354 return Fcons (Fcons (pt_marker
, Fpoint ()), window_markers
);
3358 restore_window_points (Lisp_Object window_markers
, ptrdiff_t inserted
,
3359 ptrdiff_t same_at_start
, ptrdiff_t same_at_end
)
3361 for (; CONSP (window_markers
); window_markers
= XCDR (window_markers
))
3362 if (CONSP (XCAR (window_markers
)))
3364 Lisp_Object car
= XCAR (window_markers
);
3365 Lisp_Object marker
= XCAR (car
);
3366 Lisp_Object oldpos
= XCDR (car
);
3367 if (MARKERP (marker
) && INTEGERP (oldpos
)
3368 && XINT (oldpos
) > same_at_start
3369 && XINT (oldpos
) < same_at_end
)
3371 ptrdiff_t oldsize
= same_at_end
- same_at_start
;
3372 ptrdiff_t newsize
= inserted
;
3373 double growth
= newsize
/ (double)oldsize
;
3375 = same_at_start
+ growth
* (XINT (oldpos
) - same_at_start
);
3376 Fset_marker (marker
, make_number (newpos
), Qnil
);
3381 /* FIXME: insert-file-contents should be split with the top-level moved to
3382 Elisp and only the core kept in C. */
3384 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3386 doc
: /* Insert contents of file FILENAME after point.
3387 Returns list of absolute file name and number of characters inserted.
3388 If second argument VISIT is non-nil, the buffer's visited filename and
3389 last save file modtime are set, and it is marked unmodified. If
3390 visiting and the file does not exist, visiting is completed before the
3393 The optional third and fourth arguments BEG and END specify what portion
3394 of the file to insert. These arguments count bytes in the file, not
3395 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3397 If optional fifth argument REPLACE is non-nil, replace the current
3398 buffer contents (in the accessible portion) with the file contents.
3399 This is better than simply deleting and inserting the whole thing
3400 because (1) it preserves some marker positions and (2) it puts less data
3401 in the undo list. When REPLACE is non-nil, the second return value is
3402 the number of characters that replace previous buffer contents.
3404 This function does code conversion according to the value of
3405 `coding-system-for-read' or `file-coding-system-alist', and sets the
3406 variable `last-coding-system-used' to the coding system actually used.
3408 In addition, this function decodes the inserted text from known formats
3409 by calling `format-decode', which see. */)
3410 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3413 struct timespec mtime
;
3415 ptrdiff_t inserted
= 0;
3417 off_t beg_offset
, end_offset
;
3419 ptrdiff_t count
= SPECPDL_INDEX ();
3420 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3421 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3423 ptrdiff_t total
= 0;
3424 bool not_regular
= 0;
3426 char read_buf
[READ_BUF_SIZE
];
3427 struct coding_system coding
;
3428 bool replace_handled
= false;
3429 bool set_coding_system
= false;
3430 Lisp_Object coding_system
;
3431 bool read_quit
= false;
3432 /* If the undo log only contains the insertion, there's no point
3433 keeping it. It's typically when we first fill a file-buffer. */
3434 bool empty_undo_list_p
3435 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3437 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3438 bool we_locked_file
= false;
3440 Lisp_Object window_markers
= Qnil
;
3441 /* same_at_start and same_at_end count bytes, because file access counts
3442 bytes and BEG and END count bytes. */
3443 ptrdiff_t same_at_start
= BEGV_BYTE
;
3444 ptrdiff_t same_at_end
= ZV_BYTE
;
3445 /* SAME_AT_END_CHARPOS counts characters, because
3446 restore_window_points needs the old character count. */
3447 ptrdiff_t same_at_end_charpos
= ZV
;
3449 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3450 error ("Cannot do file visiting in an indirect buffer");
3452 if (!NILP (BVAR (current_buffer
, read_only
)))
3453 Fbarf_if_buffer_read_only (Qnil
);
3457 orig_filename
= Qnil
;
3460 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3462 CHECK_STRING (filename
);
3463 filename
= Fexpand_file_name (filename
, Qnil
);
3465 /* The value Qnil means that the coding system is not yet
3467 coding_system
= Qnil
;
3469 /* If the file name has special constructs in it,
3470 call the corresponding file handler. */
3471 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3472 if (!NILP (handler
))
3474 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3475 visit
, beg
, end
, replace
);
3476 if (CONSP (val
) && CONSP (XCDR (val
))
3477 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3478 inserted
= XINT (XCAR (XCDR (val
)));
3482 orig_filename
= filename
;
3483 filename
= ENCODE_FILE (filename
);
3485 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3490 report_file_error ("Opening input file", orig_filename
);
3491 mtime
= time_error_value (save_errno
);
3493 if (!NILP (Vcoding_system_for_read
))
3494 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3498 fd_index
= SPECPDL_INDEX ();
3499 record_unwind_protect_int (close_file_unwind
, fd
);
3501 /* Replacement should preserve point as it preserves markers. */
3502 if (!NILP (replace
))
3504 window_markers
= get_window_points_and_markers ();
3505 record_unwind_protect (restore_point_unwind
,
3506 XCAR (XCAR (window_markers
)));
3509 if (fstat (fd
, &st
) != 0)
3510 report_file_error ("Input file status", orig_filename
);
3511 mtime
= get_stat_mtime (&st
);
3513 /* This code will need to be changed in order to work on named
3514 pipes, and it's probably just not worth it. So we should at
3515 least signal an error. */
3516 if (!S_ISREG (st
.st_mode
))
3523 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3524 xsignal2 (Qfile_error
,
3525 build_string ("not a regular file"), orig_filename
);
3530 if (!NILP (beg
) || !NILP (end
))
3531 error ("Attempt to visit less than an entire file");
3532 if (BEG
< Z
&& NILP (replace
))
3533 error ("Cannot do file visiting in a non-empty buffer");
3537 beg_offset
= file_offset (beg
);
3542 end_offset
= file_offset (end
);
3546 end_offset
= TYPE_MAXIMUM (off_t
);
3549 end_offset
= st
.st_size
;
3551 /* A negative size can happen on a platform that allows file
3552 sizes greater than the maximum off_t value. */
3556 /* The file size returned from stat may be zero, but data
3557 may be readable nonetheless, for example when this is a
3558 file in the /proc filesystem. */
3559 if (end_offset
== 0)
3560 end_offset
= READ_BUF_SIZE
;
3564 /* Check now whether the buffer will become too large,
3565 in the likely case where the file's length is not changing.
3566 This saves a lot of needless work before a buffer overflow. */
3569 /* The likely offset where we will stop reading. We could read
3570 more (or less), if the file grows (or shrinks) as we read it. */
3571 off_t likely_end
= min (end_offset
, st
.st_size
);
3573 if (beg_offset
< likely_end
)
3576 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3577 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3578 off_t likely_growth
= likely_end
- beg_offset
;
3579 if (buf_growth_max
< likely_growth
)
3584 /* Prevent redisplay optimizations. */
3585 current_buffer
->clip_changed
= true;
3587 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3589 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3590 setup_coding_system (coding_system
, &coding
);
3591 /* Ensure we set Vlast_coding_system_used. */
3592 set_coding_system
= true;
3596 /* Decide the coding system to use for reading the file now
3597 because we can't use an optimized method for handling
3598 `coding:' tag if the current buffer is not empty. */
3599 if (!NILP (Vcoding_system_for_read
))
3600 coding_system
= Vcoding_system_for_read
;
3603 /* Don't try looking inside a file for a coding system
3604 specification if it is not seekable. */
3605 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3607 /* Find a coding system specified in the heading two
3608 lines or in the tailing several lines of the file.
3609 We assume that the 1K-byte and 3K-byte for heading
3610 and tailing respectively are sufficient for this
3614 if (st
.st_size
<= (1024 * 4))
3615 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3618 nread
= emacs_read (fd
, read_buf
, 1024);
3622 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3623 report_file_error ("Setting file position",
3625 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3626 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3631 report_file_error ("Read error", orig_filename
);
3634 AUTO_STRING (name
, " *code-converting-work*");
3635 struct buffer
*prev
= current_buffer
;
3636 Lisp_Object workbuf
;
3639 record_unwind_current_buffer ();
3641 workbuf
= Fget_buffer_create (name
);
3642 buf
= XBUFFER (workbuf
);
3644 delete_all_overlays (buf
);
3645 bset_directory (buf
, BVAR (current_buffer
, directory
));
3646 bset_read_only (buf
, Qnil
);
3647 bset_filename (buf
, Qnil
);
3648 bset_undo_list (buf
, Qt
);
3649 eassert (buf
->overlays_before
== NULL
);
3650 eassert (buf
->overlays_after
== NULL
);
3652 set_buffer_internal (buf
);
3654 bset_enable_multibyte_characters (buf
, Qnil
);
3656 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3657 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3658 coding_system
= call2 (Vset_auto_coding_function
,
3659 filename
, make_number (nread
));
3660 set_buffer_internal (prev
);
3662 /* Discard the unwind protect for recovering the
3666 /* Rewind the file for the actual read done later. */
3667 if (lseek (fd
, 0, SEEK_SET
) < 0)
3668 report_file_error ("Setting file position", orig_filename
);
3672 if (NILP (coding_system
))
3674 /* If we have not yet decided a coding system, check
3675 file-coding-system-alist. */
3676 Lisp_Object args
[6];
3678 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3679 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3680 coding_system
= Ffind_operation_coding_system (6, args
);
3681 if (CONSP (coding_system
))
3682 coding_system
= XCAR (coding_system
);
3686 if (NILP (coding_system
))
3687 coding_system
= Qundecided
;
3689 CHECK_CODING_SYSTEM (coding_system
);
3691 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3692 /* We must suppress all character code conversion except for
3693 end-of-line conversion. */
3694 coding_system
= raw_text_coding_system (coding_system
);
3696 setup_coding_system (coding_system
, &coding
);
3697 /* Ensure we set Vlast_coding_system_used. */
3698 set_coding_system
= true;
3701 /* If requested, replace the accessible part of the buffer
3702 with the file contents. Avoid replacing text at the
3703 beginning or end of the buffer that matches the file contents;
3704 that preserves markers pointing to the unchanged parts.
3706 Here we implement this feature in an optimized way
3707 for the case where code conversion is NOT needed.
3708 The following if-statement handles the case of conversion
3709 in a less optimal way.
3711 If the code conversion is "automatic" then we try using this
3712 method and hope for the best.
3713 But if we discover the need for conversion, we give up on this method
3714 and let the following if-statement handle the replace job. */
3717 && (NILP (coding_system
)
3718 || ! CODING_REQUIRE_DECODING (&coding
)))
3721 /* There is still a possibility we will find the need to do code
3722 conversion. If that happens, set this variable to
3723 give up on handling REPLACE in the optimized way. */
3724 bool giveup_match_end
= false;
3726 if (beg_offset
!= 0)
3728 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3729 report_file_error ("Setting file position", orig_filename
);
3734 /* Count how many chars at the start of the file
3735 match the text at the beginning of the buffer. */
3740 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3742 report_file_error ("Read error", orig_filename
);
3743 else if (nread
== 0)
3746 if (CODING_REQUIRE_DETECTION (&coding
))
3748 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3751 setup_coding_system (coding_system
, &coding
);
3754 if (CODING_REQUIRE_DECODING (&coding
))
3755 /* We found that the file should be decoded somehow.
3756 Let's give up here. */
3758 giveup_match_end
= true;
3763 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3764 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3765 same_at_start
++, bufpos
++;
3766 /* If we found a discrepancy, stop the scan.
3767 Otherwise loop around and scan the next bufferful. */
3768 if (bufpos
!= nread
)
3771 immediate_quit
= false;
3772 /* If the file matches the buffer completely,
3773 there's no need to replace anything. */
3774 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3777 clear_unwind_protect (fd_index
);
3779 /* Truncate the buffer to the size of the file. */
3780 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3783 immediate_quit
= true;
3785 /* Count how many chars at the end of the file
3786 match the text at the end of the buffer. But, if we have
3787 already found that decoding is necessary, don't waste time. */
3788 while (!giveup_match_end
)
3790 int total_read
, nread
, bufpos
, trial
;
3793 /* At what file position are we now scanning? */
3794 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3795 /* If the entire file matches the buffer tail, stop the scan. */
3798 /* How much can we scan in the next step? */
3799 trial
= min (curpos
, sizeof read_buf
);
3800 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3801 report_file_error ("Setting file position", orig_filename
);
3803 total_read
= nread
= 0;
3804 while (total_read
< trial
)
3806 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3808 report_file_error ("Read error", orig_filename
);
3809 else if (nread
== 0)
3811 total_read
+= nread
;
3814 /* Scan this bufferful from the end, comparing with
3815 the Emacs buffer. */
3816 bufpos
= total_read
;
3818 /* Compare with same_at_start to avoid counting some buffer text
3819 as matching both at the file's beginning and at the end. */
3820 while (bufpos
> 0 && same_at_end
> same_at_start
3821 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3822 same_at_end
--, bufpos
--;
3824 /* If we found a discrepancy, stop the scan.
3825 Otherwise loop around and scan the preceding bufferful. */
3828 /* If this discrepancy is because of code conversion,
3829 we cannot use this method; giveup and try the other. */
3830 if (same_at_end
> same_at_start
3831 && FETCH_BYTE (same_at_end
- 1) >= 0200
3832 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3833 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3834 giveup_match_end
= true;
3843 if (! giveup_match_end
)
3847 /* We win! We can handle REPLACE the optimized way. */
3849 /* Extend the start of non-matching text area to multibyte
3850 character boundary. */
3851 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3852 while (same_at_start
> BEGV_BYTE
3853 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3856 /* Extend the end of non-matching text area to multibyte
3857 character boundary. */
3858 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3859 while (same_at_end
< ZV_BYTE
3860 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3863 /* Don't try to reuse the same piece of text twice. */
3864 overlap
= (same_at_start
- BEGV_BYTE
3866 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3868 same_at_end
+= overlap
;
3869 same_at_end_charpos
= BYTE_TO_CHAR (same_at_end
);
3871 /* Arrange to read only the nonmatching middle part of the file. */
3872 beg_offset
+= same_at_start
- BEGV_BYTE
;
3873 end_offset
-= ZV_BYTE
- same_at_end
;
3875 invalidate_buffer_caches (current_buffer
,
3876 BYTE_TO_CHAR (same_at_start
),
3877 same_at_end_charpos
);
3878 del_range_byte (same_at_start
, same_at_end
, 0);
3879 /* Insert from the file at the proper position. */
3880 temp
= BYTE_TO_CHAR (same_at_start
);
3881 SET_PT_BOTH (temp
, same_at_start
);
3883 /* If display currently starts at beginning of line,
3884 keep it that way. */
3885 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3886 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3888 replace_handled
= true;
3892 /* If requested, replace the accessible part of the buffer
3893 with the file contents. Avoid replacing text at the
3894 beginning or end of the buffer that matches the file contents;
3895 that preserves markers pointing to the unchanged parts.
3897 Here we implement this feature for the case where code conversion
3898 is needed, in a simple way that needs a lot of memory.
3899 The preceding if-statement handles the case of no conversion
3900 in a more optimized way. */
3901 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3903 ptrdiff_t same_at_start_charpos
;
3904 ptrdiff_t inserted_chars
;
3907 unsigned char *decoded
;
3910 ptrdiff_t this_count
= SPECPDL_INDEX ();
3912 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3913 Lisp_Object conversion_buffer
;
3914 struct gcpro gcpro1
;
3916 conversion_buffer
= code_conversion_save (1, multibyte
);
3918 /* First read the whole file, performing code conversion into
3919 CONVERSION_BUFFER. */
3921 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3922 report_file_error ("Setting file position", orig_filename
);
3924 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3925 unprocessed
= 0; /* Bytes not processed in previous loop. */
3927 GCPRO1 (conversion_buffer
);
3930 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3931 quitting while reading a huge file. */
3933 /* Allow quitting out of the actual I/O. */
3936 this = emacs_read (fd
, read_buf
+ unprocessed
,
3937 READ_BUF_SIZE
- unprocessed
);
3943 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3944 BUF_Z (XBUFFER (conversion_buffer
)));
3945 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3946 unprocessed
+ this, conversion_buffer
);
3947 unprocessed
= coding
.carryover_bytes
;
3948 if (coding
.carryover_bytes
> 0)
3949 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3953 report_file_error ("Read error", orig_filename
);
3955 clear_unwind_protect (fd_index
);
3957 if (unprocessed
> 0)
3959 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3960 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3961 unprocessed
, conversion_buffer
);
3962 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3965 coding_system
= CODING_ID_NAME (coding
.id
);
3966 set_coding_system
= true;
3967 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3968 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3969 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3971 /* Compare the beginning of the converted string with the buffer
3975 while (bufpos
< inserted
&& same_at_start
< same_at_end
3976 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3977 same_at_start
++, bufpos
++;
3979 /* If the file matches the head of buffer completely,
3980 there's no need to replace anything. */
3982 if (bufpos
== inserted
)
3984 /* Truncate the buffer to the size of the file. */
3985 if (same_at_start
!= same_at_end
)
3987 invalidate_buffer_caches (current_buffer
,
3988 BYTE_TO_CHAR (same_at_start
),
3989 BYTE_TO_CHAR (same_at_end
));
3990 del_range_byte (same_at_start
, same_at_end
, 0);
3994 unbind_to (this_count
, Qnil
);
3998 /* Extend the start of non-matching text area to the previous
3999 multibyte character boundary. */
4000 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4001 while (same_at_start
> BEGV_BYTE
4002 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4005 /* Scan this bufferful from the end, comparing with
4006 the Emacs buffer. */
4009 /* Compare with same_at_start to avoid counting some buffer text
4010 as matching both at the file's beginning and at the end. */
4011 while (bufpos
> 0 && same_at_end
> same_at_start
4012 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4013 same_at_end
--, bufpos
--;
4015 /* Extend the end of non-matching text area to the next
4016 multibyte character boundary. */
4017 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4018 while (same_at_end
< ZV_BYTE
4019 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4022 /* Don't try to reuse the same piece of text twice. */
4023 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4025 same_at_end
+= overlap
;
4026 same_at_end_charpos
= BYTE_TO_CHAR (same_at_end
);
4028 /* If display currently starts at beginning of line,
4029 keep it that way. */
4030 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4031 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4033 /* Replace the chars that we need to replace,
4034 and update INSERTED to equal the number of bytes
4035 we are taking from the decoded string. */
4036 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4038 if (same_at_end
!= same_at_start
)
4040 invalidate_buffer_caches (current_buffer
,
4041 BYTE_TO_CHAR (same_at_start
),
4042 same_at_end_charpos
);
4043 del_range_byte (same_at_start
, same_at_end
, 0);
4045 eassert (same_at_start
== GPT_BYTE
);
4046 same_at_start
= GPT_BYTE
;
4050 temp
= same_at_end_charpos
;
4052 /* Insert from the file at the proper position. */
4053 SET_PT_BOTH (temp
, same_at_start
);
4054 same_at_start_charpos
4055 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4056 same_at_start
- BEGV_BYTE
4057 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4058 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4060 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4061 same_at_start
+ inserted
- BEGV_BYTE
4062 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4063 - same_at_start_charpos
);
4064 /* This binding is to avoid ask-user-about-supersession-threat
4065 being called in insert_from_buffer (via in
4066 prepare_to_modify_buffer). */
4067 specbind (intern ("buffer-file-name"), Qnil
);
4068 insert_from_buffer (XBUFFER (conversion_buffer
),
4069 same_at_start_charpos
, inserted_chars
, 0);
4070 /* Set `inserted' to the number of inserted characters. */
4071 inserted
= PT
- temp
;
4072 /* Set point before the inserted characters. */
4073 SET_PT_BOTH (temp
, same_at_start
);
4075 unbind_to (this_count
, Qnil
);
4081 total
= end_offset
- beg_offset
;
4083 /* For a special file, all we can do is guess. */
4084 total
= READ_BUF_SIZE
;
4086 if (NILP (visit
) && total
> 0)
4088 if (!NILP (BVAR (current_buffer
, file_truename
))
4089 /* Make binding buffer-file-name to nil effective. */
4090 && !NILP (BVAR (current_buffer
, filename
))
4091 && SAVE_MODIFF
>= MODIFF
)
4092 we_locked_file
= true;
4093 prepare_to_modify_buffer (PT
, PT
, NULL
);
4096 move_gap_both (PT
, PT_BYTE
);
4097 if (GAP_SIZE
< total
)
4098 make_gap (total
- GAP_SIZE
);
4100 if (beg_offset
!= 0 || !NILP (replace
))
4102 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4103 report_file_error ("Setting file position", orig_filename
);
4106 /* In the following loop, HOW_MUCH contains the total bytes read so
4107 far for a regular file, and not changed for a special file. But,
4108 before exiting the loop, it is set to a negative value if I/O
4112 /* Total bytes inserted. */
4115 /* Here, we don't do code conversion in the loop. It is done by
4116 decode_coding_gap after all data are read into the buffer. */
4118 ptrdiff_t gap_size
= GAP_SIZE
;
4120 while (how_much
< total
)
4122 /* `try' is reserved in some compilers (Microsoft C). */
4123 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4130 /* Maybe make more room. */
4131 if (gap_size
< trytry
)
4133 make_gap (trytry
- gap_size
);
4134 gap_size
= GAP_SIZE
- inserted
;
4137 /* Read from the file, capturing `quit'. When an
4138 error occurs, end the loop, and arrange for a quit
4139 to be signaled after decoding the text we read. */
4140 nbytes
= internal_condition_case_1
4142 make_save_int_int_int (fd
, inserted
, trytry
),
4143 Qerror
, read_non_regular_quit
);
4151 this = XINT (nbytes
);
4155 /* Allow quitting out of the actual I/O. We don't make text
4156 part of the buffer until all the reading is done, so a C-g
4157 here doesn't do any harm. */
4160 this = emacs_read (fd
,
4161 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4175 /* For a regular file, where TOTAL is the real size,
4176 count HOW_MUCH to compare with it.
4177 For a special file, where TOTAL is just a buffer size,
4178 so don't bother counting in HOW_MUCH.
4179 (INSERTED is where we count the number of characters inserted.) */
4186 /* Now we have either read all the file data into the gap,
4187 or stop reading on I/O error or quit. If nothing was
4188 read, undo marking the buffer modified. */
4193 unlock_file (BVAR (current_buffer
, file_truename
));
4194 Vdeactivate_mark
= old_Vdeactivate_mark
;
4197 Vdeactivate_mark
= Qt
;
4200 clear_unwind_protect (fd_index
);
4203 report_file_error ("Read error", orig_filename
);
4205 /* Make the text read part of the buffer. */
4206 GAP_SIZE
-= inserted
;
4208 GPT_BYTE
+= inserted
;
4210 ZV_BYTE
+= inserted
;
4215 /* Put an anchor to ensure multi-byte form ends at gap. */
4220 if (NILP (coding_system
))
4222 /* The coding system is not yet decided. Decide it by an
4223 optimized method for handling `coding:' tag.
4225 Note that we can get here only if the buffer was empty
4226 before the insertion. */
4228 if (!NILP (Vcoding_system_for_read
))
4229 coding_system
= Vcoding_system_for_read
;
4232 /* Since we are sure that the current buffer was empty
4233 before the insertion, we can toggle
4234 enable-multibyte-characters directly here without taking
4235 care of marker adjustment. By this way, we can run Lisp
4236 program safely before decoding the inserted text. */
4237 Lisp_Object unwind_data
;
4238 ptrdiff_t count1
= SPECPDL_INDEX ();
4240 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4241 Fcons (BVAR (current_buffer
, undo_list
),
4242 Fcurrent_buffer ()));
4243 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4244 bset_undo_list (current_buffer
, Qt
);
4245 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4247 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4249 coding_system
= call2 (Vset_auto_coding_function
,
4250 filename
, make_number (inserted
));
4253 if (NILP (coding_system
))
4255 /* If the coding system is not yet decided, check
4256 file-coding-system-alist. */
4257 Lisp_Object args
[6];
4259 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4260 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4261 coding_system
= Ffind_operation_coding_system (6, args
);
4262 if (CONSP (coding_system
))
4263 coding_system
= XCAR (coding_system
);
4265 unbind_to (count1
, Qnil
);
4266 inserted
= Z_BYTE
- BEG_BYTE
;
4269 if (NILP (coding_system
))
4270 coding_system
= Qundecided
;
4272 CHECK_CODING_SYSTEM (coding_system
);
4274 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4275 /* We must suppress all character code conversion except for
4276 end-of-line conversion. */
4277 coding_system
= raw_text_coding_system (coding_system
);
4278 setup_coding_system (coding_system
, &coding
);
4279 /* Ensure we set Vlast_coding_system_used. */
4280 set_coding_system
= true;
4285 /* When we visit a file by raw-text, we change the buffer to
4287 if (CODING_FOR_UNIBYTE (&coding
)
4288 /* Can't do this if part of the buffer might be preserved. */
4290 /* Visiting a file with these coding system makes the buffer
4292 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4295 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4296 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4297 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4299 move_gap_both (PT
, PT_BYTE
);
4300 GAP_SIZE
+= inserted
;
4301 ZV_BYTE
-= inserted
;
4305 decode_coding_gap (&coding
, inserted
, inserted
);
4306 inserted
= coding
.produced_char
;
4307 coding_system
= CODING_ID_NAME (coding
.id
);
4309 else if (inserted
> 0)
4311 invalidate_buffer_caches (current_buffer
, PT
, PT
+ inserted
);
4312 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4316 /* Call after-change hooks for the inserted text, aside from the case
4317 of normal visiting (not with REPLACE), which is done in a new buffer
4318 "before" the buffer is changed. */
4319 if (inserted
> 0 && total
> 0
4320 && (NILP (visit
) || !NILP (replace
)))
4322 signal_after_change (PT
, 0, inserted
);
4323 update_compositions (PT
, PT
, CHECK_BORDER
);
4326 /* Now INSERTED is measured in characters. */
4331 restore_window_points (window_markers
, inserted
,
4332 BYTE_TO_CHAR (same_at_start
),
4333 same_at_end_charpos
);
4337 if (empty_undo_list_p
)
4338 bset_undo_list (current_buffer
, Qnil
);
4342 current_buffer
->modtime
= mtime
;
4343 current_buffer
->modtime_size
= st
.st_size
;
4344 bset_filename (current_buffer
, orig_filename
);
4347 SAVE_MODIFF
= MODIFF
;
4348 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4349 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4352 if (!NILP (BVAR (current_buffer
, file_truename
)))
4353 unlock_file (BVAR (current_buffer
, file_truename
));
4354 unlock_file (filename
);
4357 xsignal2 (Qfile_error
,
4358 build_string ("not a regular file"), orig_filename
);
4361 if (set_coding_system
)
4362 Vlast_coding_system_used
= coding_system
;
4364 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4366 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4368 if (! NILP (insval
))
4370 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4371 wrong_type_argument (intern ("inserted-chars"), insval
);
4372 inserted
= XFASTINT (insval
);
4376 /* Decode file format. */
4379 /* Don't run point motion or modification hooks when decoding. */
4380 ptrdiff_t count1
= SPECPDL_INDEX ();
4381 ptrdiff_t old_inserted
= inserted
;
4382 specbind (Qinhibit_point_motion_hooks
, Qt
);
4383 specbind (Qinhibit_modification_hooks
, Qt
);
4385 /* Save old undo list and don't record undo for decoding. */
4386 old_undo
= BVAR (current_buffer
, undo_list
);
4387 bset_undo_list (current_buffer
, Qt
);
4391 insval
= call3 (Qformat_decode
,
4392 Qnil
, make_number (inserted
), visit
);
4393 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4394 wrong_type_argument (intern ("inserted-chars"), insval
);
4395 inserted
= XFASTINT (insval
);
4399 /* If REPLACE is non-nil and we succeeded in not replacing the
4400 beginning or end of the buffer text with the file's contents,
4401 call format-decode with `point' positioned at the beginning
4402 of the buffer and `inserted' equaling the number of
4403 characters in the buffer. Otherwise, format-decode might
4404 fail to correctly analyze the beginning or end of the buffer.
4405 Hence we temporarily save `point' and `inserted' here and
4406 restore `point' iff format-decode did not insert or delete
4407 any text. Otherwise we leave `point' at point-min. */
4408 ptrdiff_t opoint
= PT
;
4409 ptrdiff_t opoint_byte
= PT_BYTE
;
4410 ptrdiff_t oinserted
= ZV
- BEGV
;
4411 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4413 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4414 insval
= call3 (Qformat_decode
,
4415 Qnil
, make_number (oinserted
), visit
);
4416 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4417 wrong_type_argument (intern ("inserted-chars"), insval
);
4418 if (ochars_modiff
== CHARS_MODIFF
)
4419 /* format_decode didn't modify buffer's characters => move
4420 point back to position before inserted text and leave
4421 value of inserted alone. */
4422 SET_PT_BOTH (opoint
, opoint_byte
);
4424 /* format_decode modified buffer's characters => consider
4425 entire buffer changed and leave point at point-min. */
4426 inserted
= XFASTINT (insval
);
4429 /* For consistency with format-decode call these now iff inserted > 0
4430 (martin 2007-06-28). */
4431 p
= Vafter_insert_file_functions
;
4436 insval
= call1 (XCAR (p
), make_number (inserted
));
4439 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4440 wrong_type_argument (intern ("inserted-chars"), insval
);
4441 inserted
= XFASTINT (insval
);
4446 /* For the rationale of this see the comment on
4447 format-decode above. */
4448 ptrdiff_t opoint
= PT
;
4449 ptrdiff_t opoint_byte
= PT_BYTE
;
4450 ptrdiff_t oinserted
= ZV
- BEGV
;
4451 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4453 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4454 insval
= call1 (XCAR (p
), make_number (oinserted
));
4457 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4458 wrong_type_argument (intern ("inserted-chars"), insval
);
4459 if (ochars_modiff
== CHARS_MODIFF
)
4460 /* after_insert_file_functions didn't modify
4461 buffer's characters => move point back to
4462 position before inserted text and leave value of
4464 SET_PT_BOTH (opoint
, opoint_byte
);
4466 /* after_insert_file_functions did modify buffer's
4467 characters => consider entire buffer changed and
4468 leave point at point-min. */
4469 inserted
= XFASTINT (insval
);
4477 if (!empty_undo_list_p
)
4479 bset_undo_list (current_buffer
, old_undo
);
4480 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4482 /* Adjust the last undo record for the size change during
4483 the format conversion. */
4484 Lisp_Object tem
= XCAR (old_undo
);
4485 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4486 && INTEGERP (XCDR (tem
))
4487 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4488 XSETCDR (tem
, make_number (PT
+ inserted
));
4492 /* If undo_list was Qt before, keep it that way.
4493 Otherwise start with an empty undo_list. */
4494 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4496 unbind_to (count1
, Qnil
);
4500 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4502 /* If visiting nonexistent file, return nil. */
4503 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4506 /* We made a lot of deletions and insertions above, so invalidate
4507 the newline cache for the entire region of the inserted
4509 if (current_buffer
->base_buffer
&& current_buffer
->base_buffer
->newline_cache
)
4510 invalidate_region_cache (current_buffer
->base_buffer
,
4511 current_buffer
->base_buffer
->newline_cache
,
4512 PT
- BEG
, Z
- PT
- inserted
);
4513 else if (current_buffer
->newline_cache
)
4514 invalidate_region_cache (current_buffer
,
4515 current_buffer
->newline_cache
,
4516 PT
- BEG
, Z
- PT
- inserted
);
4519 Fsignal (Qquit
, Qnil
);
4521 /* Retval needs to be dealt with in all cases consistently. */
4523 val
= list2 (orig_filename
, make_number (inserted
));
4525 RETURN_UNGCPRO (unbind_to (count
, val
));
4528 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4531 build_annotations_unwind (Lisp_Object arg
)
4533 Vwrite_region_annotation_buffers
= arg
;
4536 /* Decide the coding-system to encode the data with. */
4539 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4540 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4541 struct coding_system
*coding
)
4544 Lisp_Object eol_parent
= Qnil
;
4547 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4548 BVAR (current_buffer
, auto_save_file_name
))))
4553 else if (!NILP (Vcoding_system_for_write
))
4555 val
= Vcoding_system_for_write
;
4556 if (coding_system_require_warning
4557 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4558 /* Confirm that VAL can surely encode the current region. */
4559 val
= call5 (Vselect_safe_coding_system_function
,
4560 start
, end
, list2 (Qt
, val
),
4565 /* If the variable `buffer-file-coding-system' is set locally,
4566 it means that the file was read with some kind of code
4567 conversion or the variable is explicitly set by users. We
4568 had better write it out with the same coding system even if
4569 `enable-multibyte-characters' is nil.
4571 If it is not set locally, we anyway have to convert EOL
4572 format if the default value of `buffer-file-coding-system'
4573 tells that it is not Unix-like (LF only) format. */
4574 bool using_default_coding
= 0;
4575 bool force_raw_text
= 0;
4577 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4579 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4582 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4588 /* Check file-coding-system-alist. */
4589 Lisp_Object args
[7], coding_systems
;
4591 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4592 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4594 coding_systems
= Ffind_operation_coding_system (7, args
);
4595 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4596 val
= XCDR (coding_systems
);
4601 /* If we still have not decided a coding system, use the
4602 default value of buffer-file-coding-system. */
4603 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4604 using_default_coding
= 1;
4607 if (! NILP (val
) && ! force_raw_text
)
4609 Lisp_Object spec
, attrs
;
4611 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4612 attrs
= AREF (spec
, 0);
4613 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4618 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4619 /* Confirm that VAL can surely encode the current region. */
4620 val
= call5 (Vselect_safe_coding_system_function
,
4621 start
, end
, val
, Qnil
, filename
);
4623 /* If the decided coding-system doesn't specify end-of-line
4624 format, we use that of
4625 `default-buffer-file-coding-system'. */
4626 if (! using_default_coding
4627 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4628 val
= (coding_inherit_eol_type
4629 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4631 /* If we decide not to encode text, use `raw-text' or one of its
4634 val
= raw_text_coding_system (val
);
4637 val
= coding_inherit_eol_type (val
, eol_parent
);
4638 setup_coding_system (val
, coding
);
4640 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4641 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4645 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4646 "r\nFWrite region to file: \ni\ni\ni\np",
4647 doc
: /* Write current region into specified file.
4648 When called from a program, requires three arguments:
4649 START, END and FILENAME. START and END are normally buffer positions
4650 specifying the part of the buffer to write.
4651 If START is nil, that means to use the entire buffer contents.
4652 If START is a string, then output that string to the file
4653 instead of any buffer contents; END is ignored.
4655 Optional fourth argument APPEND if non-nil means
4656 append to existing file contents (if any). If it is a number,
4657 seek to that offset in the file before writing.
4658 Optional fifth argument VISIT, if t or a string, means
4659 set the last-save-file-modtime of buffer to this file's modtime
4660 and mark buffer not modified.
4661 If VISIT is a string, it is a second file name;
4662 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4663 VISIT is also the file name to lock and unlock for clash detection.
4664 If VISIT is neither t nor nil nor a string, or if Emacs is in batch mode,
4665 do not display the \"Wrote file\" message.
4666 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4667 use for locking and unlocking, overriding FILENAME and VISIT.
4668 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4669 for an existing file with the same name. If MUSTBENEW is `excl',
4670 that means to get an error if the file already exists; never overwrite.
4671 If MUSTBENEW is neither nil nor `excl', that means ask for
4672 confirmation before overwriting, but do go ahead and overwrite the file
4673 if the user confirms.
4675 This does code conversion according to the value of
4676 `coding-system-for-write', `buffer-file-coding-system', or
4677 `file-coding-system-alist', and sets the variable
4678 `last-coding-system-used' to the coding system actually used.
4680 This calls `write-region-annotate-functions' at the start, and
4681 `write-region-post-annotation-function' at the end. */)
4682 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4683 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4685 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4689 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4690 descriptor for FILENAME, so do not open or close FILENAME. */
4693 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4694 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4695 Lisp_Object mustbenew
, int desc
)
4699 off_t offset
IF_LINT (= 0);
4700 bool open_and_close_file
= desc
< 0;
4705 struct timespec modtime
;
4706 ptrdiff_t count
= SPECPDL_INDEX ();
4707 ptrdiff_t count1
IF_LINT (= 0);
4708 Lisp_Object handler
;
4709 Lisp_Object visit_file
;
4710 Lisp_Object annotations
;
4711 Lisp_Object encoded_filename
;
4712 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4713 bool quietly
= !NILP (visit
);
4714 bool file_locked
= 0;
4715 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4716 struct buffer
*given_buffer
;
4717 struct coding_system coding
;
4719 if (current_buffer
->base_buffer
&& visiting
)
4720 error ("Cannot do file visiting in an indirect buffer");
4722 if (!NILP (start
) && !STRINGP (start
))
4723 validate_region (&start
, &end
);
4726 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4728 filename
= Fexpand_file_name (filename
, Qnil
);
4730 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4731 barf_or_query_if_file_exists (filename
, false, "overwrite", true, true);
4733 if (STRINGP (visit
))
4734 visit_file
= Fexpand_file_name (visit
, Qnil
);
4736 visit_file
= filename
;
4738 if (NILP (lockname
))
4739 lockname
= visit_file
;
4743 /* If the file name has special constructs in it,
4744 call the corresponding file handler. */
4745 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4746 /* If FILENAME has no handler, see if VISIT has one. */
4747 if (NILP (handler
) && STRINGP (visit
))
4748 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4750 if (!NILP (handler
))
4753 val
= call6 (handler
, Qwrite_region
, start
, end
,
4754 filename
, append
, visit
);
4758 SAVE_MODIFF
= MODIFF
;
4759 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4760 bset_filename (current_buffer
, visit_file
);
4766 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4768 /* Special kludge to simplify auto-saving. */
4771 /* Do it later, so write-region-annotate-function can work differently
4772 if we save "the buffer" vs "a region".
4773 This is useful in tar-mode. --Stef
4774 XSETFASTINT (start, BEG);
4775 XSETFASTINT (end, Z); */
4779 record_unwind_protect (build_annotations_unwind
,
4780 Vwrite_region_annotation_buffers
);
4781 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4783 given_buffer
= current_buffer
;
4785 if (!STRINGP (start
))
4787 annotations
= build_annotations (start
, end
);
4789 if (current_buffer
!= given_buffer
)
4791 XSETFASTINT (start
, BEGV
);
4792 XSETFASTINT (end
, ZV
);
4798 XSETFASTINT (start
, BEGV
);
4799 XSETFASTINT (end
, ZV
);
4804 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4806 /* Decide the coding-system to encode the data with.
4807 We used to make this choice before calling build_annotations, but that
4808 leads to problems when a write-annotate-function takes care of
4809 unsavable chars (as was the case with X-Symbol). */
4810 Vlast_coding_system_used
4811 = choose_write_coding_system (start
, end
, filename
,
4812 append
, visit
, lockname
, &coding
);
4814 if (open_and_close_file
&& !auto_saving
)
4816 lock_file (lockname
);
4820 encoded_filename
= ENCODE_FILE (filename
);
4821 fn
= SSDATA (encoded_filename
);
4822 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4823 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4824 if (NUMBERP (append
))
4825 offset
= file_offset (append
);
4826 else if (!NILP (append
))
4827 open_flags
|= O_APPEND
;
4829 mode
= S_IREAD
| S_IWRITE
;
4831 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4834 if (open_and_close_file
)
4836 desc
= emacs_open (fn
, open_flags
, mode
);
4839 int open_errno
= errno
;
4841 unlock_file (lockname
);
4843 report_file_errno ("Opening output file", filename
, open_errno
);
4846 count1
= SPECPDL_INDEX ();
4847 record_unwind_protect_int (close_file_unwind
, desc
);
4850 if (NUMBERP (append
))
4852 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4855 int lseek_errno
= errno
;
4857 unlock_file (lockname
);
4859 report_file_errno ("Lseek error", filename
, lseek_errno
);
4867 if (STRINGP (start
))
4868 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4869 else if (XINT (start
) != XINT (end
))
4870 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4871 &annotations
, &coding
);
4874 /* If file was empty, still need to write the annotations. */
4875 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4876 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4880 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4881 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4883 /* We have to flush out a data. */
4884 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4885 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4891 /* fsync is not crucial for temporary files. Nor for auto-save
4892 files, since they might lose some work anyway. */
4893 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4895 /* Transfer data and metadata to disk, retrying if interrupted.
4896 fsync can report a write failure here, e.g., due to disk full
4897 under NFS. But ignore EINVAL, which means fsync is not
4898 supported on this file. */
4899 while (fsync (desc
) != 0)
4902 if (errno
!= EINVAL
)
4903 ok
= 0, save_errno
= errno
;
4908 modtime
= invalid_timespec ();
4911 if (fstat (desc
, &st
) == 0)
4912 modtime
= get_stat_mtime (&st
);
4914 ok
= 0, save_errno
= errno
;
4917 if (open_and_close_file
)
4919 /* NFS can report a write failure now. */
4920 if (emacs_close (desc
) < 0)
4921 ok
= 0, save_errno
= errno
;
4923 /* Discard the unwind protect for close_file_unwind. */
4924 specpdl_ptr
= specpdl
+ count1
;
4927 /* Some file systems have a bug where st_mtime is not updated
4928 properly after a write. For example, CIFS might not see the
4929 st_mtime change until after the file is opened again.
4931 Attempt to detect this file system bug, and update MODTIME to the
4932 newer st_mtime if the bug appears to be present. This introduces
4933 a race condition, so to avoid most instances of the race condition
4934 on non-buggy file systems, skip this check if the most recently
4935 encountered non-buggy file system was the current file system.
4937 A race condition can occur if some other process modifies the
4938 file between the fstat above and the fstat below, but the race is
4939 unlikely and a similar race between the last write and the fstat
4940 above cannot possibly be closed anyway. */
4942 if (timespec_valid_p (modtime
)
4943 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4945 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4949 if (fstat (desc1
, &st1
) == 0
4950 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4952 /* Use the heuristic if it appears to be valid. With neither
4953 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4954 file, the time stamp won't change. Also, some non-POSIX
4955 systems don't update an empty file's time stamp when
4956 truncating it. Finally, file systems with 100 ns or worse
4957 resolution sometimes seem to have bugs: on a system with ns
4958 resolution, checking ns % 100 incorrectly avoids the heuristic
4959 1% of the time, but the problem should be temporary as we will
4960 try again on the next time stamp. */
4962 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4964 && modtime
.tv_nsec
% 100 != 0);
4966 struct timespec modtime1
= get_stat_mtime (&st1
);
4968 && timespec_cmp (modtime
, modtime1
) == 0
4969 && st
.st_size
== st1
.st_size
)
4971 timestamp_file_system
= st
.st_dev
;
4972 valid_timestamp_file_system
= 1;
4976 st
.st_size
= st1
.st_size
;
4980 emacs_close (desc1
);
4984 /* Call write-region-post-annotation-function. */
4985 while (CONSP (Vwrite_region_annotation_buffers
))
4987 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4988 if (!NILP (Fbuffer_live_p (buf
)))
4991 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4992 call0 (Vwrite_region_post_annotation_function
);
4994 Vwrite_region_annotation_buffers
4995 = XCDR (Vwrite_region_annotation_buffers
);
4998 unbind_to (count
, Qnil
);
5001 unlock_file (lockname
);
5003 /* Do this before reporting IO error
5004 to avoid a "file has changed on disk" warning on
5005 next attempt to save. */
5006 if (timespec_valid_p (modtime
))
5008 current_buffer
->modtime
= modtime
;
5009 current_buffer
->modtime_size
= st
.st_size
;
5013 report_file_errno ("Write error", filename
, save_errno
);
5017 SAVE_MODIFF
= MODIFF
;
5018 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5019 bset_filename (current_buffer
, visit_file
);
5020 update_mode_lines
= 14;
5025 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5026 BVAR (current_buffer
, auto_save_file_name
))))
5027 SAVE_MODIFF
= MODIFF
;
5032 if (!auto_saving
&& !noninteractive
)
5033 message_with_string ((NUMBERP (append
)
5043 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5044 doc
: /* Return t if (car A) is numerically less than (car B). */)
5045 (Lisp_Object a
, Lisp_Object b
)
5047 Lisp_Object args
[2];
5050 return Flss (2, args
);
5053 /* Build the complete list of annotations appropriate for writing out
5054 the text between START and END, by calling all the functions in
5055 write-region-annotate-functions and merging the lists they return.
5056 If one of these functions switches to a different buffer, we assume
5057 that buffer contains altered text. Therefore, the caller must
5058 make sure to restore the current buffer in all cases,
5059 as save-excursion would do. */
5062 build_annotations (Lisp_Object start
, Lisp_Object end
)
5064 Lisp_Object annotations
;
5066 struct gcpro gcpro1
, gcpro2
;
5067 Lisp_Object original_buffer
;
5069 bool used_global
= 0;
5071 XSETBUFFER (original_buffer
, current_buffer
);
5074 p
= Vwrite_region_annotate_functions
;
5075 GCPRO2 (annotations
, p
);
5078 struct buffer
*given_buffer
= current_buffer
;
5079 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5080 { /* Use the global value of the hook. */
5083 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5085 p
= Fappend (2, arg
);
5088 Vwrite_region_annotations_so_far
= annotations
;
5089 res
= call2 (XCAR (p
), start
, end
);
5090 /* If the function makes a different buffer current,
5091 assume that means this buffer contains altered text to be output.
5092 Reset START and END from the buffer bounds
5093 and discard all previous annotations because they should have
5094 been dealt with by this function. */
5095 if (current_buffer
!= given_buffer
)
5097 Vwrite_region_annotation_buffers
5098 = Fcons (Fcurrent_buffer (),
5099 Vwrite_region_annotation_buffers
);
5100 XSETFASTINT (start
, BEGV
);
5101 XSETFASTINT (end
, ZV
);
5104 Flength (res
); /* Check basic validity of return value */
5105 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5109 /* Now do the same for annotation functions implied by the file-format */
5110 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5111 p
= BVAR (current_buffer
, auto_save_file_format
);
5113 p
= BVAR (current_buffer
, file_format
);
5114 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5116 struct buffer
*given_buffer
= current_buffer
;
5118 Vwrite_region_annotations_so_far
= annotations
;
5120 /* Value is either a list of annotations or nil if the function
5121 has written annotations to a temporary buffer, which is now
5123 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5124 original_buffer
, make_number (i
));
5125 if (current_buffer
!= given_buffer
)
5127 XSETFASTINT (start
, BEGV
);
5128 XSETFASTINT (end
, ZV
);
5133 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5141 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5142 If STRING is nil, POS is the character position in the current buffer.
5143 Intersperse with them the annotations from *ANNOT
5144 which fall within the range of POS to POS + NCHARS,
5145 each at its appropriate position.
5147 We modify *ANNOT by discarding elements as we use them up.
5149 Return true if successful. */
5152 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5153 ptrdiff_t nchars
, Lisp_Object
*annot
,
5154 struct coding_system
*coding
)
5158 ptrdiff_t lastpos
= pos
+ nchars
;
5160 while (NILP (*annot
) || CONSP (*annot
))
5162 tem
= Fcar_safe (Fcar (*annot
));
5165 nextpos
= XFASTINT (tem
);
5167 /* If there are no more annotations in this range,
5168 output the rest of the range all at once. */
5169 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5170 return e_write (desc
, string
, pos
, lastpos
, coding
);
5172 /* Output buffer text up to the next annotation's position. */
5175 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5179 /* Output the annotation. */
5180 tem
= Fcdr (Fcar (*annot
));
5183 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5186 *annot
= Fcdr (*annot
);
5191 /* Maximum number of characters that the next
5192 function encodes per one loop iteration. */
5194 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5196 /* Write text in the range START and END into descriptor DESC,
5197 encoding them with coding system CODING. If STRING is nil, START
5198 and END are character positions of the current buffer, else they
5199 are indexes to the string STRING. Return true if successful. */
5202 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5203 struct coding_system
*coding
)
5205 if (STRINGP (string
))
5208 end
= SCHARS (string
);
5211 /* We used to have a code for handling selective display here. But,
5212 now it is handled within encode_coding. */
5216 if (STRINGP (string
))
5218 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5219 if (CODING_REQUIRE_ENCODING (coding
))
5221 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5223 /* Avoid creating huge Lisp string in encode_coding_object. */
5224 if (nchars
== E_WRITE_MAX
)
5225 coding
->raw_destination
= 1;
5227 encode_coding_object
5228 (coding
, string
, start
, string_char_to_byte (string
, start
),
5229 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5234 coding
->dst_object
= string
;
5235 coding
->consumed_char
= SCHARS (string
);
5236 coding
->produced
= SBYTES (string
);
5241 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5242 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5244 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5245 if (CODING_REQUIRE_ENCODING (coding
))
5247 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5250 if (nchars
== E_WRITE_MAX
)
5251 coding
->raw_destination
= 1;
5253 encode_coding_object
5254 (coding
, Fcurrent_buffer (), start
, start_byte
,
5255 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5259 coding
->dst_object
= Qnil
;
5260 coding
->dst_pos_byte
= start_byte
;
5261 if (start
>= GPT
|| end
<= GPT
)
5263 coding
->consumed_char
= end
- start
;
5264 coding
->produced
= end_byte
- start_byte
;
5268 coding
->consumed_char
= GPT
- start
;
5269 coding
->produced
= GPT_BYTE
- start_byte
;
5274 if (coding
->produced
> 0)
5276 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5277 : (STRINGP (coding
->dst_object
)
5278 ? SSDATA (coding
->dst_object
)
5279 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5280 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5282 if (coding
->raw_destination
)
5284 /* We're responsible for freeing this, see
5285 encode_coding_object to check why. */
5286 xfree (coding
->destination
);
5287 coding
->raw_destination
= 0;
5289 if (coding
->produced
)
5292 start
+= coding
->consumed_char
;
5298 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5299 Sverify_visited_file_modtime
, 0, 1, 0,
5300 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5301 This means that the file has not been changed since it was visited or saved.
5302 If BUF is omitted or nil, it defaults to the current buffer.
5303 See Info node `(elisp)Modification Time' for more details. */)
5306 struct buffer
*b
= decode_buffer (buf
);
5308 Lisp_Object handler
;
5309 Lisp_Object filename
;
5310 struct timespec mtime
;
5312 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5313 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5315 /* If the file name has special constructs in it,
5316 call the corresponding file handler. */
5317 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5318 Qverify_visited_file_modtime
);
5319 if (!NILP (handler
))
5320 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5322 filename
= ENCODE_FILE (BVAR (b
, filename
));
5324 mtime
= (stat (SSDATA (filename
), &st
) == 0
5325 ? get_stat_mtime (&st
)
5326 : time_error_value (errno
));
5327 if (timespec_cmp (mtime
, b
->modtime
) == 0
5328 && (b
->modtime_size
< 0
5329 || st
.st_size
== b
->modtime_size
))
5334 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5335 Svisited_file_modtime
, 0, 0, 0,
5336 doc
: /* Return the current buffer's recorded visited file modification time.
5337 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5338 `file-attributes' returns. If the current buffer has no recorded file
5339 modification time, this function returns 0. If the visited file
5340 doesn't exist, return -1.
5341 See Info node `(elisp)Modification Time' for more details. */)
5344 int ns
= current_buffer
->modtime
.tv_nsec
;
5346 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5347 return make_lisp_time (current_buffer
->modtime
);
5350 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5351 Sset_visited_file_modtime
, 0, 1, 0,
5352 doc
: /* Update buffer's recorded modification time from the visited file's time.
5353 Useful if the buffer was not read from the file normally
5354 or if the file itself has been changed for some known benign reason.
5355 An argument specifies the modification time value to use
5356 \(instead of that of the visited file), in the form of a list
5357 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5358 `visited-file-modtime'. */)
5359 (Lisp_Object time_flag
)
5361 if (!NILP (time_flag
))
5363 struct timespec mtime
;
5364 if (INTEGERP (time_flag
))
5366 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5367 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5370 mtime
= lisp_time_argument (time_flag
);
5372 current_buffer
->modtime
= mtime
;
5373 current_buffer
->modtime_size
= -1;
5377 register Lisp_Object filename
;
5379 Lisp_Object handler
;
5381 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5383 /* If the file name has special constructs in it,
5384 call the corresponding file handler. */
5385 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5386 if (!NILP (handler
))
5387 /* The handler can find the file name the same way we did. */
5388 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5390 filename
= ENCODE_FILE (filename
);
5392 if (stat (SSDATA (filename
), &st
) >= 0)
5394 current_buffer
->modtime
= get_stat_mtime (&st
);
5395 current_buffer
->modtime_size
= st
.st_size
;
5403 auto_save_error (Lisp_Object error_val
)
5407 struct gcpro gcpro1
;
5409 auto_save_error_occurred
= 1;
5411 ring_bell (XFRAME (selected_frame
));
5413 AUTO_STRING (format
, "Auto-saving %s: %s");
5414 msg
= Fformat (3, ((Lisp_Object
[])
5415 {format
, BVAR (current_buffer
, name
),
5416 Ferror_message_string (error_val
)}));
5419 for (i
= 0; i
< 3; ++i
)
5424 message3_nolog (msg
);
5425 Fsleep_for (make_number (1), Qnil
);
5438 auto_save_mode_bits
= 0666;
5440 /* Get visited file's mode to become the auto save file's mode. */
5441 if (! NILP (BVAR (current_buffer
, filename
)))
5443 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5444 /* But make sure we can overwrite it later! */
5445 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5446 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5448 /* Remote files don't cooperate with stat. */
5449 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5453 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5454 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5458 struct auto_save_unwind
5465 do_auto_save_unwind (void *arg
)
5467 struct auto_save_unwind
*p
= arg
;
5468 FILE *stream
= p
->stream
;
5469 minibuffer_auto_raise
= p
->auto_raise
;
5480 do_auto_save_make_dir (Lisp_Object dir
)
5484 auto_saving_dir_umask
= 077;
5485 result
= call2 (Qmake_directory
, dir
, Qt
);
5486 auto_saving_dir_umask
= 0;
5491 do_auto_save_eh (Lisp_Object ignore
)
5493 auto_saving_dir_umask
= 0;
5497 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5498 doc
: /* Auto-save all buffers that need it.
5499 This is all buffers that have auto-saving enabled
5500 and are changed since last auto-saved.
5501 Auto-saving writes the buffer into a file
5502 so that your editing is not lost if the system crashes.
5503 This file is not the file you visited; that changes only when you save.
5504 Normally we run the normal hook `auto-save-hook' before saving.
5506 A non-nil NO-MESSAGE argument means do not print any message if successful.
5507 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5508 (Lisp_Object no_message
, Lisp_Object current_only
)
5510 struct buffer
*old
= current_buffer
, *b
;
5511 Lisp_Object tail
, buf
, hook
;
5512 bool auto_saved
= 0;
5513 int do_handled_files
;
5515 FILE *stream
= NULL
;
5516 ptrdiff_t count
= SPECPDL_INDEX ();
5517 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5518 bool old_message_p
= 0;
5519 struct auto_save_unwind auto_save_unwind
;
5520 struct gcpro gcpro1
, gcpro2
;
5522 if (max_specpdl_size
< specpdl_size
+ 40)
5523 max_specpdl_size
= specpdl_size
+ 40;
5528 if (NILP (no_message
))
5530 old_message_p
= push_message ();
5531 record_unwind_protect_void (pop_message_unwind
);
5534 /* Ordinarily don't quit within this function,
5535 but don't make it impossible to quit (in case we get hung in I/O). */
5539 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5540 point to non-strings reached from Vbuffer_alist. */
5542 hook
= intern ("auto-save-hook");
5543 safe_run_hooks (hook
);
5545 if (STRINGP (Vauto_save_list_file_name
))
5547 Lisp_Object listfile
;
5549 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5551 /* Don't try to create the directory when shutting down Emacs,
5552 because creating the directory might signal an error, and
5553 that would leave Emacs in a strange state. */
5554 if (!NILP (Vrun_hooks
))
5558 GCPRO2 (dir
, listfile
);
5559 dir
= Ffile_name_directory (listfile
);
5560 if (NILP (Ffile_directory_p (dir
)))
5561 internal_condition_case_1 (do_auto_save_make_dir
,
5567 stream
= emacs_fopen (SSDATA (listfile
), "w");
5570 auto_save_unwind
.stream
= stream
;
5571 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5572 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5573 minibuffer_auto_raise
= 0;
5575 auto_save_error_occurred
= 0;
5577 /* On first pass, save all files that don't have handlers.
5578 On second pass, save all files that do have handlers.
5580 If Emacs is crashing, the handlers may tweak what is causing
5581 Emacs to crash in the first place, and it would be a shame if
5582 Emacs failed to autosave perfectly ordinary files because it
5583 couldn't handle some ange-ftp'd file. */
5585 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5586 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5590 /* Record all the buffers that have auto save mode
5591 in the special file that lists them. For each of these buffers,
5592 Record visited name (if any) and auto save name. */
5593 if (STRINGP (BVAR (b
, auto_save_file_name
))
5594 && stream
!= NULL
&& do_handled_files
== 0)
5597 if (!NILP (BVAR (b
, filename
)))
5599 fwrite (SDATA (BVAR (b
, filename
)), 1,
5600 SBYTES (BVAR (b
, filename
)), stream
);
5602 putc ('\n', stream
);
5603 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5604 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5605 putc ('\n', stream
);
5609 if (!NILP (current_only
)
5610 && b
!= current_buffer
)
5613 /* Don't auto-save indirect buffers.
5614 The base buffer takes care of it. */
5618 /* Check for auto save enabled
5619 and file changed since last auto save
5620 and file changed since last real save. */
5621 if (STRINGP (BVAR (b
, auto_save_file_name
))
5622 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5623 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5624 /* -1 means we've turned off autosaving for a while--see below. */
5625 && XINT (BVAR (b
, save_length
)) >= 0
5626 && (do_handled_files
5627 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5630 struct timespec before_time
= current_timespec ();
5631 struct timespec after_time
;
5633 /* If we had a failure, don't try again for 20 minutes. */
5634 if (b
->auto_save_failure_time
> 0
5635 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5638 set_buffer_internal (b
);
5639 if (NILP (Vauto_save_include_big_deletions
)
5640 && (XFASTINT (BVAR (b
, save_length
)) * 10
5641 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5642 /* A short file is likely to change a large fraction;
5643 spare the user annoying messages. */
5644 && XFASTINT (BVAR (b
, save_length
)) > 5000
5645 /* These messages are frequent and annoying for `*mail*'. */
5646 && !EQ (BVAR (b
, filename
), Qnil
)
5647 && NILP (no_message
))
5649 /* It has shrunk too much; turn off auto-saving here. */
5650 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5651 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5653 minibuffer_auto_raise
= 0;
5654 /* Turn off auto-saving until there's a real save,
5655 and prevent any more warnings. */
5656 XSETINT (BVAR (b
, save_length
), -1);
5657 Fsleep_for (make_number (1), Qnil
);
5660 if (!auto_saved
&& NILP (no_message
))
5661 message1 ("Auto-saving...");
5662 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5664 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5665 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5666 set_buffer_internal (old
);
5668 after_time
= current_timespec ();
5670 /* If auto-save took more than 60 seconds,
5671 assume it was an NFS failure that got a timeout. */
5672 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5673 b
->auto_save_failure_time
= after_time
.tv_sec
;
5677 /* Prevent another auto save till enough input events come in. */
5678 record_auto_save ();
5680 if (auto_saved
&& NILP (no_message
))
5684 /* If we are going to restore an old message,
5685 give time to read ours. */
5686 sit_for (make_number (1), 0, 0);
5689 else if (!auto_save_error_occurred
)
5690 /* Don't overwrite the error message if an error occurred.
5691 If we displayed a message and then restored a state
5692 with no message, leave a "done" message on the screen. */
5693 message1 ("Auto-saving...done");
5698 /* This restores the message-stack status. */
5699 unbind_to (count
, Qnil
);
5703 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5704 Sset_buffer_auto_saved
, 0, 0, 0,
5705 doc
: /* Mark current buffer as auto-saved with its current text.
5706 No auto-save file will be written until the buffer changes again. */)
5709 /* FIXME: This should not be called in indirect buffers, since
5710 they're not autosaved. */
5711 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5712 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5713 current_buffer
->auto_save_failure_time
= 0;
5717 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5718 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5719 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5722 current_buffer
->auto_save_failure_time
= 0;
5726 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5728 doc
: /* Return t if current buffer has been auto-saved recently.
5729 More precisely, if it has been auto-saved since last read from or saved
5730 in the visited file. If the buffer has no visited file,
5731 then any auto-save counts as "recent". */)
5734 /* FIXME: maybe we should return nil for indirect buffers since
5735 they're never autosaved. */
5736 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5739 /* Reading and completing file names. */
5741 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5742 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5743 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5744 The return value is only relevant for a call to `read-file-name' that happens
5745 before any other event (mouse or keypress) is handled. */)
5748 #if (defined USE_GTK || defined USE_MOTIF \
5749 || defined HAVE_NS || defined HAVE_NTGUI)
5750 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5753 && window_system_available (SELECTED_FRAME ()))
5760 DEFUN ("set-binary-mode", Fset_binary_mode
, Sset_binary_mode
, 2, 2, 0,
5761 doc
: /* Switch STREAM to binary I/O mode or text I/O mode.
5762 STREAM can be one of the symbols `stdin', `stdout', or `stderr'.
5763 If MODE is non-nil, switch STREAM to binary mode, otherwise switch
5766 As a side effect, this function flushes any pending STREAM's data.
5768 Value is the previous value of STREAM's I/O mode, nil for text mode,
5769 non-nil for binary mode.
5771 On MS-Windows and MS-DOS, binary mode is needed to read or write
5772 arbitrary binary data, and for disabling translation between CR-LF
5773 pairs and a single newline character. Examples include generation
5774 of text files with Unix-style end-of-line format using `princ' in
5775 batch mode, with standard output redirected to a file.
5777 On Posix systems, this function always returns non-nil, and has no
5778 effect except for flushing STREAM's data. */)
5779 (Lisp_Object stream
, Lisp_Object mode
)
5784 CHECK_SYMBOL (stream
);
5785 if (EQ (stream
, Qstdin
))
5787 else if (EQ (stream
, Qstdout
))
5789 else if (EQ (stream
, Qstderr
))
5792 xsignal2 (Qerror
, build_string ("unsupported stream"), stream
);
5794 binmode
= NILP (mode
) ? O_TEXT
: O_BINARY
;
5798 return (set_binary_mode (fileno (fp
), binmode
) == O_BINARY
) ? Qt
: Qnil
;
5804 realmask
= umask (0);
5807 valid_timestamp_file_system
= 0;
5809 /* fsync can be a significant performance hit. Often it doesn't
5810 suffice to make the file-save operation survive a crash. For
5811 batch scripts, which are typically part of larger shell commands
5812 that don't fsync other files, its effect on performance can be
5813 significant so its utility is particularly questionable.
5814 Hence, for now by default fsync is used only when interactive.
5816 For more on why fsync often fails to work on today's hardware, see:
5817 Zheng M et al. Understanding the robustness of SSDs under power fault.
5818 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5819 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5821 For more on why fsync does not suffice even if it works properly, see:
5822 Roche X. Necessary step(s) to synchronize filename operations on disk.
5823 Austin Group Defect 672, 2013-03-19
5824 http://austingroupbugs.net/view.php?id=672 */
5825 write_region_inhibit_fsync
= noninteractive
;
5829 syms_of_fileio (void)
5831 /* Property name of a file name handler,
5832 which gives a list of operations it handles. */
5833 DEFSYM (Qoperations
, "operations");
5835 DEFSYM (Qexpand_file_name
, "expand-file-name");
5836 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5837 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5838 DEFSYM (Qfile_name_directory
, "file-name-directory");
5839 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5840 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5841 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5842 DEFSYM (Qcopy_file
, "copy-file");
5843 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5844 DEFSYM (Qmake_directory
, "make-directory");
5845 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5846 DEFSYM (Qdelete_file
, "delete-file");
5847 DEFSYM (Qrename_file
, "rename-file");
5848 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5849 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5850 DEFSYM (Qfile_exists_p
, "file-exists-p");
5851 DEFSYM (Qfile_executable_p
, "file-executable-p");
5852 DEFSYM (Qfile_readable_p
, "file-readable-p");
5853 DEFSYM (Qfile_writable_p
, "file-writable-p");
5854 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5855 DEFSYM (Qaccess_file
, "access-file");
5856 DEFSYM (Qfile_directory_p
, "file-directory-p");
5857 DEFSYM (Qfile_regular_p
, "file-regular-p");
5858 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5859 DEFSYM (Qfile_modes
, "file-modes");
5860 DEFSYM (Qset_file_modes
, "set-file-modes");
5861 DEFSYM (Qset_file_times
, "set-file-times");
5862 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5863 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5864 DEFSYM (Qfile_acl
, "file-acl");
5865 DEFSYM (Qset_file_acl
, "set-file-acl");
5866 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5867 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5868 DEFSYM (Qwrite_region
, "write-region");
5869 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5870 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5872 /* The symbol bound to coding-system-for-read when
5873 insert-file-contents is called for recovering a file. This is not
5874 an actual coding system name, but just an indicator to tell
5875 insert-file-contents to use `emacs-mule' with a special flag for
5876 auto saving and recovering a file. */
5877 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5879 DEFSYM (Qfile_name_history
, "file-name-history");
5880 Fset (Qfile_name_history
, Qnil
);
5882 DEFSYM (Qfile_error
, "file-error");
5883 DEFSYM (Qfile_already_exists
, "file-already-exists");
5884 DEFSYM (Qfile_date_error
, "file-date-error");
5885 DEFSYM (Qfile_notify_error
, "file-notify-error");
5886 DEFSYM (Qexcl
, "excl");
5888 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5889 doc
: /* Coding system for encoding file names.
5890 If it is nil, `default-file-name-coding-system' (which see) is used.
5892 On MS-Windows, the value of this variable is largely ignored if
5893 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5894 behaves as if file names were encoded in `utf-8'. */);
5895 Vfile_name_coding_system
= Qnil
;
5897 DEFVAR_LISP ("default-file-name-coding-system",
5898 Vdefault_file_name_coding_system
,
5899 doc
: /* Default coding system for encoding file names.
5900 This variable is used only when `file-name-coding-system' is nil.
5902 This variable is set/changed by the command `set-language-environment'.
5903 User should not set this variable manually,
5904 instead use `file-name-coding-system' to get a constant encoding
5905 of file names regardless of the current language environment.
5907 On MS-Windows, the value of this variable is largely ignored if
5908 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5909 behaves as if file names were encoded in `utf-8'. */);
5910 Vdefault_file_name_coding_system
= Qnil
;
5912 /* Lisp functions for translating file formats. */
5913 DEFSYM (Qformat_decode
, "format-decode");
5914 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5916 /* Lisp function for setting buffer-file-coding-system and the
5917 multibyteness of the current buffer after inserting a file. */
5918 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5920 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5922 Fput (Qfile_error
, Qerror_conditions
,
5923 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5924 Fput (Qfile_error
, Qerror_message
,
5925 build_pure_c_string ("File error"));
5927 Fput (Qfile_already_exists
, Qerror_conditions
,
5928 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5929 Fput (Qfile_already_exists
, Qerror_message
,
5930 build_pure_c_string ("File already exists"));
5932 Fput (Qfile_date_error
, Qerror_conditions
,
5933 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5934 Fput (Qfile_date_error
, Qerror_message
,
5935 build_pure_c_string ("Cannot set file date"));
5937 Fput (Qfile_notify_error
, Qerror_conditions
,
5938 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5939 Fput (Qfile_notify_error
, Qerror_message
,
5940 build_pure_c_string ("File notification error"));
5942 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5943 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5944 If a file name matches REGEXP, all I/O on that file is done by calling
5945 HANDLER. If a file name matches more than one handler, the handler
5946 whose match starts last in the file name gets precedence. The
5947 function `find-file-name-handler' checks this list for a handler for
5950 HANDLER should be a function. The first argument given to it is the
5951 name of the I/O primitive to be handled; the remaining arguments are
5952 the arguments that were passed to that primitive. For example, if you
5953 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5954 HANDLER is called like this:
5956 (funcall HANDLER 'file-exists-p FILENAME)
5958 Note that HANDLER must be able to handle all I/O primitives; if it has
5959 nothing special to do for a primitive, it should reinvoke the
5960 primitive to handle the operation \"the usual way\".
5961 See Info node `(elisp)Magic File Names' for more details. */);
5962 Vfile_name_handler_alist
= Qnil
;
5964 DEFVAR_LISP ("set-auto-coding-function",
5965 Vset_auto_coding_function
,
5966 doc
: /* If non-nil, a function to call to decide a coding system of file.
5967 Two arguments are passed to this function: the file name
5968 and the length of a file contents following the point.
5969 This function should return a coding system to decode the file contents.
5970 It should check the file name against `auto-coding-alist'.
5971 If no coding system is decided, it should check a coding system
5972 specified in the heading lines with the format:
5973 -*- ... coding: CODING-SYSTEM; ... -*-
5974 or local variable spec of the tailing lines with `coding:' tag. */);
5975 Vset_auto_coding_function
= Qnil
;
5977 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5978 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5979 Each is passed one argument, the number of characters inserted,
5980 with point at the start of the inserted text. Each function
5981 should leave point the same, and return the new character count.
5982 If `insert-file-contents' is intercepted by a handler from
5983 `file-name-handler-alist', that handler is responsible for calling the
5984 functions in `after-insert-file-functions' if appropriate. */);
5985 Vafter_insert_file_functions
= Qnil
;
5987 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5988 doc
: /* A list of functions to be called at the start of `write-region'.
5989 Each is passed two arguments, START and END as for `write-region'.
5990 These are usually two numbers but not always; see the documentation
5991 for `write-region'. The function should return a list of pairs
5992 of the form (POSITION . STRING), consisting of strings to be effectively
5993 inserted at the specified positions of the file being written (1 means to
5994 insert before the first byte written). The POSITIONs must be sorted into
5997 If there are several annotation functions, the lists returned by these
5998 functions are merged destructively. As each annotation function runs,
5999 the variable `write-region-annotations-so-far' contains a list of all
6000 annotations returned by previous annotation functions.
6002 An annotation function can return with a different buffer current.
6003 Doing so removes the annotations returned by previous functions, and
6004 resets START and END to `point-min' and `point-max' of the new buffer.
6006 After `write-region' completes, Emacs calls the function stored in
6007 `write-region-post-annotation-function', once for each buffer that was
6008 current when building the annotations (i.e., at least once), with that
6009 buffer current. */);
6010 Vwrite_region_annotate_functions
= Qnil
;
6011 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
6013 DEFVAR_LISP ("write-region-post-annotation-function",
6014 Vwrite_region_post_annotation_function
,
6015 doc
: /* Function to call after `write-region' completes.
6016 The function is called with no arguments. If one or more of the
6017 annotation functions in `write-region-annotate-functions' changed the
6018 current buffer, the function stored in this variable is called for
6019 each of those additional buffers as well, in addition to the original
6020 buffer. The relevant buffer is current during each function call. */);
6021 Vwrite_region_post_annotation_function
= Qnil
;
6022 staticpro (&Vwrite_region_annotation_buffers
);
6024 DEFVAR_LISP ("write-region-annotations-so-far",
6025 Vwrite_region_annotations_so_far
,
6026 doc
: /* When an annotation function is called, this holds the previous annotations.
6027 These are the annotations made by other annotation functions
6028 that were already called. See also `write-region-annotate-functions'. */);
6029 Vwrite_region_annotations_so_far
= Qnil
;
6031 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6032 doc
: /* A list of file name handlers that temporarily should not be used.
6033 This applies only to the operation `inhibit-file-name-operation'. */);
6034 Vinhibit_file_name_handlers
= Qnil
;
6036 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6037 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6038 Vinhibit_file_name_operation
= Qnil
;
6040 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6041 doc
: /* File name in which we write a list of all auto save file names.
6042 This variable is initialized automatically from `auto-save-list-file-prefix'
6043 shortly after Emacs reads your init file, if you have not yet given it
6044 a non-nil value. */);
6045 Vauto_save_list_file_name
= Qnil
;
6047 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6048 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6049 Normally auto-save files are written under other names. */);
6050 Vauto_save_visited_file_name
= Qnil
;
6052 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6053 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6054 If nil, deleting a substantial portion of the text disables auto-save
6055 in the buffer; this is the default behavior, because the auto-save
6056 file is usually more useful if it contains the deleted text. */);
6057 Vauto_save_include_big_deletions
= Qnil
;
6059 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6060 doc
: /* Non-nil means don't call fsync in `write-region'.
6061 This variable affects calls to `write-region' as well as save commands.
6062 Setting this to nil may avoid data loss if the system loses power or
6063 the operating system crashes. By default, it is non-nil in batch mode. */);
6064 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6066 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6067 doc
: /* Specifies whether to use the system's trash can.
6068 When non-nil, certain file deletion commands use the function
6069 `move-file-to-trash' instead of deleting files outright.
6070 This includes interactive calls to `delete-file' and
6071 `delete-directory' and the Dired deletion commands. */);
6072 delete_by_moving_to_trash
= 0;
6073 DEFSYM (Qdelete_by_moving_to_trash
, "delete-by-moving-to-trash");
6075 /* Lisp function for moving files to trash. */
6076 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6078 /* Lisp function for recursively copying directories. */
6079 DEFSYM (Qcopy_directory
, "copy-directory");
6081 /* Lisp function for recursively deleting directories. */
6082 DEFSYM (Qdelete_directory
, "delete-directory");
6084 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");
6085 DEFSYM (Qget_buffer_window_list
, "get-buffer-window-list");
6087 DEFSYM (Qstdin
, "stdin");
6088 DEFSYM (Qstdout
, "stdout");
6089 DEFSYM (Qstderr
, "stderr");
6091 defsubr (&Sfind_file_name_handler
);
6092 defsubr (&Sfile_name_directory
);
6093 defsubr (&Sfile_name_nondirectory
);
6094 defsubr (&Sunhandled_file_name_directory
);
6095 defsubr (&Sfile_name_as_directory
);
6096 defsubr (&Sdirectory_file_name
);
6097 defsubr (&Smake_temp_name
);
6098 defsubr (&Sexpand_file_name
);
6099 defsubr (&Ssubstitute_in_file_name
);
6100 defsubr (&Scopy_file
);
6101 defsubr (&Smake_directory_internal
);
6102 defsubr (&Sdelete_directory_internal
);
6103 defsubr (&Sdelete_file
);
6104 defsubr (&Srename_file
);
6105 defsubr (&Sadd_name_to_file
);
6106 defsubr (&Smake_symbolic_link
);
6107 defsubr (&Sfile_name_absolute_p
);
6108 defsubr (&Sfile_exists_p
);
6109 defsubr (&Sfile_executable_p
);
6110 defsubr (&Sfile_readable_p
);
6111 defsubr (&Sfile_writable_p
);
6112 defsubr (&Saccess_file
);
6113 defsubr (&Sfile_symlink_p
);
6114 defsubr (&Sfile_directory_p
);
6115 defsubr (&Sfile_accessible_directory_p
);
6116 defsubr (&Sfile_regular_p
);
6117 defsubr (&Sfile_modes
);
6118 defsubr (&Sset_file_modes
);
6119 defsubr (&Sset_file_times
);
6120 defsubr (&Sfile_selinux_context
);
6121 defsubr (&Sfile_acl
);
6122 defsubr (&Sset_file_acl
);
6123 defsubr (&Sset_file_selinux_context
);
6124 defsubr (&Sset_default_file_modes
);
6125 defsubr (&Sdefault_file_modes
);
6126 defsubr (&Sfile_newer_than_file_p
);
6127 defsubr (&Sinsert_file_contents
);
6128 defsubr (&Swrite_region
);
6129 defsubr (&Scar_less_than_car
);
6130 defsubr (&Sverify_visited_file_modtime
);
6131 defsubr (&Svisited_file_modtime
);
6132 defsubr (&Sset_visited_file_modtime
);
6133 defsubr (&Sdo_auto_save
);
6134 defsubr (&Sset_buffer_auto_saved
);
6135 defsubr (&Sclear_buffer_auto_save_failure
);
6136 defsubr (&Srecent_auto_save_p
);
6138 defsubr (&Snext_read_file_uses_dialog_p
);
6140 defsubr (&Sset_binary_mode
);
6143 defsubr (&Sunix_sync
);