1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
53 #include "dispextern.h"
61 #endif /* not WINDOWSNT */
65 #include <sys/param.h>
70 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
71 redirector allows the six letters between 'Z' and 'a' as well. */
73 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
76 #define IS_DRIVE(x) c_isalpha (x)
78 /* Need to lower-case the drive letter, or else expanded
79 filenames will sometimes compare unequal, because
80 `expand-file-name' doesn't always down-case the drive letter. */
81 #define DRIVE_LETTER(x) c_tolower (x)
85 /* FIXME: this macro was copied from gnulib's private acl-internal.h
87 /* Recognize some common errors such as from an NFS mount that does
88 not support ACLs, even when local drives do. */
89 #if defined __APPLE__ && defined __MACH__ /* Mac OS X */
90 #define ACL_NOT_WELL_SUPPORTED(Err) \
91 ((Err) == ENOTSUP || (Err) == ENOSYS || (Err) == EINVAL || (Err) == EBUSY || (Err) == ENOENT)
92 #elif defined EOPNOTSUPP /* Tru64 NFS */
93 #define ACL_NOT_WELL_SUPPORTED(Err) \
94 ((Err) == ENOTSUP || (Err) == ENOSYS || (Err) == EINVAL || (Err) == EBUSY || (Err) == EOPNOTSUPP)
95 #elif defined WINDOWSNT
96 #define ACL_NOT_WELL_SUPPORTED(Err) ((Err) == ENOTSUP)
98 #define ACL_NOT_WELL_SUPPORTED(Err) \
99 ((Err) == ENOTSUP || (Err) == ENOSYS || (Err) == EINVAL || (Err) == EBUSY)
101 #endif /* HAVE_POSIX_ACL */
104 #include <allocator.h>
105 #include <careadlinkat.h>
106 #include <stat-time.h>
112 #include "commands.h"
114 /* True during writing of auto-save files. */
115 static bool auto_saving
;
117 /* Nonzero umask during creation of auto-save directories. */
118 static mode_t auto_saving_dir_umask
;
120 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
121 a new file with the same mode as the original. */
122 static mode_t auto_save_mode_bits
;
124 /* Set by auto_save_1 if an error occurred during the last auto-save. */
125 static bool auto_save_error_occurred
;
127 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
128 number of a file system where time stamps were observed to to work. */
129 static bool valid_timestamp_file_system
;
130 static dev_t timestamp_file_system
;
132 /* The symbol bound to coding-system-for-read when
133 insert-file-contents is called for recovering a file. This is not
134 an actual coding system name, but just an indicator to tell
135 insert-file-contents to use `emacs-mule' with a special flag for
136 auto saving and recovering a file. */
137 static Lisp_Object Qauto_save_coding
;
139 /* Property name of a file name handler,
140 which gives a list of operations it handles.. */
141 static Lisp_Object Qoperations
;
143 /* Lisp functions for translating file formats. */
144 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
146 /* Lisp function for setting buffer-file-coding-system and the
147 multibyteness of the current buffer after inserting a file. */
148 static Lisp_Object Qafter_insert_file_set_coding
;
150 static Lisp_Object Qwrite_region_annotate_functions
;
151 /* Each time an annotation function changes the buffer, the new buffer
153 static Lisp_Object Vwrite_region_annotation_buffers
;
155 static Lisp_Object Qdelete_by_moving_to_trash
;
157 /* Lisp function for moving files to trash. */
158 static Lisp_Object Qmove_file_to_trash
;
160 /* Lisp function for recursively copying directories. */
161 static Lisp_Object Qcopy_directory
;
163 /* Lisp function for recursively deleting directories. */
164 static Lisp_Object Qdelete_directory
;
169 Lisp_Object Qfile_error
;
170 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
171 static Lisp_Object Qexcl
;
172 Lisp_Object Qfile_name_history
;
174 static Lisp_Object Qcar_less_than_car
;
176 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
177 Lisp_Object
*, struct coding_system
*);
178 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
179 struct coding_system
*);
183 report_file_error (const char *string
, Lisp_Object data
)
185 Lisp_Object errstring
;
189 synchronize_system_messages_locale ();
190 str
= strerror (errorno
);
191 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
192 Vlocale_coding_system
, 0);
198 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
201 /* System error messages are capitalized. Downcase the initial
202 unless it is followed by a slash. (The slash case caters to
203 error messages that begin with "I/O" or, in German, "E/A".) */
204 if (STRING_MULTIBYTE (errstring
)
205 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
209 str
= SSDATA (errstring
);
210 c
= STRING_CHAR ((unsigned char *) str
);
211 Faset (errstring
, make_number (0), make_number (downcase (c
)));
214 xsignal (Qfile_error
,
215 Fcons (build_string (string
), Fcons (errstring
, data
)));
220 close_file_unwind (Lisp_Object fd
)
222 emacs_close (XFASTINT (fd
));
226 /* Restore point, having saved it as a marker. */
229 restore_point_unwind (Lisp_Object location
)
231 Fgoto_char (location
);
232 Fset_marker (location
, Qnil
, Qnil
);
237 static Lisp_Object Qexpand_file_name
;
238 static Lisp_Object Qsubstitute_in_file_name
;
239 static Lisp_Object Qdirectory_file_name
;
240 static Lisp_Object Qfile_name_directory
;
241 static Lisp_Object Qfile_name_nondirectory
;
242 static Lisp_Object Qunhandled_file_name_directory
;
243 static Lisp_Object Qfile_name_as_directory
;
244 static Lisp_Object Qcopy_file
;
245 static Lisp_Object Qmake_directory_internal
;
246 static Lisp_Object Qmake_directory
;
247 static Lisp_Object Qdelete_directory_internal
;
248 Lisp_Object Qdelete_file
;
249 static Lisp_Object Qrename_file
;
250 static Lisp_Object Qadd_name_to_file
;
251 static Lisp_Object Qmake_symbolic_link
;
252 Lisp_Object Qfile_exists_p
;
253 static Lisp_Object Qfile_executable_p
;
254 static Lisp_Object Qfile_readable_p
;
255 static Lisp_Object Qfile_writable_p
;
256 static Lisp_Object Qfile_symlink_p
;
257 static Lisp_Object Qaccess_file
;
258 Lisp_Object Qfile_directory_p
;
259 static Lisp_Object Qfile_regular_p
;
260 static Lisp_Object Qfile_accessible_directory_p
;
261 static Lisp_Object Qfile_modes
;
262 static Lisp_Object Qset_file_modes
;
263 static Lisp_Object Qset_file_times
;
264 static Lisp_Object Qfile_selinux_context
;
265 static Lisp_Object Qset_file_selinux_context
;
266 static Lisp_Object Qfile_acl
;
267 static Lisp_Object Qset_file_acl
;
268 static Lisp_Object Qfile_newer_than_file_p
;
269 Lisp_Object Qinsert_file_contents
;
270 static Lisp_Object Qchoose_write_coding_system
;
271 Lisp_Object Qwrite_region
;
272 static Lisp_Object Qverify_visited_file_modtime
;
273 static Lisp_Object Qset_visited_file_modtime
;
275 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
276 Sfind_file_name_handler
, 2, 2, 0,
277 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
278 Otherwise, return nil.
279 A file name is handled if one of the regular expressions in
280 `file-name-handler-alist' matches it.
282 If OPERATION equals `inhibit-file-name-operation', then we ignore
283 any handlers that are members of `inhibit-file-name-handlers',
284 but we still do run any other handlers. This lets handlers
285 use the standard functions without calling themselves recursively. */)
286 (Lisp_Object filename
, Lisp_Object operation
)
288 /* This function must not munge the match data. */
289 Lisp_Object chain
, inhibited_handlers
, result
;
293 CHECK_STRING (filename
);
295 if (EQ (operation
, Vinhibit_file_name_operation
))
296 inhibited_handlers
= Vinhibit_file_name_handlers
;
298 inhibited_handlers
= Qnil
;
300 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
301 chain
= XCDR (chain
))
307 Lisp_Object string
= XCAR (elt
);
309 Lisp_Object handler
= XCDR (elt
);
310 Lisp_Object operations
= Qnil
;
312 if (SYMBOLP (handler
))
313 operations
= Fget (handler
, Qoperations
);
316 && (match_pos
= fast_string_match (string
, filename
)) > pos
317 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
321 handler
= XCDR (elt
);
322 tem
= Fmemq (handler
, inhibited_handlers
);
336 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
338 doc
: /* Return the directory component in file name FILENAME.
339 Return nil if FILENAME does not include a directory.
340 Otherwise return a directory name.
341 Given a Unix syntax file name, returns a string ending in slash. */)
342 (Lisp_Object filename
)
345 register const char *beg
;
350 register const char *p
;
353 CHECK_STRING (filename
);
355 /* If the file name has special constructs in it,
356 call the corresponding file handler. */
357 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
360 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
362 return STRINGP (handled_name
) ? handled_name
: Qnil
;
366 beg
= alloca (SBYTES (filename
) + 1);
367 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
369 beg
= SSDATA (filename
);
371 p
= beg
+ SBYTES (filename
);
373 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
375 /* only recognize drive specifier at the beginning */
377 /* handle the "/:d:foo" and "/:foo" cases correctly */
378 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
379 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
386 /* Expansion of "c:" to drive and default directory. */
389 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
390 char *res
= alloca (MAXPATHLEN
+ 1);
393 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
395 memcpy (res
, beg
, 2);
400 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
402 size_t l
= strlen (res
);
404 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
407 p
= beg
+ strlen (beg
);
408 dostounix_filename (beg
, 0);
409 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
410 STRING_MULTIBYTE (filename
));
413 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
414 STRING_MULTIBYTE (filename
));
416 else if (STRING_MULTIBYTE (filename
))
418 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
419 dostounix_filename (SSDATA (tem_fn
), 1);
421 if (!NILP (Vw32_downcase_file_names
))
422 tem_fn
= Fdowncase (tem_fn
);
427 dostounix_filename (beg
, 0);
428 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
432 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
436 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
437 Sfile_name_nondirectory
, 1, 1, 0,
438 doc
: /* Return file name FILENAME sans its directory.
439 For example, in a Unix-syntax file name,
440 this is everything after the last slash,
441 or the entire name if it contains no slash. */)
442 (Lisp_Object filename
)
444 register const char *beg
, *p
, *end
;
447 CHECK_STRING (filename
);
449 /* If the file name has special constructs in it,
450 call the corresponding file handler. */
451 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
454 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
456 if (STRINGP (handled_name
))
458 error ("Invalid handler in `file-name-handler-alist'");
461 beg
= SSDATA (filename
);
462 end
= p
= beg
+ SBYTES (filename
);
464 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
466 /* only recognize drive specifier at beginning */
468 /* handle the "/:d:foo" case correctly */
469 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
474 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
477 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
478 Sunhandled_file_name_directory
, 1, 1, 0,
479 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
480 A `directly usable' directory name is one that may be used without the
481 intervention of any file handler.
482 If FILENAME is a directly usable file itself, return
483 \(file-name-directory FILENAME).
484 If FILENAME refers to a file which is not accessible from a local process,
485 then this should return nil.
486 The `call-process' and `start-process' functions use this function to
487 get a current directory to run processes in. */)
488 (Lisp_Object filename
)
492 /* If the file name has special constructs in it,
493 call the corresponding file handler. */
494 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
497 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
499 return STRINGP (handled_name
) ? handled_name
: Qnil
;
502 return Ffile_name_directory (filename
);
505 /* Convert from file name SRC of length SRCLEN to directory name in
506 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
507 string. On UNIX, just make sure there is a terminating /. Return
508 the length of DST in bytes. */
511 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
524 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
526 dst
[srclen
] = DIRECTORY_SEP
;
527 dst
[srclen
+ 1] = '\0';
531 dostounix_filename (dst
, multibyte
);
536 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
537 Sfile_name_as_directory
, 1, 1, 0,
538 doc
: /* Return a string representing the file name FILE interpreted as a directory.
539 This operation exists because a directory is also a file, but its name as
540 a directory is different from its name as a file.
541 The result can be used as the value of `default-directory'
542 or passed as second argument to `expand-file-name'.
543 For a Unix-syntax file name, just appends a slash. */)
554 /* If the file name has special constructs in it,
555 call the corresponding file handler. */
556 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
559 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
561 if (STRINGP (handled_name
))
563 error ("Invalid handler in `file-name-handler-alist'");
567 if (!NILP (Vw32_downcase_file_names
))
568 file
= Fdowncase (file
);
570 buf
= alloca (SBYTES (file
) + 10);
571 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
572 STRING_MULTIBYTE (file
));
573 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
576 /* Convert from directory name SRC of length SRCLEN to file name in
577 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
578 string. On UNIX, just make sure there isn't a terminating /.
579 Return the length of DST in bytes. */
582 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
584 /* Process as Unix format: just remove any final slash.
585 But leave "/" unchanged; do not change it to "". */
588 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
590 && !IS_ANY_SEP (dst
[srclen
- 2])
598 dostounix_filename (dst
, multibyte
);
603 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
605 doc
: /* Returns the file name of the directory named DIRECTORY.
606 This is the name of the file that holds the data for the directory DIRECTORY.
607 This operation exists because a directory is also a file, but its name as
608 a directory is different from its name as a file.
609 In Unix-syntax, this function just removes the final slash. */)
610 (Lisp_Object directory
)
616 CHECK_STRING (directory
);
618 if (NILP (directory
))
621 /* If the file name has special constructs in it,
622 call the corresponding file handler. */
623 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
626 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
628 if (STRINGP (handled_name
))
630 error ("Invalid handler in `file-name-handler-alist'");
634 if (!NILP (Vw32_downcase_file_names
))
635 directory
= Fdowncase (directory
);
637 buf
= alloca (SBYTES (directory
) + 20);
638 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
639 STRING_MULTIBYTE (directory
));
640 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
643 static const char make_temp_name_tbl
[64] =
645 'A','B','C','D','E','F','G','H',
646 'I','J','K','L','M','N','O','P',
647 'Q','R','S','T','U','V','W','X',
648 'Y','Z','a','b','c','d','e','f',
649 'g','h','i','j','k','l','m','n',
650 'o','p','q','r','s','t','u','v',
651 'w','x','y','z','0','1','2','3',
652 '4','5','6','7','8','9','-','_'
655 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
657 /* Value is a temporary file name starting with PREFIX, a string.
659 The Emacs process number forms part of the result, so there is
660 no danger of generating a name being used by another process.
661 In addition, this function makes an attempt to choose a name
662 which has no existing file. To make this work, PREFIX should be
663 an absolute file name.
665 BASE64_P means add the pid as 3 characters in base64
666 encoding. In this case, 6 characters will be added to PREFIX to
667 form the file name. Otherwise, if Emacs is running on a system
668 with long file names, add the pid as a decimal number.
670 This function signals an error if no unique file name could be
674 make_temp_name (Lisp_Object prefix
, bool base64_p
)
680 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
683 CHECK_STRING (prefix
);
685 /* VAL is created by adding 6 characters to PREFIX. The first
686 three are the PID of this process, in base 64, and the second
687 three are incremented if the file already exists. This ensures
688 262144 unique file names per PID per PREFIX. */
694 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
695 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
696 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
701 #ifdef HAVE_LONG_FILE_NAMES
702 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
704 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
705 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
706 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
711 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
712 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
713 if (!STRING_MULTIBYTE (prefix
))
714 STRING_SET_UNIBYTE (val
);
716 memcpy (data
, SSDATA (prefix
), len
);
719 memcpy (p
, pidbuf
, pidlen
);
722 /* Here we try to minimize useless stat'ing when this function is
723 invoked many times successively with the same PREFIX. We achieve
724 this by initializing count to a random value, and incrementing it
727 We don't want make-temp-name to be called while dumping,
728 because then make_temp_name_count_initialized_p would get set
729 and then make_temp_name_count would not be set when Emacs starts. */
731 if (!make_temp_name_count_initialized_p
)
733 make_temp_name_count
= time (NULL
);
734 make_temp_name_count_initialized_p
= 1;
739 unsigned num
= make_temp_name_count
;
741 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
742 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
743 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
745 /* Poor man's congruential RN generator. Replace with
746 ++make_temp_name_count for debugging. */
747 make_temp_name_count
+= 25229;
748 make_temp_name_count
%= 225307;
750 if (!check_existing (data
))
752 /* We want to return only if errno is ENOENT. */
756 /* The error here is dubious, but there is little else we
757 can do. The alternatives are to return nil, which is
758 as bad as (and in many cases worse than) throwing the
759 error, or to ignore the error, which will likely result
760 in looping through 225307 stat's, which is not only
761 dog-slow, but also useless since eventually nil would
762 have to be returned anyway. */
763 report_file_error ("Cannot create temporary name for prefix",
764 Fcons (prefix
, Qnil
));
771 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
772 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
773 The Emacs process number forms part of the result,
774 so there is no danger of generating a name being used by another process.
776 In addition, this function makes an attempt to choose a name
777 which has no existing file. To make this work,
778 PREFIX should be an absolute file name.
780 There is a race condition between calling `make-temp-name' and creating the
781 file which opens all kinds of security holes. For that reason, you should
782 probably use `make-temp-file' instead, except in three circumstances:
784 * If you are creating the file in the user's home directory.
785 * If you are creating a directory rather than an ordinary file.
786 * If you are taking special precautions as `make-temp-file' does. */)
789 return make_temp_name (prefix
, 0);
794 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
795 doc
: /* Convert filename NAME to absolute, and canonicalize it.
796 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
797 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
798 the current buffer's value of `default-directory' is used.
799 NAME should be a string that is a valid file name for the underlying
801 File name components that are `.' are removed, and
802 so are file name components followed by `..', along with the `..' itself;
803 note that these simplifications are done without checking the resulting
804 file names in the file system.
805 Multiple consecutive slashes are collapsed into a single slash,
806 except at the beginning of the file name when they are significant (e.g.,
807 UNC file names on MS-Windows.)
808 An initial `~/' expands to your home directory.
809 An initial `~USER/' expands to USER's home directory.
810 See also the function `substitute-in-file-name'.
812 For technical reasons, this function can return correct but
813 non-intuitive results for the root directory; for instance,
814 \(expand-file-name ".." "/") returns "/..". For this reason, use
815 \(directory-file-name (file-name-directory dirname)) to traverse a
816 filesystem tree, not (expand-file-name ".." dirname). */)
817 (Lisp_Object name
, Lisp_Object default_directory
)
819 /* These point to SDATA and need to be careful with string-relocation
820 during GC (via DECODE_FILE). */
823 /* This should only point to alloca'd data. */
830 bool collapse_newdir
= 1;
834 Lisp_Object handler
, result
, handled_name
;
840 /* If the file name has special constructs in it,
841 call the corresponding file handler. */
842 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
845 handled_name
= call3 (handler
, Qexpand_file_name
,
846 name
, default_directory
);
847 if (STRINGP (handled_name
))
849 error ("Invalid handler in `file-name-handler-alist'");
853 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
854 if (NILP (default_directory
))
855 default_directory
= BVAR (current_buffer
, directory
);
856 if (! STRINGP (default_directory
))
859 /* "/" is not considered a root directory on DOS_NT, so using "/"
860 here causes an infinite recursion in, e.g., the following:
862 (let (default-directory)
863 (expand-file-name "a"))
865 To avoid this, we set default_directory to the root of the
867 default_directory
= build_string (emacs_root_dir ());
869 default_directory
= build_string ("/");
873 if (!NILP (default_directory
))
875 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
878 handled_name
= call3 (handler
, Qexpand_file_name
,
879 name
, default_directory
);
880 if (STRINGP (handled_name
))
882 error ("Invalid handler in `file-name-handler-alist'");
887 char *o
= SSDATA (default_directory
);
889 /* Make sure DEFAULT_DIRECTORY is properly expanded.
890 It would be better to do this down below where we actually use
891 default_directory. Unfortunately, calling Fexpand_file_name recursively
892 could invoke GC, and the strings might be relocated. This would
893 be annoying because we have pointers into strings lying around
894 that would need adjusting, and people would add new pointers to
895 the code and forget to adjust them, resulting in intermittent bugs.
896 Putting this call here avoids all that crud.
898 The EQ test avoids infinite recursion. */
899 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
900 /* Save time in some common cases - as long as default_directory
901 is not relative, it can be canonicalized with name below (if it
902 is needed at all) without requiring it to be expanded now. */
904 /* Detect MSDOS file names with drive specifiers. */
905 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
906 && IS_DIRECTORY_SEP (o
[2]))
908 /* Detect Windows file names in UNC format. */
909 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
911 #else /* not DOS_NT */
912 /* Detect Unix absolute file names (/... alone is not absolute on
914 && ! (IS_DIRECTORY_SEP (o
[0]))
915 #endif /* not DOS_NT */
921 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
925 multibyte
= STRING_MULTIBYTE (name
);
926 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
929 default_directory
= string_to_multibyte (default_directory
);
932 name
= string_to_multibyte (name
);
938 if (!NILP (Vw32_downcase_file_names
))
939 default_directory
= Fdowncase (default_directory
);
942 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
943 nm
= alloca (SBYTES (name
) + 1);
944 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
947 /* Note if special escape prefix is present, but remove for now. */
948 if (nm
[0] == '/' && nm
[1] == ':')
954 /* Find and remove drive specifier if present; this makes nm absolute
955 even if the rest of the name appears to be relative. Only look for
956 drive specifier at the beginning. */
957 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
959 drive
= (unsigned char) nm
[0];
964 /* If we see "c://somedir", we want to strip the first slash after the
965 colon when stripping the drive letter. Otherwise, this expands to
967 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
970 /* Discard any previous drive specifier if nm is now in UNC format. */
971 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
975 #endif /* WINDOWSNT */
978 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
979 none are found, we can probably return right away. We will avoid
980 allocating a new string if name is already fully expanded. */
982 IS_DIRECTORY_SEP (nm
[0])
984 && drive
&& !is_escaped
987 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
991 /* If it turns out that the filename we want to return is just a
992 suffix of FILENAME, we don't need to go through and edit
993 things; we just need to construct a new string using data
994 starting at the middle of FILENAME. If we set LOSE, that
995 means we've discovered that we can't do that cool trick. */
1001 /* Since we know the name is absolute, we can assume that each
1002 element starts with a "/". */
1004 /* "." and ".." are hairy. */
1005 if (IS_DIRECTORY_SEP (p
[0])
1007 && (IS_DIRECTORY_SEP (p
[2])
1009 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1012 /* We want to replace multiple `/' in a row with a single
1015 && IS_DIRECTORY_SEP (p
[0])
1016 && IS_DIRECTORY_SEP (p
[1]))
1023 /* Make sure directories are all separated with /, but
1024 avoid allocation of a new string when not required. */
1025 dostounix_filename (nm
, multibyte
);
1027 if (IS_DIRECTORY_SEP (nm
[1]))
1029 if (strcmp (nm
, SSDATA (name
)) != 0)
1030 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1034 /* Drive must be set, so this is okay. */
1035 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1039 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1040 temp
[0] = DRIVE_LETTER (drive
);
1041 name
= concat2 (build_string (temp
), name
);
1044 if (!NILP (Vw32_downcase_file_names
))
1045 name
= Fdowncase (name
);
1048 #else /* not DOS_NT */
1049 if (strcmp (nm
, SSDATA (name
)) == 0)
1051 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1052 #endif /* not DOS_NT */
1056 /* At this point, nm might or might not be an absolute file name. We
1057 need to expand ~ or ~user if present, otherwise prefix nm with
1058 default_directory if nm is not absolute, and finally collapse /./
1059 and /foo/../ sequences.
1061 We set newdir to be the appropriate prefix if one is needed:
1062 - the relevant user directory if nm starts with ~ or ~user
1063 - the specified drive's working dir (DOS/NT only) if nm does not
1065 - the value of default_directory.
1067 Note that these prefixes are not guaranteed to be absolute (except
1068 for the working dir of a drive). Therefore, to ensure we always
1069 return an absolute name, if the final prefix is not absolute we
1070 append it to the current working directory. */
1074 if (nm
[0] == '~') /* prefix ~ */
1076 if (IS_DIRECTORY_SEP (nm
[1])
1077 || nm
[1] == 0) /* ~ by itself */
1081 if (!(newdir
= egetenv ("HOME")))
1084 /* `egetenv' may return a unibyte string, which will bite us since
1085 we expect the directory to be multibyte. */
1086 tem
= build_string (newdir
);
1087 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1089 hdir
= DECODE_FILE (tem
);
1090 newdir
= SSDATA (hdir
);
1093 collapse_newdir
= 0;
1096 else /* ~user/filename */
1099 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1100 o
= alloca (p
- nm
+ 1);
1101 memcpy (o
, nm
, p
- nm
);
1105 pw
= getpwnam (o
+ 1);
1111 newdir
= pw
->pw_dir
;
1112 /* `getpwnam' may return a unibyte string, which will
1113 bite us since we expect the directory to be
1115 tem
= build_string (newdir
);
1116 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1118 hdir
= DECODE_FILE (tem
);
1119 newdir
= SSDATA (hdir
);
1123 collapse_newdir
= 0;
1127 /* If we don't find a user of that name, leave the name
1128 unchanged; don't move nm forward to p. */
1133 /* On DOS and Windows, nm is absolute if a drive name was specified;
1134 use the drive's current directory as the prefix if needed. */
1135 if (!newdir
&& drive
)
1137 /* Get default directory if needed to make nm absolute. */
1139 if (!IS_DIRECTORY_SEP (nm
[0]))
1141 adir
= alloca (MAXPATHLEN
+ 1);
1142 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1146 Lisp_Object tem
= build_string (adir
);
1148 tem
= DECODE_FILE (tem
);
1149 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1154 /* Either nm starts with /, or drive isn't mounted. */
1156 adir
[0] = DRIVE_LETTER (drive
);
1165 /* Finally, if no prefix has been specified and nm is not absolute,
1166 then it must be expanded relative to default_directory. */
1170 /* /... alone is not absolute on DOS and Windows. */
1171 && !IS_DIRECTORY_SEP (nm
[0])
1174 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1178 newdir
= SSDATA (default_directory
);
1180 /* Note if special escape prefix is present, but remove for now. */
1181 if (newdir
[0] == '/' && newdir
[1] == ':')
1192 /* First ensure newdir is an absolute name. */
1194 /* Detect MSDOS file names with drive specifiers. */
1195 ! (IS_DRIVE (newdir
[0])
1196 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1198 /* Detect Windows file names in UNC format. */
1199 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1203 /* Effectively, let newdir be (expand-file-name newdir cwd).
1204 Because of the admonition against calling expand-file-name
1205 when we have pointers into lisp strings, we accomplish this
1206 indirectly by prepending newdir to nm if necessary, and using
1207 cwd (or the wd of newdir's drive) as the new newdir. */
1210 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1212 drive
= (unsigned char) newdir
[0];
1215 if (!IS_DIRECTORY_SEP (nm
[0]))
1217 ptrdiff_t newlen
= strlen (newdir
);
1218 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1219 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1223 adir
= alloca (MAXPATHLEN
+ 1);
1226 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1230 getcwd (adir
, MAXPATHLEN
+ 1);
1233 Lisp_Object tem
= build_string (adir
);
1235 tem
= DECODE_FILE (tem
);
1236 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1241 /* Strip off drive name from prefix, if present. */
1242 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1248 /* Keep only a prefix from newdir if nm starts with slash
1249 (//server/share for UNC, nothing otherwise). */
1250 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1253 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1255 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1257 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1259 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1272 /* Get rid of any slash at the end of newdir, unless newdir is
1273 just / or // (an incomplete UNC name). */
1274 length
= strlen (newdir
);
1276 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1278 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1282 char *temp
= alloca (length
);
1283 memcpy (temp
, newdir
, length
- 1);
1284 temp
[length
- 1] = 0;
1295 /* Now concatenate the directory and name to new space in the stack frame. */
1296 tlen
+= strlen (nm
) + 1;
1298 /* Reserve space for drive specifier and escape prefix, since either
1299 or both may need to be inserted. (The Microsoft x86 compiler
1300 produces incorrect code if the following two lines are combined.) */
1301 target
= alloca (tlen
+ 4);
1303 #else /* not DOS_NT */
1304 target
= alloca (tlen
);
1305 #endif /* not DOS_NT */
1310 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1313 /* If newdir is effectively "C:/", then the drive letter will have
1314 been stripped and newdir will be "/". Concatenating with an
1315 absolute directory in nm produces "//", which will then be
1316 incorrectly treated as a network share. Ignore newdir in
1317 this case (keeping the drive letter). */
1318 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1319 && newdir
[1] == '\0'))
1321 strcpy (target
, newdir
);
1324 file_name_as_directory (target
, newdir
, length
, multibyte
);
1327 strcat (target
, nm
);
1329 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1337 if (!IS_DIRECTORY_SEP (*p
))
1341 else if (p
[1] == '.'
1342 && (IS_DIRECTORY_SEP (p
[2])
1345 /* If "/." is the entire filename, keep the "/". Otherwise,
1346 just delete the whole "/.". */
1347 if (o
== target
&& p
[2] == '\0')
1351 else if (p
[1] == '.' && p
[2] == '.'
1352 /* `/../' is the "superroot" on certain file systems.
1353 Turned off on DOS_NT systems because they have no
1354 "superroot" and because this causes us to produce
1355 file names like "d:/../foo" which fail file-related
1356 functions of the underlying OS. (To reproduce, try a
1357 long series of "../../" in default_directory, longer
1358 than the number of levels from the root.) */
1362 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1367 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1370 /* Don't go below server level in UNC filenames. */
1371 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1372 && IS_DIRECTORY_SEP (*target
))
1376 /* Keep initial / only if this is the whole name. */
1377 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1381 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1382 /* Collapse multiple `/' in a row. */
1391 /* At last, set drive name. */
1393 /* Except for network file name. */
1394 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1395 #endif /* WINDOWSNT */
1397 if (!drive
) emacs_abort ();
1399 target
[0] = DRIVE_LETTER (drive
);
1402 /* Reinsert the escape prefix if required. */
1409 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1410 dostounix_filename (SSDATA (result
), multibyte
);
1412 if (!NILP (Vw32_downcase_file_names
))
1413 result
= Fdowncase (result
);
1416 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1417 #endif /* !DOS_NT */
1420 /* Again look to see if the file name has special constructs in it
1421 and perhaps call the corresponding file handler. This is needed
1422 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1423 the ".." component gives us "/user@host:/bar/../baz" which needs
1424 to be expanded again. */
1425 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1426 if (!NILP (handler
))
1428 handled_name
= call3 (handler
, Qexpand_file_name
,
1429 result
, default_directory
);
1430 if (STRINGP (handled_name
))
1431 return handled_name
;
1432 error ("Invalid handler in `file-name-handler-alist'");
1439 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1440 This is the old version of expand-file-name, before it was thoroughly
1441 rewritten for Emacs 10.31. We leave this version here commented-out,
1442 because the code is very complex and likely to have subtle bugs. If
1443 bugs _are_ found, it might be of interest to look at the old code and
1444 see what did it do in the relevant situation.
1446 Don't remove this code: it's true that it will be accessible
1447 from the repository, but a few years from deletion, people will
1448 forget it is there. */
1450 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1451 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1452 "Convert FILENAME to absolute, and canonicalize it.\n\
1453 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1454 \(does not start with slash); if DEFAULT is nil or missing,\n\
1455 the current buffer's value of default-directory is used.\n\
1456 Filenames containing `.' or `..' as components are simplified;\n\
1457 initial `~/' expands to your home directory.\n\
1458 See also the function `substitute-in-file-name'.")
1460 Lisp_Object name
, defalt
;
1464 register unsigned char *newdir
, *p
, *o
;
1466 unsigned char *target
;
1469 CHECK_STRING (name
);
1472 /* If nm is absolute, flush ...// and detect /./ and /../.
1473 If no /./ or /../ we can return right away. */
1480 if (p
[0] == '/' && p
[1] == '/')
1482 if (p
[0] == '/' && p
[1] == '~')
1483 nm
= p
+ 1, lose
= 1;
1484 if (p
[0] == '/' && p
[1] == '.'
1485 && (p
[2] == '/' || p
[2] == 0
1486 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1492 if (nm
== SDATA (name
))
1494 return build_string (nm
);
1498 /* Now determine directory to start with and put it in NEWDIR. */
1502 if (nm
[0] == '~') /* prefix ~ */
1503 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1505 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1506 newdir
= (unsigned char *) "";
1509 else /* ~user/filename */
1511 /* Get past ~ to user. */
1512 unsigned char *user
= nm
+ 1;
1513 /* Find end of name. */
1514 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1515 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1516 /* Copy the user name into temp storage. */
1517 o
= alloca (len
+ 1);
1518 memcpy (o
, user
, len
);
1521 /* Look up the user name. */
1523 pw
= (struct passwd
*) getpwnam (o
+ 1);
1526 error ("\"%s\" isn't a registered user", o
+ 1);
1528 newdir
= (unsigned char *) pw
->pw_dir
;
1530 /* Discard the user name from NM. */
1534 if (nm
[0] != '/' && !newdir
)
1537 defalt
= current_buffer
->directory
;
1538 CHECK_STRING (defalt
);
1539 newdir
= SDATA (defalt
);
1542 /* Now concatenate the directory and name to new space in the stack frame. */
1544 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1545 target
= alloca (tlen
);
1550 if (nm
[0] == 0 || nm
[0] == '/')
1551 strcpy (target
, newdir
);
1553 file_name_as_directory (target
, newdir
);
1556 strcat (target
, nm
);
1558 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1569 else if (!strncmp (p
, "//", 2)
1575 else if (p
[0] == '/' && p
[1] == '.'
1576 && (p
[2] == '/' || p
[2] == 0))
1578 else if (!strncmp (p
, "/..", 3)
1579 /* `/../' is the "superroot" on certain file systems. */
1581 && (p
[3] == '/' || p
[3] == 0))
1583 while (o
!= target
&& *--o
!= '/')
1585 if (o
== target
&& *o
== '/')
1595 return make_string (target
, o
- target
);
1599 /* If /~ or // appears, discard everything through first slash. */
1601 file_name_absolute_p (const char *filename
)
1604 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1606 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1607 && IS_DIRECTORY_SEP (filename
[2]))
1613 search_embedded_absfilename (char *nm
, char *endp
)
1617 for (p
= nm
+ 1; p
< endp
; p
++)
1619 if (IS_DIRECTORY_SEP (p
[-1])
1620 && file_name_absolute_p (p
)
1621 #if defined (WINDOWSNT) || defined (CYGWIN)
1622 /* // at start of file name is meaningful in Apollo,
1623 WindowsNT and Cygwin systems. */
1624 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1625 #endif /* not (WINDOWSNT || CYGWIN) */
1628 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1629 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1631 char *o
= alloca (s
- p
+ 1);
1633 memcpy (o
, p
, s
- p
);
1636 /* If we have ~user and `user' exists, discard
1637 everything up to ~. But if `user' does not exist, leave
1638 ~user alone, it might be a literal file name. */
1640 pw
= getpwnam (o
+ 1);
1652 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1653 Ssubstitute_in_file_name
, 1, 1, 0,
1654 doc
: /* Substitute environment variables referred to in FILENAME.
1655 `$FOO' where FOO is an environment variable name means to substitute
1656 the value of that variable. The variable name should be terminated
1657 with a character not a letter, digit or underscore; otherwise, enclose
1658 the entire variable name in braces.
1660 If `/~' appears, all of FILENAME through that `/' is discarded.
1661 If `//' appears, everything up to and including the first of
1662 those `/' is discarded. */)
1663 (Lisp_Object filename
)
1665 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1666 char *target
= NULL
;
1667 ptrdiff_t total
= 0;
1668 bool substituted
= 0;
1671 Lisp_Object handler
;
1673 CHECK_STRING (filename
);
1675 multibyte
= STRING_MULTIBYTE (filename
);
1677 /* If the file name has special constructs in it,
1678 call the corresponding file handler. */
1679 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1680 if (!NILP (handler
))
1682 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1684 if (STRINGP (handled_name
))
1685 return handled_name
;
1686 error ("Invalid handler in `file-name-handler-alist'");
1689 /* Always work on a copy of the string, in case GC happens during
1690 decode of environment variables, causing the original Lisp_String
1691 data to be relocated. */
1692 nm
= alloca (SBYTES (filename
) + 1);
1693 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1696 dostounix_filename (nm
, multibyte
);
1697 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1699 endp
= nm
+ SBYTES (filename
);
1701 /* If /~ or // appears, discard everything through first slash. */
1702 p
= search_embedded_absfilename (nm
, endp
);
1704 /* Start over with the new string, so we check the file-name-handler
1705 again. Important with filenames like "/home/foo//:/hello///there"
1706 which would substitute to "/:/hello///there" rather than "/there". */
1707 return Fsubstitute_in_file_name
1708 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1710 /* See if any variables are substituted into the string
1711 and find the total length of their values in `total'. */
1713 for (p
= nm
; p
!= endp
;)
1723 /* "$$" means a single "$". */
1732 p
= memchr (p
, '}', endp
- p
);
1740 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1744 /* Copy out the variable name. */
1745 target
= alloca (s
- o
+ 1);
1746 memcpy (target
, o
, s
- o
);
1749 strupr (target
); /* $home == $HOME etc. */
1752 /* Get variable value. */
1753 o
= egetenv (target
);
1756 /* Don't try to guess a maximum length - UTF8 can use up to
1757 four bytes per character. This code is unlikely to run
1758 in a situation that requires performance, so decoding the
1759 env variables twice should be acceptable. Note that
1760 decoding may cause a garbage collect. */
1761 Lisp_Object orig
, decoded
;
1762 orig
= build_unibyte_string (o
);
1763 decoded
= DECODE_FILE (orig
);
1764 total
+= SBYTES (decoded
);
1774 if (!NILP (Vw32_downcase_file_names
))
1775 filename
= Fdowncase (filename
);
1780 /* If substitution required, recopy the string and do it. */
1781 /* Make space in stack frame for the new copy. */
1782 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1785 /* Copy the rest of the name through, replacing $ constructs with values. */
1802 p
= memchr (p
, '}', endp
- p
);
1810 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1814 /* Copy out the variable name. */
1815 target
= alloca (s
- o
+ 1);
1816 memcpy (target
, o
, s
- o
);
1819 /* Get variable value. */
1820 o
= egetenv (target
);
1824 strcpy (x
, target
); x
+= strlen (target
);
1828 Lisp_Object orig
, decoded
;
1829 ptrdiff_t orig_length
, decoded_length
;
1830 orig_length
= strlen (o
);
1831 orig
= make_unibyte_string (o
, orig_length
);
1832 decoded
= DECODE_FILE (orig
);
1833 decoded_length
= SBYTES (decoded
);
1834 memcpy (x
, SDATA (decoded
), decoded_length
);
1835 x
+= decoded_length
;
1837 /* If environment variable needed decoding, return value
1838 needs to be multibyte. */
1839 if (decoded_length
!= orig_length
1840 || memcmp (SDATA (decoded
), o
, orig_length
))
1847 /* If /~ or // appears, discard everything through first slash. */
1848 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1849 /* This time we do not start over because we've already expanded envvars
1850 and replaced $$ with $. Maybe we should start over as well, but we'd
1851 need to quote some $ to $$ first. */
1855 if (!NILP (Vw32_downcase_file_names
))
1857 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1859 xname
= Fdowncase (xname
);
1864 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1867 error ("Bad format environment-variable substitution");
1869 error ("Missing \"}\" in environment-variable substitution");
1871 error ("Substituting nonexistent environment variable \"%s\"", target
);
1874 /* A slightly faster and more convenient way to get
1875 (directory-file-name (expand-file-name FOO)). */
1878 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1880 register Lisp_Object absname
;
1882 absname
= Fexpand_file_name (filename
, defdir
);
1884 /* Remove final slash, if any (unless this is the root dir).
1885 stat behaves differently depending! */
1886 if (SCHARS (absname
) > 1
1887 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1888 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1889 /* We cannot take shortcuts; they might be wrong for magic file names. */
1890 absname
= Fdirectory_file_name (absname
);
1894 /* Signal an error if the file ABSNAME already exists.
1895 If INTERACTIVE, ask the user whether to proceed,
1896 and bypass the error if the user says to go ahead.
1897 QUERYSTRING is a name for the action that is being considered
1900 *STATPTR is used to store the stat information if the file exists.
1901 If the file does not exist, STATPTR->st_mode is set to 0.
1902 If STATPTR is null, we don't store into it.
1904 If QUICK, ask for y or n, not yes or no. */
1907 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1908 bool interactive
, struct stat
*statptr
,
1911 Lisp_Object tem
, encoded_filename
;
1912 struct stat statbuf
;
1913 struct gcpro gcpro1
;
1915 encoded_filename
= ENCODE_FILE (absname
);
1917 /* `stat' is a good way to tell whether the file exists,
1918 regardless of what access permissions it has. */
1919 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1921 if (S_ISDIR (statbuf
.st_mode
))
1922 xsignal2 (Qfile_error
,
1923 build_string ("File is a directory"), absname
);
1926 xsignal2 (Qfile_already_exists
,
1927 build_string ("File already exists"), absname
);
1929 tem
= format2 ("File %s already exists; %s anyway? ",
1930 absname
, build_string (querystring
));
1932 tem
= call1 (intern ("y-or-n-p"), tem
);
1934 tem
= do_yes_or_no_p (tem
);
1937 xsignal2 (Qfile_already_exists
,
1938 build_string ("File already exists"), absname
);
1945 statptr
->st_mode
= 0;
1950 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1951 "fCopy file: \nGCopy %s to file: \np\nP",
1952 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1953 If NEWNAME names a directory, copy FILE there.
1955 This function always sets the file modes of the output file to match
1958 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1959 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1960 signal a `file-already-exists' error without overwriting. If
1961 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1962 about overwriting; this is what happens in interactive use with M-x.
1963 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1966 Fourth arg KEEP-TIME non-nil means give the output file the same
1967 last-modified time as the old one. (This works on only some systems.)
1969 A prefix arg makes KEEP-TIME non-nil.
1971 If PRESERVE-UID-GID is non-nil, we try to transfer the
1972 uid and gid of FILE to NEWNAME.
1974 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1975 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1976 entries (depending on how Emacs was built). */)
1977 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
, Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
, Lisp_Object preserve_extended_attributes
)
1981 char buf
[16 * 1024];
1982 struct stat st
, out_st
;
1983 Lisp_Object handler
;
1984 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1985 ptrdiff_t count
= SPECPDL_INDEX ();
1986 Lisp_Object encoded_file
, encoded_newname
;
1988 security_context_t con
;
1991 #ifdef HAVE_POSIX_ACL
1995 encoded_file
= encoded_newname
= Qnil
;
1996 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1997 CHECK_STRING (file
);
1998 CHECK_STRING (newname
);
2000 if (!NILP (Ffile_directory_p (newname
)))
2001 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2003 newname
= Fexpand_file_name (newname
, Qnil
);
2005 file
= Fexpand_file_name (file
, Qnil
);
2007 /* If the input file name has special constructs in it,
2008 call the corresponding file handler. */
2009 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2010 /* Likewise for output file name. */
2012 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2013 if (!NILP (handler
))
2014 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
2015 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
2016 preserve_extended_attributes
));
2018 encoded_file
= ENCODE_FILE (file
);
2019 encoded_newname
= ENCODE_FILE (newname
);
2021 if (NILP (ok_if_already_exists
)
2022 || INTEGERP (ok_if_already_exists
))
2023 barf_or_query_if_file_exists (newname
, "copy to it",
2024 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2025 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
2029 if (!NILP (preserve_extended_attributes
))
2031 #ifdef HAVE_POSIX_ACL
2032 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2033 if (acl
== NULL
&& !ACL_NOT_WELL_SUPPORTED (errno
))
2034 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2037 if (!CopyFile (SDATA (encoded_file
),
2038 SDATA (encoded_newname
),
2041 /* CopyFile doesn't set errno when it fails. By far the most
2042 "popular" reason is that the target is read-only. */
2043 if (GetLastError () == 5)
2047 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2049 /* CopyFile retains the timestamp by default. */
2050 else if (NILP (keep_time
))
2056 filename
= SDATA (encoded_newname
);
2058 /* Ensure file is writable while its modified time is set. */
2059 attributes
= GetFileAttributes (filename
);
2060 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2061 now
= current_emacs_time ();
2062 if (set_file_times (-1, filename
, now
, now
))
2064 /* Restore original attributes. */
2065 SetFileAttributes (filename
, attributes
);
2066 xsignal2 (Qfile_date_error
,
2067 build_string ("Cannot set file date"), newname
);
2069 /* Restore original attributes. */
2070 SetFileAttributes (filename
, attributes
);
2072 #ifdef HAVE_POSIX_ACL
2076 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2077 if (fail
&& !ACL_NOT_WELL_SUPPORTED (errno
))
2078 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2083 #else /* not WINDOWSNT */
2085 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2089 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2091 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2093 if (fstat (ifd
, &st
) != 0)
2094 report_file_error ("Input file status", Fcons (file
, Qnil
));
2096 if (!NILP (preserve_extended_attributes
))
2099 if (is_selinux_enabled ())
2101 conlength
= fgetfilecon (ifd
, &con
);
2102 if (conlength
== -1)
2103 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
2107 #ifdef HAVE_POSIX_ACL
2108 acl
= acl_get_fd (ifd
);
2109 if (acl
== NULL
&& !ACL_NOT_WELL_SUPPORTED (errno
))
2110 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2114 if (out_st
.st_mode
!= 0
2115 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2118 report_file_error ("Input and output files are the same",
2119 Fcons (file
, Fcons (newname
, Qnil
)));
2122 /* We can copy only regular files. */
2123 if (!S_ISREG (st
.st_mode
))
2125 /* Get a better looking error message. */
2126 errno
= S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
;
2127 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2131 /* System's default file type was set to binary by _fmode in emacs.c. */
2132 ofd
= emacs_open (SDATA (encoded_newname
),
2133 O_WRONLY
| O_TRUNC
| O_CREAT
2134 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2135 S_IREAD
| S_IWRITE
);
2136 #else /* not MSDOS */
2138 mode_t new_mask
= !NILP (preserve_uid_gid
) ? 0600 : 0666;
2139 new_mask
&= st
.st_mode
;
2140 ofd
= emacs_open (SSDATA (encoded_newname
),
2141 (O_WRONLY
| O_TRUNC
| O_CREAT
2142 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2145 #endif /* not MSDOS */
2147 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2149 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2153 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2154 if (emacs_write (ofd
, buf
, n
) != n
)
2155 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2159 /* Preserve the original file modes, and if requested, also its
2162 mode_t mode_mask
= 07777;
2163 if (!NILP (preserve_uid_gid
))
2165 /* Attempt to change owner and group. If that doesn't work
2166 attempt to change just the group, as that is sometimes allowed.
2167 Adjust the mode mask to eliminate setuid or setgid bits
2168 that are inappropriate if the owner and group are wrong. */
2169 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2171 mode_mask
&= ~06000;
2172 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2176 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2177 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2179 #endif /* not MSDOS */
2184 /* Set the modified context back to the file. */
2185 bool fail
= fsetfilecon (ofd
, con
) != 0;
2186 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2187 if (fail
&& errno
!= ENOTSUP
)
2188 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2194 #ifdef HAVE_POSIX_ACL
2197 bool fail
= acl_set_fd (ofd
, acl
) != 0;
2198 if (fail
&& !ACL_NOT_WELL_SUPPORTED (errno
))
2199 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2205 if (!NILP (keep_time
))
2207 EMACS_TIME atime
= get_stat_atime (&st
);
2208 EMACS_TIME mtime
= get_stat_mtime (&st
);
2209 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2210 xsignal2 (Qfile_date_error
,
2211 build_string ("Cannot set file date"), newname
);
2214 if (emacs_close (ofd
) < 0)
2215 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2220 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2221 and if it can't, it tells so. Otherwise, under MSDOS we usually
2222 get only the READ bit, which will make the copied file read-only,
2223 so it's better not to chmod at all. */
2224 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2225 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2227 #endif /* not WINDOWSNT */
2229 /* Discard the unwind protects. */
2230 specpdl_ptr
= specpdl
+ count
;
2236 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2237 Smake_directory_internal
, 1, 1, 0,
2238 doc
: /* Create a new directory named DIRECTORY. */)
2239 (Lisp_Object directory
)
2242 Lisp_Object handler
;
2243 Lisp_Object encoded_dir
;
2245 CHECK_STRING (directory
);
2246 directory
= Fexpand_file_name (directory
, Qnil
);
2248 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2249 if (!NILP (handler
))
2250 return call2 (handler
, Qmake_directory_internal
, directory
);
2252 encoded_dir
= ENCODE_FILE (directory
);
2254 dir
= SSDATA (encoded_dir
);
2257 if (mkdir (dir
) != 0)
2259 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2261 report_file_error ("Creating directory", list1 (directory
));
2266 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2267 Sdelete_directory_internal
, 1, 1, 0,
2268 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2269 (Lisp_Object directory
)
2272 Lisp_Object encoded_dir
;
2274 CHECK_STRING (directory
);
2275 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2276 encoded_dir
= ENCODE_FILE (directory
);
2277 dir
= SSDATA (encoded_dir
);
2279 if (rmdir (dir
) != 0)
2280 report_file_error ("Removing directory", list1 (directory
));
2285 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2286 "(list (read-file-name \
2287 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2288 \"Move file to trash: \" \"Delete file: \") \
2289 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2290 (null current-prefix-arg))",
2291 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2292 If file has multiple names, it continues to exist with the other names.
2293 TRASH non-nil means to trash the file instead of deleting, provided
2294 `delete-by-moving-to-trash' is non-nil.
2296 When called interactively, TRASH is t if no prefix argument is given.
2297 With a prefix argument, TRASH is nil. */)
2298 (Lisp_Object filename
, Lisp_Object trash
)
2300 Lisp_Object handler
;
2301 Lisp_Object encoded_file
;
2302 struct gcpro gcpro1
;
2305 if (!NILP (Ffile_directory_p (filename
))
2306 && NILP (Ffile_symlink_p (filename
)))
2307 xsignal2 (Qfile_error
,
2308 build_string ("Removing old name: is a directory"),
2311 filename
= Fexpand_file_name (filename
, Qnil
);
2313 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2314 if (!NILP (handler
))
2315 return call3 (handler
, Qdelete_file
, filename
, trash
);
2317 if (delete_by_moving_to_trash
&& !NILP (trash
))
2318 return call1 (Qmove_file_to_trash
, filename
);
2320 encoded_file
= ENCODE_FILE (filename
);
2322 if (unlink (SSDATA (encoded_file
)) < 0)
2323 report_file_error ("Removing old name", list1 (filename
));
2328 internal_delete_file_1 (Lisp_Object ignore
)
2333 /* Delete file FILENAME, returning true if successful.
2334 This ignores `delete-by-moving-to-trash'. */
2337 internal_delete_file (Lisp_Object filename
)
2341 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2342 Qt
, internal_delete_file_1
);
2346 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2347 "fRename file: \nGRename %s to file: \np",
2348 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2349 If file has names other than FILE, it continues to have those names.
2350 Signals a `file-already-exists' error if a file NEWNAME already exists
2351 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2352 A number as third arg means request confirmation if NEWNAME already exists.
2353 This is what happens in interactive use with M-x. */)
2354 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2356 Lisp_Object handler
;
2357 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2358 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2360 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2361 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2362 CHECK_STRING (file
);
2363 CHECK_STRING (newname
);
2364 file
= Fexpand_file_name (file
, Qnil
);
2366 if ((!NILP (Ffile_directory_p (newname
)))
2368 /* If the file names are identical but for the case,
2369 don't attempt to move directory to itself. */
2370 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2374 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2375 ? file
: Fdirectory_file_name (file
));
2376 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2379 newname
= Fexpand_file_name (newname
, Qnil
);
2381 /* If the file name has special constructs in it,
2382 call the corresponding file handler. */
2383 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2385 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2386 if (!NILP (handler
))
2387 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2388 file
, newname
, ok_if_already_exists
));
2390 encoded_file
= ENCODE_FILE (file
);
2391 encoded_newname
= ENCODE_FILE (newname
);
2394 /* If the file names are identical but for the case, don't ask for
2395 confirmation: they simply want to change the letter-case of the
2397 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2399 if (NILP (ok_if_already_exists
)
2400 || INTEGERP (ok_if_already_exists
))
2401 barf_or_query_if_file_exists (newname
, "rename to it",
2402 INTEGERP (ok_if_already_exists
), 0, 0);
2403 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2408 symlink_target
= Ffile_symlink_p (file
);
2409 if (! NILP (symlink_target
))
2410 Fmake_symbolic_link (symlink_target
, newname
,
2411 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2412 else if (!NILP (Ffile_directory_p (file
)))
2413 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2415 /* We have already prompted if it was an integer, so don't
2416 have copy-file prompt again. */
2417 Fcopy_file (file
, newname
,
2418 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2421 count
= SPECPDL_INDEX ();
2422 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2424 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2425 call2 (Qdelete_directory
, file
, Qt
);
2427 Fdelete_file (file
, Qnil
);
2428 unbind_to (count
, Qnil
);
2431 report_file_error ("Renaming", list2 (file
, newname
));
2437 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2438 "fAdd name to file: \nGName to add to %s: \np",
2439 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2440 Signals a `file-already-exists' error if a file NEWNAME already exists
2441 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2442 A number as third arg means request confirmation if NEWNAME already exists.
2443 This is what happens in interactive use with M-x. */)
2444 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2446 Lisp_Object handler
;
2447 Lisp_Object encoded_file
, encoded_newname
;
2448 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2450 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2451 encoded_file
= encoded_newname
= Qnil
;
2452 CHECK_STRING (file
);
2453 CHECK_STRING (newname
);
2454 file
= Fexpand_file_name (file
, Qnil
);
2456 if (!NILP (Ffile_directory_p (newname
)))
2457 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2459 newname
= Fexpand_file_name (newname
, Qnil
);
2461 /* If the file name has special constructs in it,
2462 call the corresponding file handler. */
2463 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2464 if (!NILP (handler
))
2465 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2466 newname
, ok_if_already_exists
));
2468 /* If the new name has special constructs in it,
2469 call the corresponding file handler. */
2470 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2471 if (!NILP (handler
))
2472 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2473 newname
, ok_if_already_exists
));
2475 encoded_file
= ENCODE_FILE (file
);
2476 encoded_newname
= ENCODE_FILE (newname
);
2478 if (NILP (ok_if_already_exists
)
2479 || INTEGERP (ok_if_already_exists
))
2480 barf_or_query_if_file_exists (newname
, "make it a new name",
2481 INTEGERP (ok_if_already_exists
), 0, 0);
2483 unlink (SSDATA (newname
));
2484 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2485 report_file_error ("Adding new name", list2 (file
, newname
));
2491 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2492 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2493 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2494 Both args must be strings.
2495 Signals a `file-already-exists' error if a file LINKNAME already exists
2496 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2497 A number as third arg means request confirmation if LINKNAME already exists.
2498 This happens for interactive use with M-x. */)
2499 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2501 Lisp_Object handler
;
2502 Lisp_Object encoded_filename
, encoded_linkname
;
2503 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2505 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2506 encoded_filename
= encoded_linkname
= Qnil
;
2507 CHECK_STRING (filename
);
2508 CHECK_STRING (linkname
);
2509 /* If the link target has a ~, we must expand it to get
2510 a truly valid file name. Otherwise, do not expand;
2511 we want to permit links to relative file names. */
2512 if (SREF (filename
, 0) == '~')
2513 filename
= Fexpand_file_name (filename
, Qnil
);
2515 if (!NILP (Ffile_directory_p (linkname
)))
2516 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2518 linkname
= Fexpand_file_name (linkname
, Qnil
);
2520 /* If the file name has special constructs in it,
2521 call the corresponding file handler. */
2522 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2523 if (!NILP (handler
))
2524 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2525 linkname
, ok_if_already_exists
));
2527 /* If the new link name has special constructs in it,
2528 call the corresponding file handler. */
2529 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2530 if (!NILP (handler
))
2531 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2532 linkname
, ok_if_already_exists
));
2534 encoded_filename
= ENCODE_FILE (filename
);
2535 encoded_linkname
= ENCODE_FILE (linkname
);
2537 if (NILP (ok_if_already_exists
)
2538 || INTEGERP (ok_if_already_exists
))
2539 barf_or_query_if_file_exists (linkname
, "make it a link",
2540 INTEGERP (ok_if_already_exists
), 0, 0);
2541 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2543 /* If we didn't complain already, silently delete existing file. */
2544 if (errno
== EEXIST
)
2546 unlink (SSDATA (encoded_linkname
));
2547 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2554 if (errno
== ENOSYS
)
2557 xsignal1 (Qfile_error
,
2558 build_string ("Symbolic links are not supported"));
2561 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2568 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2570 doc
: /* Return t if file FILENAME specifies an absolute file name.
2571 On Unix, this is a name starting with a `/' or a `~'. */)
2572 (Lisp_Object filename
)
2574 CHECK_STRING (filename
);
2575 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2578 /* Return true if FILENAME exists. */
2580 check_existing (const char *filename
)
2582 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2585 /* Return true if file FILENAME exists and can be executed. */
2588 check_executable (char *filename
)
2590 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2593 /* Return true if file FILENAME exists and can be accessed
2594 according to AMODE, which should include W_OK.
2595 On failure, return false and set errno. */
2598 check_writable (const char *filename
, int amode
)
2601 /* FIXME: an faccessat implementation should be added to the
2602 DOS/Windows ports and this #ifdef branch should be removed. */
2604 if (stat (filename
, &st
) < 0)
2607 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2608 #else /* not MSDOS */
2609 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2611 /* faccessat may have returned failure because Cygwin couldn't
2612 determine the file's UID or GID; if so, we return success. */
2615 int faccessat_errno
= errno
;
2617 if (stat (filename
, &st
) < 0)
2619 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2620 errno
= faccessat_errno
;
2624 #endif /* not MSDOS */
2627 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2628 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2629 See also `file-readable-p' and `file-attributes'.
2630 This returns nil for a symlink to a nonexistent file.
2631 Use `file-symlink-p' to test for such links. */)
2632 (Lisp_Object filename
)
2634 Lisp_Object absname
;
2635 Lisp_Object handler
;
2637 CHECK_STRING (filename
);
2638 absname
= Fexpand_file_name (filename
, Qnil
);
2640 /* If the file name has special constructs in it,
2641 call the corresponding file handler. */
2642 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2643 if (!NILP (handler
))
2644 return call2 (handler
, Qfile_exists_p
, absname
);
2646 absname
= ENCODE_FILE (absname
);
2648 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2651 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2652 doc
: /* Return t if FILENAME can be executed by you.
2653 For a directory, this means you can access files in that directory. */)
2654 (Lisp_Object filename
)
2656 Lisp_Object absname
;
2657 Lisp_Object handler
;
2659 CHECK_STRING (filename
);
2660 absname
= Fexpand_file_name (filename
, Qnil
);
2662 /* If the file name has special constructs in it,
2663 call the corresponding file handler. */
2664 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2665 if (!NILP (handler
))
2666 return call2 (handler
, Qfile_executable_p
, absname
);
2668 absname
= ENCODE_FILE (absname
);
2670 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2673 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2674 doc
: /* Return t if file FILENAME exists and you can read it.
2675 See also `file-exists-p' and `file-attributes'. */)
2676 (Lisp_Object filename
)
2678 Lisp_Object absname
;
2679 Lisp_Object handler
;
2681 CHECK_STRING (filename
);
2682 absname
= Fexpand_file_name (filename
, Qnil
);
2684 /* If the file name has special constructs in it,
2685 call the corresponding file handler. */
2686 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2687 if (!NILP (handler
))
2688 return call2 (handler
, Qfile_readable_p
, absname
);
2690 absname
= ENCODE_FILE (absname
);
2691 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2695 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2696 doc
: /* Return t if file FILENAME can be written or created by you. */)
2697 (Lisp_Object filename
)
2699 Lisp_Object absname
, dir
, encoded
;
2700 Lisp_Object handler
;
2702 CHECK_STRING (filename
);
2703 absname
= Fexpand_file_name (filename
, Qnil
);
2705 /* If the file name has special constructs in it,
2706 call the corresponding file handler. */
2707 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2708 if (!NILP (handler
))
2709 return call2 (handler
, Qfile_writable_p
, absname
);
2711 encoded
= ENCODE_FILE (absname
);
2712 if (check_writable (SSDATA (encoded
), W_OK
))
2714 if (errno
!= ENOENT
)
2717 dir
= Ffile_name_directory (absname
);
2718 eassert (!NILP (dir
));
2720 dir
= Fdirectory_file_name (dir
);
2723 dir
= ENCODE_FILE (dir
);
2725 /* The read-only attribute of the parent directory doesn't affect
2726 whether a file or directory can be created within it. Some day we
2727 should check ACLs though, which do affect this. */
2728 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2730 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2734 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2735 doc
: /* Access file FILENAME, and get an error if that does not work.
2736 The second argument STRING is used in the error message.
2737 If there is no error, returns nil. */)
2738 (Lisp_Object filename
, Lisp_Object string
)
2740 Lisp_Object handler
, encoded_filename
, absname
;
2743 CHECK_STRING (filename
);
2744 absname
= Fexpand_file_name (filename
, Qnil
);
2746 CHECK_STRING (string
);
2748 /* If the file name has special constructs in it,
2749 call the corresponding file handler. */
2750 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2751 if (!NILP (handler
))
2752 return call3 (handler
, Qaccess_file
, absname
, string
);
2754 encoded_filename
= ENCODE_FILE (absname
);
2756 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2758 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2764 /* Relative to directory FD, return the symbolic link value of FILENAME.
2765 On failure, return nil. */
2767 emacs_readlinkat (int fd
, char const *filename
)
2769 static struct allocator
const emacs_norealloc_allocator
=
2770 { xmalloc
, NULL
, xfree
, memory_full
};
2772 char readlink_buf
[1024];
2773 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2774 &emacs_norealloc_allocator
, readlinkat
);
2778 val
= build_string (buf
);
2779 if (buf
[0] == '/' && strchr (buf
, ':'))
2780 val
= concat2 (build_string ("/:"), val
);
2781 if (buf
!= readlink_buf
)
2783 val
= DECODE_FILE (val
);
2787 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2788 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2789 The value is the link target, as a string.
2790 Otherwise it returns nil.
2792 This function returns t when given the name of a symlink that
2793 points to a nonexistent file. */)
2794 (Lisp_Object filename
)
2796 Lisp_Object handler
;
2798 CHECK_STRING (filename
);
2799 filename
= Fexpand_file_name (filename
, Qnil
);
2801 /* If the file name has special constructs in it,
2802 call the corresponding file handler. */
2803 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2804 if (!NILP (handler
))
2805 return call2 (handler
, Qfile_symlink_p
, filename
);
2807 filename
= ENCODE_FILE (filename
);
2809 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2812 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2813 doc
: /* Return t if FILENAME names an existing directory.
2814 Symbolic links to directories count as directories.
2815 See `file-symlink-p' to distinguish symlinks. */)
2816 (Lisp_Object filename
)
2818 Lisp_Object absname
;
2819 Lisp_Object handler
;
2821 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2823 /* If the file name has special constructs in it,
2824 call the corresponding file handler. */
2825 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2826 if (!NILP (handler
))
2827 return call2 (handler
, Qfile_directory_p
, absname
);
2829 absname
= ENCODE_FILE (absname
);
2831 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2834 /* Return true if FILE is a directory or a symlink to a directory. */
2836 file_directory_p (char const *file
)
2839 /* This is cheaper than 'stat'. */
2840 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2843 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2847 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2848 Sfile_accessible_directory_p
, 1, 1, 0,
2849 doc
: /* Return t if file FILENAME names a directory you can open.
2850 For the value to be t, FILENAME must specify the name of a directory as a file,
2851 and the directory must allow you to open files in it. In order to use a
2852 directory as a buffer's current directory, this predicate must return true.
2853 A directory name spec may be given instead; then the value is t
2854 if the directory so specified exists and really is a readable and
2855 searchable directory. */)
2856 (Lisp_Object filename
)
2858 Lisp_Object absname
;
2859 Lisp_Object handler
;
2861 CHECK_STRING (filename
);
2862 absname
= Fexpand_file_name (filename
, Qnil
);
2864 /* If the file name has special constructs in it,
2865 call the corresponding file handler. */
2866 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2867 if (!NILP (handler
))
2868 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2870 absname
= ENCODE_FILE (absname
);
2871 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2874 /* If FILE is a searchable directory or a symlink to a
2875 searchable directory, return true. Otherwise return
2876 false and set errno to an error number. */
2878 file_accessible_directory_p (char const *file
)
2881 /* There's no need to test whether FILE is searchable, as the
2882 searchable/executable bit is invented on DOS_NT platforms. */
2883 return file_directory_p (file
);
2885 /* On POSIXish platforms, use just one system call; this avoids a
2886 race and is typically faster. */
2887 ptrdiff_t len
= strlen (file
);
2893 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2894 There are three exceptions: "", "/", and "//". Leave "" alone,
2895 as it's invalid. Append only "." to the other two exceptions as
2896 "/" and "//" are distinct on some platforms, whereas "/", "///",
2897 "////", etc. are all equivalent. */
2902 /* Just check for trailing '/' when deciding whether to append '/'.
2903 That's simpler than testing the two special cases "/" and "//",
2904 and it's a safe optimization here. */
2905 char *buf
= SAFE_ALLOCA (len
+ 3);
2906 memcpy (buf
, file
, len
);
2907 strcpy (buf
+ len
, "/." + (file
[len
- 1] == '/'));
2911 ok
= check_existing (dir
);
2912 saved_errno
= errno
;
2914 errno
= saved_errno
;
2919 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2920 doc
: /* Return t if FILENAME names a regular file.
2921 This is the sort of file that holds an ordinary stream of data bytes.
2922 Symbolic links to regular files count as regular files.
2923 See `file-symlink-p' to distinguish symlinks. */)
2924 (Lisp_Object filename
)
2926 register Lisp_Object absname
;
2928 Lisp_Object handler
;
2930 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2932 /* If the file name has special constructs in it,
2933 call the corresponding file handler. */
2934 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2935 if (!NILP (handler
))
2936 return call2 (handler
, Qfile_regular_p
, absname
);
2938 absname
= ENCODE_FILE (absname
);
2943 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2945 /* Tell stat to use expensive method to get accurate info. */
2946 Vw32_get_true_file_attributes
= Qt
;
2947 result
= stat (SDATA (absname
), &st
);
2948 Vw32_get_true_file_attributes
= tem
;
2952 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2955 if (stat (SSDATA (absname
), &st
) < 0)
2957 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2961 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2962 Sfile_selinux_context
, 1, 1, 0,
2963 doc
: /* Return SELinux context of file named FILENAME.
2964 The return value is a list (USER ROLE TYPE RANGE), where the list
2965 elements are strings naming the user, role, type, and range of the
2966 file's SELinux security context.
2968 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2969 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2970 (Lisp_Object filename
)
2972 Lisp_Object absname
;
2973 Lisp_Object values
[4];
2974 Lisp_Object handler
;
2976 security_context_t con
;
2981 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2983 /* If the file name has special constructs in it,
2984 call the corresponding file handler. */
2985 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2986 if (!NILP (handler
))
2987 return call2 (handler
, Qfile_selinux_context
, absname
);
2989 absname
= ENCODE_FILE (absname
);
2996 if (is_selinux_enabled ())
2998 conlength
= lgetfilecon (SSDATA (absname
), &con
);
3001 context
= context_new (con
);
3002 if (context_user_get (context
))
3003 values
[0] = build_string (context_user_get (context
));
3004 if (context_role_get (context
))
3005 values
[1] = build_string (context_role_get (context
));
3006 if (context_type_get (context
))
3007 values
[2] = build_string (context_type_get (context
));
3008 if (context_range_get (context
))
3009 values
[3] = build_string (context_range_get (context
));
3010 context_free (context
);
3016 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
3019 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
3020 Sset_file_selinux_context
, 2, 2, 0,
3021 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
3022 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
3023 elements are strings naming the components of a SELinux context.
3025 Value is t if setting of SELinux context was successful, nil otherwise.
3027 This function does nothing and returns nil if SELinux is disabled,
3028 or if Emacs was not compiled with SELinux support. */)
3029 (Lisp_Object filename
, Lisp_Object context
)
3031 Lisp_Object absname
;
3032 Lisp_Object handler
;
3034 Lisp_Object encoded_absname
;
3035 Lisp_Object user
= CAR_SAFE (context
);
3036 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
3037 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
3038 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
3039 security_context_t con
;
3042 context_t parsed_con
;
3045 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3047 /* If the file name has special constructs in it,
3048 call the corresponding file handler. */
3049 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
3050 if (!NILP (handler
))
3051 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
3054 if (is_selinux_enabled ())
3056 /* Get current file context. */
3057 encoded_absname
= ENCODE_FILE (absname
);
3058 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
3061 parsed_con
= context_new (con
);
3062 /* Change the parts defined in the parameter.*/
3065 if (context_user_set (parsed_con
, SSDATA (user
)))
3066 error ("Doing context_user_set");
3070 if (context_role_set (parsed_con
, SSDATA (role
)))
3071 error ("Doing context_role_set");
3075 if (context_type_set (parsed_con
, SSDATA (type
)))
3076 error ("Doing context_type_set");
3078 if (STRINGP (range
))
3080 if (context_range_set (parsed_con
, SSDATA (range
)))
3081 error ("Doing context_range_set");
3084 /* Set the modified context back to the file. */
3085 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3086 context_str (parsed_con
))
3088 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3089 if (fail
&& errno
!= ENOTSUP
)
3090 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
3092 context_free (parsed_con
);
3094 return fail
? Qnil
: Qt
;
3097 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
3104 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3105 doc
: /* Return ACL entries of file named FILENAME.
3106 The entries are returned in a format suitable for use in `set-file-acl'
3107 but is otherwise undocumented and subject to change.
3108 Return nil if file does not exist or is not accessible, or if Emacs
3109 was unable to determine the ACL entries. */)
3110 (Lisp_Object filename
)
3112 Lisp_Object absname
;
3113 Lisp_Object handler
;
3114 #ifdef HAVE_POSIX_ACL
3116 Lisp_Object acl_string
;
3120 absname
= expand_and_dir_to_file (filename
,
3121 BVAR (current_buffer
, directory
));
3123 /* If the file name has special constructs in it,
3124 call the corresponding file handler. */
3125 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3126 if (!NILP (handler
))
3127 return call2 (handler
, Qfile_acl
, absname
);
3129 #ifdef HAVE_POSIX_ACL
3130 absname
= ENCODE_FILE (absname
);
3132 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3136 str
= acl_to_text (acl
, NULL
);
3143 acl_string
= build_string (str
);
3153 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3155 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3156 ACL-STRING should contain the textual representation of the ACL
3157 entries in a format suitable for the platform.
3159 Value is t if setting of ACL was successful, nil otherwise.
3161 Setting ACL for local files requires Emacs to be built with ACL
3163 (Lisp_Object filename
, Lisp_Object acl_string
)
3165 Lisp_Object absname
;
3166 Lisp_Object handler
;
3167 #ifdef HAVE_POSIX_ACL
3168 Lisp_Object encoded_absname
;
3173 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3175 /* If the file name has special constructs in it,
3176 call the corresponding file handler. */
3177 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3178 if (!NILP (handler
))
3179 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3181 #ifdef HAVE_POSIX_ACL
3182 if (STRINGP (acl_string
))
3184 acl
= acl_from_text (SSDATA (acl_string
));
3187 report_file_error ("Converting ACL", Fcons (absname
, Qnil
));
3191 encoded_absname
= ENCODE_FILE (absname
);
3193 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3196 if (fail
&& !ACL_NOT_WELL_SUPPORTED (errno
))
3197 report_file_error ("Setting ACL", Fcons (absname
, Qnil
));
3200 return fail
? Qnil
: Qt
;
3207 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3208 doc
: /* Return mode bits of file named FILENAME, as an integer.
3209 Return nil, if file does not exist or is not accessible. */)
3210 (Lisp_Object filename
)
3212 Lisp_Object absname
;
3214 Lisp_Object handler
;
3216 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3218 /* If the file name has special constructs in it,
3219 call the corresponding file handler. */
3220 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3221 if (!NILP (handler
))
3222 return call2 (handler
, Qfile_modes
, absname
);
3224 absname
= ENCODE_FILE (absname
);
3226 if (stat (SSDATA (absname
), &st
) < 0)
3229 return make_number (st
.st_mode
& 07777);
3232 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3233 "(let ((file (read-file-name \"File: \"))) \
3234 (list file (read-file-modes nil file)))",
3235 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3236 Only the 12 low bits of MODE are used.
3238 Interactively, mode bits are read by `read-file-modes', which accepts
3239 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3240 (Lisp_Object filename
, Lisp_Object mode
)
3242 Lisp_Object absname
, encoded_absname
;
3243 Lisp_Object handler
;
3245 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3246 CHECK_NUMBER (mode
);
3248 /* If the file name has special constructs in it,
3249 call the corresponding file handler. */
3250 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3251 if (!NILP (handler
))
3252 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3254 encoded_absname
= ENCODE_FILE (absname
);
3256 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3257 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3262 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3263 doc
: /* Set the file permission bits for newly created files.
3264 The argument MODE should be an integer; only the low 9 bits are used.
3265 This setting is inherited by subprocesses. */)
3268 CHECK_NUMBER (mode
);
3270 umask ((~ XINT (mode
)) & 0777);
3275 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3276 doc
: /* Return the default file protection for created files.
3277 The value is an integer. */)
3284 realmask
= umask (0);
3288 XSETINT (value
, (~ realmask
) & 0777);
3293 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3294 doc
: /* Set times of file FILENAME to TIMESTAMP.
3295 Set both access and modification times.
3296 Return t on success, else nil.
3297 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3299 (Lisp_Object filename
, Lisp_Object timestamp
)
3301 Lisp_Object absname
, encoded_absname
;
3302 Lisp_Object handler
;
3303 EMACS_TIME t
= lisp_time_argument (timestamp
);
3305 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3307 /* If the file name has special constructs in it,
3308 call the corresponding file handler. */
3309 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3310 if (!NILP (handler
))
3311 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3313 encoded_absname
= ENCODE_FILE (absname
);
3316 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3319 /* Setting times on a directory always fails. */
3320 if (file_directory_p (SSDATA (encoded_absname
)))
3323 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3331 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3332 doc
: /* Tell Unix to finish all pending disk updates. */)
3339 #endif /* HAVE_SYNC */
3341 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3342 doc
: /* Return t if file FILE1 is newer than file FILE2.
3343 If FILE1 does not exist, the answer is nil;
3344 otherwise, if FILE2 does not exist, the answer is t. */)
3345 (Lisp_Object file1
, Lisp_Object file2
)
3347 Lisp_Object absname1
, absname2
;
3348 struct stat st1
, st2
;
3349 Lisp_Object handler
;
3350 struct gcpro gcpro1
, gcpro2
;
3352 CHECK_STRING (file1
);
3353 CHECK_STRING (file2
);
3356 GCPRO2 (absname1
, file2
);
3357 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3358 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3361 /* If the file name has special constructs in it,
3362 call the corresponding file handler. */
3363 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3365 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3366 if (!NILP (handler
))
3367 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3369 GCPRO2 (absname1
, absname2
);
3370 absname1
= ENCODE_FILE (absname1
);
3371 absname2
= ENCODE_FILE (absname2
);
3374 if (stat (SSDATA (absname1
), &st1
) < 0)
3377 if (stat (SSDATA (absname2
), &st2
) < 0)
3380 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3384 #ifndef READ_BUF_SIZE
3385 #define READ_BUF_SIZE (64 << 10)
3387 /* Some buffer offsets are stored in 'int' variables. */
3388 verify (READ_BUF_SIZE
<= INT_MAX
);
3390 /* This function is called after Lisp functions to decide a coding
3391 system are called, or when they cause an error. Before they are
3392 called, the current buffer is set unibyte and it contains only a
3393 newly inserted text (thus the buffer was empty before the
3396 The functions may set markers, overlays, text properties, or even
3397 alter the buffer contents, change the current buffer.
3399 Here, we reset all those changes by:
3400 o set back the current buffer.
3401 o move all markers and overlays to BEG.
3402 o remove all text properties.
3403 o set back the buffer multibyteness. */
3406 decide_coding_unwind (Lisp_Object unwind_data
)
3408 Lisp_Object multibyte
, undo_list
, buffer
;
3410 multibyte
= XCAR (unwind_data
);
3411 unwind_data
= XCDR (unwind_data
);
3412 undo_list
= XCAR (unwind_data
);
3413 buffer
= XCDR (unwind_data
);
3415 set_buffer_internal (XBUFFER (buffer
));
3416 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3417 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3418 set_buffer_intervals (current_buffer
, NULL
);
3419 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3421 /* Now we are safe to change the buffer's multibyteness directly. */
3422 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3423 bset_undo_list (current_buffer
, undo_list
);
3428 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3429 object where slot 0 is the file descriptor, slot 1 specifies
3430 an offset to put the read bytes, and slot 2 is the maximum
3431 amount of bytes to read. Value is the number of bytes read. */
3434 read_non_regular (Lisp_Object state
)
3440 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3441 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3442 + XSAVE_INTEGER (state
, 1)),
3443 XSAVE_INTEGER (state
, 2));
3445 /* Fast recycle this object for the likely next call. */
3447 return make_number (nbytes
);
3451 /* Condition-case handler used when reading from non-regular files
3452 in insert-file-contents. */
3455 read_non_regular_quit (Lisp_Object ignore
)
3460 /* Return the file offset that VAL represents, checking for type
3461 errors and overflow. */
3463 file_offset (Lisp_Object val
)
3465 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3470 double v
= XFLOAT_DATA (val
);
3472 && (sizeof (off_t
) < sizeof v
3473 ? v
<= TYPE_MAXIMUM (off_t
)
3474 : v
< TYPE_MAXIMUM (off_t
)))
3478 wrong_type_argument (intern ("file-offset"), val
);
3481 /* Return a special time value indicating the error number ERRNUM. */
3483 time_error_value (int errnum
)
3485 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3486 ? NONEXISTENT_MODTIME_NSECS
3487 : UNKNOWN_MODTIME_NSECS
);
3488 return make_emacs_time (0, ns
);
3491 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3493 doc
: /* Insert contents of file FILENAME after point.
3494 Returns list of absolute file name and number of characters inserted.
3495 If second argument VISIT is non-nil, the buffer's visited filename and
3496 last save file modtime are set, and it is marked unmodified. If
3497 visiting and the file does not exist, visiting is completed before the
3500 The optional third and fourth arguments BEG and END specify what portion
3501 of the file to insert. These arguments count bytes in the file, not
3502 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3504 If optional fifth argument REPLACE is non-nil, replace the current
3505 buffer contents (in the accessible portion) with the file contents.
3506 This is better than simply deleting and inserting the whole thing
3507 because (1) it preserves some marker positions and (2) it puts less data
3508 in the undo list. When REPLACE is non-nil, the second return value is
3509 the number of characters that replace previous buffer contents.
3511 This function does code conversion according to the value of
3512 `coding-system-for-read' or `file-coding-system-alist', and sets the
3513 variable `last-coding-system-used' to the coding system actually used.
3515 In addition, this function decodes the inserted text from known formats
3516 by calling `format-decode', which see. */)
3517 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3522 ptrdiff_t inserted
= 0;
3525 off_t beg_offset
, end_offset
;
3527 ptrdiff_t count
= SPECPDL_INDEX ();
3528 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3529 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3531 ptrdiff_t total
= 0;
3532 bool not_regular
= 0;
3534 char read_buf
[READ_BUF_SIZE
];
3535 struct coding_system coding
;
3536 bool replace_handled
= 0;
3537 bool set_coding_system
= 0;
3538 Lisp_Object coding_system
;
3540 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3541 bool we_locked_file
= 0;
3542 bool deferred_remove_unwind_protect
= 0;
3544 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3545 error ("Cannot do file visiting in an indirect buffer");
3547 if (!NILP (BVAR (current_buffer
, read_only
)))
3548 Fbarf_if_buffer_read_only ();
3552 orig_filename
= Qnil
;
3555 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3557 CHECK_STRING (filename
);
3558 filename
= Fexpand_file_name (filename
, Qnil
);
3560 /* The value Qnil means that the coding system is not yet
3562 coding_system
= Qnil
;
3564 /* If the file name has special constructs in it,
3565 call the corresponding file handler. */
3566 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3567 if (!NILP (handler
))
3569 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3570 visit
, beg
, end
, replace
);
3571 if (CONSP (val
) && CONSP (XCDR (val
))
3572 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3573 inserted
= XINT (XCAR (XCDR (val
)));
3577 orig_filename
= filename
;
3578 filename
= ENCODE_FILE (filename
);
3580 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3585 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3586 mtime
= time_error_value (save_errno
);
3588 if (!NILP (Vcoding_system_for_read
))
3589 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3593 /* Replacement should preserve point as it preserves markers. */
3594 if (!NILP (replace
))
3595 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3597 record_unwind_protect (close_file_unwind
, make_number (fd
));
3599 if (fstat (fd
, &st
) != 0)
3600 report_file_error ("Input file status", Fcons (orig_filename
, Qnil
));
3601 mtime
= get_stat_mtime (&st
);
3603 /* This code will need to be changed in order to work on named
3604 pipes, and it's probably just not worth it. So we should at
3605 least signal an error. */
3606 if (!S_ISREG (st
.st_mode
))
3613 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3614 xsignal2 (Qfile_error
,
3615 build_string ("not a regular file"), orig_filename
);
3620 if (!NILP (beg
) || !NILP (end
))
3621 error ("Attempt to visit less than an entire file");
3622 if (BEG
< Z
&& NILP (replace
))
3623 error ("Cannot do file visiting in a non-empty buffer");
3627 beg_offset
= file_offset (beg
);
3632 end_offset
= file_offset (end
);
3636 end_offset
= TYPE_MAXIMUM (off_t
);
3639 end_offset
= st
.st_size
;
3641 /* A negative size can happen on a platform that allows file
3642 sizes greater than the maximum off_t value. */
3646 /* The file size returned from stat may be zero, but data
3647 may be readable nonetheless, for example when this is a
3648 file in the /proc filesystem. */
3649 if (end_offset
== 0)
3650 end_offset
= READ_BUF_SIZE
;
3654 /* Check now whether the buffer will become too large,
3655 in the likely case where the file's length is not changing.
3656 This saves a lot of needless work before a buffer overflow. */
3659 /* The likely offset where we will stop reading. We could read
3660 more (or less), if the file grows (or shrinks) as we read it. */
3661 off_t likely_end
= min (end_offset
, st
.st_size
);
3663 if (beg_offset
< likely_end
)
3666 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3667 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3668 off_t likely_growth
= likely_end
- beg_offset
;
3669 if (buf_growth_max
< likely_growth
)
3674 /* Prevent redisplay optimizations. */
3675 current_buffer
->clip_changed
= 1;
3677 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3679 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3680 setup_coding_system (coding_system
, &coding
);
3681 /* Ensure we set Vlast_coding_system_used. */
3682 set_coding_system
= 1;
3686 /* Decide the coding system to use for reading the file now
3687 because we can't use an optimized method for handling
3688 `coding:' tag if the current buffer is not empty. */
3689 if (!NILP (Vcoding_system_for_read
))
3690 coding_system
= Vcoding_system_for_read
;
3693 /* Don't try looking inside a file for a coding system
3694 specification if it is not seekable. */
3695 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3697 /* Find a coding system specified in the heading two
3698 lines or in the tailing several lines of the file.
3699 We assume that the 1K-byte and 3K-byte for heading
3700 and tailing respectively are sufficient for this
3704 if (st
.st_size
<= (1024 * 4))
3705 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3708 nread
= emacs_read (fd
, read_buf
, 1024);
3712 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3713 report_file_error ("Setting file position",
3714 Fcons (orig_filename
, Qnil
));
3715 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3716 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3721 error ("IO error reading %s: %s",
3722 SDATA (orig_filename
), emacs_strerror (errno
));
3725 struct buffer
*prev
= current_buffer
;
3726 Lisp_Object workbuf
;
3729 record_unwind_current_buffer ();
3731 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3732 buf
= XBUFFER (workbuf
);
3734 delete_all_overlays (buf
);
3735 bset_directory (buf
, BVAR (current_buffer
, directory
));
3736 bset_read_only (buf
, Qnil
);
3737 bset_filename (buf
, Qnil
);
3738 bset_undo_list (buf
, Qt
);
3739 eassert (buf
->overlays_before
== NULL
);
3740 eassert (buf
->overlays_after
== NULL
);
3742 set_buffer_internal (buf
);
3744 bset_enable_multibyte_characters (buf
, Qnil
);
3746 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3747 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3748 coding_system
= call2 (Vset_auto_coding_function
,
3749 filename
, make_number (nread
));
3750 set_buffer_internal (prev
);
3752 /* Discard the unwind protect for recovering the
3756 /* Rewind the file for the actual read done later. */
3757 if (lseek (fd
, 0, SEEK_SET
) < 0)
3758 report_file_error ("Setting file position",
3759 Fcons (orig_filename
, Qnil
));
3763 if (NILP (coding_system
))
3765 /* If we have not yet decided a coding system, check
3766 file-coding-system-alist. */
3767 Lisp_Object args
[6];
3769 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3770 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3771 coding_system
= Ffind_operation_coding_system (6, args
);
3772 if (CONSP (coding_system
))
3773 coding_system
= XCAR (coding_system
);
3777 if (NILP (coding_system
))
3778 coding_system
= Qundecided
;
3780 CHECK_CODING_SYSTEM (coding_system
);
3782 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3783 /* We must suppress all character code conversion except for
3784 end-of-line conversion. */
3785 coding_system
= raw_text_coding_system (coding_system
);
3787 setup_coding_system (coding_system
, &coding
);
3788 /* Ensure we set Vlast_coding_system_used. */
3789 set_coding_system
= 1;
3792 /* If requested, replace the accessible part of the buffer
3793 with the file contents. Avoid replacing text at the
3794 beginning or end of the buffer that matches the file contents;
3795 that preserves markers pointing to the unchanged parts.
3797 Here we implement this feature in an optimized way
3798 for the case where code conversion is NOT needed.
3799 The following if-statement handles the case of conversion
3800 in a less optimal way.
3802 If the code conversion is "automatic" then we try using this
3803 method and hope for the best.
3804 But if we discover the need for conversion, we give up on this method
3805 and let the following if-statement handle the replace job. */
3808 && (NILP (coding_system
)
3809 || ! CODING_REQUIRE_DECODING (&coding
)))
3811 /* same_at_start and same_at_end count bytes,
3812 because file access counts bytes
3813 and BEG and END count bytes. */
3814 ptrdiff_t same_at_start
= BEGV_BYTE
;
3815 ptrdiff_t same_at_end
= ZV_BYTE
;
3817 /* There is still a possibility we will find the need to do code
3818 conversion. If that happens, set this variable to
3819 give up on handling REPLACE in the optimized way. */
3820 bool giveup_match_end
= 0;
3822 if (beg_offset
!= 0)
3824 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3825 report_file_error ("Setting file position",
3826 Fcons (orig_filename
, Qnil
));
3831 /* Count how many chars at the start of the file
3832 match the text at the beginning of the buffer. */
3837 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3839 error ("IO error reading %s: %s",
3840 SSDATA (orig_filename
), emacs_strerror (errno
));
3841 else if (nread
== 0)
3844 if (CODING_REQUIRE_DETECTION (&coding
))
3846 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3849 setup_coding_system (coding_system
, &coding
);
3852 if (CODING_REQUIRE_DECODING (&coding
))
3853 /* We found that the file should be decoded somehow.
3854 Let's give up here. */
3856 giveup_match_end
= 1;
3861 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3862 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3863 same_at_start
++, bufpos
++;
3864 /* If we found a discrepancy, stop the scan.
3865 Otherwise loop around and scan the next bufferful. */
3866 if (bufpos
!= nread
)
3870 /* If the file matches the buffer completely,
3871 there's no need to replace anything. */
3872 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3876 /* Truncate the buffer to the size of the file. */
3877 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3882 /* Count how many chars at the end of the file
3883 match the text at the end of the buffer. But, if we have
3884 already found that decoding is necessary, don't waste time. */
3885 while (!giveup_match_end
)
3887 int total_read
, nread
, bufpos
, trial
;
3890 /* At what file position are we now scanning? */
3891 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3892 /* If the entire file matches the buffer tail, stop the scan. */
3895 /* How much can we scan in the next step? */
3896 trial
= min (curpos
, sizeof read_buf
);
3897 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3898 report_file_error ("Setting file position",
3899 Fcons (orig_filename
, Qnil
));
3901 total_read
= nread
= 0;
3902 while (total_read
< trial
)
3904 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3906 error ("IO error reading %s: %s",
3907 SDATA (orig_filename
), emacs_strerror (errno
));
3908 else if (nread
== 0)
3910 total_read
+= nread
;
3913 /* Scan this bufferful from the end, comparing with
3914 the Emacs buffer. */
3915 bufpos
= total_read
;
3917 /* Compare with same_at_start to avoid counting some buffer text
3918 as matching both at the file's beginning and at the end. */
3919 while (bufpos
> 0 && same_at_end
> same_at_start
3920 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3921 same_at_end
--, bufpos
--;
3923 /* If we found a discrepancy, stop the scan.
3924 Otherwise loop around and scan the preceding bufferful. */
3927 /* If this discrepancy is because of code conversion,
3928 we cannot use this method; giveup and try the other. */
3929 if (same_at_end
> same_at_start
3930 && FETCH_BYTE (same_at_end
- 1) >= 0200
3931 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3932 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3933 giveup_match_end
= 1;
3942 if (! giveup_match_end
)
3946 /* We win! We can handle REPLACE the optimized way. */
3948 /* Extend the start of non-matching text area to multibyte
3949 character boundary. */
3950 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3951 while (same_at_start
> BEGV_BYTE
3952 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3955 /* Extend the end of non-matching text area to multibyte
3956 character boundary. */
3957 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3958 while (same_at_end
< ZV_BYTE
3959 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3962 /* Don't try to reuse the same piece of text twice. */
3963 overlap
= (same_at_start
- BEGV_BYTE
3965 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3967 same_at_end
+= overlap
;
3969 /* Arrange to read only the nonmatching middle part of the file. */
3970 beg_offset
+= same_at_start
- BEGV_BYTE
;
3971 end_offset
-= ZV_BYTE
- same_at_end
;
3973 del_range_byte (same_at_start
, same_at_end
, 0);
3974 /* Insert from the file at the proper position. */
3975 temp
= BYTE_TO_CHAR (same_at_start
);
3976 SET_PT_BOTH (temp
, same_at_start
);
3978 /* If display currently starts at beginning of line,
3979 keep it that way. */
3980 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3981 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3983 replace_handled
= 1;
3987 /* If requested, replace the accessible part of the buffer
3988 with the file contents. Avoid replacing text at the
3989 beginning or end of the buffer that matches the file contents;
3990 that preserves markers pointing to the unchanged parts.
3992 Here we implement this feature for the case where code conversion
3993 is needed, in a simple way that needs a lot of memory.
3994 The preceding if-statement handles the case of no conversion
3995 in a more optimized way. */
3996 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3998 ptrdiff_t same_at_start
= BEGV_BYTE
;
3999 ptrdiff_t same_at_end
= ZV_BYTE
;
4000 ptrdiff_t same_at_start_charpos
;
4001 ptrdiff_t inserted_chars
;
4004 unsigned char *decoded
;
4007 ptrdiff_t this_count
= SPECPDL_INDEX ();
4009 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4010 Lisp_Object conversion_buffer
;
4011 struct gcpro gcpro1
;
4013 conversion_buffer
= code_conversion_save (1, multibyte
);
4015 /* First read the whole file, performing code conversion into
4016 CONVERSION_BUFFER. */
4018 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4019 report_file_error ("Setting file position",
4020 Fcons (orig_filename
, Qnil
));
4022 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4023 unprocessed
= 0; /* Bytes not processed in previous loop. */
4025 GCPRO1 (conversion_buffer
);
4028 /* Read at most READ_BUF_SIZE bytes at a time, to allow
4029 quitting while reading a huge file. */
4031 /* Allow quitting out of the actual I/O. */
4034 this = emacs_read (fd
, read_buf
+ unprocessed
,
4035 READ_BUF_SIZE
- unprocessed
);
4041 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
4042 BUF_Z (XBUFFER (conversion_buffer
)));
4043 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4044 unprocessed
+ this, conversion_buffer
);
4045 unprocessed
= coding
.carryover_bytes
;
4046 if (coding
.carryover_bytes
> 0)
4047 memcpy (read_buf
, coding
.carryover
, unprocessed
);
4052 /* We should remove the unwind_protect calling
4053 close_file_unwind, but other stuff has been added the stack,
4054 so defer the removal till we reach the `handled' label. */
4055 deferred_remove_unwind_protect
= 1;
4058 error ("IO error reading %s: %s",
4059 SDATA (orig_filename
), emacs_strerror (errno
));
4061 if (unprocessed
> 0)
4063 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4064 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4065 unprocessed
, conversion_buffer
);
4066 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4069 coding_system
= CODING_ID_NAME (coding
.id
);
4070 set_coding_system
= 1;
4071 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4072 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4073 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4075 /* Compare the beginning of the converted string with the buffer
4079 while (bufpos
< inserted
&& same_at_start
< same_at_end
4080 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4081 same_at_start
++, bufpos
++;
4083 /* If the file matches the head of buffer completely,
4084 there's no need to replace anything. */
4086 if (bufpos
== inserted
)
4088 /* Truncate the buffer to the size of the file. */
4089 if (same_at_start
== same_at_end
)
4092 del_range_byte (same_at_start
, same_at_end
, 0);
4095 unbind_to (this_count
, Qnil
);
4099 /* Extend the start of non-matching text area to the previous
4100 multibyte character boundary. */
4101 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4102 while (same_at_start
> BEGV_BYTE
4103 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4106 /* Scan this bufferful from the end, comparing with
4107 the Emacs buffer. */
4110 /* Compare with same_at_start to avoid counting some buffer text
4111 as matching both at the file's beginning and at the end. */
4112 while (bufpos
> 0 && same_at_end
> same_at_start
4113 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4114 same_at_end
--, bufpos
--;
4116 /* Extend the end of non-matching text area to the next
4117 multibyte character boundary. */
4118 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4119 while (same_at_end
< ZV_BYTE
4120 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4123 /* Don't try to reuse the same piece of text twice. */
4124 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4126 same_at_end
+= overlap
;
4128 /* If display currently starts at beginning of line,
4129 keep it that way. */
4130 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4131 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4133 /* Replace the chars that we need to replace,
4134 and update INSERTED to equal the number of bytes
4135 we are taking from the decoded string. */
4136 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4138 if (same_at_end
!= same_at_start
)
4140 del_range_byte (same_at_start
, same_at_end
, 0);
4142 same_at_start
= GPT_BYTE
;
4146 temp
= BYTE_TO_CHAR (same_at_start
);
4148 /* Insert from the file at the proper position. */
4149 SET_PT_BOTH (temp
, same_at_start
);
4150 same_at_start_charpos
4151 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4152 same_at_start
- BEGV_BYTE
4153 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4155 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4156 same_at_start
+ inserted
- BEGV_BYTE
4157 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4158 - same_at_start_charpos
);
4159 /* This binding is to avoid ask-user-about-supersession-threat
4160 being called in insert_from_buffer (via in
4161 prepare_to_modify_buffer). */
4162 specbind (intern ("buffer-file-name"), Qnil
);
4163 insert_from_buffer (XBUFFER (conversion_buffer
),
4164 same_at_start_charpos
, inserted_chars
, 0);
4165 /* Set `inserted' to the number of inserted characters. */
4166 inserted
= PT
- temp
;
4167 /* Set point before the inserted characters. */
4168 SET_PT_BOTH (temp
, same_at_start
);
4170 unbind_to (this_count
, Qnil
);
4176 total
= end_offset
- beg_offset
;
4178 /* For a special file, all we can do is guess. */
4179 total
= READ_BUF_SIZE
;
4181 if (NILP (visit
) && total
> 0)
4183 #ifdef CLASH_DETECTION
4184 if (!NILP (BVAR (current_buffer
, file_truename
))
4185 /* Make binding buffer-file-name to nil effective. */
4186 && !NILP (BVAR (current_buffer
, filename
))
4187 && SAVE_MODIFF
>= MODIFF
)
4189 #endif /* CLASH_DETECTION */
4190 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4193 move_gap_both (PT
, PT_BYTE
);
4194 if (GAP_SIZE
< total
)
4195 make_gap (total
- GAP_SIZE
);
4197 if (beg_offset
!= 0 || !NILP (replace
))
4199 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4200 report_file_error ("Setting file position",
4201 Fcons (orig_filename
, Qnil
));
4204 /* In the following loop, HOW_MUCH contains the total bytes read so
4205 far for a regular file, and not changed for a special file. But,
4206 before exiting the loop, it is set to a negative value if I/O
4210 /* Total bytes inserted. */
4213 /* Here, we don't do code conversion in the loop. It is done by
4214 decode_coding_gap after all data are read into the buffer. */
4216 ptrdiff_t gap_size
= GAP_SIZE
;
4218 while (how_much
< total
)
4220 /* try is reserved in some compilers (Microsoft C) */
4221 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4228 /* Maybe make more room. */
4229 if (gap_size
< trytry
)
4231 make_gap (trytry
- gap_size
);
4232 gap_size
= GAP_SIZE
- inserted
;
4235 /* Read from the file, capturing `quit'. When an
4236 error occurs, end the loop, and arrange for a quit
4237 to be signaled after decoding the text we read. */
4238 nbytes
= internal_condition_case_1
4240 make_save_value (SAVE_TYPE_INT_INT_INT
, (ptrdiff_t) fd
,
4242 Qerror
, read_non_regular_quit
);
4250 this = XINT (nbytes
);
4254 /* Allow quitting out of the actual I/O. We don't make text
4255 part of the buffer until all the reading is done, so a C-g
4256 here doesn't do any harm. */
4259 this = emacs_read (fd
,
4260 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4274 /* For a regular file, where TOTAL is the real size,
4275 count HOW_MUCH to compare with it.
4276 For a special file, where TOTAL is just a buffer size,
4277 so don't bother counting in HOW_MUCH.
4278 (INSERTED is where we count the number of characters inserted.) */
4285 /* Now we have either read all the file data into the gap,
4286 or stop reading on I/O error or quit. If nothing was
4287 read, undo marking the buffer modified. */
4291 #ifdef CLASH_DETECTION
4293 unlock_file (BVAR (current_buffer
, file_truename
));
4295 Vdeactivate_mark
= old_Vdeactivate_mark
;
4298 Vdeactivate_mark
= Qt
;
4302 /* Discard the unwind protect for closing the file. */
4306 error ("IO error reading %s: %s",
4307 SDATA (orig_filename
), emacs_strerror (errno
));
4309 /* Make the text read part of the buffer. */
4310 GAP_SIZE
-= inserted
;
4312 GPT_BYTE
+= inserted
;
4314 ZV_BYTE
+= inserted
;
4319 /* Put an anchor to ensure multi-byte form ends at gap. */
4324 if (NILP (coding_system
))
4326 /* The coding system is not yet decided. Decide it by an
4327 optimized method for handling `coding:' tag.
4329 Note that we can get here only if the buffer was empty
4330 before the insertion. */
4332 if (!NILP (Vcoding_system_for_read
))
4333 coding_system
= Vcoding_system_for_read
;
4336 /* Since we are sure that the current buffer was empty
4337 before the insertion, we can toggle
4338 enable-multibyte-characters directly here without taking
4339 care of marker adjustment. By this way, we can run Lisp
4340 program safely before decoding the inserted text. */
4341 Lisp_Object unwind_data
;
4342 ptrdiff_t count1
= SPECPDL_INDEX ();
4344 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4345 Fcons (BVAR (current_buffer
, undo_list
),
4346 Fcurrent_buffer ()));
4347 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4348 bset_undo_list (current_buffer
, Qt
);
4349 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4351 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4353 coding_system
= call2 (Vset_auto_coding_function
,
4354 filename
, make_number (inserted
));
4357 if (NILP (coding_system
))
4359 /* If the coding system is not yet decided, check
4360 file-coding-system-alist. */
4361 Lisp_Object args
[6];
4363 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4364 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4365 coding_system
= Ffind_operation_coding_system (6, args
);
4366 if (CONSP (coding_system
))
4367 coding_system
= XCAR (coding_system
);
4369 unbind_to (count1
, Qnil
);
4370 inserted
= Z_BYTE
- BEG_BYTE
;
4373 if (NILP (coding_system
))
4374 coding_system
= Qundecided
;
4376 CHECK_CODING_SYSTEM (coding_system
);
4378 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4379 /* We must suppress all character code conversion except for
4380 end-of-line conversion. */
4381 coding_system
= raw_text_coding_system (coding_system
);
4382 setup_coding_system (coding_system
, &coding
);
4383 /* Ensure we set Vlast_coding_system_used. */
4384 set_coding_system
= 1;
4389 /* When we visit a file by raw-text, we change the buffer to
4391 if (CODING_FOR_UNIBYTE (&coding
)
4392 /* Can't do this if part of the buffer might be preserved. */
4394 /* Visiting a file with these coding system makes the buffer
4396 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4399 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4400 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4401 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4403 move_gap_both (PT
, PT_BYTE
);
4404 GAP_SIZE
+= inserted
;
4405 ZV_BYTE
-= inserted
;
4409 decode_coding_gap (&coding
, inserted
, inserted
);
4410 inserted
= coding
.produced_char
;
4411 coding_system
= CODING_ID_NAME (coding
.id
);
4413 else if (inserted
> 0)
4414 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4417 /* Call after-change hooks for the inserted text, aside from the case
4418 of normal visiting (not with REPLACE), which is done in a new buffer
4419 "before" the buffer is changed. */
4420 if (inserted
> 0 && total
> 0
4421 && (NILP (visit
) || !NILP (replace
)))
4423 signal_after_change (PT
, 0, inserted
);
4424 update_compositions (PT
, PT
, CHECK_BORDER
);
4427 /* Now INSERTED is measured in characters. */
4431 if (deferred_remove_unwind_protect
)
4432 /* If requested above, discard the unwind protect for closing the
4438 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4439 bset_undo_list (current_buffer
, Qnil
);
4443 current_buffer
->modtime
= mtime
;
4444 current_buffer
->modtime_size
= st
.st_size
;
4445 bset_filename (current_buffer
, orig_filename
);
4448 SAVE_MODIFF
= MODIFF
;
4449 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4450 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4451 #ifdef CLASH_DETECTION
4454 if (!NILP (BVAR (current_buffer
, file_truename
)))
4455 unlock_file (BVAR (current_buffer
, file_truename
));
4456 unlock_file (filename
);
4458 #endif /* CLASH_DETECTION */
4460 xsignal2 (Qfile_error
,
4461 build_string ("not a regular file"), orig_filename
);
4464 if (set_coding_system
)
4465 Vlast_coding_system_used
= coding_system
;
4467 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4469 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4471 if (! NILP (insval
))
4473 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4474 wrong_type_argument (intern ("inserted-chars"), insval
);
4475 inserted
= XFASTINT (insval
);
4479 /* Decode file format. */
4482 /* Don't run point motion or modification hooks when decoding. */
4483 ptrdiff_t count1
= SPECPDL_INDEX ();
4484 ptrdiff_t old_inserted
= inserted
;
4485 specbind (Qinhibit_point_motion_hooks
, Qt
);
4486 specbind (Qinhibit_modification_hooks
, Qt
);
4488 /* Save old undo list and don't record undo for decoding. */
4489 old_undo
= BVAR (current_buffer
, undo_list
);
4490 bset_undo_list (current_buffer
, Qt
);
4494 insval
= call3 (Qformat_decode
,
4495 Qnil
, make_number (inserted
), visit
);
4496 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4497 wrong_type_argument (intern ("inserted-chars"), insval
);
4498 inserted
= XFASTINT (insval
);
4502 /* If REPLACE is non-nil and we succeeded in not replacing the
4503 beginning or end of the buffer text with the file's contents,
4504 call format-decode with `point' positioned at the beginning
4505 of the buffer and `inserted' equaling the number of
4506 characters in the buffer. Otherwise, format-decode might
4507 fail to correctly analyze the beginning or end of the buffer.
4508 Hence we temporarily save `point' and `inserted' here and
4509 restore `point' iff format-decode did not insert or delete
4510 any text. Otherwise we leave `point' at point-min. */
4511 ptrdiff_t opoint
= PT
;
4512 ptrdiff_t opoint_byte
= PT_BYTE
;
4513 ptrdiff_t oinserted
= ZV
- BEGV
;
4514 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4516 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4517 insval
= call3 (Qformat_decode
,
4518 Qnil
, make_number (oinserted
), visit
);
4519 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4520 wrong_type_argument (intern ("inserted-chars"), insval
);
4521 if (ochars_modiff
== CHARS_MODIFF
)
4522 /* format_decode didn't modify buffer's characters => move
4523 point back to position before inserted text and leave
4524 value of inserted alone. */
4525 SET_PT_BOTH (opoint
, opoint_byte
);
4527 /* format_decode modified buffer's characters => consider
4528 entire buffer changed and leave point at point-min. */
4529 inserted
= XFASTINT (insval
);
4532 /* For consistency with format-decode call these now iff inserted > 0
4533 (martin 2007-06-28). */
4534 p
= Vafter_insert_file_functions
;
4539 insval
= call1 (XCAR (p
), make_number (inserted
));
4542 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4543 wrong_type_argument (intern ("inserted-chars"), insval
);
4544 inserted
= XFASTINT (insval
);
4549 /* For the rationale of this see the comment on
4550 format-decode above. */
4551 ptrdiff_t opoint
= PT
;
4552 ptrdiff_t opoint_byte
= PT_BYTE
;
4553 ptrdiff_t oinserted
= ZV
- BEGV
;
4554 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4556 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4557 insval
= call1 (XCAR (p
), make_number (oinserted
));
4560 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4561 wrong_type_argument (intern ("inserted-chars"), insval
);
4562 if (ochars_modiff
== CHARS_MODIFF
)
4563 /* after_insert_file_functions didn't modify
4564 buffer's characters => move point back to
4565 position before inserted text and leave value of
4567 SET_PT_BOTH (opoint
, opoint_byte
);
4569 /* after_insert_file_functions did modify buffer's
4570 characters => consider entire buffer changed and
4571 leave point at point-min. */
4572 inserted
= XFASTINT (insval
);
4582 bset_undo_list (current_buffer
, old_undo
);
4583 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4585 /* Adjust the last undo record for the size change during
4586 the format conversion. */
4587 Lisp_Object tem
= XCAR (old_undo
);
4588 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4589 && INTEGERP (XCDR (tem
))
4590 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4591 XSETCDR (tem
, make_number (PT
+ inserted
));
4595 /* If undo_list was Qt before, keep it that way.
4596 Otherwise start with an empty undo_list. */
4597 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4599 unbind_to (count1
, Qnil
);
4603 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4605 /* If visiting nonexistent file, return nil. */
4607 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4611 Fsignal (Qquit
, Qnil
);
4613 /* Retval needs to be dealt with in all cases consistently. */
4615 val
= list2 (orig_filename
, make_number (inserted
));
4617 RETURN_UNGCPRO (unbind_to (count
, val
));
4620 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4623 build_annotations_unwind (Lisp_Object arg
)
4625 Vwrite_region_annotation_buffers
= arg
;
4629 /* Decide the coding-system to encode the data with. */
4631 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4632 Schoose_write_coding_system
, 3, 6, 0,
4633 doc
: /* Choose the coding system for writing a file.
4634 Arguments are as for `write-region'.
4635 This function is for internal use only. It may prompt the user. */ )
4636 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4637 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4640 Lisp_Object eol_parent
= Qnil
;
4642 /* Mimic write-region behavior. */
4645 XSETFASTINT (start
, BEGV
);
4646 XSETFASTINT (end
, ZV
);
4650 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4651 BVAR (current_buffer
, auto_save_file_name
))))
4656 else if (!NILP (Vcoding_system_for_write
))
4658 val
= Vcoding_system_for_write
;
4659 if (coding_system_require_warning
4660 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4661 /* Confirm that VAL can surely encode the current region. */
4662 val
= call5 (Vselect_safe_coding_system_function
,
4663 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4668 /* If the variable `buffer-file-coding-system' is set locally,
4669 it means that the file was read with some kind of code
4670 conversion or the variable is explicitly set by users. We
4671 had better write it out with the same coding system even if
4672 `enable-multibyte-characters' is nil.
4674 If it is not set locally, we anyway have to convert EOL
4675 format if the default value of `buffer-file-coding-system'
4676 tells that it is not Unix-like (LF only) format. */
4677 bool using_default_coding
= 0;
4678 bool force_raw_text
= 0;
4680 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4682 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4685 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4691 /* Check file-coding-system-alist. */
4692 Lisp_Object args
[7], coding_systems
;
4694 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4695 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4697 coding_systems
= Ffind_operation_coding_system (7, args
);
4698 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4699 val
= XCDR (coding_systems
);
4704 /* If we still have not decided a coding system, use the
4705 default value of buffer-file-coding-system. */
4706 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4707 using_default_coding
= 1;
4710 if (! NILP (val
) && ! force_raw_text
)
4712 Lisp_Object spec
, attrs
;
4714 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4715 attrs
= AREF (spec
, 0);
4716 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4721 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4722 /* Confirm that VAL can surely encode the current region. */
4723 val
= call5 (Vselect_safe_coding_system_function
,
4724 start
, end
, val
, Qnil
, filename
);
4726 /* If the decided coding-system doesn't specify end-of-line
4727 format, we use that of
4728 `default-buffer-file-coding-system'. */
4729 if (! using_default_coding
4730 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4731 val
= (coding_inherit_eol_type
4732 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4734 /* If we decide not to encode text, use `raw-text' or one of its
4737 val
= raw_text_coding_system (val
);
4740 val
= coding_inherit_eol_type (val
, eol_parent
);
4744 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4745 "r\nFWrite region to file: \ni\ni\ni\np",
4746 doc
: /* Write current region into specified file.
4747 When called from a program, requires three arguments:
4748 START, END and FILENAME. START and END are normally buffer positions
4749 specifying the part of the buffer to write.
4750 If START is nil, that means to use the entire buffer contents.
4751 If START is a string, then output that string to the file
4752 instead of any buffer contents; END is ignored.
4754 Optional fourth argument APPEND if non-nil means
4755 append to existing file contents (if any). If it is a number,
4756 seek to that offset in the file before writing.
4757 Optional fifth argument VISIT, if t or a string, means
4758 set the last-save-file-modtime of buffer to this file's modtime
4759 and mark buffer not modified.
4760 If VISIT is a string, it is a second file name;
4761 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4762 VISIT is also the file name to lock and unlock for clash detection.
4763 If VISIT is neither t nor nil nor a string,
4764 that means do not display the \"Wrote file\" message.
4765 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4766 use for locking and unlocking, overriding FILENAME and VISIT.
4767 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4768 for an existing file with the same name. If MUSTBENEW is `excl',
4769 that means to get an error if the file already exists; never overwrite.
4770 If MUSTBENEW is neither nil nor `excl', that means ask for
4771 confirmation before overwriting, but do go ahead and overwrite the file
4772 if the user confirms.
4774 This does code conversion according to the value of
4775 `coding-system-for-write', `buffer-file-coding-system', or
4776 `file-coding-system-alist', and sets the variable
4777 `last-coding-system-used' to the coding system actually used.
4779 This calls `write-region-annotate-functions' at the start, and
4780 `write-region-post-annotation-function' at the end. */)
4781 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4786 off_t offset
IF_LINT (= 0);
4792 ptrdiff_t count
= SPECPDL_INDEX ();
4794 Lisp_Object handler
;
4795 Lisp_Object visit_file
;
4796 Lisp_Object annotations
;
4797 Lisp_Object encoded_filename
;
4798 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4799 bool quietly
= !NILP (visit
);
4800 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4801 struct buffer
*given_buffer
;
4802 struct coding_system coding
;
4804 if (current_buffer
->base_buffer
&& visiting
)
4805 error ("Cannot do file visiting in an indirect buffer");
4807 if (!NILP (start
) && !STRINGP (start
))
4808 validate_region (&start
, &end
);
4811 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4813 filename
= Fexpand_file_name (filename
, Qnil
);
4815 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4816 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4818 if (STRINGP (visit
))
4819 visit_file
= Fexpand_file_name (visit
, Qnil
);
4821 visit_file
= filename
;
4823 if (NILP (lockname
))
4824 lockname
= visit_file
;
4828 /* If the file name has special constructs in it,
4829 call the corresponding file handler. */
4830 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4831 /* If FILENAME has no handler, see if VISIT has one. */
4832 if (NILP (handler
) && STRINGP (visit
))
4833 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4835 if (!NILP (handler
))
4838 val
= call6 (handler
, Qwrite_region
, start
, end
,
4839 filename
, append
, visit
);
4843 SAVE_MODIFF
= MODIFF
;
4844 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4845 bset_filename (current_buffer
, visit_file
);
4851 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4853 /* Special kludge to simplify auto-saving. */
4856 /* Do it later, so write-region-annotate-function can work differently
4857 if we save "the buffer" vs "a region".
4858 This is useful in tar-mode. --Stef
4859 XSETFASTINT (start, BEG);
4860 XSETFASTINT (end, Z); */
4864 record_unwind_protect (build_annotations_unwind
,
4865 Vwrite_region_annotation_buffers
);
4866 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4867 count1
= SPECPDL_INDEX ();
4869 given_buffer
= current_buffer
;
4871 if (!STRINGP (start
))
4873 annotations
= build_annotations (start
, end
);
4875 if (current_buffer
!= given_buffer
)
4877 XSETFASTINT (start
, BEGV
);
4878 XSETFASTINT (end
, ZV
);
4884 XSETFASTINT (start
, BEGV
);
4885 XSETFASTINT (end
, ZV
);
4890 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4892 /* Decide the coding-system to encode the data with.
4893 We used to make this choice before calling build_annotations, but that
4894 leads to problems when a write-annotate-function takes care of
4895 unsavable chars (as was the case with X-Symbol). */
4896 Vlast_coding_system_used
=
4897 Fchoose_write_coding_system (start
, end
, filename
,
4898 append
, visit
, lockname
);
4900 setup_coding_system (Vlast_coding_system_used
, &coding
);
4902 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4903 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4905 #ifdef CLASH_DETECTION
4907 lock_file (lockname
);
4908 #endif /* CLASH_DETECTION */
4910 encoded_filename
= ENCODE_FILE (filename
);
4911 fn
= SSDATA (encoded_filename
);
4912 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4913 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4914 if (NUMBERP (append
))
4915 offset
= file_offset (append
);
4916 else if (!NILP (append
))
4917 open_flags
|= O_APPEND
;
4919 mode
= S_IREAD
| S_IWRITE
;
4921 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4924 desc
= emacs_open (fn
, open_flags
, mode
);
4928 #ifdef CLASH_DETECTION
4930 if (!auto_saving
) unlock_file (lockname
);
4932 #endif /* CLASH_DETECTION */
4934 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4937 record_unwind_protect (close_file_unwind
, make_number (desc
));
4939 if (NUMBERP (append
))
4941 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4944 #ifdef CLASH_DETECTION
4946 if (!auto_saving
) unlock_file (lockname
);
4948 #endif /* CLASH_DETECTION */
4950 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4958 if (STRINGP (start
))
4959 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4960 else if (XINT (start
) != XINT (end
))
4961 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4962 &annotations
, &coding
);
4965 /* If file was empty, still need to write the annotations. */
4966 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4967 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4971 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4972 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4974 /* We have to flush out a data. */
4975 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4976 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4982 /* fsync appears to change the modtime on BSD4.2.
4983 Disk full in NFS may be reported here. */
4984 /* mib says that closing the file will try to write as fast as NFS can do
4985 it, and that means the fsync here is not crucial for autosave files. */
4986 if (!auto_saving
&& !write_region_inhibit_fsync
)
4988 /* Transfer data and metadata to disk, retrying if interrupted. Also,
4989 ignore EINVAL which happens when fsync is not supported on this
4991 while (fsync (desc
) != 0)
4994 if (errno
!= EINVAL
)
4995 ok
= 0, save_errno
= errno
;
5000 modtime
= invalid_emacs_time ();
5003 if (fstat (desc
, &st
) == 0)
5004 modtime
= get_stat_mtime (&st
);
5006 ok
= 0, save_errno
= errno
;
5009 /* NFS can report a write failure now. */
5010 if (emacs_close (desc
) < 0)
5011 ok
= 0, save_errno
= errno
;
5013 /* Discard the unwind protect for close_file_unwind. */
5014 specpdl_ptr
= specpdl
+ count1
;
5016 /* Some file systems have a bug where st_mtime is not updated
5017 properly after a write. For example, CIFS might not see the
5018 st_mtime change until after the file is opened again.
5020 Attempt to detect this file system bug, and update MODTIME to the
5021 newer st_mtime if the bug appears to be present. This introduces
5022 a race condition, so to avoid most instances of the race condition
5023 on non-buggy file systems, skip this check if the most recently
5024 encountered non-buggy file system was the current file system.
5026 A race condition can occur if some other process modifies the
5027 file between the fstat above and the fstat below, but the race is
5028 unlikely and a similar race between the last write and the fstat
5029 above cannot possibly be closed anyway. */
5031 if (EMACS_TIME_VALID_P (modtime
)
5032 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
5034 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
5038 if (fstat (desc1
, &st1
) == 0
5039 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
5041 /* Use the heuristic if it appears to be valid. With neither
5042 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
5043 file, the time stamp won't change. Also, some non-POSIX
5044 systems don't update an empty file's time stamp when
5045 truncating it. Finally, file systems with 100 ns or worse
5046 resolution sometimes seem to have bugs: on a system with ns
5047 resolution, checking ns % 100 incorrectly avoids the heuristic
5048 1% of the time, but the problem should be temporary as we will
5049 try again on the next time stamp. */
5051 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
5053 && EMACS_NSECS (modtime
) % 100 != 0);
5055 EMACS_TIME modtime1
= get_stat_mtime (&st1
);
5057 && EMACS_TIME_EQ (modtime
, modtime1
)
5058 && st
.st_size
== st1
.st_size
)
5060 timestamp_file_system
= st
.st_dev
;
5061 valid_timestamp_file_system
= 1;
5065 st
.st_size
= st1
.st_size
;
5069 emacs_close (desc1
);
5073 /* Call write-region-post-annotation-function. */
5074 while (CONSP (Vwrite_region_annotation_buffers
))
5076 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5077 if (!NILP (Fbuffer_live_p (buf
)))
5080 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5081 call0 (Vwrite_region_post_annotation_function
);
5083 Vwrite_region_annotation_buffers
5084 = XCDR (Vwrite_region_annotation_buffers
);
5087 unbind_to (count
, Qnil
);
5089 #ifdef CLASH_DETECTION
5091 unlock_file (lockname
);
5092 #endif /* CLASH_DETECTION */
5094 /* Do this before reporting IO error
5095 to avoid a "file has changed on disk" warning on
5096 next attempt to save. */
5097 if (EMACS_TIME_VALID_P (modtime
))
5099 current_buffer
->modtime
= modtime
;
5100 current_buffer
->modtime_size
= st
.st_size
;
5104 error ("IO error writing %s: %s", SDATA (filename
),
5105 emacs_strerror (save_errno
));
5109 SAVE_MODIFF
= MODIFF
;
5110 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5111 bset_filename (current_buffer
, visit_file
);
5112 update_mode_lines
++;
5117 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5118 BVAR (current_buffer
, auto_save_file_name
))))
5119 SAVE_MODIFF
= MODIFF
;
5125 message_with_string ((NUMBERP (append
)
5135 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
5137 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5138 doc
: /* Return t if (car A) is numerically less than (car B). */)
5139 (Lisp_Object a
, Lisp_Object b
)
5141 return Flss (Fcar (a
), Fcar (b
));
5144 /* Build the complete list of annotations appropriate for writing out
5145 the text between START and END, by calling all the functions in
5146 write-region-annotate-functions and merging the lists they return.
5147 If one of these functions switches to a different buffer, we assume
5148 that buffer contains altered text. Therefore, the caller must
5149 make sure to restore the current buffer in all cases,
5150 as save-excursion would do. */
5153 build_annotations (Lisp_Object start
, Lisp_Object end
)
5155 Lisp_Object annotations
;
5157 struct gcpro gcpro1
, gcpro2
;
5158 Lisp_Object original_buffer
;
5160 bool used_global
= 0;
5162 XSETBUFFER (original_buffer
, current_buffer
);
5165 p
= Vwrite_region_annotate_functions
;
5166 GCPRO2 (annotations
, p
);
5169 struct buffer
*given_buffer
= current_buffer
;
5170 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5171 { /* Use the global value of the hook. */
5174 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5176 p
= Fappend (2, arg
);
5179 Vwrite_region_annotations_so_far
= annotations
;
5180 res
= call2 (XCAR (p
), start
, end
);
5181 /* If the function makes a different buffer current,
5182 assume that means this buffer contains altered text to be output.
5183 Reset START and END from the buffer bounds
5184 and discard all previous annotations because they should have
5185 been dealt with by this function. */
5186 if (current_buffer
!= given_buffer
)
5188 Vwrite_region_annotation_buffers
5189 = Fcons (Fcurrent_buffer (),
5190 Vwrite_region_annotation_buffers
);
5191 XSETFASTINT (start
, BEGV
);
5192 XSETFASTINT (end
, ZV
);
5195 Flength (res
); /* Check basic validity of return value */
5196 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5200 /* Now do the same for annotation functions implied by the file-format */
5201 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5202 p
= BVAR (current_buffer
, auto_save_file_format
);
5204 p
= BVAR (current_buffer
, file_format
);
5205 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5207 struct buffer
*given_buffer
= current_buffer
;
5209 Vwrite_region_annotations_so_far
= annotations
;
5211 /* Value is either a list of annotations or nil if the function
5212 has written annotations to a temporary buffer, which is now
5214 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5215 original_buffer
, make_number (i
));
5216 if (current_buffer
!= given_buffer
)
5218 XSETFASTINT (start
, BEGV
);
5219 XSETFASTINT (end
, ZV
);
5224 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5232 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5233 If STRING is nil, POS is the character position in the current buffer.
5234 Intersperse with them the annotations from *ANNOT
5235 which fall within the range of POS to POS + NCHARS,
5236 each at its appropriate position.
5238 We modify *ANNOT by discarding elements as we use them up.
5240 Return true if successful. */
5243 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5244 ptrdiff_t nchars
, Lisp_Object
*annot
,
5245 struct coding_system
*coding
)
5249 ptrdiff_t lastpos
= pos
+ nchars
;
5251 while (NILP (*annot
) || CONSP (*annot
))
5253 tem
= Fcar_safe (Fcar (*annot
));
5256 nextpos
= XFASTINT (tem
);
5258 /* If there are no more annotations in this range,
5259 output the rest of the range all at once. */
5260 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5261 return e_write (desc
, string
, pos
, lastpos
, coding
);
5263 /* Output buffer text up to the next annotation's position. */
5266 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5270 /* Output the annotation. */
5271 tem
= Fcdr (Fcar (*annot
));
5274 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5277 *annot
= Fcdr (*annot
);
5283 /* Write text in the range START and END into descriptor DESC,
5284 encoding them with coding system CODING. If STRING is nil, START
5285 and END are character positions of the current buffer, else they
5286 are indexes to the string STRING. Return true if successful. */
5289 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5290 struct coding_system
*coding
)
5292 if (STRINGP (string
))
5295 end
= SCHARS (string
);
5298 /* We used to have a code for handling selective display here. But,
5299 now it is handled within encode_coding. */
5303 if (STRINGP (string
))
5305 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5306 if (CODING_REQUIRE_ENCODING (coding
))
5308 encode_coding_object (coding
, string
,
5309 start
, string_char_to_byte (string
, start
),
5310 end
, string_char_to_byte (string
, end
), Qt
);
5314 coding
->dst_object
= string
;
5315 coding
->consumed_char
= SCHARS (string
);
5316 coding
->produced
= SBYTES (string
);
5321 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5322 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5324 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5325 if (CODING_REQUIRE_ENCODING (coding
))
5327 encode_coding_object (coding
, Fcurrent_buffer (),
5328 start
, start_byte
, end
, end_byte
, Qt
);
5332 coding
->dst_object
= Qnil
;
5333 coding
->dst_pos_byte
= start_byte
;
5334 if (start
>= GPT
|| end
<= GPT
)
5336 coding
->consumed_char
= end
- start
;
5337 coding
->produced
= end_byte
- start_byte
;
5341 coding
->consumed_char
= GPT
- start
;
5342 coding
->produced
= GPT_BYTE
- start_byte
;
5347 if (coding
->produced
> 0)
5350 -= emacs_write (desc
,
5351 STRINGP (coding
->dst_object
)
5352 ? SSDATA (coding
->dst_object
)
5353 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5356 if (coding
->produced
)
5359 start
+= coding
->consumed_char
;
5365 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5366 Sverify_visited_file_modtime
, 0, 1, 0,
5367 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5368 This means that the file has not been changed since it was visited or saved.
5369 If BUF is omitted or nil, it defaults to the current buffer.
5370 See Info node `(elisp)Modification Time' for more details. */)
5375 Lisp_Object handler
;
5376 Lisp_Object filename
;
5387 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5388 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5390 /* If the file name has special constructs in it,
5391 call the corresponding file handler. */
5392 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5393 Qverify_visited_file_modtime
);
5394 if (!NILP (handler
))
5395 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5397 filename
= ENCODE_FILE (BVAR (b
, filename
));
5399 mtime
= (stat (SSDATA (filename
), &st
) == 0
5400 ? get_stat_mtime (&st
)
5401 : time_error_value (errno
));
5402 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5403 && (b
->modtime_size
< 0
5404 || st
.st_size
== b
->modtime_size
))
5409 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5410 Sclear_visited_file_modtime
, 0, 0, 0,
5411 doc
: /* Clear out records of last mod time of visited file.
5412 Next attempt to save will certainly not complain of a discrepancy. */)
5415 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5416 current_buffer
->modtime_size
= -1;
5420 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5421 Svisited_file_modtime
, 0, 0, 0,
5422 doc
: /* Return the current buffer's recorded visited file modification time.
5423 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5424 `file-attributes' returns. If the current buffer has no recorded file
5425 modification time, this function returns 0. If the visited file
5426 doesn't exist, HIGH will be -1.
5427 See Info node `(elisp)Modification Time' for more details. */)
5430 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5432 if (EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
5434 /* make_lisp_time won't work here if time_t is unsigned. */
5435 return list4i (-1, 65535, 0, 0);
5437 return make_number (0);
5439 return make_lisp_time (current_buffer
->modtime
);
5442 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5443 Sset_visited_file_modtime
, 0, 1, 0,
5444 doc
: /* Update buffer's recorded modification time from the visited file's time.
5445 Useful if the buffer was not read from the file normally
5446 or if the file itself has been changed for some known benign reason.
5447 An argument specifies the modification time value to use
5448 \(instead of that of the visited file), in the form of a list
5449 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5450 (Lisp_Object time_list
)
5452 if (!NILP (time_list
))
5454 current_buffer
->modtime
= lisp_time_argument (time_list
);
5455 current_buffer
->modtime_size
= -1;
5459 register Lisp_Object filename
;
5461 Lisp_Object handler
;
5463 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5465 /* If the file name has special constructs in it,
5466 call the corresponding file handler. */
5467 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5468 if (!NILP (handler
))
5469 /* The handler can find the file name the same way we did. */
5470 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5472 filename
= ENCODE_FILE (filename
);
5474 if (stat (SSDATA (filename
), &st
) >= 0)
5476 current_buffer
->modtime
= get_stat_mtime (&st
);
5477 current_buffer
->modtime_size
= st
.st_size
;
5485 auto_save_error (Lisp_Object error_val
)
5487 Lisp_Object args
[3], msg
;
5489 struct gcpro gcpro1
;
5491 auto_save_error_occurred
= 1;
5493 ring_bell (XFRAME (selected_frame
));
5495 args
[0] = build_string ("Auto-saving %s: %s");
5496 args
[1] = BVAR (current_buffer
, name
);
5497 args
[2] = Ferror_message_string (error_val
);
5498 msg
= Fformat (3, args
);
5501 for (i
= 0; i
< 3; ++i
)
5506 message3_nolog (msg
);
5507 Fsleep_for (make_number (1), Qnil
);
5520 auto_save_mode_bits
= 0666;
5522 /* Get visited file's mode to become the auto save file's mode. */
5523 if (! NILP (BVAR (current_buffer
, filename
)))
5525 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5526 /* But make sure we can overwrite it later! */
5527 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5528 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5530 /* Remote files don't cooperate with stat. */
5531 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5535 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5536 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5541 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5544 FILE *stream
= XSAVE_POINTER (arg
, 0);
5556 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5559 minibuffer_auto_raise
= XINT (value
);
5564 do_auto_save_make_dir (Lisp_Object dir
)
5568 auto_saving_dir_umask
= 077;
5569 result
= call2 (Qmake_directory
, dir
, Qt
);
5570 auto_saving_dir_umask
= 0;
5575 do_auto_save_eh (Lisp_Object ignore
)
5577 auto_saving_dir_umask
= 0;
5581 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5582 doc
: /* Auto-save all buffers that need it.
5583 This is all buffers that have auto-saving enabled
5584 and are changed since last auto-saved.
5585 Auto-saving writes the buffer into a file
5586 so that your editing is not lost if the system crashes.
5587 This file is not the file you visited; that changes only when you save.
5588 Normally we run the normal hook `auto-save-hook' before saving.
5590 A non-nil NO-MESSAGE argument means do not print any message if successful.
5591 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5592 (Lisp_Object no_message
, Lisp_Object current_only
)
5594 struct buffer
*old
= current_buffer
, *b
;
5595 Lisp_Object tail
, buf
, hook
;
5596 bool auto_saved
= 0;
5597 int do_handled_files
;
5599 FILE *stream
= NULL
;
5600 ptrdiff_t count
= SPECPDL_INDEX ();
5601 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5602 bool old_message_p
= 0;
5603 struct gcpro gcpro1
, gcpro2
;
5605 if (max_specpdl_size
< specpdl_size
+ 40)
5606 max_specpdl_size
= specpdl_size
+ 40;
5611 if (NILP (no_message
))
5613 old_message_p
= push_message ();
5614 record_unwind_protect (pop_message_unwind
, Qnil
);
5617 /* Ordinarily don't quit within this function,
5618 but don't make it impossible to quit (in case we get hung in I/O). */
5622 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5623 point to non-strings reached from Vbuffer_alist. */
5625 hook
= intern ("auto-save-hook");
5626 Frun_hooks (1, &hook
);
5628 if (STRINGP (Vauto_save_list_file_name
))
5630 Lisp_Object listfile
;
5632 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5634 /* Don't try to create the directory when shutting down Emacs,
5635 because creating the directory might signal an error, and
5636 that would leave Emacs in a strange state. */
5637 if (!NILP (Vrun_hooks
))
5641 GCPRO2 (dir
, listfile
);
5642 dir
= Ffile_name_directory (listfile
);
5643 if (NILP (Ffile_directory_p (dir
)))
5644 internal_condition_case_1 (do_auto_save_make_dir
,
5650 stream
= fopen (SSDATA (listfile
), "w");
5653 record_unwind_protect (do_auto_save_unwind
,
5654 make_save_pointer (stream
));
5655 record_unwind_protect (do_auto_save_unwind_1
,
5656 make_number (minibuffer_auto_raise
));
5657 minibuffer_auto_raise
= 0;
5659 auto_save_error_occurred
= 0;
5661 /* On first pass, save all files that don't have handlers.
5662 On second pass, save all files that do have handlers.
5664 If Emacs is crashing, the handlers may tweak what is causing
5665 Emacs to crash in the first place, and it would be a shame if
5666 Emacs failed to autosave perfectly ordinary files because it
5667 couldn't handle some ange-ftp'd file. */
5669 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5670 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5672 buf
= XCDR (XCAR (tail
));
5675 /* Record all the buffers that have auto save mode
5676 in the special file that lists them. For each of these buffers,
5677 Record visited name (if any) and auto save name. */
5678 if (STRINGP (BVAR (b
, auto_save_file_name
))
5679 && stream
!= NULL
&& do_handled_files
== 0)
5682 if (!NILP (BVAR (b
, filename
)))
5684 fwrite (SDATA (BVAR (b
, filename
)), 1,
5685 SBYTES (BVAR (b
, filename
)), stream
);
5687 putc ('\n', stream
);
5688 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5689 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5690 putc ('\n', stream
);
5694 if (!NILP (current_only
)
5695 && b
!= current_buffer
)
5698 /* Don't auto-save indirect buffers.
5699 The base buffer takes care of it. */
5703 /* Check for auto save enabled
5704 and file changed since last auto save
5705 and file changed since last real save. */
5706 if (STRINGP (BVAR (b
, auto_save_file_name
))
5707 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5708 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5709 /* -1 means we've turned off autosaving for a while--see below. */
5710 && XINT (BVAR (b
, save_length
)) >= 0
5711 && (do_handled_files
5712 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5715 EMACS_TIME before_time
= current_emacs_time ();
5716 EMACS_TIME after_time
;
5718 /* If we had a failure, don't try again for 20 minutes. */
5719 if (b
->auto_save_failure_time
> 0
5720 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5723 set_buffer_internal (b
);
5724 if (NILP (Vauto_save_include_big_deletions
)
5725 && (XFASTINT (BVAR (b
, save_length
)) * 10
5726 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5727 /* A short file is likely to change a large fraction;
5728 spare the user annoying messages. */
5729 && XFASTINT (BVAR (b
, save_length
)) > 5000
5730 /* These messages are frequent and annoying for `*mail*'. */
5731 && !EQ (BVAR (b
, filename
), Qnil
)
5732 && NILP (no_message
))
5734 /* It has shrunk too much; turn off auto-saving here. */
5735 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5736 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5738 minibuffer_auto_raise
= 0;
5739 /* Turn off auto-saving until there's a real save,
5740 and prevent any more warnings. */
5741 XSETINT (BVAR (b
, save_length
), -1);
5742 Fsleep_for (make_number (1), Qnil
);
5745 if (!auto_saved
&& NILP (no_message
))
5746 message1 ("Auto-saving...");
5747 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5749 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5750 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5751 set_buffer_internal (old
);
5753 after_time
= current_emacs_time ();
5755 /* If auto-save took more than 60 seconds,
5756 assume it was an NFS failure that got a timeout. */
5757 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5758 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5762 /* Prevent another auto save till enough input events come in. */
5763 record_auto_save ();
5765 if (auto_saved
&& NILP (no_message
))
5769 /* If we are going to restore an old message,
5770 give time to read ours. */
5771 sit_for (make_number (1), 0, 0);
5774 else if (!auto_save_error_occurred
)
5775 /* Don't overwrite the error message if an error occurred.
5776 If we displayed a message and then restored a state
5777 with no message, leave a "done" message on the screen. */
5778 message1 ("Auto-saving...done");
5783 /* This restores the message-stack status. */
5784 unbind_to (count
, Qnil
);
5788 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5789 Sset_buffer_auto_saved
, 0, 0, 0,
5790 doc
: /* Mark current buffer as auto-saved with its current text.
5791 No auto-save file will be written until the buffer changes again. */)
5794 /* FIXME: This should not be called in indirect buffers, since
5795 they're not autosaved. */
5796 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5797 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5798 current_buffer
->auto_save_failure_time
= 0;
5802 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5803 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5804 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5807 current_buffer
->auto_save_failure_time
= 0;
5811 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5813 doc
: /* Return t if current buffer has been auto-saved recently.
5814 More precisely, if it has been auto-saved since last read from or saved
5815 in the visited file. If the buffer has no visited file,
5816 then any auto-save counts as "recent". */)
5819 /* FIXME: maybe we should return nil for indirect buffers since
5820 they're never autosaved. */
5821 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5824 /* Reading and completing file names */
5826 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5827 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5828 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5829 The return value is only relevant for a call to `read-file-name' that happens
5830 before any other event (mouse or keypress) is handled. */)
5833 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5834 || defined (HAVE_NS)
5835 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5838 && window_system_available (SELECTED_FRAME ()))
5845 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5847 struct gcpro gcpro1
;
5848 Lisp_Object args
[7];
5850 GCPRO1 (default_filename
);
5851 args
[0] = intern ("read-file-name");
5854 args
[3] = default_filename
;
5855 args
[4] = mustmatch
;
5857 args
[6] = predicate
;
5858 RETURN_UNGCPRO (Ffuncall (7, args
));
5865 valid_timestamp_file_system
= 0;
5869 syms_of_fileio (void)
5871 DEFSYM (Qoperations
, "operations");
5872 DEFSYM (Qexpand_file_name
, "expand-file-name");
5873 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5874 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5875 DEFSYM (Qfile_name_directory
, "file-name-directory");
5876 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5877 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5878 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5879 DEFSYM (Qcopy_file
, "copy-file");
5880 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5881 DEFSYM (Qmake_directory
, "make-directory");
5882 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5883 DEFSYM (Qdelete_file
, "delete-file");
5884 DEFSYM (Qrename_file
, "rename-file");
5885 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5886 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5887 DEFSYM (Qfile_exists_p
, "file-exists-p");
5888 DEFSYM (Qfile_executable_p
, "file-executable-p");
5889 DEFSYM (Qfile_readable_p
, "file-readable-p");
5890 DEFSYM (Qfile_writable_p
, "file-writable-p");
5891 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5892 DEFSYM (Qaccess_file
, "access-file");
5893 DEFSYM (Qfile_directory_p
, "file-directory-p");
5894 DEFSYM (Qfile_regular_p
, "file-regular-p");
5895 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5896 DEFSYM (Qfile_modes
, "file-modes");
5897 DEFSYM (Qset_file_modes
, "set-file-modes");
5898 DEFSYM (Qset_file_times
, "set-file-times");
5899 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5900 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5901 DEFSYM (Qfile_acl
, "file-acl");
5902 DEFSYM (Qset_file_acl
, "set-file-acl");
5903 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5904 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5905 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5906 DEFSYM (Qwrite_region
, "write-region");
5907 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5908 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5909 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5911 DEFSYM (Qfile_name_history
, "file-name-history");
5912 Fset (Qfile_name_history
, Qnil
);
5914 DEFSYM (Qfile_error
, "file-error");
5915 DEFSYM (Qfile_already_exists
, "file-already-exists");
5916 DEFSYM (Qfile_date_error
, "file-date-error");
5917 DEFSYM (Qexcl
, "excl");
5919 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5920 doc
: /* Coding system for encoding file names.
5921 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5922 Vfile_name_coding_system
= Qnil
;
5924 DEFVAR_LISP ("default-file-name-coding-system",
5925 Vdefault_file_name_coding_system
,
5926 doc
: /* Default coding system for encoding file names.
5927 This variable is used only when `file-name-coding-system' is nil.
5929 This variable is set/changed by the command `set-language-environment'.
5930 User should not set this variable manually,
5931 instead use `file-name-coding-system' to get a constant encoding
5932 of file names regardless of the current language environment. */);
5933 Vdefault_file_name_coding_system
= Qnil
;
5935 DEFSYM (Qformat_decode
, "format-decode");
5936 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5937 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5938 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5940 Fput (Qfile_error
, Qerror_conditions
,
5941 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5942 Fput (Qfile_error
, Qerror_message
,
5943 build_pure_c_string ("File error"));
5945 Fput (Qfile_already_exists
, Qerror_conditions
,
5946 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5947 Fput (Qfile_already_exists
, Qerror_message
,
5948 build_pure_c_string ("File already exists"));
5950 Fput (Qfile_date_error
, Qerror_conditions
,
5951 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5952 Fput (Qfile_date_error
, Qerror_message
,
5953 build_pure_c_string ("Cannot set file date"));
5955 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5956 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5957 If a file name matches REGEXP, all I/O on that file is done by calling
5958 HANDLER. If a file name matches more than one handler, the handler
5959 whose match starts last in the file name gets precedence. The
5960 function `find-file-name-handler' checks this list for a handler for
5963 HANDLER should be a function. The first argument given to it is the
5964 name of the I/O primitive to be handled; the remaining arguments are
5965 the arguments that were passed to that primitive. For example, if you
5966 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5967 HANDLER is called like this:
5969 (funcall HANDLER 'file-exists-p FILENAME)
5971 Note that HANDLER must be able to handle all I/O primitives; if it has
5972 nothing special to do for a primitive, it should reinvoke the
5973 primitive to handle the operation \"the usual way\".
5974 See Info node `(elisp)Magic File Names' for more details. */);
5975 Vfile_name_handler_alist
= Qnil
;
5977 DEFVAR_LISP ("set-auto-coding-function",
5978 Vset_auto_coding_function
,
5979 doc
: /* If non-nil, a function to call to decide a coding system of file.
5980 Two arguments are passed to this function: the file name
5981 and the length of a file contents following the point.
5982 This function should return a coding system to decode the file contents.
5983 It should check the file name against `auto-coding-alist'.
5984 If no coding system is decided, it should check a coding system
5985 specified in the heading lines with the format:
5986 -*- ... coding: CODING-SYSTEM; ... -*-
5987 or local variable spec of the tailing lines with `coding:' tag. */);
5988 Vset_auto_coding_function
= Qnil
;
5990 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5991 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5992 Each is passed one argument, the number of characters inserted,
5993 with point at the start of the inserted text. Each function
5994 should leave point the same, and return the new character count.
5995 If `insert-file-contents' is intercepted by a handler from
5996 `file-name-handler-alist', that handler is responsible for calling the
5997 functions in `after-insert-file-functions' if appropriate. */);
5998 Vafter_insert_file_functions
= Qnil
;
6000 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
6001 doc
: /* A list of functions to be called at the start of `write-region'.
6002 Each is passed two arguments, START and END as for `write-region'.
6003 These are usually two numbers but not always; see the documentation
6004 for `write-region'. The function should return a list of pairs
6005 of the form (POSITION . STRING), consisting of strings to be effectively
6006 inserted at the specified positions of the file being written (1 means to
6007 insert before the first byte written). The POSITIONs must be sorted into
6010 If there are several annotation functions, the lists returned by these
6011 functions are merged destructively. As each annotation function runs,
6012 the variable `write-region-annotations-so-far' contains a list of all
6013 annotations returned by previous annotation functions.
6015 An annotation function can return with a different buffer current.
6016 Doing so removes the annotations returned by previous functions, and
6017 resets START and END to `point-min' and `point-max' of the new buffer.
6019 After `write-region' completes, Emacs calls the function stored in
6020 `write-region-post-annotation-function', once for each buffer that was
6021 current when building the annotations (i.e., at least once), with that
6022 buffer current. */);
6023 Vwrite_region_annotate_functions
= Qnil
;
6024 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
6026 DEFVAR_LISP ("write-region-post-annotation-function",
6027 Vwrite_region_post_annotation_function
,
6028 doc
: /* Function to call after `write-region' completes.
6029 The function is called with no arguments. If one or more of the
6030 annotation functions in `write-region-annotate-functions' changed the
6031 current buffer, the function stored in this variable is called for
6032 each of those additional buffers as well, in addition to the original
6033 buffer. The relevant buffer is current during each function call. */);
6034 Vwrite_region_post_annotation_function
= Qnil
;
6035 staticpro (&Vwrite_region_annotation_buffers
);
6037 DEFVAR_LISP ("write-region-annotations-so-far",
6038 Vwrite_region_annotations_so_far
,
6039 doc
: /* When an annotation function is called, this holds the previous annotations.
6040 These are the annotations made by other annotation functions
6041 that were already called. See also `write-region-annotate-functions'. */);
6042 Vwrite_region_annotations_so_far
= Qnil
;
6044 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6045 doc
: /* A list of file name handlers that temporarily should not be used.
6046 This applies only to the operation `inhibit-file-name-operation'. */);
6047 Vinhibit_file_name_handlers
= Qnil
;
6049 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6050 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6051 Vinhibit_file_name_operation
= Qnil
;
6053 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6054 doc
: /* File name in which we write a list of all auto save file names.
6055 This variable is initialized automatically from `auto-save-list-file-prefix'
6056 shortly after Emacs reads your init file, if you have not yet given it
6057 a non-nil value. */);
6058 Vauto_save_list_file_name
= Qnil
;
6060 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6061 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6062 Normally auto-save files are written under other names. */);
6063 Vauto_save_visited_file_name
= Qnil
;
6065 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6066 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6067 If nil, deleting a substantial portion of the text disables auto-save
6068 in the buffer; this is the default behavior, because the auto-save
6069 file is usually more useful if it contains the deleted text. */);
6070 Vauto_save_include_big_deletions
= Qnil
;
6072 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6073 doc
: /* Non-nil means don't call fsync in `write-region'.
6074 This variable affects calls to `write-region' as well as save commands.
6075 A non-nil value may result in data loss! */);
6076 write_region_inhibit_fsync
= 0;
6078 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6079 doc
: /* Specifies whether to use the system's trash can.
6080 When non-nil, certain file deletion commands use the function
6081 `move-file-to-trash' instead of deleting files outright.
6082 This includes interactive calls to `delete-file' and
6083 `delete-directory' and the Dired deletion commands. */);
6084 delete_by_moving_to_trash
= 0;
6085 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6087 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6088 DEFSYM (Qcopy_directory
, "copy-directory");
6089 DEFSYM (Qdelete_directory
, "delete-directory");
6091 defsubr (&Sfind_file_name_handler
);
6092 defsubr (&Sfile_name_directory
);
6093 defsubr (&Sfile_name_nondirectory
);
6094 defsubr (&Sunhandled_file_name_directory
);
6095 defsubr (&Sfile_name_as_directory
);
6096 defsubr (&Sdirectory_file_name
);
6097 defsubr (&Smake_temp_name
);
6098 defsubr (&Sexpand_file_name
);
6099 defsubr (&Ssubstitute_in_file_name
);
6100 defsubr (&Scopy_file
);
6101 defsubr (&Smake_directory_internal
);
6102 defsubr (&Sdelete_directory_internal
);
6103 defsubr (&Sdelete_file
);
6104 defsubr (&Srename_file
);
6105 defsubr (&Sadd_name_to_file
);
6106 defsubr (&Smake_symbolic_link
);
6107 defsubr (&Sfile_name_absolute_p
);
6108 defsubr (&Sfile_exists_p
);
6109 defsubr (&Sfile_executable_p
);
6110 defsubr (&Sfile_readable_p
);
6111 defsubr (&Sfile_writable_p
);
6112 defsubr (&Saccess_file
);
6113 defsubr (&Sfile_symlink_p
);
6114 defsubr (&Sfile_directory_p
);
6115 defsubr (&Sfile_accessible_directory_p
);
6116 defsubr (&Sfile_regular_p
);
6117 defsubr (&Sfile_modes
);
6118 defsubr (&Sset_file_modes
);
6119 defsubr (&Sset_file_times
);
6120 defsubr (&Sfile_selinux_context
);
6121 defsubr (&Sfile_acl
);
6122 defsubr (&Sset_file_acl
);
6123 defsubr (&Sset_file_selinux_context
);
6124 defsubr (&Sset_default_file_modes
);
6125 defsubr (&Sdefault_file_modes
);
6126 defsubr (&Sfile_newer_than_file_p
);
6127 defsubr (&Sinsert_file_contents
);
6128 defsubr (&Schoose_write_coding_system
);
6129 defsubr (&Swrite_region
);
6130 defsubr (&Scar_less_than_car
);
6131 defsubr (&Sverify_visited_file_modtime
);
6132 defsubr (&Sclear_visited_file_modtime
);
6133 defsubr (&Svisited_file_modtime
);
6134 defsubr (&Sset_visited_file_modtime
);
6135 defsubr (&Sdo_auto_save
);
6136 defsubr (&Sset_buffer_auto_saved
);
6137 defsubr (&Sclear_buffer_auto_save_failure
);
6138 defsubr (&Srecent_auto_save_p
);
6140 defsubr (&Snext_read_file_uses_dialog_p
);
6143 defsubr (&Sunix_sync
);