1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2014 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>
95 /* True during writing of auto-save files. */
96 static bool auto_saving
;
98 /* Emacs's real umask. */
99 static mode_t realmask
;
101 /* Nonzero umask during creation of auto-save directories. */
102 static mode_t auto_saving_dir_umask
;
104 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
105 a new file with the same mode as the original. */
106 static mode_t auto_save_mode_bits
;
108 /* Set by auto_save_1 if an error occurred during the last auto-save. */
109 static bool auto_save_error_occurred
;
111 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
112 number of a file system where time stamps were observed to to work. */
113 static bool valid_timestamp_file_system
;
114 static dev_t timestamp_file_system
;
116 /* The symbol bound to coding-system-for-read when
117 insert-file-contents is called for recovering a file. This is not
118 an actual coding system name, but just an indicator to tell
119 insert-file-contents to use `emacs-mule' with a special flag for
120 auto saving and recovering a file. */
121 static Lisp_Object Qauto_save_coding
;
123 /* Property name of a file name handler,
124 which gives a list of operations it handles.. */
125 static Lisp_Object Qoperations
;
127 /* Lisp functions for translating file formats. */
128 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
130 /* Lisp function for setting buffer-file-coding-system and the
131 multibyteness of the current buffer after inserting a file. */
132 static Lisp_Object Qafter_insert_file_set_coding
;
134 static Lisp_Object Qwrite_region_annotate_functions
;
135 /* Each time an annotation function changes the buffer, the new buffer
137 static Lisp_Object Vwrite_region_annotation_buffers
;
139 static Lisp_Object Qdelete_by_moving_to_trash
;
141 /* Lisp function for moving files to trash. */
142 static Lisp_Object Qmove_file_to_trash
;
144 /* Lisp function for recursively copying directories. */
145 static Lisp_Object Qcopy_directory
;
147 /* Lisp function for recursively deleting directories. */
148 static Lisp_Object Qdelete_directory
;
150 static Lisp_Object Qsubstitute_env_in_file_name
;
152 Lisp_Object Qfile_error
, Qfile_notify_error
;
153 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
154 static Lisp_Object Qexcl
;
155 Lisp_Object Qfile_name_history
;
157 static Lisp_Object Qcar_less_than_car
;
159 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
160 Lisp_Object
*, struct coding_system
*);
161 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
162 struct coding_system
*);
165 /* Return true if FILENAME exists. */
168 check_existing (const char *filename
)
170 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
173 /* Return true if file FILENAME exists and can be executed. */
176 check_executable (char *filename
)
178 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
181 /* Return true if file FILENAME exists and can be accessed
182 according to AMODE, which should include W_OK.
183 On failure, return false and set errno. */
186 check_writable (const char *filename
, int amode
)
189 /* FIXME: an faccessat implementation should be added to the
190 DOS/Windows ports and this #ifdef branch should be removed. */
192 if (stat (filename
, &st
) < 0)
195 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
196 #else /* not MSDOS */
197 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
199 /* faccessat may have returned failure because Cygwin couldn't
200 determine the file's UID or GID; if so, we return success. */
203 int faccessat_errno
= errno
;
205 if (stat (filename
, &st
) < 0)
207 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
208 errno
= faccessat_errno
;
212 #endif /* not MSDOS */
215 /* Signal a file-access failure. STRING describes the failure,
216 NAME the file involved, and ERRORNO the errno value.
218 If NAME is neither null nor a pair, package it up as a singleton
219 list before reporting it; this saves report_file_errno's caller the
220 trouble of preserving errno before calling list1. */
223 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
225 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
226 Lisp_Object errstring
;
229 synchronize_system_messages_locale ();
230 str
= strerror (errorno
);
231 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
232 Vlocale_coding_system
, 0);
238 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
241 /* System error messages are capitalized. Downcase the initial
242 unless it is followed by a slash. (The slash case caters to
243 error messages that begin with "I/O" or, in German, "E/A".) */
244 if (STRING_MULTIBYTE (errstring
)
245 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
249 str
= SSDATA (errstring
);
250 c
= STRING_CHAR ((unsigned char *) str
);
251 Faset (errstring
, make_number (0), make_number (downcase (c
)));
254 xsignal (Qfile_error
,
255 Fcons (build_string (string
), Fcons (errstring
, data
)));
259 /* Signal a file-access failure that set errno. STRING describes the
260 failure, NAME the file involved. When invoking this function, take
261 care to not use arguments such as build_string ("foo") that involve
262 side effects that may set errno. */
265 report_file_error (char const *string
, Lisp_Object name
)
267 report_file_errno (string
, name
, errno
);
271 close_file_unwind (int fd
)
277 fclose_unwind (void *arg
)
283 /* Restore point, having saved it as a marker. */
286 restore_point_unwind (Lisp_Object location
)
288 Fgoto_char (location
);
289 unchain_marker (XMARKER (location
));
293 static Lisp_Object Qexpand_file_name
;
294 static Lisp_Object Qsubstitute_in_file_name
;
295 static Lisp_Object Qdirectory_file_name
;
296 static Lisp_Object Qfile_name_directory
;
297 static Lisp_Object Qfile_name_nondirectory
;
298 static Lisp_Object Qunhandled_file_name_directory
;
299 static Lisp_Object Qfile_name_as_directory
;
300 static Lisp_Object Qcopy_file
;
301 static Lisp_Object Qmake_directory_internal
;
302 static Lisp_Object Qmake_directory
;
303 static Lisp_Object Qdelete_directory_internal
;
304 Lisp_Object Qdelete_file
;
305 static Lisp_Object Qrename_file
;
306 static Lisp_Object Qadd_name_to_file
;
307 static Lisp_Object Qmake_symbolic_link
;
308 Lisp_Object Qfile_exists_p
;
309 static Lisp_Object Qfile_executable_p
;
310 static Lisp_Object Qfile_readable_p
;
311 static Lisp_Object Qfile_writable_p
;
312 static Lisp_Object Qfile_symlink_p
;
313 static Lisp_Object Qaccess_file
;
314 Lisp_Object Qfile_directory_p
;
315 static Lisp_Object Qfile_regular_p
;
316 static Lisp_Object Qfile_accessible_directory_p
;
317 static Lisp_Object Qfile_modes
;
318 static Lisp_Object Qset_file_modes
;
319 static Lisp_Object Qset_file_times
;
320 static Lisp_Object Qfile_selinux_context
;
321 static Lisp_Object Qset_file_selinux_context
;
322 static Lisp_Object Qfile_acl
;
323 static Lisp_Object Qset_file_acl
;
324 static Lisp_Object Qfile_newer_than_file_p
;
325 Lisp_Object Qinsert_file_contents
;
326 static Lisp_Object Qchoose_write_coding_system
;
327 Lisp_Object Qwrite_region
;
328 static Lisp_Object Qverify_visited_file_modtime
;
329 static Lisp_Object Qset_visited_file_modtime
;
331 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
332 Sfind_file_name_handler
, 2, 2, 0,
333 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
334 Otherwise, return nil.
335 A file name is handled if one of the regular expressions in
336 `file-name-handler-alist' matches it.
338 If OPERATION equals `inhibit-file-name-operation', then we ignore
339 any handlers that are members of `inhibit-file-name-handlers',
340 but we still do run any other handlers. This lets handlers
341 use the standard functions without calling themselves recursively. */)
342 (Lisp_Object filename
, Lisp_Object operation
)
344 /* This function must not munge the match data. */
345 Lisp_Object chain
, inhibited_handlers
, result
;
349 CHECK_STRING (filename
);
351 if (EQ (operation
, Vinhibit_file_name_operation
))
352 inhibited_handlers
= Vinhibit_file_name_handlers
;
354 inhibited_handlers
= Qnil
;
356 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
357 chain
= XCDR (chain
))
363 Lisp_Object string
= XCAR (elt
);
365 Lisp_Object handler
= XCDR (elt
);
366 Lisp_Object operations
= Qnil
;
368 if (SYMBOLP (handler
))
369 operations
= Fget (handler
, Qoperations
);
372 && (match_pos
= fast_string_match (string
, filename
)) > pos
373 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
377 handler
= XCDR (elt
);
378 tem
= Fmemq (handler
, inhibited_handlers
);
392 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
394 doc
: /* Return the directory component in file name FILENAME.
395 Return nil if FILENAME does not include a directory.
396 Otherwise return a directory name.
397 Given a Unix syntax file name, returns a string ending in slash. */)
398 (Lisp_Object filename
)
401 register const char *beg
;
406 register const char *p
;
409 CHECK_STRING (filename
);
411 /* If the file name has special constructs in it,
412 call the corresponding file handler. */
413 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
416 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
418 return STRINGP (handled_name
) ? handled_name
: Qnil
;
422 beg
= xlispstrdupa (filename
);
424 beg
= SSDATA (filename
);
426 p
= beg
+ SBYTES (filename
);
428 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
430 /* only recognize drive specifier at the beginning */
432 /* handle the "/:d:foo" and "/:foo" cases correctly */
433 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
434 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
441 /* Expansion of "c:" to drive and default directory. */
444 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
445 char *res
= alloca (MAXPATHLEN
+ 1);
448 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
450 memcpy (res
, beg
, 2);
455 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
457 size_t l
= strlen (res
);
459 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
462 p
= beg
+ strlen (beg
);
463 dostounix_filename (beg
);
464 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
465 STRING_MULTIBYTE (filename
));
468 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
469 STRING_MULTIBYTE (filename
));
471 else if (STRING_MULTIBYTE (filename
))
473 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
474 dostounix_filename (SSDATA (tem_fn
));
476 if (!NILP (Vw32_downcase_file_names
))
477 tem_fn
= Fdowncase (tem_fn
);
482 dostounix_filename (beg
);
483 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
487 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
491 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
492 Sfile_name_nondirectory
, 1, 1, 0,
493 doc
: /* Return file name FILENAME sans its directory.
494 For example, in a Unix-syntax file name,
495 this is everything after the last slash,
496 or the entire name if it contains no slash. */)
497 (Lisp_Object filename
)
499 register const char *beg
, *p
, *end
;
502 CHECK_STRING (filename
);
504 /* If the file name has special constructs in it,
505 call the corresponding file handler. */
506 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
509 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
511 if (STRINGP (handled_name
))
513 error ("Invalid handler in `file-name-handler-alist'");
516 beg
= SSDATA (filename
);
517 end
= p
= beg
+ SBYTES (filename
);
519 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
521 /* only recognize drive specifier at beginning */
523 /* handle the "/:d:foo" case correctly */
524 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
529 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
532 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
533 Sunhandled_file_name_directory
, 1, 1, 0,
534 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
535 A `directly usable' directory name is one that may be used without the
536 intervention of any file handler.
537 If FILENAME is a directly usable file itself, return
538 \(file-name-directory FILENAME).
539 If FILENAME refers to a file which is not accessible from a local process,
540 then this should return nil.
541 The `call-process' and `start-process' functions use this function to
542 get a current directory to run processes in. */)
543 (Lisp_Object filename
)
547 /* If the file name has special constructs in it,
548 call the corresponding file handler. */
549 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
552 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
554 return STRINGP (handled_name
) ? handled_name
: Qnil
;
557 return Ffile_name_directory (filename
);
560 /* Maximum number of bytes that DST will be longer than SRC
561 in file_name_as_directory. This occurs when SRCLEN == 0. */
562 enum { file_name_as_directory_slop
= 2 };
564 /* Convert from file name SRC of length SRCLEN to directory name in
565 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
566 string. On UNIX, just make sure there is a terminating /. Return
567 the length of DST in bytes. */
570 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
581 memcpy (dst
, src
, srclen
);
582 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
583 dst
[srclen
++] = DIRECTORY_SEP
;
586 dostounix_filename (dst
);
591 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
592 Sfile_name_as_directory
, 1, 1, 0,
593 doc
: /* Return a string representing the file name FILE interpreted as a directory.
594 This operation exists because a directory is also a file, but its name as
595 a directory is different from its name as a file.
596 The result can be used as the value of `default-directory'
597 or passed as second argument to `expand-file-name'.
598 For a Unix-syntax file name, just appends a slash. */)
603 Lisp_Object handler
, val
;
610 /* If the file name has special constructs in it,
611 call the corresponding file handler. */
612 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
615 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
617 if (STRINGP (handled_name
))
619 error ("Invalid handler in `file-name-handler-alist'");
623 if (!NILP (Vw32_downcase_file_names
))
624 file
= Fdowncase (file
);
626 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
627 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
628 STRING_MULTIBYTE (file
));
629 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
634 /* Convert from directory name SRC of length SRCLEN to file name in
635 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
636 string. On UNIX, just make sure there isn't a terminating /.
637 Return the length of DST in bytes. */
640 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
642 /* Process as Unix format: just remove any final slash.
643 But leave "/" and "//" unchanged. */
646 && !IS_ANY_SEP (src
[srclen
- 2])
648 && IS_DIRECTORY_SEP (src
[srclen
- 1])
649 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
652 memcpy (dst
, src
, srclen
);
655 dostounix_filename (dst
);
660 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
662 doc
: /* Returns the file name of the directory named DIRECTORY.
663 This is the name of the file that holds the data for the directory DIRECTORY.
664 This operation exists because a directory is also a file, but its name as
665 a directory is different from its name as a file.
666 In Unix-syntax, this function just removes the final slash. */)
667 (Lisp_Object directory
)
671 Lisp_Object handler
, val
;
674 CHECK_STRING (directory
);
676 if (NILP (directory
))
679 /* If the file name has special constructs in it,
680 call the corresponding file handler. */
681 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
684 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
686 if (STRINGP (handled_name
))
688 error ("Invalid handler in `file-name-handler-alist'");
692 if (!NILP (Vw32_downcase_file_names
))
693 directory
= Fdowncase (directory
);
695 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
696 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
697 STRING_MULTIBYTE (directory
));
698 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
703 static const char make_temp_name_tbl
[64] =
705 'A','B','C','D','E','F','G','H',
706 'I','J','K','L','M','N','O','P',
707 'Q','R','S','T','U','V','W','X',
708 'Y','Z','a','b','c','d','e','f',
709 'g','h','i','j','k','l','m','n',
710 'o','p','q','r','s','t','u','v',
711 'w','x','y','z','0','1','2','3',
712 '4','5','6','7','8','9','-','_'
715 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
717 /* Value is a temporary file name starting with PREFIX, a string.
719 The Emacs process number forms part of the result, so there is
720 no danger of generating a name being used by another process.
721 In addition, this function makes an attempt to choose a name
722 which has no existing file. To make this work, PREFIX should be
723 an absolute file name.
725 BASE64_P means add the pid as 3 characters in base64
726 encoding. In this case, 6 characters will be added to PREFIX to
727 form the file name. Otherwise, if Emacs is running on a system
728 with long file names, add the pid as a decimal number.
730 This function signals an error if no unique file name could be
734 make_temp_name (Lisp_Object prefix
, bool base64_p
)
736 Lisp_Object val
, encoded_prefix
;
740 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
743 CHECK_STRING (prefix
);
745 /* VAL is created by adding 6 characters to PREFIX. The first
746 three are the PID of this process, in base 64, and the second
747 three are incremented if the file already exists. This ensures
748 262144 unique file names per PID per PREFIX. */
754 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
755 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
756 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
761 #ifdef HAVE_LONG_FILE_NAMES
762 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
764 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
765 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
766 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
771 encoded_prefix
= ENCODE_FILE (prefix
);
772 len
= SBYTES (encoded_prefix
);
773 val
= make_uninit_string (len
+ 3 + pidlen
);
775 memcpy (data
, SSDATA (encoded_prefix
), len
);
778 memcpy (p
, pidbuf
, pidlen
);
781 /* Here we try to minimize useless stat'ing when this function is
782 invoked many times successively with the same PREFIX. We achieve
783 this by initializing count to a random value, and incrementing it
786 We don't want make-temp-name to be called while dumping,
787 because then make_temp_name_count_initialized_p would get set
788 and then make_temp_name_count would not be set when Emacs starts. */
790 if (!make_temp_name_count_initialized_p
)
792 make_temp_name_count
= time (NULL
);
793 make_temp_name_count_initialized_p
= 1;
798 unsigned num
= make_temp_name_count
;
800 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
801 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
802 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
804 /* Poor man's congruential RN generator. Replace with
805 ++make_temp_name_count for debugging. */
806 make_temp_name_count
+= 25229;
807 make_temp_name_count
%= 225307;
809 if (!check_existing (data
))
811 /* We want to return only if errno is ENOENT. */
813 return DECODE_FILE (val
);
815 /* The error here is dubious, but there is little else we
816 can do. The alternatives are to return nil, which is
817 as bad as (and in many cases worse than) throwing the
818 error, or to ignore the error, which will likely result
819 in looping through 225307 stat's, which is not only
820 dog-slow, but also useless since eventually nil would
821 have to be returned anyway. */
822 report_file_error ("Cannot create temporary name for prefix",
830 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
831 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
832 The Emacs process number forms part of the result,
833 so there is no danger of generating a name being used by another process.
835 In addition, this function makes an attempt to choose a name
836 which has no existing file. To make this work,
837 PREFIX should be an absolute file name.
839 There is a race condition between calling `make-temp-name' and creating the
840 file which opens all kinds of security holes. For that reason, you should
841 probably use `make-temp-file' instead, except in three circumstances:
843 * If you are creating the file in the user's home directory.
844 * If you are creating a directory rather than an ordinary file.
845 * If you are taking special precautions as `make-temp-file' does. */)
848 return make_temp_name (prefix
, 0);
853 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
854 doc
: /* Convert filename NAME to absolute, and canonicalize it.
855 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
856 \(does not start with slash or tilde); both the directory name and
857 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
858 missing, the current buffer's value of `default-directory' is used.
859 NAME should be a string that is a valid file name for the underlying
861 File name components that are `.' are removed, and
862 so are file name components followed by `..', along with the `..' itself;
863 note that these simplifications are done without checking the resulting
864 file names in the file system.
865 Multiple consecutive slashes are collapsed into a single slash,
866 except at the beginning of the file name when they are significant (e.g.,
867 UNC file names on MS-Windows.)
868 An initial `~/' expands to your home directory.
869 An initial `~USER/' expands to USER's home directory.
870 See also the function `substitute-in-file-name'.
872 For technical reasons, this function can return correct but
873 non-intuitive results for the root directory; for instance,
874 \(expand-file-name ".." "/") returns "/..". For this reason, use
875 \(directory-file-name (file-name-directory dirname)) to traverse a
876 filesystem tree, not (expand-file-name ".." dirname). */)
877 (Lisp_Object name
, Lisp_Object default_directory
)
879 /* These point to SDATA and need to be careful with string-relocation
880 during GC (via DECODE_FILE). */
883 /* This should only point to alloca'd data. */
890 bool collapse_newdir
= 1;
894 Lisp_Object handler
, result
, handled_name
;
901 /* If the file name has special constructs in it,
902 call the corresponding file handler. */
903 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
906 handled_name
= call3 (handler
, Qexpand_file_name
,
907 name
, default_directory
);
908 if (STRINGP (handled_name
))
910 error ("Invalid handler in `file-name-handler-alist'");
914 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
915 if (NILP (default_directory
))
916 default_directory
= BVAR (current_buffer
, directory
);
917 if (! STRINGP (default_directory
))
920 /* "/" is not considered a root directory on DOS_NT, so using "/"
921 here causes an infinite recursion in, e.g., the following:
923 (let (default-directory)
924 (expand-file-name "a"))
926 To avoid this, we set default_directory to the root of the
928 default_directory
= build_string (emacs_root_dir ());
930 default_directory
= build_string ("/");
934 if (!NILP (default_directory
))
936 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
939 handled_name
= call3 (handler
, Qexpand_file_name
,
940 name
, default_directory
);
941 if (STRINGP (handled_name
))
943 error ("Invalid handler in `file-name-handler-alist'");
948 char *o
= SSDATA (default_directory
);
950 /* Make sure DEFAULT_DIRECTORY is properly expanded.
951 It would be better to do this down below where we actually use
952 default_directory. Unfortunately, calling Fexpand_file_name recursively
953 could invoke GC, and the strings might be relocated. This would
954 be annoying because we have pointers into strings lying around
955 that would need adjusting, and people would add new pointers to
956 the code and forget to adjust them, resulting in intermittent bugs.
957 Putting this call here avoids all that crud.
959 The EQ test avoids infinite recursion. */
960 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
961 /* Save time in some common cases - as long as default_directory
962 is not relative, it can be canonicalized with name below (if it
963 is needed at all) without requiring it to be expanded now. */
965 /* Detect MSDOS file names with drive specifiers. */
966 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
967 && IS_DIRECTORY_SEP (o
[2]))
969 /* Detect Windows file names in UNC format. */
970 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
972 #else /* not DOS_NT */
973 /* Detect Unix absolute file names (/... alone is not absolute on
975 && ! (IS_DIRECTORY_SEP (o
[0]))
976 #endif /* not DOS_NT */
982 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
986 multibyte
= STRING_MULTIBYTE (name
);
987 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
991 unsigned char *p
= SDATA (name
);
993 while (*p
&& ASCII_BYTE_P (*p
))
997 /* NAME is a pure ASCII string, and DEFAULT_DIRECTORY is
998 unibyte. Do not convert DEFAULT_DIRECTORY to
999 multibyte; instead, convert NAME to a unibyte string,
1000 so that the result of this function is also a unibyte
1001 string. This is needed during bootstrapping and
1002 dumping, when Emacs cannot decode file names, because
1003 the locale environment is not set up. */
1004 name
= make_unibyte_string (SSDATA (name
), SBYTES (name
));
1008 default_directory
= string_to_multibyte (default_directory
);
1012 name
= string_to_multibyte (name
);
1018 if (!NILP (Vw32_downcase_file_names
))
1019 default_directory
= Fdowncase (default_directory
);
1022 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
1023 nm
= xlispstrdupa (name
);
1026 /* Note if special escape prefix is present, but remove for now. */
1027 if (nm
[0] == '/' && nm
[1] == ':')
1033 /* Find and remove drive specifier if present; this makes nm absolute
1034 even if the rest of the name appears to be relative. Only look for
1035 drive specifier at the beginning. */
1036 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1038 drive
= (unsigned char) nm
[0];
1043 /* If we see "c://somedir", we want to strip the first slash after the
1044 colon when stripping the drive letter. Otherwise, this expands to
1046 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1049 /* Discard any previous drive specifier if nm is now in UNC format. */
1050 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1051 && !IS_DIRECTORY_SEP (nm
[2]))
1053 #endif /* WINDOWSNT */
1056 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1057 none are found, we can probably return right away. We will avoid
1058 allocating a new string if name is already fully expanded. */
1060 IS_DIRECTORY_SEP (nm
[0])
1062 && drive
&& !is_escaped
1065 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1069 /* If it turns out that the filename we want to return is just a
1070 suffix of FILENAME, we don't need to go through and edit
1071 things; we just need to construct a new string using data
1072 starting at the middle of FILENAME. If we set LOSE, that
1073 means we've discovered that we can't do that cool trick. */
1079 /* Since we know the name is absolute, we can assume that each
1080 element starts with a "/". */
1082 /* "." and ".." are hairy. */
1083 if (IS_DIRECTORY_SEP (p
[0])
1085 && (IS_DIRECTORY_SEP (p
[2])
1087 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1090 /* Replace multiple slashes with a single one, except
1091 leave leading "//" alone. */
1092 else if (IS_DIRECTORY_SEP (p
[0])
1093 && IS_DIRECTORY_SEP (p
[1])
1094 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1101 /* Make sure directories are all separated with /, but
1102 avoid allocation of a new string when not required. */
1103 dostounix_filename (nm
);
1105 if (IS_DIRECTORY_SEP (nm
[1]))
1107 if (strcmp (nm
, SSDATA (name
)) != 0)
1108 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1112 /* Drive must be set, so this is okay. */
1113 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1117 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1118 temp
[0] = DRIVE_LETTER (drive
);
1119 name
= concat2 (build_string (temp
), name
);
1122 if (!NILP (Vw32_downcase_file_names
))
1123 name
= Fdowncase (name
);
1126 #else /* not DOS_NT */
1127 if (strcmp (nm
, SSDATA (name
)) == 0)
1129 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1130 #endif /* not DOS_NT */
1134 /* At this point, nm might or might not be an absolute file name. We
1135 need to expand ~ or ~user if present, otherwise prefix nm with
1136 default_directory if nm is not absolute, and finally collapse /./
1137 and /foo/../ sequences.
1139 We set newdir to be the appropriate prefix if one is needed:
1140 - the relevant user directory if nm starts with ~ or ~user
1141 - the specified drive's working dir (DOS/NT only) if nm does not
1143 - the value of default_directory.
1145 Note that these prefixes are not guaranteed to be absolute (except
1146 for the working dir of a drive). Therefore, to ensure we always
1147 return an absolute name, if the final prefix is not absolute we
1148 append it to the current working directory. */
1152 if (nm
[0] == '~') /* prefix ~ */
1154 if (IS_DIRECTORY_SEP (nm
[1])
1155 || nm
[1] == 0) /* ~ by itself */
1159 if (!(newdir
= egetenv ("HOME")))
1162 /* `egetenv' may return a unibyte string, which will bite us since
1163 we expect the directory to be multibyte. */
1167 char newdir_utf8
[MAX_UTF8_PATH
];
1169 filename_from_ansi (newdir
, newdir_utf8
);
1170 tem
= build_string (newdir_utf8
);
1174 tem
= build_string (newdir
);
1175 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1177 hdir
= DECODE_FILE (tem
);
1178 newdir
= SSDATA (hdir
);
1181 collapse_newdir
= 0;
1184 else /* ~user/filename */
1187 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1189 o
= SAFE_ALLOCA (p
- nm
+ 1);
1190 memcpy (o
, nm
, p
- nm
);
1194 pw
= getpwnam (o
+ 1);
1200 newdir
= pw
->pw_dir
;
1201 /* `getpwnam' may return a unibyte string, which will
1202 bite us since we expect the directory to be
1204 tem
= build_string (newdir
);
1205 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1207 hdir
= DECODE_FILE (tem
);
1208 newdir
= SSDATA (hdir
);
1212 collapse_newdir
= 0;
1216 /* If we don't find a user of that name, leave the name
1217 unchanged; don't move nm forward to p. */
1222 /* On DOS and Windows, nm is absolute if a drive name was specified;
1223 use the drive's current directory as the prefix if needed. */
1224 if (!newdir
&& drive
)
1226 /* Get default directory if needed to make nm absolute. */
1228 if (!IS_DIRECTORY_SEP (nm
[0]))
1230 adir
= alloca (MAXPATHLEN
+ 1);
1231 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1235 Lisp_Object tem
= build_string (adir
);
1237 tem
= DECODE_FILE (tem
);
1238 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1243 /* Either nm starts with /, or drive isn't mounted. */
1245 adir
[0] = DRIVE_LETTER (drive
);
1254 /* Finally, if no prefix has been specified and nm is not absolute,
1255 then it must be expanded relative to default_directory. */
1259 /* /... alone is not absolute on DOS and Windows. */
1260 && !IS_DIRECTORY_SEP (nm
[0])
1263 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1])
1264 && !IS_DIRECTORY_SEP (nm
[2]))
1268 newdir
= SSDATA (default_directory
);
1270 /* Note if special escape prefix is present, but remove for now. */
1271 if (newdir
[0] == '/' && newdir
[1] == ':')
1282 /* First ensure newdir is an absolute name. */
1284 /* Detect MSDOS file names with drive specifiers. */
1285 ! (IS_DRIVE (newdir
[0])
1286 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1288 /* Detect Windows file names in UNC format. */
1289 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1290 && !IS_DIRECTORY_SEP (newdir
[2]))
1294 /* Effectively, let newdir be (expand-file-name newdir cwd).
1295 Because of the admonition against calling expand-file-name
1296 when we have pointers into lisp strings, we accomplish this
1297 indirectly by prepending newdir to nm if necessary, and using
1298 cwd (or the wd of newdir's drive) as the new newdir. */
1301 const int adir_size
= MAX_UTF8_PATH
;
1303 const int adir_size
= MAXPATHLEN
+ 1;
1306 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1308 drive
= (unsigned char) newdir
[0];
1311 if (!IS_DIRECTORY_SEP (nm
[0]))
1313 ptrdiff_t newlen
= strlen (newdir
);
1314 char *tmp
= alloca (newlen
+ file_name_as_directory_slop
1316 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1320 adir
= alloca (adir_size
);
1323 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1327 getcwd (adir
, adir_size
);
1330 Lisp_Object tem
= build_string (adir
);
1332 tem
= DECODE_FILE (tem
);
1333 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1338 /* Strip off drive name from prefix, if present. */
1339 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1345 /* Keep only a prefix from newdir if nm starts with slash
1346 (//server/share for UNC, nothing otherwise). */
1347 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1350 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1])
1351 && !IS_DIRECTORY_SEP (newdir
[2]))
1353 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1355 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1357 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1370 /* Ignore any slash at the end of newdir, unless newdir is
1371 just "/" or "//". */
1372 length
= strlen (newdir
);
1373 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1374 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1380 /* Now concatenate the directory and name to new space in the stack frame. */
1381 tlen
= length
+ file_name_as_directory_slop
+ strlen (nm
) + 1;
1383 /* Reserve space for drive specifier and escape prefix, since either
1384 or both may need to be inserted. (The Microsoft x86 compiler
1385 produces incorrect code if the following two lines are combined.) */
1386 target
= alloca (tlen
+ 4);
1388 #else /* not DOS_NT */
1389 target
= SAFE_ALLOCA (tlen
);
1390 #endif /* not DOS_NT */
1395 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1398 /* If newdir is effectively "C:/", then the drive letter will have
1399 been stripped and newdir will be "/". Concatenating with an
1400 absolute directory in nm produces "//", which will then be
1401 incorrectly treated as a network share. Ignore newdir in
1402 this case (keeping the drive letter). */
1403 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1404 && newdir
[1] == '\0'))
1407 memcpy (target
, newdir
, length
);
1412 file_name_as_directory (target
, newdir
, length
, multibyte
);
1415 strcat (target
, nm
);
1417 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1425 if (!IS_DIRECTORY_SEP (*p
))
1429 else if (p
[1] == '.'
1430 && (IS_DIRECTORY_SEP (p
[2])
1433 /* If "/." is the entire filename, keep the "/". Otherwise,
1434 just delete the whole "/.". */
1435 if (o
== target
&& p
[2] == '\0')
1439 else if (p
[1] == '.' && p
[2] == '.'
1440 /* `/../' is the "superroot" on certain file systems.
1441 Turned off on DOS_NT systems because they have no
1442 "superroot" and because this causes us to produce
1443 file names like "d:/../foo" which fail file-related
1444 functions of the underlying OS. (To reproduce, try a
1445 long series of "../../" in default_directory, longer
1446 than the number of levels from the root.) */
1450 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1455 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1458 /* Don't go below server level in UNC filenames. */
1459 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1460 && IS_DIRECTORY_SEP (*target
))
1464 /* Keep initial / only if this is the whole name. */
1465 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1469 else if (IS_DIRECTORY_SEP (p
[1])
1470 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1471 /* Collapse multiple "/", except leave leading "//" alone. */
1480 /* At last, set drive name. */
1482 /* Except for network file name. */
1483 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1484 #endif /* WINDOWSNT */
1486 if (!drive
) emacs_abort ();
1488 target
[0] = DRIVE_LETTER (drive
);
1491 /* Reinsert the escape prefix if required. */
1498 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1499 dostounix_filename (SSDATA (result
));
1501 if (!NILP (Vw32_downcase_file_names
))
1502 result
= Fdowncase (result
);
1505 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1506 #endif /* !DOS_NT */
1509 /* Again look to see if the file name has special constructs in it
1510 and perhaps call the corresponding file handler. This is needed
1511 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1512 the ".." component gives us "/user@host:/bar/../baz" which needs
1513 to be expanded again. */
1514 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1515 if (!NILP (handler
))
1517 handled_name
= call3 (handler
, Qexpand_file_name
,
1518 result
, default_directory
);
1519 if (! STRINGP (handled_name
))
1520 error ("Invalid handler in `file-name-handler-alist'");
1521 result
= handled_name
;
1529 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1530 This is the old version of expand-file-name, before it was thoroughly
1531 rewritten for Emacs 10.31. We leave this version here commented-out,
1532 because the code is very complex and likely to have subtle bugs. If
1533 bugs _are_ found, it might be of interest to look at the old code and
1534 see what did it do in the relevant situation.
1536 Don't remove this code: it's true that it will be accessible
1537 from the repository, but a few years from deletion, people will
1538 forget it is there. */
1540 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1541 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1542 "Convert FILENAME to absolute, and canonicalize it.\n\
1543 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1544 \(does not start with slash); if DEFAULT is nil or missing,\n\
1545 the current buffer's value of default-directory is used.\n\
1546 Filenames containing `.' or `..' as components are simplified;\n\
1547 initial `~/' expands to your home directory.\n\
1548 See also the function `substitute-in-file-name'.")
1550 Lisp_Object name
, defalt
;
1554 register unsigned char *newdir
, *p
, *o
;
1556 unsigned char *target
;
1559 CHECK_STRING (name
);
1562 /* If nm is absolute, flush ...// and detect /./ and /../.
1563 If no /./ or /../ we can return right away. */
1570 if (p
[0] == '/' && p
[1] == '/')
1572 if (p
[0] == '/' && p
[1] == '~')
1573 nm
= p
+ 1, lose
= 1;
1574 if (p
[0] == '/' && p
[1] == '.'
1575 && (p
[2] == '/' || p
[2] == 0
1576 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1582 if (nm
== SDATA (name
))
1584 return build_string (nm
);
1588 /* Now determine directory to start with and put it in NEWDIR. */
1592 if (nm
[0] == '~') /* prefix ~ */
1593 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1595 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1596 newdir
= (unsigned char *) "";
1599 else /* ~user/filename */
1601 /* Get past ~ to user. */
1602 unsigned char *user
= nm
+ 1;
1603 /* Find end of name. */
1604 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1605 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1606 /* Copy the user name into temp storage. */
1607 o
= alloca (len
+ 1);
1608 memcpy (o
, user
, len
);
1611 /* Look up the user name. */
1613 pw
= (struct passwd
*) getpwnam (o
+ 1);
1616 error ("\"%s\" isn't a registered user", o
+ 1);
1618 newdir
= (unsigned char *) pw
->pw_dir
;
1620 /* Discard the user name from NM. */
1624 if (nm
[0] != '/' && !newdir
)
1627 defalt
= current_buffer
->directory
;
1628 CHECK_STRING (defalt
);
1629 newdir
= SDATA (defalt
);
1632 /* Now concatenate the directory and name to new space in the stack frame. */
1634 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1635 target
= alloca (tlen
);
1640 if (nm
[0] == 0 || nm
[0] == '/')
1641 strcpy (target
, newdir
);
1643 file_name_as_directory (target
, newdir
);
1646 strcat (target
, nm
);
1648 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1659 else if (!strncmp (p
, "//", 2)
1665 else if (p
[0] == '/' && p
[1] == '.'
1666 && (p
[2] == '/' || p
[2] == 0))
1668 else if (!strncmp (p
, "/..", 3)
1669 /* `/../' is the "superroot" on certain file systems. */
1671 && (p
[3] == '/' || p
[3] == 0))
1673 while (o
!= target
&& *--o
!= '/')
1675 if (o
== target
&& *o
== '/')
1685 return make_string (target
, o
- target
);
1689 /* If /~ or // appears, discard everything through first slash. */
1691 file_name_absolute_p (const char *filename
)
1694 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1696 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1697 && IS_DIRECTORY_SEP (filename
[2]))
1703 search_embedded_absfilename (char *nm
, char *endp
)
1707 for (p
= nm
+ 1; p
< endp
; p
++)
1709 if (IS_DIRECTORY_SEP (p
[-1])
1710 && file_name_absolute_p (p
)
1711 #if defined (WINDOWSNT) || defined (CYGWIN)
1712 /* // at start of file name is meaningful in Apollo,
1713 WindowsNT and Cygwin systems. */
1714 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1715 #endif /* not (WINDOWSNT || CYGWIN) */
1718 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1719 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1721 char *o
= alloca (s
- p
+ 1);
1723 memcpy (o
, p
, s
- p
);
1726 /* If we have ~user and `user' exists, discard
1727 everything up to ~. But if `user' does not exist, leave
1728 ~user alone, it might be a literal file name. */
1730 pw
= getpwnam (o
+ 1);
1742 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1743 Ssubstitute_in_file_name
, 1, 1, 0,
1744 doc
: /* Substitute environment variables referred to in FILENAME.
1745 `$FOO' where FOO is an environment variable name means to substitute
1746 the value of that variable. The variable name should be terminated
1747 with a character not a letter, digit or underscore; otherwise, enclose
1748 the entire variable name in braces.
1750 If `/~' appears, all of FILENAME through that `/' is discarded.
1751 If `//' appears, everything up to and including the first of
1752 those `/' is discarded. */)
1753 (Lisp_Object filename
)
1755 char *nm
, *p
, *x
, *endp
;
1756 bool substituted
= false;
1759 Lisp_Object handler
;
1761 CHECK_STRING (filename
);
1763 multibyte
= STRING_MULTIBYTE (filename
);
1765 /* If the file name has special constructs in it,
1766 call the corresponding file handler. */
1767 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1768 if (!NILP (handler
))
1770 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1772 if (STRINGP (handled_name
))
1773 return handled_name
;
1774 error ("Invalid handler in `file-name-handler-alist'");
1777 /* Always work on a copy of the string, in case GC happens during
1778 decode of environment variables, causing the original Lisp_String
1779 data to be relocated. */
1780 nm
= xlispstrdupa (filename
);
1783 dostounix_filename (nm
);
1784 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1786 endp
= nm
+ SBYTES (filename
);
1788 /* If /~ or // appears, discard everything through first slash. */
1789 p
= search_embedded_absfilename (nm
, endp
);
1791 /* Start over with the new string, so we check the file-name-handler
1792 again. Important with filenames like "/home/foo//:/hello///there"
1793 which would substitute to "/:/hello///there" rather than "/there". */
1794 return Fsubstitute_in_file_name
1795 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1797 /* See if any variables are substituted into the string. */
1799 if (!NILP (Ffboundp (Qsubstitute_env_in_file_name
)))
1802 = (!substituted
? filename
1803 : make_specified_string (nm
, -1, endp
- nm
, multibyte
));
1804 Lisp_Object tmp
= call1 (Qsubstitute_env_in_file_name
, name
);
1806 if (!EQ (tmp
, name
))
1814 if (!NILP (Vw32_downcase_file_names
))
1815 filename
= Fdowncase (filename
);
1820 xnm
= SSDATA (filename
);
1821 x
= xnm
+ SBYTES (filename
);
1823 /* If /~ or // appears, discard everything through first slash. */
1824 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1825 /* This time we do not start over because we've already expanded envvars
1826 and replaced $$ with $. Maybe we should start over as well, but we'd
1827 need to quote some $ to $$ first. */
1831 if (!NILP (Vw32_downcase_file_names
))
1833 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1835 xname
= Fdowncase (xname
);
1840 return (xnm
== SSDATA (filename
)
1842 : make_specified_string (xnm
, -1, x
- xnm
, multibyte
));
1845 /* A slightly faster and more convenient way to get
1846 (directory-file-name (expand-file-name FOO)). */
1849 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1851 register Lisp_Object absname
;
1853 absname
= Fexpand_file_name (filename
, defdir
);
1855 /* Remove final slash, if any (unless this is the root dir).
1856 stat behaves differently depending! */
1857 if (SCHARS (absname
) > 1
1858 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1859 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1860 /* We cannot take shortcuts; they might be wrong for magic file names. */
1861 absname
= Fdirectory_file_name (absname
);
1865 /* Signal an error if the file ABSNAME already exists.
1866 If KNOWN_TO_EXIST, the file is known to exist.
1867 QUERYSTRING is a name for the action that is being considered
1869 If INTERACTIVE, ask the user whether to proceed,
1870 and bypass the error if the user says to go ahead.
1871 If QUICK, ask for y or n, not yes or no. */
1874 barf_or_query_if_file_exists (Lisp_Object absname
, bool known_to_exist
,
1875 const char *querystring
, bool interactive
,
1878 Lisp_Object tem
, encoded_filename
;
1879 struct stat statbuf
;
1880 struct gcpro gcpro1
;
1882 encoded_filename
= ENCODE_FILE (absname
);
1884 if (! known_to_exist
&& lstat (SSDATA (encoded_filename
), &statbuf
) == 0)
1886 if (S_ISDIR (statbuf
.st_mode
))
1887 xsignal2 (Qfile_error
,
1888 build_string ("File is a directory"), absname
);
1889 known_to_exist
= true;
1895 xsignal2 (Qfile_already_exists
,
1896 build_string ("File already exists"), absname
);
1898 tem
= format2 ("File %s already exists; %s anyway? ",
1899 absname
, build_string (querystring
));
1901 tem
= call1 (intern ("y-or-n-p"), tem
);
1903 tem
= do_yes_or_no_p (tem
);
1906 xsignal2 (Qfile_already_exists
,
1907 build_string ("File already exists"), absname
);
1911 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1912 "fCopy file: \nGCopy %s to file: \np\nP",
1913 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1914 If NEWNAME names a directory, copy FILE there.
1916 This function always sets the file modes of the output file to match
1919 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1920 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1921 signal a `file-already-exists' error without overwriting. If
1922 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1923 about overwriting; this is what happens in interactive use with M-x.
1924 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1927 Fourth arg KEEP-TIME non-nil means give the output file the same
1928 last-modified time as the old one. (This works on only some systems.)
1930 A prefix arg makes KEEP-TIME non-nil.
1932 If PRESERVE-UID-GID is non-nil, we try to transfer the
1933 uid and gid of FILE to NEWNAME.
1935 If PRESERVE-PERMISSIONS is non-nil, copy permissions of FILE to NEWNAME;
1936 this includes the file modes, along with ACL entries and SELinux
1937 context if present. Otherwise, if NEWNAME is created its file
1938 permission bits are those of FILE, masked by the default file
1940 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
,
1941 Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
,
1942 Lisp_Object preserve_permissions
)
1944 Lisp_Object handler
;
1945 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1946 ptrdiff_t count
= SPECPDL_INDEX ();
1947 Lisp_Object encoded_file
, encoded_newname
;
1949 security_context_t con
;
1955 bool already_exists
= false;
1959 char buf
[16 * 1024];
1963 encoded_file
= encoded_newname
= Qnil
;
1964 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1965 CHECK_STRING (file
);
1966 CHECK_STRING (newname
);
1968 if (!NILP (Ffile_directory_p (newname
)))
1969 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1971 newname
= Fexpand_file_name (newname
, Qnil
);
1973 file
= Fexpand_file_name (file
, Qnil
);
1975 /* If the input file name has special constructs in it,
1976 call the corresponding file handler. */
1977 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1978 /* Likewise for output file name. */
1980 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1981 if (!NILP (handler
))
1982 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1983 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1984 preserve_permissions
));
1986 encoded_file
= ENCODE_FILE (file
);
1987 encoded_newname
= ENCODE_FILE (newname
);
1990 if (NILP (ok_if_already_exists
)
1991 || INTEGERP (ok_if_already_exists
))
1992 barf_or_query_if_file_exists (newname
, false, "copy to it",
1993 INTEGERP (ok_if_already_exists
), false);
1995 result
= w32_copy_file (SSDATA (encoded_file
), SSDATA (encoded_newname
),
1996 !NILP (keep_time
), !NILP (preserve_uid_gid
),
1997 !NILP (preserve_permissions
));
2001 report_file_error ("Copying file", list2 (file
, newname
));
2003 report_file_error ("Copying permissions from", file
);
2005 xsignal2 (Qfile_date_error
,
2006 build_string ("Resetting file times"), newname
);
2008 report_file_error ("Copying permissions to", newname
);
2010 #else /* not WINDOWSNT */
2012 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2016 report_file_error ("Opening input file", file
);
2018 record_unwind_protect_int (close_file_unwind
, ifd
);
2020 if (fstat (ifd
, &st
) != 0)
2021 report_file_error ("Input file status", file
);
2023 if (!NILP (preserve_permissions
))
2026 if (is_selinux_enabled ())
2028 conlength
= fgetfilecon (ifd
, &con
);
2029 if (conlength
== -1)
2030 report_file_error ("Doing fgetfilecon", file
);
2035 /* We can copy only regular files. */
2036 if (!S_ISREG (st
.st_mode
))
2037 report_file_errno ("Non-regular file", file
,
2038 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
2041 new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0700 : 0777);
2043 new_mask
= S_IREAD
| S_IWRITE
;
2046 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
| O_CREAT
| O_EXCL
,
2048 if (ofd
< 0 && errno
== EEXIST
)
2050 if (NILP (ok_if_already_exists
) || INTEGERP (ok_if_already_exists
))
2051 barf_or_query_if_file_exists (newname
, true, "copy to it",
2052 INTEGERP (ok_if_already_exists
), false);
2053 already_exists
= true;
2054 ofd
= emacs_open (SSDATA (encoded_newname
), O_WRONLY
, 0);
2057 report_file_error ("Opening output file", newname
);
2059 record_unwind_protect_int (close_file_unwind
, ofd
);
2064 if (fstat (ofd
, &out_st
) != 0)
2065 report_file_error ("Output file status", newname
);
2066 if (st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2067 report_file_errno ("Input and output files are the same",
2068 list2 (file
, newname
), 0);
2069 if (ftruncate (ofd
, 0) != 0)
2070 report_file_error ("Truncating output file", newname
);
2075 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2076 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2077 report_file_error ("Write error", newname
);
2081 /* Preserve the original file permissions, and if requested, also its
2084 mode_t preserved_permissions
= st
.st_mode
& 07777;
2085 mode_t default_permissions
= st
.st_mode
& 0777 & ~realmask
;
2086 if (!NILP (preserve_uid_gid
))
2088 /* Attempt to change owner and group. If that doesn't work
2089 attempt to change just the group, as that is sometimes allowed.
2090 Adjust the mode mask to eliminate setuid or setgid bits
2091 or group permissions bits that are inappropriate if the
2092 owner or group are wrong. */
2093 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2095 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2096 preserved_permissions
&= ~04000;
2099 preserved_permissions
&= ~06000;
2101 /* Copy the other bits to the group bits, since the
2103 preserved_permissions
&= ~070;
2104 preserved_permissions
|= (preserved_permissions
& 7) << 3;
2105 default_permissions
&= ~070;
2106 default_permissions
|= (default_permissions
& 7) << 3;
2111 switch (!NILP (preserve_permissions
)
2112 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2113 SSDATA (encoded_newname
), ofd
,
2114 preserved_permissions
)
2116 || (new_mask
& ~realmask
) == default_permissions
)
2118 : fchmod (ofd
, default_permissions
))
2120 case -2: report_file_error ("Copying permissions from", file
);
2121 case -1: report_file_error ("Copying permissions to", newname
);
2124 #endif /* not MSDOS */
2129 /* Set the modified context back to the file. */
2130 bool fail
= fsetfilecon (ofd
, con
) != 0;
2131 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2132 if (fail
&& errno
!= ENOTSUP
)
2133 report_file_error ("Doing fsetfilecon", newname
);
2139 if (!NILP (keep_time
))
2141 struct timespec atime
= get_stat_atime (&st
);
2142 struct timespec mtime
= get_stat_mtime (&st
);
2143 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
) != 0)
2144 xsignal2 (Qfile_date_error
,
2145 build_string ("Cannot set file date"), newname
);
2148 if (emacs_close (ofd
) < 0)
2149 report_file_error ("Write error", newname
);
2154 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2155 and if it can't, it tells so. Otherwise, under MSDOS we usually
2156 get only the READ bit, which will make the copied file read-only,
2157 so it's better not to chmod at all. */
2158 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2159 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2161 #endif /* not WINDOWSNT */
2163 /* Discard the unwind protects. */
2164 specpdl_ptr
= specpdl
+ count
;
2170 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2171 Smake_directory_internal
, 1, 1, 0,
2172 doc
: /* Create a new directory named DIRECTORY. */)
2173 (Lisp_Object directory
)
2176 Lisp_Object handler
;
2177 Lisp_Object encoded_dir
;
2179 CHECK_STRING (directory
);
2180 directory
= Fexpand_file_name (directory
, Qnil
);
2182 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2183 if (!NILP (handler
))
2184 return call2 (handler
, Qmake_directory_internal
, directory
);
2186 encoded_dir
= ENCODE_FILE (directory
);
2188 dir
= SSDATA (encoded_dir
);
2191 if (mkdir (dir
) != 0)
2193 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2195 report_file_error ("Creating directory", directory
);
2200 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2201 Sdelete_directory_internal
, 1, 1, 0,
2202 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2203 (Lisp_Object directory
)
2206 Lisp_Object encoded_dir
;
2208 CHECK_STRING (directory
);
2209 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2210 encoded_dir
= ENCODE_FILE (directory
);
2211 dir
= SSDATA (encoded_dir
);
2213 if (rmdir (dir
) != 0)
2214 report_file_error ("Removing directory", directory
);
2219 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2220 "(list (read-file-name \
2221 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2222 \"Move file to trash: \" \"Delete file: \") \
2223 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2224 (null current-prefix-arg))",
2225 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2226 If file has multiple names, it continues to exist with the other names.
2227 TRASH non-nil means to trash the file instead of deleting, provided
2228 `delete-by-moving-to-trash' is non-nil.
2230 When called interactively, TRASH is t if no prefix argument is given.
2231 With a prefix argument, TRASH is nil. */)
2232 (Lisp_Object filename
, Lisp_Object trash
)
2234 Lisp_Object handler
;
2235 Lisp_Object encoded_file
;
2236 struct gcpro gcpro1
;
2239 if (!NILP (Ffile_directory_p (filename
))
2240 && NILP (Ffile_symlink_p (filename
)))
2241 xsignal2 (Qfile_error
,
2242 build_string ("Removing old name: is a directory"),
2245 filename
= Fexpand_file_name (filename
, Qnil
);
2247 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2248 if (!NILP (handler
))
2249 return call3 (handler
, Qdelete_file
, filename
, trash
);
2251 if (delete_by_moving_to_trash
&& !NILP (trash
))
2252 return call1 (Qmove_file_to_trash
, filename
);
2254 encoded_file
= ENCODE_FILE (filename
);
2256 if (unlink (SSDATA (encoded_file
)) < 0)
2257 report_file_error ("Removing old name", filename
);
2262 internal_delete_file_1 (Lisp_Object ignore
)
2267 /* Delete file FILENAME, returning true if successful.
2268 This ignores `delete-by-moving-to-trash'. */
2271 internal_delete_file (Lisp_Object filename
)
2275 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2276 Qt
, internal_delete_file_1
);
2280 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2281 "fRename file: \nGRename %s to file: \np",
2282 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2283 If file has names other than FILE, it continues to have those names.
2284 Signals a `file-already-exists' error if a file NEWNAME already exists
2285 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2286 A number as third arg means request confirmation if NEWNAME already exists.
2287 This is what happens in interactive use with M-x. */)
2288 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2290 Lisp_Object handler
;
2291 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2292 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2294 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2295 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2296 CHECK_STRING (file
);
2297 CHECK_STRING (newname
);
2298 file
= Fexpand_file_name (file
, Qnil
);
2300 if ((!NILP (Ffile_directory_p (newname
)))
2302 /* If the file names are identical but for the case,
2303 don't attempt to move directory to itself. */
2304 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2308 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2309 ? file
: Fdirectory_file_name (file
));
2310 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2313 newname
= Fexpand_file_name (newname
, Qnil
);
2315 /* If the file name has special constructs in it,
2316 call the corresponding file handler. */
2317 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2319 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2320 if (!NILP (handler
))
2321 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2322 file
, newname
, ok_if_already_exists
));
2324 encoded_file
= ENCODE_FILE (file
);
2325 encoded_newname
= ENCODE_FILE (newname
);
2328 /* If the file names are identical but for the case, don't ask for
2329 confirmation: they simply want to change the letter-case of the
2331 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2333 if (NILP (ok_if_already_exists
)
2334 || INTEGERP (ok_if_already_exists
))
2335 barf_or_query_if_file_exists (newname
, false, "rename to it",
2336 INTEGERP (ok_if_already_exists
), false);
2337 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2339 int rename_errno
= errno
;
2340 if (rename_errno
== EXDEV
)
2343 symlink_target
= Ffile_symlink_p (file
);
2344 if (! NILP (symlink_target
))
2345 Fmake_symbolic_link (symlink_target
, newname
,
2346 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2347 else if (!NILP (Ffile_directory_p (file
)))
2348 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2350 /* We have already prompted if it was an integer, so don't
2351 have copy-file prompt again. */
2352 Fcopy_file (file
, newname
,
2353 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2356 count
= SPECPDL_INDEX ();
2357 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2359 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2360 call2 (Qdelete_directory
, file
, Qt
);
2362 Fdelete_file (file
, Qnil
);
2363 unbind_to (count
, Qnil
);
2366 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2372 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2373 "fAdd name to file: \nGName to add to %s: \np",
2374 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2375 Signals a `file-already-exists' error if a file NEWNAME already exists
2376 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2377 A number as third arg means request confirmation if NEWNAME already exists.
2378 This is what happens in interactive use with M-x. */)
2379 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2381 Lisp_Object handler
;
2382 Lisp_Object encoded_file
, encoded_newname
;
2383 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2385 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2386 encoded_file
= encoded_newname
= Qnil
;
2387 CHECK_STRING (file
);
2388 CHECK_STRING (newname
);
2389 file
= Fexpand_file_name (file
, Qnil
);
2391 if (!NILP (Ffile_directory_p (newname
)))
2392 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2394 newname
= Fexpand_file_name (newname
, Qnil
);
2396 /* If the file name has special constructs in it,
2397 call the corresponding file handler. */
2398 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2399 if (!NILP (handler
))
2400 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2401 newname
, ok_if_already_exists
));
2403 /* If the new name has special constructs in it,
2404 call the corresponding file handler. */
2405 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2406 if (!NILP (handler
))
2407 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2408 newname
, ok_if_already_exists
));
2410 encoded_file
= ENCODE_FILE (file
);
2411 encoded_newname
= ENCODE_FILE (newname
);
2413 if (NILP (ok_if_already_exists
)
2414 || INTEGERP (ok_if_already_exists
))
2415 barf_or_query_if_file_exists (newname
, false, "make it a new name",
2416 INTEGERP (ok_if_already_exists
), false);
2418 unlink (SSDATA (newname
));
2419 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2421 int link_errno
= errno
;
2422 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2429 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2430 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2431 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2432 Both args must be strings.
2433 Signals a `file-already-exists' error if a file LINKNAME already exists
2434 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2435 A number as third arg means request confirmation if LINKNAME already exists.
2436 This happens for interactive use with M-x. */)
2437 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2439 Lisp_Object handler
;
2440 Lisp_Object encoded_filename
, encoded_linkname
;
2441 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2443 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2444 encoded_filename
= encoded_linkname
= Qnil
;
2445 CHECK_STRING (filename
);
2446 CHECK_STRING (linkname
);
2447 /* If the link target has a ~, we must expand it to get
2448 a truly valid file name. Otherwise, do not expand;
2449 we want to permit links to relative file names. */
2450 if (SREF (filename
, 0) == '~')
2451 filename
= Fexpand_file_name (filename
, Qnil
);
2453 if (!NILP (Ffile_directory_p (linkname
)))
2454 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2456 linkname
= Fexpand_file_name (linkname
, Qnil
);
2458 /* If the file name has special constructs in it,
2459 call the corresponding file handler. */
2460 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2461 if (!NILP (handler
))
2462 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2463 linkname
, ok_if_already_exists
));
2465 /* If the new link name has special constructs in it,
2466 call the corresponding file handler. */
2467 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2468 if (!NILP (handler
))
2469 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2470 linkname
, ok_if_already_exists
));
2472 encoded_filename
= ENCODE_FILE (filename
);
2473 encoded_linkname
= ENCODE_FILE (linkname
);
2475 if (NILP (ok_if_already_exists
)
2476 || INTEGERP (ok_if_already_exists
))
2477 barf_or_query_if_file_exists (linkname
, false, "make it a link",
2478 INTEGERP (ok_if_already_exists
), false);
2479 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2481 /* If we didn't complain already, silently delete existing file. */
2483 if (errno
== EEXIST
)
2485 unlink (SSDATA (encoded_linkname
));
2486 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2493 if (errno
== ENOSYS
)
2496 xsignal1 (Qfile_error
,
2497 build_string ("Symbolic links are not supported"));
2500 symlink_errno
= errno
;
2501 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2509 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2511 doc
: /* Return t if file FILENAME specifies an absolute file name.
2512 On Unix, this is a name starting with a `/' or a `~'. */)
2513 (Lisp_Object filename
)
2515 CHECK_STRING (filename
);
2516 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2519 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2520 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2521 See also `file-readable-p' and `file-attributes'.
2522 This returns nil for a symlink to a nonexistent file.
2523 Use `file-symlink-p' to test for such links. */)
2524 (Lisp_Object filename
)
2526 Lisp_Object absname
;
2527 Lisp_Object handler
;
2529 CHECK_STRING (filename
);
2530 absname
= Fexpand_file_name (filename
, Qnil
);
2532 /* If the file name has special constructs in it,
2533 call the corresponding file handler. */
2534 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2535 if (!NILP (handler
))
2537 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2542 absname
= ENCODE_FILE (absname
);
2544 return check_existing (SSDATA (absname
)) ? Qt
: Qnil
;
2547 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2548 doc
: /* Return t if FILENAME can be executed by you.
2549 For a directory, this means you can access files in that directory.
2550 \(It is generally better to use `file-accessible-directory-p' for that
2551 purpose, though.) */)
2552 (Lisp_Object filename
)
2554 Lisp_Object absname
;
2555 Lisp_Object handler
;
2557 CHECK_STRING (filename
);
2558 absname
= Fexpand_file_name (filename
, Qnil
);
2560 /* If the file name has special constructs in it,
2561 call the corresponding file handler. */
2562 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2563 if (!NILP (handler
))
2564 return call2 (handler
, Qfile_executable_p
, absname
);
2566 absname
= ENCODE_FILE (absname
);
2568 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2571 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2572 doc
: /* Return t if file FILENAME exists and you can read it.
2573 See also `file-exists-p' and `file-attributes'. */)
2574 (Lisp_Object filename
)
2576 Lisp_Object absname
;
2577 Lisp_Object handler
;
2579 CHECK_STRING (filename
);
2580 absname
= Fexpand_file_name (filename
, Qnil
);
2582 /* If the file name has special constructs in it,
2583 call the corresponding file handler. */
2584 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2585 if (!NILP (handler
))
2586 return call2 (handler
, Qfile_readable_p
, absname
);
2588 absname
= ENCODE_FILE (absname
);
2589 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2593 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2594 doc
: /* Return t if file FILENAME can be written or created by you. */)
2595 (Lisp_Object filename
)
2597 Lisp_Object absname
, dir
, encoded
;
2598 Lisp_Object handler
;
2600 CHECK_STRING (filename
);
2601 absname
= Fexpand_file_name (filename
, Qnil
);
2603 /* If the file name has special constructs in it,
2604 call the corresponding file handler. */
2605 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2606 if (!NILP (handler
))
2607 return call2 (handler
, Qfile_writable_p
, absname
);
2609 encoded
= ENCODE_FILE (absname
);
2610 if (check_writable (SSDATA (encoded
), W_OK
))
2612 if (errno
!= ENOENT
)
2615 dir
= Ffile_name_directory (absname
);
2616 eassert (!NILP (dir
));
2618 dir
= Fdirectory_file_name (dir
);
2621 dir
= ENCODE_FILE (dir
);
2623 /* The read-only attribute of the parent directory doesn't affect
2624 whether a file or directory can be created within it. Some day we
2625 should check ACLs though, which do affect this. */
2626 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2628 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2632 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2633 doc
: /* Access file FILENAME, and get an error if that does not work.
2634 The second argument STRING is used in the error message.
2635 If there is no error, returns nil. */)
2636 (Lisp_Object filename
, Lisp_Object string
)
2638 Lisp_Object handler
, encoded_filename
, absname
;
2640 CHECK_STRING (filename
);
2641 absname
= Fexpand_file_name (filename
, Qnil
);
2643 CHECK_STRING (string
);
2645 /* If the file name has special constructs in it,
2646 call the corresponding file handler. */
2647 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2648 if (!NILP (handler
))
2649 return call3 (handler
, Qaccess_file
, absname
, string
);
2651 encoded_filename
= ENCODE_FILE (absname
);
2653 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2654 report_file_error (SSDATA (string
), filename
);
2659 /* Relative to directory FD, return the symbolic link value of FILENAME.
2660 On failure, return nil. */
2662 emacs_readlinkat (int fd
, char const *filename
)
2664 static struct allocator
const emacs_norealloc_allocator
=
2665 { xmalloc
, NULL
, xfree
, memory_full
};
2667 char readlink_buf
[1024];
2668 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2669 &emacs_norealloc_allocator
, readlinkat
);
2673 val
= build_unibyte_string (buf
);
2674 if (buf
[0] == '/' && strchr (buf
, ':'))
2675 val
= concat2 (build_unibyte_string ("/:"), val
);
2676 if (buf
!= readlink_buf
)
2678 val
= DECODE_FILE (val
);
2682 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2683 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2684 The value is the link target, as a string.
2685 Otherwise it returns nil.
2687 This function does not check whether the link target exists. */)
2688 (Lisp_Object filename
)
2690 Lisp_Object handler
;
2692 CHECK_STRING (filename
);
2693 filename
= Fexpand_file_name (filename
, Qnil
);
2695 /* If the file name has special constructs in it,
2696 call the corresponding file handler. */
2697 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2698 if (!NILP (handler
))
2699 return call2 (handler
, Qfile_symlink_p
, filename
);
2701 filename
= ENCODE_FILE (filename
);
2703 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2706 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2707 doc
: /* Return t if FILENAME names an existing directory.
2708 Symbolic links to directories count as directories.
2709 See `file-symlink-p' to distinguish symlinks. */)
2710 (Lisp_Object filename
)
2712 Lisp_Object absname
;
2713 Lisp_Object handler
;
2715 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2717 /* If the file name has special constructs in it,
2718 call the corresponding file handler. */
2719 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2720 if (!NILP (handler
))
2721 return call2 (handler
, Qfile_directory_p
, absname
);
2723 absname
= ENCODE_FILE (absname
);
2725 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2728 /* Return true if FILE is a directory or a symlink to a directory. */
2730 file_directory_p (char const *file
)
2733 /* This is cheaper than 'stat'. */
2734 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2737 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2741 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2742 Sfile_accessible_directory_p
, 1, 1, 0,
2743 doc
: /* Return t if file FILENAME names a directory you can open.
2744 For the value to be t, FILENAME must specify the name of a directory as a file,
2745 and the directory must allow you to open files in it. In order to use a
2746 directory as a buffer's current directory, this predicate must return true.
2747 A directory name spec may be given instead; then the value is t
2748 if the directory so specified exists and really is a readable and
2749 searchable directory. */)
2750 (Lisp_Object filename
)
2752 Lisp_Object absname
;
2753 Lisp_Object handler
;
2755 CHECK_STRING (filename
);
2756 absname
= Fexpand_file_name (filename
, Qnil
);
2758 /* If the file name has special constructs in it,
2759 call the corresponding file handler. */
2760 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2761 if (!NILP (handler
))
2763 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2768 absname
= ENCODE_FILE (absname
);
2769 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2772 /* If FILE is a searchable directory or a symlink to a
2773 searchable directory, return true. Otherwise return
2774 false and set errno to an error number. */
2776 file_accessible_directory_p (char const *file
)
2779 /* There's no need to test whether FILE is searchable, as the
2780 searchable/executable bit is invented on DOS_NT platforms. */
2781 return file_directory_p (file
);
2783 /* On POSIXish platforms, use just one system call; this avoids a
2784 race and is typically faster. */
2785 ptrdiff_t len
= strlen (file
);
2791 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2792 There are three exceptions: "", "/", and "//". Leave "" alone,
2793 as it's invalid. Append only "." to the other two exceptions as
2794 "/" and "//" are distinct on some platforms, whereas "/", "///",
2795 "////", etc. are all equivalent. */
2800 /* Just check for trailing '/' when deciding whether to append '/'.
2801 That's simpler than testing the two special cases "/" and "//",
2802 and it's a safe optimization here. */
2803 char *buf
= SAFE_ALLOCA (len
+ 3);
2804 memcpy (buf
, file
, len
);
2805 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2809 ok
= check_existing (dir
);
2810 saved_errno
= errno
;
2812 errno
= saved_errno
;
2817 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2818 doc
: /* Return t if FILENAME names a regular file.
2819 This is the sort of file that holds an ordinary stream of data bytes.
2820 Symbolic links to regular files count as regular files.
2821 See `file-symlink-p' to distinguish symlinks. */)
2822 (Lisp_Object filename
)
2824 register Lisp_Object absname
;
2826 Lisp_Object handler
;
2828 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2830 /* If the file name has special constructs in it,
2831 call the corresponding file handler. */
2832 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2833 if (!NILP (handler
))
2834 return call2 (handler
, Qfile_regular_p
, absname
);
2836 absname
= ENCODE_FILE (absname
);
2841 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2843 /* Tell stat to use expensive method to get accurate info. */
2844 Vw32_get_true_file_attributes
= Qt
;
2845 result
= stat (SDATA (absname
), &st
);
2846 Vw32_get_true_file_attributes
= tem
;
2850 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2853 if (stat (SSDATA (absname
), &st
) < 0)
2855 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2859 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2860 Sfile_selinux_context
, 1, 1, 0,
2861 doc
: /* Return SELinux context of file named FILENAME.
2862 The return value is a list (USER ROLE TYPE RANGE), where the list
2863 elements are strings naming the user, role, type, and range of the
2864 file's SELinux security context.
2866 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2867 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2868 (Lisp_Object filename
)
2870 Lisp_Object absname
;
2871 Lisp_Object values
[4];
2872 Lisp_Object handler
;
2874 security_context_t con
;
2879 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2881 /* If the file name has special constructs in it,
2882 call the corresponding file handler. */
2883 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2884 if (!NILP (handler
))
2885 return call2 (handler
, Qfile_selinux_context
, absname
);
2887 absname
= ENCODE_FILE (absname
);
2894 if (is_selinux_enabled ())
2896 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2899 context
= context_new (con
);
2900 if (context_user_get (context
))
2901 values
[0] = build_string (context_user_get (context
));
2902 if (context_role_get (context
))
2903 values
[1] = build_string (context_role_get (context
));
2904 if (context_type_get (context
))
2905 values
[2] = build_string (context_type_get (context
));
2906 if (context_range_get (context
))
2907 values
[3] = build_string (context_range_get (context
));
2908 context_free (context
);
2914 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2917 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2918 Sset_file_selinux_context
, 2, 2, 0,
2919 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2920 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2921 elements are strings naming the components of a SELinux context.
2923 Value is t if setting of SELinux context was successful, nil otherwise.
2925 This function does nothing and returns nil if SELinux is disabled,
2926 or if Emacs was not compiled with SELinux support. */)
2927 (Lisp_Object filename
, Lisp_Object context
)
2929 Lisp_Object absname
;
2930 Lisp_Object handler
;
2932 Lisp_Object encoded_absname
;
2933 Lisp_Object user
= CAR_SAFE (context
);
2934 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2935 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2936 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2937 security_context_t con
;
2940 context_t parsed_con
;
2943 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2945 /* If the file name has special constructs in it,
2946 call the corresponding file handler. */
2947 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2948 if (!NILP (handler
))
2949 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2952 if (is_selinux_enabled ())
2954 /* Get current file context. */
2955 encoded_absname
= ENCODE_FILE (absname
);
2956 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2959 parsed_con
= context_new (con
);
2960 /* Change the parts defined in the parameter.*/
2963 if (context_user_set (parsed_con
, SSDATA (user
)))
2964 error ("Doing context_user_set");
2968 if (context_role_set (parsed_con
, SSDATA (role
)))
2969 error ("Doing context_role_set");
2973 if (context_type_set (parsed_con
, SSDATA (type
)))
2974 error ("Doing context_type_set");
2976 if (STRINGP (range
))
2978 if (context_range_set (parsed_con
, SSDATA (range
)))
2979 error ("Doing context_range_set");
2982 /* Set the modified context back to the file. */
2983 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2984 context_str (parsed_con
))
2986 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2987 if (fail
&& errno
!= ENOTSUP
)
2988 report_file_error ("Doing lsetfilecon", absname
);
2990 context_free (parsed_con
);
2992 return fail
? Qnil
: Qt
;
2995 report_file_error ("Doing lgetfilecon", absname
);
3002 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3003 doc
: /* Return ACL entries of file named FILENAME.
3004 The entries are returned in a format suitable for use in `set-file-acl'
3005 but is otherwise undocumented and subject to change.
3006 Return nil if file does not exist or is not accessible, or if Emacs
3007 was unable to determine the ACL entries. */)
3008 (Lisp_Object filename
)
3010 Lisp_Object absname
;
3011 Lisp_Object handler
;
3012 #ifdef HAVE_ACL_SET_FILE
3014 Lisp_Object acl_string
;
3016 # ifndef HAVE_ACL_TYPE_EXTENDED
3017 acl_type_t ACL_TYPE_EXTENDED
= ACL_TYPE_ACCESS
;
3021 absname
= expand_and_dir_to_file (filename
,
3022 BVAR (current_buffer
, directory
));
3024 /* If the file name has special constructs in it,
3025 call the corresponding file handler. */
3026 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3027 if (!NILP (handler
))
3028 return call2 (handler
, Qfile_acl
, absname
);
3030 #ifdef HAVE_ACL_SET_FILE
3031 absname
= ENCODE_FILE (absname
);
3033 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_EXTENDED
);
3037 str
= acl_to_text (acl
, NULL
);
3044 acl_string
= build_string (str
);
3054 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3056 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3057 ACL-STRING should contain the textual representation of the ACL
3058 entries in a format suitable for the platform.
3060 Value is t if setting of ACL was successful, nil otherwise.
3062 Setting ACL for local files requires Emacs to be built with ACL
3064 (Lisp_Object filename
, Lisp_Object acl_string
)
3066 Lisp_Object absname
;
3067 Lisp_Object handler
;
3068 #ifdef HAVE_ACL_SET_FILE
3069 Lisp_Object encoded_absname
;
3074 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3076 /* If the file name has special constructs in it,
3077 call the corresponding file handler. */
3078 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3079 if (!NILP (handler
))
3080 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3082 #ifdef HAVE_ACL_SET_FILE
3083 if (STRINGP (acl_string
))
3085 acl
= acl_from_text (SSDATA (acl_string
));
3088 report_file_error ("Converting ACL", absname
);
3092 encoded_absname
= ENCODE_FILE (absname
);
3094 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3097 if (fail
&& acl_errno_valid (errno
))
3098 report_file_error ("Setting ACL", absname
);
3101 return fail
? Qnil
: Qt
;
3108 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3109 doc
: /* Return mode bits of file named FILENAME, as an integer.
3110 Return nil, if file does not exist or is not accessible. */)
3111 (Lisp_Object filename
)
3113 Lisp_Object absname
;
3115 Lisp_Object handler
;
3117 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3119 /* If the file name has special constructs in it,
3120 call the corresponding file handler. */
3121 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3122 if (!NILP (handler
))
3123 return call2 (handler
, Qfile_modes
, absname
);
3125 absname
= ENCODE_FILE (absname
);
3127 if (stat (SSDATA (absname
), &st
) < 0)
3130 return make_number (st
.st_mode
& 07777);
3133 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3134 "(let ((file (read-file-name \"File: \"))) \
3135 (list file (read-file-modes nil file)))",
3136 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3137 Only the 12 low bits of MODE are used.
3139 Interactively, mode bits are read by `read-file-modes', which accepts
3140 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3141 (Lisp_Object filename
, Lisp_Object mode
)
3143 Lisp_Object absname
, encoded_absname
;
3144 Lisp_Object handler
;
3146 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3147 CHECK_NUMBER (mode
);
3149 /* If the file name has special constructs in it,
3150 call the corresponding file handler. */
3151 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3152 if (!NILP (handler
))
3153 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3155 encoded_absname
= ENCODE_FILE (absname
);
3157 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3158 report_file_error ("Doing chmod", absname
);
3163 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3164 doc
: /* Set the file permission bits for newly created files.
3165 The argument MODE should be an integer; only the low 9 bits are used.
3166 This setting is inherited by subprocesses. */)
3169 mode_t oldrealmask
, oldumask
, newumask
;
3170 CHECK_NUMBER (mode
);
3171 oldrealmask
= realmask
;
3172 newumask
= ~ XINT (mode
) & 0777;
3175 realmask
= newumask
;
3176 oldumask
= umask (newumask
);
3179 eassert (oldumask
== oldrealmask
);
3183 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3184 doc
: /* Return the default file protection for created files.
3185 The value is an integer. */)
3189 XSETINT (value
, (~ realmask
) & 0777);
3194 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3195 doc
: /* Set times of file FILENAME to TIMESTAMP.
3196 Set both access and modification times.
3197 Return t on success, else nil.
3198 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3200 (Lisp_Object filename
, Lisp_Object timestamp
)
3202 Lisp_Object absname
, encoded_absname
;
3203 Lisp_Object handler
;
3204 struct timespec t
= lisp_time_argument (timestamp
);
3206 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3208 /* If the file name has special constructs in it,
3209 call the corresponding file handler. */
3210 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3211 if (!NILP (handler
))
3212 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3214 encoded_absname
= ENCODE_FILE (absname
);
3217 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
) != 0)
3220 /* Setting times on a directory always fails. */
3221 if (file_directory_p (SSDATA (encoded_absname
)))
3224 report_file_error ("Setting file times", absname
);
3232 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3233 doc
: /* Tell Unix to finish all pending disk updates. */)
3240 #endif /* HAVE_SYNC */
3242 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3243 doc
: /* Return t if file FILE1 is newer than file FILE2.
3244 If FILE1 does not exist, the answer is nil;
3245 otherwise, if FILE2 does not exist, the answer is t. */)
3246 (Lisp_Object file1
, Lisp_Object file2
)
3248 Lisp_Object absname1
, absname2
;
3249 struct stat st1
, st2
;
3250 Lisp_Object handler
;
3251 struct gcpro gcpro1
, gcpro2
;
3253 CHECK_STRING (file1
);
3254 CHECK_STRING (file2
);
3257 GCPRO2 (absname1
, file2
);
3258 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3259 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3262 /* If the file name has special constructs in it,
3263 call the corresponding file handler. */
3264 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3266 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3267 if (!NILP (handler
))
3268 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3270 GCPRO2 (absname1
, absname2
);
3271 absname1
= ENCODE_FILE (absname1
);
3272 absname2
= ENCODE_FILE (absname2
);
3275 if (stat (SSDATA (absname1
), &st1
) < 0)
3278 if (stat (SSDATA (absname2
), &st2
) < 0)
3281 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3285 #ifndef READ_BUF_SIZE
3286 #define READ_BUF_SIZE (64 << 10)
3288 /* Some buffer offsets are stored in 'int' variables. */
3289 verify (READ_BUF_SIZE
<= INT_MAX
);
3291 /* This function is called after Lisp functions to decide a coding
3292 system are called, or when they cause an error. Before they are
3293 called, the current buffer is set unibyte and it contains only a
3294 newly inserted text (thus the buffer was empty before the
3297 The functions may set markers, overlays, text properties, or even
3298 alter the buffer contents, change the current buffer.
3300 Here, we reset all those changes by:
3301 o set back the current buffer.
3302 o move all markers and overlays to BEG.
3303 o remove all text properties.
3304 o set back the buffer multibyteness. */
3307 decide_coding_unwind (Lisp_Object unwind_data
)
3309 Lisp_Object multibyte
, undo_list
, buffer
;
3311 multibyte
= XCAR (unwind_data
);
3312 unwind_data
= XCDR (unwind_data
);
3313 undo_list
= XCAR (unwind_data
);
3314 buffer
= XCDR (unwind_data
);
3316 set_buffer_internal (XBUFFER (buffer
));
3317 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3318 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3319 set_buffer_intervals (current_buffer
, NULL
);
3320 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3322 /* Now we are safe to change the buffer's multibyteness directly. */
3323 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3324 bset_undo_list (current_buffer
, undo_list
);
3327 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3328 object where slot 0 is the file descriptor, slot 1 specifies
3329 an offset to put the read bytes, and slot 2 is the maximum
3330 amount of bytes to read. Value is the number of bytes read. */
3333 read_non_regular (Lisp_Object state
)
3339 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3340 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3341 + XSAVE_INTEGER (state
, 1)),
3342 XSAVE_INTEGER (state
, 2));
3344 /* Fast recycle this object for the likely next call. */
3346 return make_number (nbytes
);
3350 /* Condition-case handler used when reading from non-regular files
3351 in insert-file-contents. */
3354 read_non_regular_quit (Lisp_Object ignore
)
3359 /* Return the file offset that VAL represents, checking for type
3360 errors and overflow. */
3362 file_offset (Lisp_Object val
)
3364 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3369 double v
= XFLOAT_DATA (val
);
3371 && (sizeof (off_t
) < sizeof v
3372 ? v
<= TYPE_MAXIMUM (off_t
)
3373 : v
< TYPE_MAXIMUM (off_t
)))
3377 wrong_type_argument (intern ("file-offset"), val
);
3380 /* Return a special time value indicating the error number ERRNUM. */
3381 static struct timespec
3382 time_error_value (int errnum
)
3384 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3385 ? NONEXISTENT_MODTIME_NSECS
3386 : UNKNOWN_MODTIME_NSECS
);
3387 return make_timespec (0, ns
);
3390 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3392 doc
: /* Insert contents of file FILENAME after point.
3393 Returns list of absolute file name and number of characters inserted.
3394 If second argument VISIT is non-nil, the buffer's visited filename and
3395 last save file modtime are set, and it is marked unmodified. If
3396 visiting and the file does not exist, visiting is completed before the
3399 The optional third and fourth arguments BEG and END specify what portion
3400 of the file to insert. These arguments count bytes in the file, not
3401 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3403 If optional fifth argument REPLACE is non-nil, replace the current
3404 buffer contents (in the accessible portion) with the file contents.
3405 This is better than simply deleting and inserting the whole thing
3406 because (1) it preserves some marker positions and (2) it puts less data
3407 in the undo list. When REPLACE is non-nil, the second return value is
3408 the number of characters that replace previous buffer contents.
3410 This function does code conversion according to the value of
3411 `coding-system-for-read' or `file-coding-system-alist', and sets the
3412 variable `last-coding-system-used' to the coding system actually used.
3414 In addition, this function decodes the inserted text from known formats
3415 by calling `format-decode', which see. */)
3416 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3419 struct timespec mtime
;
3421 ptrdiff_t inserted
= 0;
3423 off_t beg_offset
, end_offset
;
3425 ptrdiff_t count
= SPECPDL_INDEX ();
3426 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3427 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3429 ptrdiff_t total
= 0;
3430 bool not_regular
= 0;
3432 char read_buf
[READ_BUF_SIZE
];
3433 struct coding_system coding
;
3434 bool replace_handled
= 0;
3435 bool set_coding_system
= 0;
3436 Lisp_Object coding_system
;
3438 /* If the undo log only contains the insertion, there's no point
3439 keeping it. It's typically when we first fill a file-buffer. */
3440 bool empty_undo_list_p
3441 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3443 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3444 bool we_locked_file
= 0;
3447 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3448 error ("Cannot do file visiting in an indirect buffer");
3450 if (!NILP (BVAR (current_buffer
, read_only
)))
3451 Fbarf_if_buffer_read_only ();
3455 orig_filename
= Qnil
;
3458 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3460 CHECK_STRING (filename
);
3461 filename
= Fexpand_file_name (filename
, Qnil
);
3463 /* The value Qnil means that the coding system is not yet
3465 coding_system
= Qnil
;
3467 /* If the file name has special constructs in it,
3468 call the corresponding file handler. */
3469 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3470 if (!NILP (handler
))
3472 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3473 visit
, beg
, end
, replace
);
3474 if (CONSP (val
) && CONSP (XCDR (val
))
3475 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3476 inserted
= XINT (XCAR (XCDR (val
)));
3480 orig_filename
= filename
;
3481 filename
= ENCODE_FILE (filename
);
3483 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3488 report_file_error ("Opening input file", orig_filename
);
3489 mtime
= time_error_value (save_errno
);
3491 if (!NILP (Vcoding_system_for_read
))
3492 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3496 fd_index
= SPECPDL_INDEX ();
3497 record_unwind_protect_int (close_file_unwind
, fd
);
3499 /* Replacement should preserve point as it preserves markers. */
3500 if (!NILP (replace
))
3501 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3503 if (fstat (fd
, &st
) != 0)
3504 report_file_error ("Input file status", orig_filename
);
3505 mtime
= get_stat_mtime (&st
);
3507 /* This code will need to be changed in order to work on named
3508 pipes, and it's probably just not worth it. So we should at
3509 least signal an error. */
3510 if (!S_ISREG (st
.st_mode
))
3517 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3518 xsignal2 (Qfile_error
,
3519 build_string ("not a regular file"), orig_filename
);
3524 if (!NILP (beg
) || !NILP (end
))
3525 error ("Attempt to visit less than an entire file");
3526 if (BEG
< Z
&& NILP (replace
))
3527 error ("Cannot do file visiting in a non-empty buffer");
3531 beg_offset
= file_offset (beg
);
3536 end_offset
= file_offset (end
);
3540 end_offset
= TYPE_MAXIMUM (off_t
);
3543 end_offset
= st
.st_size
;
3545 /* A negative size can happen on a platform that allows file
3546 sizes greater than the maximum off_t value. */
3550 /* The file size returned from stat may be zero, but data
3551 may be readable nonetheless, for example when this is a
3552 file in the /proc filesystem. */
3553 if (end_offset
== 0)
3554 end_offset
= READ_BUF_SIZE
;
3558 /* Check now whether the buffer will become too large,
3559 in the likely case where the file's length is not changing.
3560 This saves a lot of needless work before a buffer overflow. */
3563 /* The likely offset where we will stop reading. We could read
3564 more (or less), if the file grows (or shrinks) as we read it. */
3565 off_t likely_end
= min (end_offset
, st
.st_size
);
3567 if (beg_offset
< likely_end
)
3570 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3571 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3572 off_t likely_growth
= likely_end
- beg_offset
;
3573 if (buf_growth_max
< likely_growth
)
3578 /* Prevent redisplay optimizations. */
3579 current_buffer
->clip_changed
= 1;
3581 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3583 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3584 setup_coding_system (coding_system
, &coding
);
3585 /* Ensure we set Vlast_coding_system_used. */
3586 set_coding_system
= 1;
3590 /* Decide the coding system to use for reading the file now
3591 because we can't use an optimized method for handling
3592 `coding:' tag if the current buffer is not empty. */
3593 if (!NILP (Vcoding_system_for_read
))
3594 coding_system
= Vcoding_system_for_read
;
3597 /* Don't try looking inside a file for a coding system
3598 specification if it is not seekable. */
3599 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3601 /* Find a coding system specified in the heading two
3602 lines or in the tailing several lines of the file.
3603 We assume that the 1K-byte and 3K-byte for heading
3604 and tailing respectively are sufficient for this
3608 if (st
.st_size
<= (1024 * 4))
3609 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3612 nread
= emacs_read (fd
, read_buf
, 1024);
3616 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3617 report_file_error ("Setting file position",
3619 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3620 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3625 report_file_error ("Read error", orig_filename
);
3628 struct buffer
*prev
= current_buffer
;
3629 Lisp_Object workbuf
;
3632 record_unwind_current_buffer ();
3634 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3635 buf
= XBUFFER (workbuf
);
3637 delete_all_overlays (buf
);
3638 bset_directory (buf
, BVAR (current_buffer
, directory
));
3639 bset_read_only (buf
, Qnil
);
3640 bset_filename (buf
, Qnil
);
3641 bset_undo_list (buf
, Qt
);
3642 eassert (buf
->overlays_before
== NULL
);
3643 eassert (buf
->overlays_after
== NULL
);
3645 set_buffer_internal (buf
);
3647 bset_enable_multibyte_characters (buf
, Qnil
);
3649 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3650 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3651 coding_system
= call2 (Vset_auto_coding_function
,
3652 filename
, make_number (nread
));
3653 set_buffer_internal (prev
);
3655 /* Discard the unwind protect for recovering the
3659 /* Rewind the file for the actual read done later. */
3660 if (lseek (fd
, 0, SEEK_SET
) < 0)
3661 report_file_error ("Setting file position", orig_filename
);
3665 if (NILP (coding_system
))
3667 /* If we have not yet decided a coding system, check
3668 file-coding-system-alist. */
3669 Lisp_Object args
[6];
3671 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3672 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3673 coding_system
= Ffind_operation_coding_system (6, args
);
3674 if (CONSP (coding_system
))
3675 coding_system
= XCAR (coding_system
);
3679 if (NILP (coding_system
))
3680 coding_system
= Qundecided
;
3682 CHECK_CODING_SYSTEM (coding_system
);
3684 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3685 /* We must suppress all character code conversion except for
3686 end-of-line conversion. */
3687 coding_system
= raw_text_coding_system (coding_system
);
3689 setup_coding_system (coding_system
, &coding
);
3690 /* Ensure we set Vlast_coding_system_used. */
3691 set_coding_system
= 1;
3694 /* If requested, replace the accessible part of the buffer
3695 with the file contents. Avoid replacing text at the
3696 beginning or end of the buffer that matches the file contents;
3697 that preserves markers pointing to the unchanged parts.
3699 Here we implement this feature in an optimized way
3700 for the case where code conversion is NOT needed.
3701 The following if-statement handles the case of conversion
3702 in a less optimal way.
3704 If the code conversion is "automatic" then we try using this
3705 method and hope for the best.
3706 But if we discover the need for conversion, we give up on this method
3707 and let the following if-statement handle the replace job. */
3710 && (NILP (coding_system
)
3711 || ! CODING_REQUIRE_DECODING (&coding
)))
3713 /* same_at_start and same_at_end count bytes,
3714 because file access counts bytes
3715 and BEG and END count bytes. */
3716 ptrdiff_t same_at_start
= BEGV_BYTE
;
3717 ptrdiff_t same_at_end
= ZV_BYTE
;
3719 /* There is still a possibility we will find the need to do code
3720 conversion. If that happens, set this variable to
3721 give up on handling REPLACE in the optimized way. */
3722 bool giveup_match_end
= 0;
3724 if (beg_offset
!= 0)
3726 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3727 report_file_error ("Setting file position", orig_filename
);
3732 /* Count how many chars at the start of the file
3733 match the text at the beginning of the buffer. */
3738 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3740 report_file_error ("Read error", orig_filename
);
3741 else if (nread
== 0)
3744 if (CODING_REQUIRE_DETECTION (&coding
))
3746 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3749 setup_coding_system (coding_system
, &coding
);
3752 if (CODING_REQUIRE_DECODING (&coding
))
3753 /* We found that the file should be decoded somehow.
3754 Let's give up here. */
3756 giveup_match_end
= 1;
3761 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3762 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3763 same_at_start
++, bufpos
++;
3764 /* If we found a discrepancy, stop the scan.
3765 Otherwise loop around and scan the next bufferful. */
3766 if (bufpos
!= nread
)
3770 /* If the file matches the buffer completely,
3771 there's no need to replace anything. */
3772 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3775 clear_unwind_protect (fd_index
);
3777 /* Truncate the buffer to the size of the file. */
3778 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3783 /* Count how many chars at the end of the file
3784 match the text at the end of the buffer. But, if we have
3785 already found that decoding is necessary, don't waste time. */
3786 while (!giveup_match_end
)
3788 int total_read
, nread
, bufpos
, trial
;
3791 /* At what file position are we now scanning? */
3792 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3793 /* If the entire file matches the buffer tail, stop the scan. */
3796 /* How much can we scan in the next step? */
3797 trial
= min (curpos
, sizeof read_buf
);
3798 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3799 report_file_error ("Setting file position", orig_filename
);
3801 total_read
= nread
= 0;
3802 while (total_read
< trial
)
3804 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3806 report_file_error ("Read error", orig_filename
);
3807 else if (nread
== 0)
3809 total_read
+= nread
;
3812 /* Scan this bufferful from the end, comparing with
3813 the Emacs buffer. */
3814 bufpos
= total_read
;
3816 /* Compare with same_at_start to avoid counting some buffer text
3817 as matching both at the file's beginning and at the end. */
3818 while (bufpos
> 0 && same_at_end
> same_at_start
3819 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3820 same_at_end
--, bufpos
--;
3822 /* If we found a discrepancy, stop the scan.
3823 Otherwise loop around and scan the preceding bufferful. */
3826 /* If this discrepancy is because of code conversion,
3827 we cannot use this method; giveup and try the other. */
3828 if (same_at_end
> same_at_start
3829 && FETCH_BYTE (same_at_end
- 1) >= 0200
3830 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3831 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3832 giveup_match_end
= 1;
3841 if (! giveup_match_end
)
3845 /* We win! We can handle REPLACE the optimized way. */
3847 /* Extend the start of non-matching text area to multibyte
3848 character boundary. */
3849 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3850 while (same_at_start
> BEGV_BYTE
3851 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3854 /* Extend the end of non-matching text area to multibyte
3855 character boundary. */
3856 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3857 while (same_at_end
< ZV_BYTE
3858 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3861 /* Don't try to reuse the same piece of text twice. */
3862 overlap
= (same_at_start
- BEGV_BYTE
3864 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3866 same_at_end
+= overlap
;
3868 /* Arrange to read only the nonmatching middle part of the file. */
3869 beg_offset
+= same_at_start
- BEGV_BYTE
;
3870 end_offset
-= ZV_BYTE
- same_at_end
;
3872 invalidate_buffer_caches (current_buffer
,
3873 BYTE_TO_CHAR (same_at_start
),
3874 BYTE_TO_CHAR (same_at_end
));
3875 del_range_byte (same_at_start
, same_at_end
, 0);
3876 /* Insert from the file at the proper position. */
3877 temp
= BYTE_TO_CHAR (same_at_start
);
3878 SET_PT_BOTH (temp
, same_at_start
);
3880 /* If display currently starts at beginning of line,
3881 keep it that way. */
3882 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3883 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3885 replace_handled
= 1;
3889 /* If requested, replace the accessible part of the buffer
3890 with the file contents. Avoid replacing text at the
3891 beginning or end of the buffer that matches the file contents;
3892 that preserves markers pointing to the unchanged parts.
3894 Here we implement this feature for the case where code conversion
3895 is needed, in a simple way that needs a lot of memory.
3896 The preceding if-statement handles the case of no conversion
3897 in a more optimized way. */
3898 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3900 ptrdiff_t same_at_start
= BEGV_BYTE
;
3901 ptrdiff_t same_at_end
= ZV_BYTE
;
3902 ptrdiff_t same_at_start_charpos
;
3903 ptrdiff_t inserted_chars
;
3906 unsigned char *decoded
;
3909 ptrdiff_t this_count
= SPECPDL_INDEX ();
3911 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3912 Lisp_Object conversion_buffer
;
3913 struct gcpro gcpro1
;
3915 conversion_buffer
= code_conversion_save (1, multibyte
);
3917 /* First read the whole file, performing code conversion into
3918 CONVERSION_BUFFER. */
3920 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3921 report_file_error ("Setting file position", orig_filename
);
3923 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3924 unprocessed
= 0; /* Bytes not processed in previous loop. */
3926 GCPRO1 (conversion_buffer
);
3929 /* Read at most READ_BUF_SIZE bytes at a time, to allow
3930 quitting while reading a huge file. */
3932 /* Allow quitting out of the actual I/O. */
3935 this = emacs_read (fd
, read_buf
+ unprocessed
,
3936 READ_BUF_SIZE
- unprocessed
);
3942 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3943 BUF_Z (XBUFFER (conversion_buffer
)));
3944 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3945 unprocessed
+ this, conversion_buffer
);
3946 unprocessed
= coding
.carryover_bytes
;
3947 if (coding
.carryover_bytes
> 0)
3948 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3952 report_file_error ("Read error", orig_filename
);
3954 clear_unwind_protect (fd_index
);
3956 if (unprocessed
> 0)
3958 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3959 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3960 unprocessed
, conversion_buffer
);
3961 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3964 coding_system
= CODING_ID_NAME (coding
.id
);
3965 set_coding_system
= 1;
3966 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3967 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3968 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3970 /* Compare the beginning of the converted string with the buffer
3974 while (bufpos
< inserted
&& same_at_start
< same_at_end
3975 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3976 same_at_start
++, bufpos
++;
3978 /* If the file matches the head of buffer completely,
3979 there's no need to replace anything. */
3981 if (bufpos
== inserted
)
3983 /* Truncate the buffer to the size of the file. */
3984 if (same_at_start
!= same_at_end
)
3986 invalidate_buffer_caches (current_buffer
,
3987 BYTE_TO_CHAR (same_at_start
),
3988 BYTE_TO_CHAR (same_at_end
));
3989 del_range_byte (same_at_start
, same_at_end
, 0);
3993 unbind_to (this_count
, Qnil
);
3997 /* Extend the start of non-matching text area to the previous
3998 multibyte character boundary. */
3999 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4000 while (same_at_start
> BEGV_BYTE
4001 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4004 /* Scan this bufferful from the end, comparing with
4005 the Emacs buffer. */
4008 /* Compare with same_at_start to avoid counting some buffer text
4009 as matching both at the file's beginning and at the end. */
4010 while (bufpos
> 0 && same_at_end
> same_at_start
4011 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4012 same_at_end
--, bufpos
--;
4014 /* Extend the end of non-matching text area to the next
4015 multibyte character boundary. */
4016 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4017 while (same_at_end
< ZV_BYTE
4018 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4021 /* Don't try to reuse the same piece of text twice. */
4022 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4024 same_at_end
+= overlap
;
4026 /* If display currently starts at beginning of line,
4027 keep it that way. */
4028 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4029 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4031 /* Replace the chars that we need to replace,
4032 and update INSERTED to equal the number of bytes
4033 we are taking from the decoded string. */
4034 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4036 if (same_at_end
!= same_at_start
)
4038 invalidate_buffer_caches (current_buffer
,
4039 BYTE_TO_CHAR (same_at_start
),
4040 BYTE_TO_CHAR (same_at_end
));
4041 del_range_byte (same_at_start
, same_at_end
, 0);
4043 eassert (same_at_start
== GPT_BYTE
);
4044 same_at_start
= GPT_BYTE
;
4048 temp
= BYTE_TO_CHAR (same_at_start
);
4050 /* Insert from the file at the proper position. */
4051 SET_PT_BOTH (temp
, same_at_start
);
4052 same_at_start_charpos
4053 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4054 same_at_start
- BEGV_BYTE
4055 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4056 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4058 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4059 same_at_start
+ inserted
- BEGV_BYTE
4060 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4061 - same_at_start_charpos
);
4062 /* This binding is to avoid ask-user-about-supersession-threat
4063 being called in insert_from_buffer (via in
4064 prepare_to_modify_buffer). */
4065 specbind (intern ("buffer-file-name"), Qnil
);
4066 insert_from_buffer (XBUFFER (conversion_buffer
),
4067 same_at_start_charpos
, inserted_chars
, 0);
4068 /* Set `inserted' to the number of inserted characters. */
4069 inserted
= PT
- temp
;
4070 /* Set point before the inserted characters. */
4071 SET_PT_BOTH (temp
, same_at_start
);
4073 unbind_to (this_count
, Qnil
);
4079 total
= end_offset
- beg_offset
;
4081 /* For a special file, all we can do is guess. */
4082 total
= READ_BUF_SIZE
;
4084 if (NILP (visit
) && total
> 0)
4086 #ifdef CLASH_DETECTION
4087 if (!NILP (BVAR (current_buffer
, file_truename
))
4088 /* Make binding buffer-file-name to nil effective. */
4089 && !NILP (BVAR (current_buffer
, filename
))
4090 && SAVE_MODIFF
>= MODIFF
)
4092 #endif /* CLASH_DETECTION */
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. */
4192 #ifdef CLASH_DETECTION
4194 unlock_file (BVAR (current_buffer
, file_truename
));
4196 Vdeactivate_mark
= old_Vdeactivate_mark
;
4199 Vdeactivate_mark
= Qt
;
4202 clear_unwind_protect (fd_index
);
4205 report_file_error ("Read error", orig_filename
);
4207 /* Make the text read part of the buffer. */
4208 GAP_SIZE
-= inserted
;
4210 GPT_BYTE
+= inserted
;
4212 ZV_BYTE
+= inserted
;
4217 /* Put an anchor to ensure multi-byte form ends at gap. */
4222 if (NILP (coding_system
))
4224 /* The coding system is not yet decided. Decide it by an
4225 optimized method for handling `coding:' tag.
4227 Note that we can get here only if the buffer was empty
4228 before the insertion. */
4230 if (!NILP (Vcoding_system_for_read
))
4231 coding_system
= Vcoding_system_for_read
;
4234 /* Since we are sure that the current buffer was empty
4235 before the insertion, we can toggle
4236 enable-multibyte-characters directly here without taking
4237 care of marker adjustment. By this way, we can run Lisp
4238 program safely before decoding the inserted text. */
4239 Lisp_Object unwind_data
;
4240 ptrdiff_t count1
= SPECPDL_INDEX ();
4242 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4243 Fcons (BVAR (current_buffer
, undo_list
),
4244 Fcurrent_buffer ()));
4245 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4246 bset_undo_list (current_buffer
, Qt
);
4247 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4249 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4251 coding_system
= call2 (Vset_auto_coding_function
,
4252 filename
, make_number (inserted
));
4255 if (NILP (coding_system
))
4257 /* If the coding system is not yet decided, check
4258 file-coding-system-alist. */
4259 Lisp_Object args
[6];
4261 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4262 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4263 coding_system
= Ffind_operation_coding_system (6, args
);
4264 if (CONSP (coding_system
))
4265 coding_system
= XCAR (coding_system
);
4267 unbind_to (count1
, Qnil
);
4268 inserted
= Z_BYTE
- BEG_BYTE
;
4271 if (NILP (coding_system
))
4272 coding_system
= Qundecided
;
4274 CHECK_CODING_SYSTEM (coding_system
);
4276 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4277 /* We must suppress all character code conversion except for
4278 end-of-line conversion. */
4279 coding_system
= raw_text_coding_system (coding_system
);
4280 setup_coding_system (coding_system
, &coding
);
4281 /* Ensure we set Vlast_coding_system_used. */
4282 set_coding_system
= 1;
4287 /* When we visit a file by raw-text, we change the buffer to
4289 if (CODING_FOR_UNIBYTE (&coding
)
4290 /* Can't do this if part of the buffer might be preserved. */
4292 /* Visiting a file with these coding system makes the buffer
4294 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4297 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4298 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4299 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4301 move_gap_both (PT
, PT_BYTE
);
4302 GAP_SIZE
+= inserted
;
4303 ZV_BYTE
-= inserted
;
4307 decode_coding_gap (&coding
, inserted
, inserted
);
4308 inserted
= coding
.produced_char
;
4309 coding_system
= CODING_ID_NAME (coding
.id
);
4311 else if (inserted
> 0)
4312 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4315 /* Call after-change hooks for the inserted text, aside from the case
4316 of normal visiting (not with REPLACE), which is done in a new buffer
4317 "before" the buffer is changed. */
4318 if (inserted
> 0 && total
> 0
4319 && (NILP (visit
) || !NILP (replace
)))
4321 signal_after_change (PT
, 0, inserted
);
4322 update_compositions (PT
, PT
, CHECK_BORDER
);
4325 /* Now INSERTED is measured in characters. */
4331 if (empty_undo_list_p
)
4332 bset_undo_list (current_buffer
, Qnil
);
4336 current_buffer
->modtime
= mtime
;
4337 current_buffer
->modtime_size
= st
.st_size
;
4338 bset_filename (current_buffer
, orig_filename
);
4341 SAVE_MODIFF
= MODIFF
;
4342 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4343 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4344 #ifdef CLASH_DETECTION
4347 if (!NILP (BVAR (current_buffer
, file_truename
)))
4348 unlock_file (BVAR (current_buffer
, file_truename
));
4349 unlock_file (filename
);
4351 #endif /* CLASH_DETECTION */
4353 xsignal2 (Qfile_error
,
4354 build_string ("not a regular file"), orig_filename
);
4357 if (set_coding_system
)
4358 Vlast_coding_system_used
= coding_system
;
4360 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4362 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4364 if (! NILP (insval
))
4366 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4367 wrong_type_argument (intern ("inserted-chars"), insval
);
4368 inserted
= XFASTINT (insval
);
4372 /* Decode file format. */
4375 /* Don't run point motion or modification hooks when decoding. */
4376 ptrdiff_t count1
= SPECPDL_INDEX ();
4377 ptrdiff_t old_inserted
= inserted
;
4378 specbind (Qinhibit_point_motion_hooks
, Qt
);
4379 specbind (Qinhibit_modification_hooks
, Qt
);
4381 /* Save old undo list and don't record undo for decoding. */
4382 old_undo
= BVAR (current_buffer
, undo_list
);
4383 bset_undo_list (current_buffer
, Qt
);
4387 insval
= call3 (Qformat_decode
,
4388 Qnil
, make_number (inserted
), visit
);
4389 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4390 wrong_type_argument (intern ("inserted-chars"), insval
);
4391 inserted
= XFASTINT (insval
);
4395 /* If REPLACE is non-nil and we succeeded in not replacing the
4396 beginning or end of the buffer text with the file's contents,
4397 call format-decode with `point' positioned at the beginning
4398 of the buffer and `inserted' equaling the number of
4399 characters in the buffer. Otherwise, format-decode might
4400 fail to correctly analyze the beginning or end of the buffer.
4401 Hence we temporarily save `point' and `inserted' here and
4402 restore `point' iff format-decode did not insert or delete
4403 any text. Otherwise we leave `point' at point-min. */
4404 ptrdiff_t opoint
= PT
;
4405 ptrdiff_t opoint_byte
= PT_BYTE
;
4406 ptrdiff_t oinserted
= ZV
- BEGV
;
4407 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4409 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4410 insval
= call3 (Qformat_decode
,
4411 Qnil
, make_number (oinserted
), visit
);
4412 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4413 wrong_type_argument (intern ("inserted-chars"), insval
);
4414 if (ochars_modiff
== CHARS_MODIFF
)
4415 /* format_decode didn't modify buffer's characters => move
4416 point back to position before inserted text and leave
4417 value of inserted alone. */
4418 SET_PT_BOTH (opoint
, opoint_byte
);
4420 /* format_decode modified buffer's characters => consider
4421 entire buffer changed and leave point at point-min. */
4422 inserted
= XFASTINT (insval
);
4425 /* For consistency with format-decode call these now iff inserted > 0
4426 (martin 2007-06-28). */
4427 p
= Vafter_insert_file_functions
;
4432 insval
= call1 (XCAR (p
), make_number (inserted
));
4435 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4436 wrong_type_argument (intern ("inserted-chars"), insval
);
4437 inserted
= XFASTINT (insval
);
4442 /* For the rationale of this see the comment on
4443 format-decode above. */
4444 ptrdiff_t opoint
= PT
;
4445 ptrdiff_t opoint_byte
= PT_BYTE
;
4446 ptrdiff_t oinserted
= ZV
- BEGV
;
4447 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4449 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4450 insval
= call1 (XCAR (p
), make_number (oinserted
));
4453 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4454 wrong_type_argument (intern ("inserted-chars"), insval
);
4455 if (ochars_modiff
== CHARS_MODIFF
)
4456 /* after_insert_file_functions didn't modify
4457 buffer's characters => move point back to
4458 position before inserted text and leave value of
4460 SET_PT_BOTH (opoint
, opoint_byte
);
4462 /* after_insert_file_functions did modify buffer's
4463 characters => consider entire buffer changed and
4464 leave point at point-min. */
4465 inserted
= XFASTINT (insval
);
4473 if (!empty_undo_list_p
)
4475 bset_undo_list (current_buffer
, old_undo
);
4476 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4478 /* Adjust the last undo record for the size change during
4479 the format conversion. */
4480 Lisp_Object tem
= XCAR (old_undo
);
4481 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4482 && INTEGERP (XCDR (tem
))
4483 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4484 XSETCDR (tem
, make_number (PT
+ inserted
));
4488 /* If undo_list was Qt before, keep it that way.
4489 Otherwise start with an empty undo_list. */
4490 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4492 unbind_to (count1
, Qnil
);
4496 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4498 /* If visiting nonexistent file, return nil. */
4499 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4502 /* We made a lot of deletions and insertions above, so invalidate
4503 the newline cache for the entire region of the inserted
4505 if (current_buffer
->base_buffer
&& current_buffer
->base_buffer
->newline_cache
)
4506 invalidate_region_cache (current_buffer
->base_buffer
,
4507 current_buffer
->base_buffer
->newline_cache
,
4508 PT
- BEG
, Z
- PT
- inserted
);
4509 else if (current_buffer
->newline_cache
)
4510 invalidate_region_cache (current_buffer
,
4511 current_buffer
->newline_cache
,
4512 PT
- BEG
, Z
- PT
- inserted
);
4515 Fsignal (Qquit
, Qnil
);
4517 /* Retval needs to be dealt with in all cases consistently. */
4519 val
= list2 (orig_filename
, make_number (inserted
));
4521 RETURN_UNGCPRO (unbind_to (count
, val
));
4524 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4527 build_annotations_unwind (Lisp_Object arg
)
4529 Vwrite_region_annotation_buffers
= arg
;
4532 /* Decide the coding-system to encode the data with. */
4534 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4535 Schoose_write_coding_system
, 3, 6, 0,
4536 doc
: /* Choose the coding system for writing a file.
4537 Arguments are as for `write-region'.
4538 This function is for internal use only. It may prompt the user. */ )
4539 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4540 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4543 Lisp_Object eol_parent
= Qnil
;
4545 /* Mimic write-region behavior. */
4548 XSETFASTINT (start
, BEGV
);
4549 XSETFASTINT (end
, ZV
);
4553 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4554 BVAR (current_buffer
, auto_save_file_name
))))
4559 else if (!NILP (Vcoding_system_for_write
))
4561 val
= Vcoding_system_for_write
;
4562 if (coding_system_require_warning
4563 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4564 /* Confirm that VAL can surely encode the current region. */
4565 val
= call5 (Vselect_safe_coding_system_function
,
4566 start
, end
, list2 (Qt
, val
),
4571 /* If the variable `buffer-file-coding-system' is set locally,
4572 it means that the file was read with some kind of code
4573 conversion or the variable is explicitly set by users. We
4574 had better write it out with the same coding system even if
4575 `enable-multibyte-characters' is nil.
4577 If it is not set locally, we anyway have to convert EOL
4578 format if the default value of `buffer-file-coding-system'
4579 tells that it is not Unix-like (LF only) format. */
4580 bool using_default_coding
= 0;
4581 bool force_raw_text
= 0;
4583 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4585 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4588 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4594 /* Check file-coding-system-alist. */
4595 Lisp_Object args
[7], coding_systems
;
4597 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4598 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4600 coding_systems
= Ffind_operation_coding_system (7, args
);
4601 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4602 val
= XCDR (coding_systems
);
4607 /* If we still have not decided a coding system, use the
4608 default value of buffer-file-coding-system. */
4609 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4610 using_default_coding
= 1;
4613 if (! NILP (val
) && ! force_raw_text
)
4615 Lisp_Object spec
, attrs
;
4617 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4618 attrs
= AREF (spec
, 0);
4619 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4624 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4625 /* Confirm that VAL can surely encode the current region. */
4626 val
= call5 (Vselect_safe_coding_system_function
,
4627 start
, end
, val
, Qnil
, filename
);
4629 /* If the decided coding-system doesn't specify end-of-line
4630 format, we use that of
4631 `default-buffer-file-coding-system'. */
4632 if (! using_default_coding
4633 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4634 val
= (coding_inherit_eol_type
4635 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4637 /* If we decide not to encode text, use `raw-text' or one of its
4640 val
= raw_text_coding_system (val
);
4643 val
= coding_inherit_eol_type (val
, eol_parent
);
4647 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4648 "r\nFWrite region to file: \ni\ni\ni\np",
4649 doc
: /* Write current region into specified file.
4650 When called from a program, requires three arguments:
4651 START, END and FILENAME. START and END are normally buffer positions
4652 specifying the part of the buffer to write.
4653 If START is nil, that means to use the entire buffer contents.
4654 If START is a string, then output that string to the file
4655 instead of any buffer contents; END is ignored.
4657 Optional fourth argument APPEND if non-nil means
4658 append to existing file contents (if any). If it is a number,
4659 seek to that offset in the file before writing.
4660 Optional fifth argument VISIT, if t or a string, means
4661 set the last-save-file-modtime of buffer to this file's modtime
4662 and mark buffer not modified.
4663 If VISIT is a string, it is a second file name;
4664 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4665 VISIT is also the file name to lock and unlock for clash detection.
4666 If VISIT is neither t nor nil nor a string,
4667 that means do not display the \"Wrote file\" message.
4668 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4669 use for locking and unlocking, overriding FILENAME and VISIT.
4670 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4671 for an existing file with the same name. If MUSTBENEW is `excl',
4672 that means to get an error if the file already exists; never overwrite.
4673 If MUSTBENEW is neither nil nor `excl', that means ask for
4674 confirmation before overwriting, but do go ahead and overwrite the file
4675 if the user confirms.
4677 This does code conversion according to the value of
4678 `coding-system-for-write', `buffer-file-coding-system', or
4679 `file-coding-system-alist', and sets the variable
4680 `last-coding-system-used' to the coding system actually used.
4682 This calls `write-region-annotate-functions' at the start, and
4683 `write-region-post-annotation-function' at the end. */)
4684 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4685 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4687 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4691 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4692 descriptor for FILENAME, so do not open or close FILENAME. */
4695 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4696 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4697 Lisp_Object mustbenew
, int desc
)
4701 off_t offset
IF_LINT (= 0);
4702 bool open_and_close_file
= desc
< 0;
4707 struct timespec modtime
;
4708 ptrdiff_t count
= SPECPDL_INDEX ();
4709 ptrdiff_t count1
IF_LINT (= 0);
4710 Lisp_Object handler
;
4711 Lisp_Object visit_file
;
4712 Lisp_Object annotations
;
4713 Lisp_Object encoded_filename
;
4714 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4715 bool quietly
= !NILP (visit
);
4716 bool file_locked
= 0;
4717 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4718 struct buffer
*given_buffer
;
4719 struct coding_system coding
;
4721 if (current_buffer
->base_buffer
&& visiting
)
4722 error ("Cannot do file visiting in an indirect buffer");
4724 if (!NILP (start
) && !STRINGP (start
))
4725 validate_region (&start
, &end
);
4728 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4730 filename
= Fexpand_file_name (filename
, Qnil
);
4732 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4733 barf_or_query_if_file_exists (filename
, false, "overwrite", true, true);
4735 if (STRINGP (visit
))
4736 visit_file
= Fexpand_file_name (visit
, Qnil
);
4738 visit_file
= filename
;
4740 if (NILP (lockname
))
4741 lockname
= visit_file
;
4745 /* If the file name has special constructs in it,
4746 call the corresponding file handler. */
4747 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4748 /* If FILENAME has no handler, see if VISIT has one. */
4749 if (NILP (handler
) && STRINGP (visit
))
4750 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4752 if (!NILP (handler
))
4755 val
= call6 (handler
, Qwrite_region
, start
, end
,
4756 filename
, append
, visit
);
4760 SAVE_MODIFF
= MODIFF
;
4761 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4762 bset_filename (current_buffer
, visit_file
);
4768 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4770 /* Special kludge to simplify auto-saving. */
4773 /* Do it later, so write-region-annotate-function can work differently
4774 if we save "the buffer" vs "a region".
4775 This is useful in tar-mode. --Stef
4776 XSETFASTINT (start, BEG);
4777 XSETFASTINT (end, Z); */
4781 record_unwind_protect (build_annotations_unwind
,
4782 Vwrite_region_annotation_buffers
);
4783 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4785 given_buffer
= current_buffer
;
4787 if (!STRINGP (start
))
4789 annotations
= build_annotations (start
, end
);
4791 if (current_buffer
!= given_buffer
)
4793 XSETFASTINT (start
, BEGV
);
4794 XSETFASTINT (end
, ZV
);
4800 XSETFASTINT (start
, BEGV
);
4801 XSETFASTINT (end
, ZV
);
4806 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4808 /* Decide the coding-system to encode the data with.
4809 We used to make this choice before calling build_annotations, but that
4810 leads to problems when a write-annotate-function takes care of
4811 unsavable chars (as was the case with X-Symbol). */
4812 Vlast_coding_system_used
=
4813 Fchoose_write_coding_system (start
, end
, filename
,
4814 append
, visit
, lockname
);
4816 setup_coding_system (Vlast_coding_system_used
, &coding
);
4818 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4819 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4821 #ifdef CLASH_DETECTION
4822 if (open_and_close_file
&& !auto_saving
)
4824 lock_file (lockname
);
4827 #endif /* CLASH_DETECTION */
4829 encoded_filename
= ENCODE_FILE (filename
);
4830 fn
= SSDATA (encoded_filename
);
4831 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4832 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4833 if (NUMBERP (append
))
4834 offset
= file_offset (append
);
4835 else if (!NILP (append
))
4836 open_flags
|= O_APPEND
;
4838 mode
= S_IREAD
| S_IWRITE
;
4840 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4843 if (open_and_close_file
)
4845 desc
= emacs_open (fn
, open_flags
, mode
);
4848 int open_errno
= errno
;
4849 #ifdef CLASH_DETECTION
4851 unlock_file (lockname
);
4852 #endif /* CLASH_DETECTION */
4854 report_file_errno ("Opening output file", filename
, open_errno
);
4857 count1
= SPECPDL_INDEX ();
4858 record_unwind_protect_int (close_file_unwind
, desc
);
4861 if (NUMBERP (append
))
4863 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4866 int lseek_errno
= errno
;
4867 #ifdef CLASH_DETECTION
4869 unlock_file (lockname
);
4870 #endif /* CLASH_DETECTION */
4872 report_file_errno ("Lseek error", filename
, lseek_errno
);
4880 if (STRINGP (start
))
4881 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4882 else if (XINT (start
) != XINT (end
))
4883 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4884 &annotations
, &coding
);
4887 /* If file was empty, still need to write the annotations. */
4888 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4889 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4893 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4894 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4896 /* We have to flush out a data. */
4897 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4898 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4904 /* fsync is not crucial for temporary files. Nor for auto-save
4905 files, since they might lose some work anyway. */
4906 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4908 /* Transfer data and metadata to disk, retrying if interrupted.
4909 fsync can report a write failure here, e.g., due to disk full
4910 under NFS. But ignore EINVAL, which means fsync is not
4911 supported on this file. */
4912 while (fsync (desc
) != 0)
4915 if (errno
!= EINVAL
)
4916 ok
= 0, save_errno
= errno
;
4921 modtime
= invalid_timespec ();
4924 if (fstat (desc
, &st
) == 0)
4925 modtime
= get_stat_mtime (&st
);
4927 ok
= 0, save_errno
= errno
;
4930 if (open_and_close_file
)
4932 /* NFS can report a write failure now. */
4933 if (emacs_close (desc
) < 0)
4934 ok
= 0, save_errno
= errno
;
4936 /* Discard the unwind protect for close_file_unwind. */
4937 specpdl_ptr
= specpdl
+ count1
;
4940 /* Some file systems have a bug where st_mtime is not updated
4941 properly after a write. For example, CIFS might not see the
4942 st_mtime change until after the file is opened again.
4944 Attempt to detect this file system bug, and update MODTIME to the
4945 newer st_mtime if the bug appears to be present. This introduces
4946 a race condition, so to avoid most instances of the race condition
4947 on non-buggy file systems, skip this check if the most recently
4948 encountered non-buggy file system was the current file system.
4950 A race condition can occur if some other process modifies the
4951 file between the fstat above and the fstat below, but the race is
4952 unlikely and a similar race between the last write and the fstat
4953 above cannot possibly be closed anyway. */
4955 if (timespec_valid_p (modtime
)
4956 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
4958 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4962 if (fstat (desc1
, &st1
) == 0
4963 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
4965 /* Use the heuristic if it appears to be valid. With neither
4966 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
4967 file, the time stamp won't change. Also, some non-POSIX
4968 systems don't update an empty file's time stamp when
4969 truncating it. Finally, file systems with 100 ns or worse
4970 resolution sometimes seem to have bugs: on a system with ns
4971 resolution, checking ns % 100 incorrectly avoids the heuristic
4972 1% of the time, but the problem should be temporary as we will
4973 try again on the next time stamp. */
4975 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
4977 && modtime
.tv_nsec
% 100 != 0);
4979 struct timespec modtime1
= get_stat_mtime (&st1
);
4981 && timespec_cmp (modtime
, modtime1
) == 0
4982 && st
.st_size
== st1
.st_size
)
4984 timestamp_file_system
= st
.st_dev
;
4985 valid_timestamp_file_system
= 1;
4989 st
.st_size
= st1
.st_size
;
4993 emacs_close (desc1
);
4997 /* Call write-region-post-annotation-function. */
4998 while (CONSP (Vwrite_region_annotation_buffers
))
5000 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5001 if (!NILP (Fbuffer_live_p (buf
)))
5004 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5005 call0 (Vwrite_region_post_annotation_function
);
5007 Vwrite_region_annotation_buffers
5008 = XCDR (Vwrite_region_annotation_buffers
);
5011 unbind_to (count
, Qnil
);
5013 #ifdef CLASH_DETECTION
5015 unlock_file (lockname
);
5016 #endif /* CLASH_DETECTION */
5018 /* Do this before reporting IO error
5019 to avoid a "file has changed on disk" warning on
5020 next attempt to save. */
5021 if (timespec_valid_p (modtime
))
5023 current_buffer
->modtime
= modtime
;
5024 current_buffer
->modtime_size
= st
.st_size
;
5028 report_file_errno ("Write error", filename
, save_errno
);
5032 SAVE_MODIFF
= MODIFF
;
5033 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5034 bset_filename (current_buffer
, visit_file
);
5035 update_mode_lines
= 14;
5040 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5041 BVAR (current_buffer
, auto_save_file_name
))))
5042 SAVE_MODIFF
= MODIFF
;
5048 message_with_string ((NUMBERP (append
)
5058 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5059 doc
: /* Return t if (car A) is numerically less than (car B). */)
5060 (Lisp_Object a
, Lisp_Object b
)
5062 Lisp_Object args
[2];
5065 return Flss (2, args
);
5068 /* Build the complete list of annotations appropriate for writing out
5069 the text between START and END, by calling all the functions in
5070 write-region-annotate-functions and merging the lists they return.
5071 If one of these functions switches to a different buffer, we assume
5072 that buffer contains altered text. Therefore, the caller must
5073 make sure to restore the current buffer in all cases,
5074 as save-excursion would do. */
5077 build_annotations (Lisp_Object start
, Lisp_Object end
)
5079 Lisp_Object annotations
;
5081 struct gcpro gcpro1
, gcpro2
;
5082 Lisp_Object original_buffer
;
5084 bool used_global
= 0;
5086 XSETBUFFER (original_buffer
, current_buffer
);
5089 p
= Vwrite_region_annotate_functions
;
5090 GCPRO2 (annotations
, p
);
5093 struct buffer
*given_buffer
= current_buffer
;
5094 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5095 { /* Use the global value of the hook. */
5098 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5100 p
= Fappend (2, arg
);
5103 Vwrite_region_annotations_so_far
= annotations
;
5104 res
= call2 (XCAR (p
), start
, end
);
5105 /* If the function makes a different buffer current,
5106 assume that means this buffer contains altered text to be output.
5107 Reset START and END from the buffer bounds
5108 and discard all previous annotations because they should have
5109 been dealt with by this function. */
5110 if (current_buffer
!= given_buffer
)
5112 Vwrite_region_annotation_buffers
5113 = Fcons (Fcurrent_buffer (),
5114 Vwrite_region_annotation_buffers
);
5115 XSETFASTINT (start
, BEGV
);
5116 XSETFASTINT (end
, ZV
);
5119 Flength (res
); /* Check basic validity of return value */
5120 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5124 /* Now do the same for annotation functions implied by the file-format */
5125 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5126 p
= BVAR (current_buffer
, auto_save_file_format
);
5128 p
= BVAR (current_buffer
, file_format
);
5129 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5131 struct buffer
*given_buffer
= current_buffer
;
5133 Vwrite_region_annotations_so_far
= annotations
;
5135 /* Value is either a list of annotations or nil if the function
5136 has written annotations to a temporary buffer, which is now
5138 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5139 original_buffer
, make_number (i
));
5140 if (current_buffer
!= given_buffer
)
5142 XSETFASTINT (start
, BEGV
);
5143 XSETFASTINT (end
, ZV
);
5148 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5156 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5157 If STRING is nil, POS is the character position in the current buffer.
5158 Intersperse with them the annotations from *ANNOT
5159 which fall within the range of POS to POS + NCHARS,
5160 each at its appropriate position.
5162 We modify *ANNOT by discarding elements as we use them up.
5164 Return true if successful. */
5167 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5168 ptrdiff_t nchars
, Lisp_Object
*annot
,
5169 struct coding_system
*coding
)
5173 ptrdiff_t lastpos
= pos
+ nchars
;
5175 while (NILP (*annot
) || CONSP (*annot
))
5177 tem
= Fcar_safe (Fcar (*annot
));
5180 nextpos
= XFASTINT (tem
);
5182 /* If there are no more annotations in this range,
5183 output the rest of the range all at once. */
5184 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5185 return e_write (desc
, string
, pos
, lastpos
, coding
);
5187 /* Output buffer text up to the next annotation's position. */
5190 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5194 /* Output the annotation. */
5195 tem
= Fcdr (Fcar (*annot
));
5198 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5201 *annot
= Fcdr (*annot
);
5206 /* Maximum number of characters that the next
5207 function encodes per one loop iteration. */
5209 enum { E_WRITE_MAX
= 8 * 1024 * 1024 };
5211 /* Write text in the range START and END into descriptor DESC,
5212 encoding them with coding system CODING. If STRING is nil, START
5213 and END are character positions of the current buffer, else they
5214 are indexes to the string STRING. Return true if successful. */
5217 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5218 struct coding_system
*coding
)
5220 if (STRINGP (string
))
5223 end
= SCHARS (string
);
5226 /* We used to have a code for handling selective display here. But,
5227 now it is handled within encode_coding. */
5231 if (STRINGP (string
))
5233 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5234 if (CODING_REQUIRE_ENCODING (coding
))
5236 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5238 /* Avoid creating huge Lisp string in encode_coding_object. */
5239 if (nchars
== E_WRITE_MAX
)
5240 coding
->raw_destination
= 1;
5242 encode_coding_object
5243 (coding
, string
, start
, string_char_to_byte (string
, start
),
5244 start
+ nchars
, string_char_to_byte (string
, start
+ nchars
),
5249 coding
->dst_object
= string
;
5250 coding
->consumed_char
= SCHARS (string
);
5251 coding
->produced
= SBYTES (string
);
5256 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5257 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5259 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5260 if (CODING_REQUIRE_ENCODING (coding
))
5262 ptrdiff_t nchars
= min (end
- start
, E_WRITE_MAX
);
5265 if (nchars
== E_WRITE_MAX
)
5266 coding
->raw_destination
= 1;
5268 encode_coding_object
5269 (coding
, Fcurrent_buffer (), start
, start_byte
,
5270 start
+ nchars
, CHAR_TO_BYTE (start
+ nchars
), Qt
);
5274 coding
->dst_object
= Qnil
;
5275 coding
->dst_pos_byte
= start_byte
;
5276 if (start
>= GPT
|| end
<= GPT
)
5278 coding
->consumed_char
= end
- start
;
5279 coding
->produced
= end_byte
- start_byte
;
5283 coding
->consumed_char
= GPT
- start
;
5284 coding
->produced
= GPT_BYTE
- start_byte
;
5289 if (coding
->produced
> 0)
5291 char *buf
= (coding
->raw_destination
? (char *) coding
->destination
5292 : (STRINGP (coding
->dst_object
)
5293 ? SSDATA (coding
->dst_object
)
5294 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
)));
5295 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5297 if (coding
->raw_destination
)
5299 /* We're responsible for freeing this, see
5300 encode_coding_object to check why. */
5301 xfree (coding
->destination
);
5302 coding
->raw_destination
= 0;
5304 if (coding
->produced
)
5307 start
+= coding
->consumed_char
;
5313 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5314 Sverify_visited_file_modtime
, 0, 1, 0,
5315 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5316 This means that the file has not been changed since it was visited or saved.
5317 If BUF is omitted or nil, it defaults to the current buffer.
5318 See Info node `(elisp)Modification Time' for more details. */)
5323 Lisp_Object handler
;
5324 Lisp_Object filename
;
5325 struct timespec mtime
;
5335 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5336 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5338 /* If the file name has special constructs in it,
5339 call the corresponding file handler. */
5340 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5341 Qverify_visited_file_modtime
);
5342 if (!NILP (handler
))
5343 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5345 filename
= ENCODE_FILE (BVAR (b
, filename
));
5347 mtime
= (stat (SSDATA (filename
), &st
) == 0
5348 ? get_stat_mtime (&st
)
5349 : time_error_value (errno
));
5350 if (timespec_cmp (mtime
, b
->modtime
) == 0
5351 && (b
->modtime_size
< 0
5352 || st
.st_size
== b
->modtime_size
))
5357 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5358 Svisited_file_modtime
, 0, 0, 0,
5359 doc
: /* Return the current buffer's recorded visited file modification time.
5360 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5361 `file-attributes' returns. If the current buffer has no recorded file
5362 modification time, this function returns 0. If the visited file
5363 doesn't exist, return -1.
5364 See Info node `(elisp)Modification Time' for more details. */)
5367 int ns
= current_buffer
->modtime
.tv_nsec
;
5369 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5370 return make_lisp_time (current_buffer
->modtime
);
5373 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5374 Sset_visited_file_modtime
, 0, 1, 0,
5375 doc
: /* Update buffer's recorded modification time from the visited file's time.
5376 Useful if the buffer was not read from the file normally
5377 or if the file itself has been changed for some known benign reason.
5378 An argument specifies the modification time value to use
5379 \(instead of that of the visited file), in the form of a list
5380 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5381 `visited-file-modtime'. */)
5382 (Lisp_Object time_flag
)
5384 if (!NILP (time_flag
))
5386 struct timespec mtime
;
5387 if (INTEGERP (time_flag
))
5389 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5390 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5393 mtime
= lisp_time_argument (time_flag
);
5395 current_buffer
->modtime
= mtime
;
5396 current_buffer
->modtime_size
= -1;
5400 register Lisp_Object filename
;
5402 Lisp_Object handler
;
5404 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5406 /* If the file name has special constructs in it,
5407 call the corresponding file handler. */
5408 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5409 if (!NILP (handler
))
5410 /* The handler can find the file name the same way we did. */
5411 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5413 filename
= ENCODE_FILE (filename
);
5415 if (stat (SSDATA (filename
), &st
) >= 0)
5417 current_buffer
->modtime
= get_stat_mtime (&st
);
5418 current_buffer
->modtime_size
= st
.st_size
;
5426 auto_save_error (Lisp_Object error_val
)
5428 Lisp_Object args
[3], msg
;
5430 struct gcpro gcpro1
;
5432 auto_save_error_occurred
= 1;
5434 ring_bell (XFRAME (selected_frame
));
5436 args
[0] = build_string ("Auto-saving %s: %s");
5437 args
[1] = BVAR (current_buffer
, name
);
5438 args
[2] = Ferror_message_string (error_val
);
5439 msg
= Fformat (3, args
);
5442 for (i
= 0; i
< 3; ++i
)
5447 message3_nolog (msg
);
5448 Fsleep_for (make_number (1), Qnil
);
5461 auto_save_mode_bits
= 0666;
5463 /* Get visited file's mode to become the auto save file's mode. */
5464 if (! NILP (BVAR (current_buffer
, filename
)))
5466 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5467 /* But make sure we can overwrite it later! */
5468 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5469 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5471 /* Remote files don't cooperate with stat. */
5472 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5476 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5477 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5481 struct auto_save_unwind
5488 do_auto_save_unwind (void *arg
)
5490 struct auto_save_unwind
*p
= arg
;
5491 FILE *stream
= p
->stream
;
5492 minibuffer_auto_raise
= p
->auto_raise
;
5503 do_auto_save_make_dir (Lisp_Object dir
)
5507 auto_saving_dir_umask
= 077;
5508 result
= call2 (Qmake_directory
, dir
, Qt
);
5509 auto_saving_dir_umask
= 0;
5514 do_auto_save_eh (Lisp_Object ignore
)
5516 auto_saving_dir_umask
= 0;
5520 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5521 doc
: /* Auto-save all buffers that need it.
5522 This is all buffers that have auto-saving enabled
5523 and are changed since last auto-saved.
5524 Auto-saving writes the buffer into a file
5525 so that your editing is not lost if the system crashes.
5526 This file is not the file you visited; that changes only when you save.
5527 Normally we run the normal hook `auto-save-hook' before saving.
5529 A non-nil NO-MESSAGE argument means do not print any message if successful.
5530 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5531 (Lisp_Object no_message
, Lisp_Object current_only
)
5533 struct buffer
*old
= current_buffer
, *b
;
5534 Lisp_Object tail
, buf
, hook
;
5535 bool auto_saved
= 0;
5536 int do_handled_files
;
5538 FILE *stream
= NULL
;
5539 ptrdiff_t count
= SPECPDL_INDEX ();
5540 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5541 bool old_message_p
= 0;
5542 struct auto_save_unwind auto_save_unwind
;
5543 struct gcpro gcpro1
, gcpro2
;
5545 if (max_specpdl_size
< specpdl_size
+ 40)
5546 max_specpdl_size
= specpdl_size
+ 40;
5551 if (NILP (no_message
))
5553 old_message_p
= push_message ();
5554 record_unwind_protect_void (pop_message_unwind
);
5557 /* Ordinarily don't quit within this function,
5558 but don't make it impossible to quit (in case we get hung in I/O). */
5562 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5563 point to non-strings reached from Vbuffer_alist. */
5565 hook
= intern ("auto-save-hook");
5566 safe_run_hooks (hook
);
5568 if (STRINGP (Vauto_save_list_file_name
))
5570 Lisp_Object listfile
;
5572 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5574 /* Don't try to create the directory when shutting down Emacs,
5575 because creating the directory might signal an error, and
5576 that would leave Emacs in a strange state. */
5577 if (!NILP (Vrun_hooks
))
5581 GCPRO2 (dir
, listfile
);
5582 dir
= Ffile_name_directory (listfile
);
5583 if (NILP (Ffile_directory_p (dir
)))
5584 internal_condition_case_1 (do_auto_save_make_dir
,
5590 stream
= emacs_fopen (SSDATA (listfile
), "w");
5593 auto_save_unwind
.stream
= stream
;
5594 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5595 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5596 minibuffer_auto_raise
= 0;
5598 auto_save_error_occurred
= 0;
5600 /* On first pass, save all files that don't have handlers.
5601 On second pass, save all files that do have handlers.
5603 If Emacs is crashing, the handlers may tweak what is causing
5604 Emacs to crash in the first place, and it would be a shame if
5605 Emacs failed to autosave perfectly ordinary files because it
5606 couldn't handle some ange-ftp'd file. */
5608 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5609 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5613 /* Record all the buffers that have auto save mode
5614 in the special file that lists them. For each of these buffers,
5615 Record visited name (if any) and auto save name. */
5616 if (STRINGP (BVAR (b
, auto_save_file_name
))
5617 && stream
!= NULL
&& do_handled_files
== 0)
5620 if (!NILP (BVAR (b
, filename
)))
5622 fwrite (SDATA (BVAR (b
, filename
)), 1,
5623 SBYTES (BVAR (b
, filename
)), stream
);
5625 putc ('\n', stream
);
5626 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5627 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5628 putc ('\n', stream
);
5632 if (!NILP (current_only
)
5633 && b
!= current_buffer
)
5636 /* Don't auto-save indirect buffers.
5637 The base buffer takes care of it. */
5641 /* Check for auto save enabled
5642 and file changed since last auto save
5643 and file changed since last real save. */
5644 if (STRINGP (BVAR (b
, auto_save_file_name
))
5645 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5646 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5647 /* -1 means we've turned off autosaving for a while--see below. */
5648 && XINT (BVAR (b
, save_length
)) >= 0
5649 && (do_handled_files
5650 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5653 struct timespec before_time
= current_timespec ();
5654 struct timespec after_time
;
5656 /* If we had a failure, don't try again for 20 minutes. */
5657 if (b
->auto_save_failure_time
> 0
5658 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5661 set_buffer_internal (b
);
5662 if (NILP (Vauto_save_include_big_deletions
)
5663 && (XFASTINT (BVAR (b
, save_length
)) * 10
5664 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5665 /* A short file is likely to change a large fraction;
5666 spare the user annoying messages. */
5667 && XFASTINT (BVAR (b
, save_length
)) > 5000
5668 /* These messages are frequent and annoying for `*mail*'. */
5669 && !EQ (BVAR (b
, filename
), Qnil
)
5670 && NILP (no_message
))
5672 /* It has shrunk too much; turn off auto-saving here. */
5673 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5674 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5676 minibuffer_auto_raise
= 0;
5677 /* Turn off auto-saving until there's a real save,
5678 and prevent any more warnings. */
5679 XSETINT (BVAR (b
, save_length
), -1);
5680 Fsleep_for (make_number (1), Qnil
);
5683 if (!auto_saved
&& NILP (no_message
))
5684 message1 ("Auto-saving...");
5685 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5687 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5688 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5689 set_buffer_internal (old
);
5691 after_time
= current_timespec ();
5693 /* If auto-save took more than 60 seconds,
5694 assume it was an NFS failure that got a timeout. */
5695 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5696 b
->auto_save_failure_time
= after_time
.tv_sec
;
5700 /* Prevent another auto save till enough input events come in. */
5701 record_auto_save ();
5703 if (auto_saved
&& NILP (no_message
))
5707 /* If we are going to restore an old message,
5708 give time to read ours. */
5709 sit_for (make_number (1), 0, 0);
5712 else if (!auto_save_error_occurred
)
5713 /* Don't overwrite the error message if an error occurred.
5714 If we displayed a message and then restored a state
5715 with no message, leave a "done" message on the screen. */
5716 message1 ("Auto-saving...done");
5721 /* This restores the message-stack status. */
5722 unbind_to (count
, Qnil
);
5726 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5727 Sset_buffer_auto_saved
, 0, 0, 0,
5728 doc
: /* Mark current buffer as auto-saved with its current text.
5729 No auto-save file will be written until the buffer changes again. */)
5732 /* FIXME: This should not be called in indirect buffers, since
5733 they're not autosaved. */
5734 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5735 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5736 current_buffer
->auto_save_failure_time
= 0;
5740 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5741 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5742 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5745 current_buffer
->auto_save_failure_time
= 0;
5749 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5751 doc
: /* Return t if current buffer has been auto-saved recently.
5752 More precisely, if it has been auto-saved since last read from or saved
5753 in the visited file. If the buffer has no visited file,
5754 then any auto-save counts as "recent". */)
5757 /* FIXME: maybe we should return nil for indirect buffers since
5758 they're never autosaved. */
5759 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5762 /* Reading and completing file names */
5764 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5765 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5766 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5767 The return value is only relevant for a call to `read-file-name' that happens
5768 before any other event (mouse or keypress) is handled. */)
5771 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5772 || defined (HAVE_NS)
5773 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5776 && window_system_available (SELECTED_FRAME ()))
5783 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5785 struct gcpro gcpro1
;
5786 Lisp_Object args
[7];
5788 GCPRO1 (default_filename
);
5789 args
[0] = intern ("read-file-name");
5792 args
[3] = default_filename
;
5793 args
[4] = mustmatch
;
5795 args
[6] = predicate
;
5796 RETURN_UNGCPRO (Ffuncall (7, args
));
5803 realmask
= umask (0);
5806 valid_timestamp_file_system
= 0;
5808 /* fsync can be a significant performance hit. Often it doesn't
5809 suffice to make the file-save operation survive a crash. For
5810 batch scripts, which are typically part of larger shell commands
5811 that don't fsync other files, its effect on performance can be
5812 significant so its utility is particularly questionable.
5813 Hence, for now by default fsync is used only when interactive.
5815 For more on why fsync often fails to work on today's hardware, see:
5816 Zheng M et al. Understanding the robustness of SSDs under power fault.
5817 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
5818 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
5820 For more on why fsync does not suffice even if it works properly, see:
5821 Roche X. Necessary step(s) to synchronize filename operations on disk.
5822 Austin Group Defect 672, 2013-03-19
5823 http://austingroupbugs.net/view.php?id=672 */
5824 write_region_inhibit_fsync
= noninteractive
;
5828 syms_of_fileio (void)
5830 DEFSYM (Qoperations
, "operations");
5831 DEFSYM (Qexpand_file_name
, "expand-file-name");
5832 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5833 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5834 DEFSYM (Qfile_name_directory
, "file-name-directory");
5835 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5836 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5837 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5838 DEFSYM (Qcopy_file
, "copy-file");
5839 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5840 DEFSYM (Qmake_directory
, "make-directory");
5841 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5842 DEFSYM (Qdelete_file
, "delete-file");
5843 DEFSYM (Qrename_file
, "rename-file");
5844 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5845 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5846 DEFSYM (Qfile_exists_p
, "file-exists-p");
5847 DEFSYM (Qfile_executable_p
, "file-executable-p");
5848 DEFSYM (Qfile_readable_p
, "file-readable-p");
5849 DEFSYM (Qfile_writable_p
, "file-writable-p");
5850 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5851 DEFSYM (Qaccess_file
, "access-file");
5852 DEFSYM (Qfile_directory_p
, "file-directory-p");
5853 DEFSYM (Qfile_regular_p
, "file-regular-p");
5854 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5855 DEFSYM (Qfile_modes
, "file-modes");
5856 DEFSYM (Qset_file_modes
, "set-file-modes");
5857 DEFSYM (Qset_file_times
, "set-file-times");
5858 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5859 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5860 DEFSYM (Qfile_acl
, "file-acl");
5861 DEFSYM (Qset_file_acl
, "set-file-acl");
5862 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5863 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5864 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5865 DEFSYM (Qwrite_region
, "write-region");
5866 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5867 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5868 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5870 DEFSYM (Qfile_name_history
, "file-name-history");
5871 Fset (Qfile_name_history
, Qnil
);
5873 DEFSYM (Qfile_error
, "file-error");
5874 DEFSYM (Qfile_already_exists
, "file-already-exists");
5875 DEFSYM (Qfile_date_error
, "file-date-error");
5876 DEFSYM (Qfile_notify_error
, "file-notify-error");
5877 DEFSYM (Qexcl
, "excl");
5879 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5880 doc
: /* Coding system for encoding file names.
5881 If it is nil, `default-file-name-coding-system' (which see) is used.
5883 On MS-Windows, the value of this variable is largely ignored if
5884 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5885 behaves as if file names were encoded in `utf-8'. */);
5886 Vfile_name_coding_system
= Qnil
;
5888 DEFVAR_LISP ("default-file-name-coding-system",
5889 Vdefault_file_name_coding_system
,
5890 doc
: /* Default coding system for encoding file names.
5891 This variable is used only when `file-name-coding-system' is nil.
5893 This variable is set/changed by the command `set-language-environment'.
5894 User should not set this variable manually,
5895 instead use `file-name-coding-system' to get a constant encoding
5896 of file names regardless of the current language environment.
5898 On MS-Windows, the value of this variable is largely ignored if
5899 \`w32-unicode-filenames' (which see) is non-nil. Emacs on Windows
5900 behaves as if file names were encoded in `utf-8'. */);
5901 Vdefault_file_name_coding_system
= Qnil
;
5903 DEFSYM (Qformat_decode
, "format-decode");
5904 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5905 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5906 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5908 Fput (Qfile_error
, Qerror_conditions
,
5909 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5910 Fput (Qfile_error
, Qerror_message
,
5911 build_pure_c_string ("File error"));
5913 Fput (Qfile_already_exists
, Qerror_conditions
,
5914 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5915 Fput (Qfile_already_exists
, Qerror_message
,
5916 build_pure_c_string ("File already exists"));
5918 Fput (Qfile_date_error
, Qerror_conditions
,
5919 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5920 Fput (Qfile_date_error
, Qerror_message
,
5921 build_pure_c_string ("Cannot set file date"));
5923 Fput (Qfile_notify_error
, Qerror_conditions
,
5924 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5925 Fput (Qfile_notify_error
, Qerror_message
,
5926 build_pure_c_string ("File notification error"));
5928 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5929 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5930 If a file name matches REGEXP, all I/O on that file is done by calling
5931 HANDLER. If a file name matches more than one handler, the handler
5932 whose match starts last in the file name gets precedence. The
5933 function `find-file-name-handler' checks this list for a handler for
5936 HANDLER should be a function. The first argument given to it is the
5937 name of the I/O primitive to be handled; the remaining arguments are
5938 the arguments that were passed to that primitive. For example, if you
5939 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5940 HANDLER is called like this:
5942 (funcall HANDLER 'file-exists-p FILENAME)
5944 Note that HANDLER must be able to handle all I/O primitives; if it has
5945 nothing special to do for a primitive, it should reinvoke the
5946 primitive to handle the operation \"the usual way\".
5947 See Info node `(elisp)Magic File Names' for more details. */);
5948 Vfile_name_handler_alist
= Qnil
;
5950 DEFVAR_LISP ("set-auto-coding-function",
5951 Vset_auto_coding_function
,
5952 doc
: /* If non-nil, a function to call to decide a coding system of file.
5953 Two arguments are passed to this function: the file name
5954 and the length of a file contents following the point.
5955 This function should return a coding system to decode the file contents.
5956 It should check the file name against `auto-coding-alist'.
5957 If no coding system is decided, it should check a coding system
5958 specified in the heading lines with the format:
5959 -*- ... coding: CODING-SYSTEM; ... -*-
5960 or local variable spec of the tailing lines with `coding:' tag. */);
5961 Vset_auto_coding_function
= Qnil
;
5963 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5964 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5965 Each is passed one argument, the number of characters inserted,
5966 with point at the start of the inserted text. Each function
5967 should leave point the same, and return the new character count.
5968 If `insert-file-contents' is intercepted by a handler from
5969 `file-name-handler-alist', that handler is responsible for calling the
5970 functions in `after-insert-file-functions' if appropriate. */);
5971 Vafter_insert_file_functions
= Qnil
;
5973 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5974 doc
: /* A list of functions to be called at the start of `write-region'.
5975 Each is passed two arguments, START and END as for `write-region'.
5976 These are usually two numbers but not always; see the documentation
5977 for `write-region'. The function should return a list of pairs
5978 of the form (POSITION . STRING), consisting of strings to be effectively
5979 inserted at the specified positions of the file being written (1 means to
5980 insert before the first byte written). The POSITIONs must be sorted into
5983 If there are several annotation functions, the lists returned by these
5984 functions are merged destructively. As each annotation function runs,
5985 the variable `write-region-annotations-so-far' contains a list of all
5986 annotations returned by previous annotation functions.
5988 An annotation function can return with a different buffer current.
5989 Doing so removes the annotations returned by previous functions, and
5990 resets START and END to `point-min' and `point-max' of the new buffer.
5992 After `write-region' completes, Emacs calls the function stored in
5993 `write-region-post-annotation-function', once for each buffer that was
5994 current when building the annotations (i.e., at least once), with that
5995 buffer current. */);
5996 Vwrite_region_annotate_functions
= Qnil
;
5997 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5999 DEFVAR_LISP ("write-region-post-annotation-function",
6000 Vwrite_region_post_annotation_function
,
6001 doc
: /* Function to call after `write-region' completes.
6002 The function is called with no arguments. If one or more of the
6003 annotation functions in `write-region-annotate-functions' changed the
6004 current buffer, the function stored in this variable is called for
6005 each of those additional buffers as well, in addition to the original
6006 buffer. The relevant buffer is current during each function call. */);
6007 Vwrite_region_post_annotation_function
= Qnil
;
6008 staticpro (&Vwrite_region_annotation_buffers
);
6010 DEFVAR_LISP ("write-region-annotations-so-far",
6011 Vwrite_region_annotations_so_far
,
6012 doc
: /* When an annotation function is called, this holds the previous annotations.
6013 These are the annotations made by other annotation functions
6014 that were already called. See also `write-region-annotate-functions'. */);
6015 Vwrite_region_annotations_so_far
= Qnil
;
6017 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6018 doc
: /* A list of file name handlers that temporarily should not be used.
6019 This applies only to the operation `inhibit-file-name-operation'. */);
6020 Vinhibit_file_name_handlers
= Qnil
;
6022 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6023 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6024 Vinhibit_file_name_operation
= Qnil
;
6026 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6027 doc
: /* File name in which we write a list of all auto save file names.
6028 This variable is initialized automatically from `auto-save-list-file-prefix'
6029 shortly after Emacs reads your init file, if you have not yet given it
6030 a non-nil value. */);
6031 Vauto_save_list_file_name
= Qnil
;
6033 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6034 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6035 Normally auto-save files are written under other names. */);
6036 Vauto_save_visited_file_name
= Qnil
;
6038 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6039 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6040 If nil, deleting a substantial portion of the text disables auto-save
6041 in the buffer; this is the default behavior, because the auto-save
6042 file is usually more useful if it contains the deleted text. */);
6043 Vauto_save_include_big_deletions
= Qnil
;
6045 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6046 doc
: /* Non-nil means don't call fsync in `write-region'.
6047 This variable affects calls to `write-region' as well as save commands.
6048 Setting this to nil may avoid data loss if the system loses power or
6049 the operating system crashes. By default, it is non-nil in batch mode. */);
6050 write_region_inhibit_fsync
= 0; /* See also `init_fileio' above. */
6052 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6053 doc
: /* Specifies whether to use the system's trash can.
6054 When non-nil, certain file deletion commands use the function
6055 `move-file-to-trash' instead of deleting files outright.
6056 This includes interactive calls to `delete-file' and
6057 `delete-directory' and the Dired deletion commands. */);
6058 delete_by_moving_to_trash
= 0;
6059 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6061 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6062 DEFSYM (Qcopy_directory
, "copy-directory");
6063 DEFSYM (Qdelete_directory
, "delete-directory");
6064 DEFSYM (Qsubstitute_env_in_file_name
, "substitute-env-in-file-name");
6066 defsubr (&Sfind_file_name_handler
);
6067 defsubr (&Sfile_name_directory
);
6068 defsubr (&Sfile_name_nondirectory
);
6069 defsubr (&Sunhandled_file_name_directory
);
6070 defsubr (&Sfile_name_as_directory
);
6071 defsubr (&Sdirectory_file_name
);
6072 defsubr (&Smake_temp_name
);
6073 defsubr (&Sexpand_file_name
);
6074 defsubr (&Ssubstitute_in_file_name
);
6075 defsubr (&Scopy_file
);
6076 defsubr (&Smake_directory_internal
);
6077 defsubr (&Sdelete_directory_internal
);
6078 defsubr (&Sdelete_file
);
6079 defsubr (&Srename_file
);
6080 defsubr (&Sadd_name_to_file
);
6081 defsubr (&Smake_symbolic_link
);
6082 defsubr (&Sfile_name_absolute_p
);
6083 defsubr (&Sfile_exists_p
);
6084 defsubr (&Sfile_executable_p
);
6085 defsubr (&Sfile_readable_p
);
6086 defsubr (&Sfile_writable_p
);
6087 defsubr (&Saccess_file
);
6088 defsubr (&Sfile_symlink_p
);
6089 defsubr (&Sfile_directory_p
);
6090 defsubr (&Sfile_accessible_directory_p
);
6091 defsubr (&Sfile_regular_p
);
6092 defsubr (&Sfile_modes
);
6093 defsubr (&Sset_file_modes
);
6094 defsubr (&Sset_file_times
);
6095 defsubr (&Sfile_selinux_context
);
6096 defsubr (&Sfile_acl
);
6097 defsubr (&Sset_file_acl
);
6098 defsubr (&Sset_file_selinux_context
);
6099 defsubr (&Sset_default_file_modes
);
6100 defsubr (&Sdefault_file_modes
);
6101 defsubr (&Sfile_newer_than_file_p
);
6102 defsubr (&Sinsert_file_contents
);
6103 defsubr (&Schoose_write_coding_system
);
6104 defsubr (&Swrite_region
);
6105 defsubr (&Scar_less_than_car
);
6106 defsubr (&Sverify_visited_file_modtime
);
6107 defsubr (&Svisited_file_modtime
);
6108 defsubr (&Sset_visited_file_modtime
);
6109 defsubr (&Sdo_auto_save
);
6110 defsubr (&Sset_buffer_auto_saved
);
6111 defsubr (&Sclear_buffer_auto_save_failure
);
6112 defsubr (&Srecent_auto_save_p
);
6114 defsubr (&Snext_read_file_uses_dialog_p
);
6117 defsubr (&Sunix_sync
);