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)
96 #define ACL_NOT_WELL_SUPPORTED(Err) \
97 ((Err) == ENOTSUP || (Err) == ENOSYS || (Err) == EINVAL || (Err) == EBUSY)
99 #endif /* HAVE_POSIX_ACL */
102 #include <allocator.h>
103 #include <careadlinkat.h>
104 #include <stat-time.h>
110 #include "commands.h"
112 /* True during writing of auto-save files. */
113 static bool auto_saving
;
115 /* Nonzero umask during creation of auto-save directories. */
116 static mode_t auto_saving_dir_umask
;
118 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
119 a new file with the same mode as the original. */
120 static mode_t auto_save_mode_bits
;
122 /* Set by auto_save_1 if an error occurred during the last auto-save. */
123 static bool auto_save_error_occurred
;
125 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
126 number of a file system where time stamps were observed to to work. */
127 static bool valid_timestamp_file_system
;
128 static dev_t timestamp_file_system
;
130 /* The symbol bound to coding-system-for-read when
131 insert-file-contents is called for recovering a file. This is not
132 an actual coding system name, but just an indicator to tell
133 insert-file-contents to use `emacs-mule' with a special flag for
134 auto saving and recovering a file. */
135 static Lisp_Object Qauto_save_coding
;
137 /* Property name of a file name handler,
138 which gives a list of operations it handles.. */
139 static Lisp_Object Qoperations
;
141 /* Lisp functions for translating file formats. */
142 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
144 /* Lisp function for setting buffer-file-coding-system and the
145 multibyteness of the current buffer after inserting a file. */
146 static Lisp_Object Qafter_insert_file_set_coding
;
148 static Lisp_Object Qwrite_region_annotate_functions
;
149 /* Each time an annotation function changes the buffer, the new buffer
151 static Lisp_Object Vwrite_region_annotation_buffers
;
153 static Lisp_Object Qdelete_by_moving_to_trash
;
155 /* Lisp function for moving files to trash. */
156 static Lisp_Object Qmove_file_to_trash
;
158 /* Lisp function for recursively copying directories. */
159 static Lisp_Object Qcopy_directory
;
161 /* Lisp function for recursively deleting directories. */
162 static Lisp_Object Qdelete_directory
;
167 Lisp_Object Qfile_error
;
168 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
169 static Lisp_Object Qexcl
;
170 Lisp_Object Qfile_name_history
;
172 static Lisp_Object Qcar_less_than_car
;
174 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
175 Lisp_Object
*, struct coding_system
*);
176 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
177 struct coding_system
*);
181 report_file_error (const char *string
, Lisp_Object data
)
183 Lisp_Object errstring
;
187 synchronize_system_messages_locale ();
188 str
= strerror (errorno
);
189 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
190 Vlocale_coding_system
, 0);
196 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
199 /* System error messages are capitalized. Downcase the initial
200 unless it is followed by a slash. (The slash case caters to
201 error messages that begin with "I/O" or, in German, "E/A".) */
202 if (STRING_MULTIBYTE (errstring
)
203 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
207 str
= SSDATA (errstring
);
208 c
= STRING_CHAR ((unsigned char *) str
);
209 Faset (errstring
, make_number (0), make_number (downcase (c
)));
212 xsignal (Qfile_error
,
213 Fcons (build_string (string
), Fcons (errstring
, data
)));
218 close_file_unwind (Lisp_Object fd
)
220 emacs_close (XFASTINT (fd
));
224 /* Restore point, having saved it as a marker. */
227 restore_point_unwind (Lisp_Object location
)
229 Fgoto_char (location
);
230 Fset_marker (location
, Qnil
, Qnil
);
235 static Lisp_Object Qexpand_file_name
;
236 static Lisp_Object Qsubstitute_in_file_name
;
237 static Lisp_Object Qdirectory_file_name
;
238 static Lisp_Object Qfile_name_directory
;
239 static Lisp_Object Qfile_name_nondirectory
;
240 static Lisp_Object Qunhandled_file_name_directory
;
241 static Lisp_Object Qfile_name_as_directory
;
242 static Lisp_Object Qcopy_file
;
243 static Lisp_Object Qmake_directory_internal
;
244 static Lisp_Object Qmake_directory
;
245 static Lisp_Object Qdelete_directory_internal
;
246 Lisp_Object Qdelete_file
;
247 static Lisp_Object Qrename_file
;
248 static Lisp_Object Qadd_name_to_file
;
249 static Lisp_Object Qmake_symbolic_link
;
250 Lisp_Object Qfile_exists_p
;
251 static Lisp_Object Qfile_executable_p
;
252 static Lisp_Object Qfile_readable_p
;
253 static Lisp_Object Qfile_writable_p
;
254 static Lisp_Object Qfile_symlink_p
;
255 static Lisp_Object Qaccess_file
;
256 Lisp_Object Qfile_directory_p
;
257 static Lisp_Object Qfile_regular_p
;
258 static Lisp_Object Qfile_accessible_directory_p
;
259 static Lisp_Object Qfile_modes
;
260 static Lisp_Object Qset_file_modes
;
261 static Lisp_Object Qset_file_times
;
262 static Lisp_Object Qfile_selinux_context
;
263 static Lisp_Object Qset_file_selinux_context
;
264 static Lisp_Object Qfile_acl
;
265 static Lisp_Object Qset_file_acl
;
266 static Lisp_Object Qfile_newer_than_file_p
;
267 Lisp_Object Qinsert_file_contents
;
268 static Lisp_Object Qchoose_write_coding_system
;
269 Lisp_Object Qwrite_region
;
270 static Lisp_Object Qverify_visited_file_modtime
;
271 static Lisp_Object Qset_visited_file_modtime
;
273 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
274 Sfind_file_name_handler
, 2, 2, 0,
275 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
276 Otherwise, return nil.
277 A file name is handled if one of the regular expressions in
278 `file-name-handler-alist' matches it.
280 If OPERATION equals `inhibit-file-name-operation', then we ignore
281 any handlers that are members of `inhibit-file-name-handlers',
282 but we still do run any other handlers. This lets handlers
283 use the standard functions without calling themselves recursively. */)
284 (Lisp_Object filename
, Lisp_Object operation
)
286 /* This function must not munge the match data. */
287 Lisp_Object chain
, inhibited_handlers
, result
;
291 CHECK_STRING (filename
);
293 if (EQ (operation
, Vinhibit_file_name_operation
))
294 inhibited_handlers
= Vinhibit_file_name_handlers
;
296 inhibited_handlers
= Qnil
;
298 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
299 chain
= XCDR (chain
))
305 Lisp_Object string
= XCAR (elt
);
307 Lisp_Object handler
= XCDR (elt
);
308 Lisp_Object operations
= Qnil
;
310 if (SYMBOLP (handler
))
311 operations
= Fget (handler
, Qoperations
);
314 && (match_pos
= fast_string_match (string
, filename
)) > pos
315 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
319 handler
= XCDR (elt
);
320 tem
= Fmemq (handler
, inhibited_handlers
);
334 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
336 doc
: /* Return the directory component in file name FILENAME.
337 Return nil if FILENAME does not include a directory.
338 Otherwise return a directory name.
339 Given a Unix syntax file name, returns a string ending in slash. */)
340 (Lisp_Object filename
)
343 register const char *beg
;
348 register const char *p
;
351 CHECK_STRING (filename
);
353 /* If the file name has special constructs in it,
354 call the corresponding file handler. */
355 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
358 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
360 return STRINGP (handled_name
) ? handled_name
: Qnil
;
364 beg
= alloca (SBYTES (filename
) + 1);
365 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
367 beg
= SSDATA (filename
);
369 p
= beg
+ SBYTES (filename
);
371 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
373 /* only recognize drive specifier at the beginning */
375 /* handle the "/:d:foo" and "/:foo" cases correctly */
376 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
377 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
384 /* Expansion of "c:" to drive and default directory. */
387 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
388 char *res
= alloca (MAXPATHLEN
+ 1);
391 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
393 memcpy (res
, beg
, 2);
398 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
400 size_t l
= strlen (res
);
402 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
405 p
= beg
+ strlen (beg
);
406 dostounix_filename (beg
, 0);
407 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
408 STRING_MULTIBYTE (filename
));
411 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
412 STRING_MULTIBYTE (filename
));
414 else if (STRING_MULTIBYTE (filename
))
416 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
417 dostounix_filename (SSDATA (tem_fn
), 1);
419 if (!NILP (Vw32_downcase_file_names
))
420 tem_fn
= Fdowncase (tem_fn
);
425 dostounix_filename (beg
, 0);
426 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
430 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
434 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
435 Sfile_name_nondirectory
, 1, 1, 0,
436 doc
: /* Return file name FILENAME sans its directory.
437 For example, in a Unix-syntax file name,
438 this is everything after the last slash,
439 or the entire name if it contains no slash. */)
440 (Lisp_Object filename
)
442 register const char *beg
, *p
, *end
;
445 CHECK_STRING (filename
);
447 /* If the file name has special constructs in it,
448 call the corresponding file handler. */
449 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
452 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
454 if (STRINGP (handled_name
))
456 error ("Invalid handler in `file-name-handler-alist'");
459 beg
= SSDATA (filename
);
460 end
= p
= beg
+ SBYTES (filename
);
462 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
464 /* only recognize drive specifier at beginning */
466 /* handle the "/:d:foo" case correctly */
467 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
472 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
475 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
476 Sunhandled_file_name_directory
, 1, 1, 0,
477 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
478 A `directly usable' directory name is one that may be used without the
479 intervention of any file handler.
480 If FILENAME is a directly usable file itself, return
481 \(file-name-directory FILENAME).
482 If FILENAME refers to a file which is not accessible from a local process,
483 then this should return nil.
484 The `call-process' and `start-process' functions use this function to
485 get a current directory to run processes in. */)
486 (Lisp_Object filename
)
490 /* If the file name has special constructs in it,
491 call the corresponding file handler. */
492 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
495 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
497 return STRINGP (handled_name
) ? handled_name
: Qnil
;
500 return Ffile_name_directory (filename
);
503 /* Convert from file name SRC of length SRCLEN to directory name in
504 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
505 string. On UNIX, just make sure there is a terminating /. Return
506 the length of DST in bytes. */
509 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
522 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
524 dst
[srclen
] = DIRECTORY_SEP
;
525 dst
[srclen
+ 1] = '\0';
529 dostounix_filename (dst
, multibyte
);
534 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
535 Sfile_name_as_directory
, 1, 1, 0,
536 doc
: /* Return a string representing the file name FILE interpreted as a directory.
537 This operation exists because a directory is also a file, but its name as
538 a directory is different from its name as a file.
539 The result can be used as the value of `default-directory'
540 or passed as second argument to `expand-file-name'.
541 For a Unix-syntax file name, just appends a slash. */)
552 /* If the file name has special constructs in it,
553 call the corresponding file handler. */
554 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
557 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
559 if (STRINGP (handled_name
))
561 error ("Invalid handler in `file-name-handler-alist'");
565 if (!NILP (Vw32_downcase_file_names
))
566 file
= Fdowncase (file
);
568 buf
= alloca (SBYTES (file
) + 10);
569 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
570 STRING_MULTIBYTE (file
));
571 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
574 /* Convert from directory name SRC of length SRCLEN to file name in
575 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
576 string. On UNIX, just make sure there isn't a terminating /.
577 Return the length of DST in bytes. */
580 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
582 /* Process as Unix format: just remove any final slash.
583 But leave "/" unchanged; do not change it to "". */
586 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
588 && !IS_ANY_SEP (dst
[srclen
- 2])
596 dostounix_filename (dst
, multibyte
);
601 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
603 doc
: /* Returns the file name of the directory named DIRECTORY.
604 This is the name of the file that holds the data for the directory DIRECTORY.
605 This operation exists because a directory is also a file, but its name as
606 a directory is different from its name as a file.
607 In Unix-syntax, this function just removes the final slash. */)
608 (Lisp_Object directory
)
614 CHECK_STRING (directory
);
616 if (NILP (directory
))
619 /* If the file name has special constructs in it,
620 call the corresponding file handler. */
621 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
624 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
626 if (STRINGP (handled_name
))
628 error ("Invalid handler in `file-name-handler-alist'");
632 if (!NILP (Vw32_downcase_file_names
))
633 directory
= Fdowncase (directory
);
635 buf
= alloca (SBYTES (directory
) + 20);
636 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
637 STRING_MULTIBYTE (directory
));
638 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
641 static const char make_temp_name_tbl
[64] =
643 'A','B','C','D','E','F','G','H',
644 'I','J','K','L','M','N','O','P',
645 'Q','R','S','T','U','V','W','X',
646 'Y','Z','a','b','c','d','e','f',
647 'g','h','i','j','k','l','m','n',
648 'o','p','q','r','s','t','u','v',
649 'w','x','y','z','0','1','2','3',
650 '4','5','6','7','8','9','-','_'
653 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
655 /* Value is a temporary file name starting with PREFIX, a string.
657 The Emacs process number forms part of the result, so there is
658 no danger of generating a name being used by another process.
659 In addition, this function makes an attempt to choose a name
660 which has no existing file. To make this work, PREFIX should be
661 an absolute file name.
663 BASE64_P means add the pid as 3 characters in base64
664 encoding. In this case, 6 characters will be added to PREFIX to
665 form the file name. Otherwise, if Emacs is running on a system
666 with long file names, add the pid as a decimal number.
668 This function signals an error if no unique file name could be
672 make_temp_name (Lisp_Object prefix
, bool base64_p
)
678 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
681 CHECK_STRING (prefix
);
683 /* VAL is created by adding 6 characters to PREFIX. The first
684 three are the PID of this process, in base 64, and the second
685 three are incremented if the file already exists. This ensures
686 262144 unique file names per PID per PREFIX. */
692 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
693 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
694 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
699 #ifdef HAVE_LONG_FILE_NAMES
700 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
702 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
703 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
704 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
709 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
710 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
711 if (!STRING_MULTIBYTE (prefix
))
712 STRING_SET_UNIBYTE (val
);
714 memcpy (data
, SSDATA (prefix
), len
);
717 memcpy (p
, pidbuf
, pidlen
);
720 /* Here we try to minimize useless stat'ing when this function is
721 invoked many times successively with the same PREFIX. We achieve
722 this by initializing count to a random value, and incrementing it
725 We don't want make-temp-name to be called while dumping,
726 because then make_temp_name_count_initialized_p would get set
727 and then make_temp_name_count would not be set when Emacs starts. */
729 if (!make_temp_name_count_initialized_p
)
731 make_temp_name_count
= time (NULL
);
732 make_temp_name_count_initialized_p
= 1;
737 unsigned num
= make_temp_name_count
;
739 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
740 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
741 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
743 /* Poor man's congruential RN generator. Replace with
744 ++make_temp_name_count for debugging. */
745 make_temp_name_count
+= 25229;
746 make_temp_name_count
%= 225307;
748 if (!check_existing (data
))
750 /* We want to return only if errno is ENOENT. */
754 /* The error here is dubious, but there is little else we
755 can do. The alternatives are to return nil, which is
756 as bad as (and in many cases worse than) throwing the
757 error, or to ignore the error, which will likely result
758 in looping through 225307 stat's, which is not only
759 dog-slow, but also useless since eventually nil would
760 have to be returned anyway. */
761 report_file_error ("Cannot create temporary name for prefix",
762 Fcons (prefix
, Qnil
));
769 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
770 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
771 The Emacs process number forms part of the result,
772 so there is no danger of generating a name being used by another process.
774 In addition, this function makes an attempt to choose a name
775 which has no existing file. To make this work,
776 PREFIX should be an absolute file name.
778 There is a race condition between calling `make-temp-name' and creating the
779 file which opens all kinds of security holes. For that reason, you should
780 probably use `make-temp-file' instead, except in three circumstances:
782 * If you are creating the file in the user's home directory.
783 * If you are creating a directory rather than an ordinary file.
784 * If you are taking special precautions as `make-temp-file' does. */)
787 return make_temp_name (prefix
, 0);
792 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
793 doc
: /* Convert filename NAME to absolute, and canonicalize it.
794 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
795 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
796 the current buffer's value of `default-directory' is used.
797 NAME should be a string that is a valid file name for the underlying
799 File name components that are `.' are removed, and
800 so are file name components followed by `..', along with the `..' itself;
801 note that these simplifications are done without checking the resulting
802 file names in the file system.
803 Multiple consecutive slashes are collapsed into a single slash,
804 except at the beginning of the file name when they are significant (e.g.,
805 UNC file names on MS-Windows.)
806 An initial `~/' expands to your home directory.
807 An initial `~USER/' expands to USER's home directory.
808 See also the function `substitute-in-file-name'.
810 For technical reasons, this function can return correct but
811 non-intuitive results for the root directory; for instance,
812 \(expand-file-name ".." "/") returns "/..". For this reason, use
813 \(directory-file-name (file-name-directory dirname)) to traverse a
814 filesystem tree, not (expand-file-name ".." dirname). */)
815 (Lisp_Object name
, Lisp_Object default_directory
)
817 /* These point to SDATA and need to be careful with string-relocation
818 during GC (via DECODE_FILE). */
821 /* This should only point to alloca'd data. */
828 bool collapse_newdir
= 1;
832 Lisp_Object handler
, result
, handled_name
;
838 /* If the file name has special constructs in it,
839 call the corresponding file handler. */
840 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
843 handled_name
= call3 (handler
, Qexpand_file_name
,
844 name
, default_directory
);
845 if (STRINGP (handled_name
))
847 error ("Invalid handler in `file-name-handler-alist'");
851 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
852 if (NILP (default_directory
))
853 default_directory
= BVAR (current_buffer
, directory
);
854 if (! STRINGP (default_directory
))
857 /* "/" is not considered a root directory on DOS_NT, so using "/"
858 here causes an infinite recursion in, e.g., the following:
860 (let (default-directory)
861 (expand-file-name "a"))
863 To avoid this, we set default_directory to the root of the
865 default_directory
= build_string (emacs_root_dir ());
867 default_directory
= build_string ("/");
871 if (!NILP (default_directory
))
873 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
876 handled_name
= call3 (handler
, Qexpand_file_name
,
877 name
, default_directory
);
878 if (STRINGP (handled_name
))
880 error ("Invalid handler in `file-name-handler-alist'");
885 char *o
= SSDATA (default_directory
);
887 /* Make sure DEFAULT_DIRECTORY is properly expanded.
888 It would be better to do this down below where we actually use
889 default_directory. Unfortunately, calling Fexpand_file_name recursively
890 could invoke GC, and the strings might be relocated. This would
891 be annoying because we have pointers into strings lying around
892 that would need adjusting, and people would add new pointers to
893 the code and forget to adjust them, resulting in intermittent bugs.
894 Putting this call here avoids all that crud.
896 The EQ test avoids infinite recursion. */
897 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
898 /* Save time in some common cases - as long as default_directory
899 is not relative, it can be canonicalized with name below (if it
900 is needed at all) without requiring it to be expanded now. */
902 /* Detect MSDOS file names with drive specifiers. */
903 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
904 && IS_DIRECTORY_SEP (o
[2]))
906 /* Detect Windows file names in UNC format. */
907 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
909 #else /* not DOS_NT */
910 /* Detect Unix absolute file names (/... alone is not absolute on
912 && ! (IS_DIRECTORY_SEP (o
[0]))
913 #endif /* not DOS_NT */
919 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
923 multibyte
= STRING_MULTIBYTE (name
);
924 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
927 default_directory
= string_to_multibyte (default_directory
);
930 name
= string_to_multibyte (name
);
936 if (!NILP (Vw32_downcase_file_names
))
937 default_directory
= Fdowncase (default_directory
);
940 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
941 nm
= alloca (SBYTES (name
) + 1);
942 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
945 /* Note if special escape prefix is present, but remove for now. */
946 if (nm
[0] == '/' && nm
[1] == ':')
952 /* Find and remove drive specifier if present; this makes nm absolute
953 even if the rest of the name appears to be relative. Only look for
954 drive specifier at the beginning. */
955 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
957 drive
= (unsigned char) nm
[0];
962 /* If we see "c://somedir", we want to strip the first slash after the
963 colon when stripping the drive letter. Otherwise, this expands to
965 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
968 /* Discard any previous drive specifier if nm is now in UNC format. */
969 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
973 #endif /* WINDOWSNT */
976 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
977 none are found, we can probably return right away. We will avoid
978 allocating a new string if name is already fully expanded. */
980 IS_DIRECTORY_SEP (nm
[0])
982 && drive
&& !is_escaped
985 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
989 /* If it turns out that the filename we want to return is just a
990 suffix of FILENAME, we don't need to go through and edit
991 things; we just need to construct a new string using data
992 starting at the middle of FILENAME. If we set LOSE, that
993 means we've discovered that we can't do that cool trick. */
999 /* Since we know the name is absolute, we can assume that each
1000 element starts with a "/". */
1002 /* "." and ".." are hairy. */
1003 if (IS_DIRECTORY_SEP (p
[0])
1005 && (IS_DIRECTORY_SEP (p
[2])
1007 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1010 /* We want to replace multiple `/' in a row with a single
1013 && IS_DIRECTORY_SEP (p
[0])
1014 && IS_DIRECTORY_SEP (p
[1]))
1021 /* Make sure directories are all separated with /, but
1022 avoid allocation of a new string when not required. */
1023 dostounix_filename (nm
, multibyte
);
1025 if (IS_DIRECTORY_SEP (nm
[1]))
1027 if (strcmp (nm
, SSDATA (name
)) != 0)
1028 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1032 /* Drive must be set, so this is okay. */
1033 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1037 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1038 temp
[0] = DRIVE_LETTER (drive
);
1039 name
= concat2 (build_string (temp
), name
);
1042 if (!NILP (Vw32_downcase_file_names
))
1043 name
= Fdowncase (name
);
1046 #else /* not DOS_NT */
1047 if (strcmp (nm
, SSDATA (name
)) == 0)
1049 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1050 #endif /* not DOS_NT */
1054 /* At this point, nm might or might not be an absolute file name. We
1055 need to expand ~ or ~user if present, otherwise prefix nm with
1056 default_directory if nm is not absolute, and finally collapse /./
1057 and /foo/../ sequences.
1059 We set newdir to be the appropriate prefix if one is needed:
1060 - the relevant user directory if nm starts with ~ or ~user
1061 - the specified drive's working dir (DOS/NT only) if nm does not
1063 - the value of default_directory.
1065 Note that these prefixes are not guaranteed to be absolute (except
1066 for the working dir of a drive). Therefore, to ensure we always
1067 return an absolute name, if the final prefix is not absolute we
1068 append it to the current working directory. */
1072 if (nm
[0] == '~') /* prefix ~ */
1074 if (IS_DIRECTORY_SEP (nm
[1])
1075 || nm
[1] == 0) /* ~ by itself */
1079 if (!(newdir
= egetenv ("HOME")))
1082 /* `egetenv' may return a unibyte string, which will bite us since
1083 we expect the directory to be multibyte. */
1084 tem
= build_string (newdir
);
1085 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1087 hdir
= DECODE_FILE (tem
);
1088 newdir
= SSDATA (hdir
);
1091 collapse_newdir
= 0;
1094 else /* ~user/filename */
1097 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1098 o
= alloca (p
- nm
+ 1);
1099 memcpy (o
, nm
, p
- nm
);
1103 pw
= getpwnam (o
+ 1);
1109 newdir
= pw
->pw_dir
;
1110 /* `getpwnam' may return a unibyte string, which will
1111 bite us since we expect the directory to be
1113 tem
= build_string (newdir
);
1114 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1116 hdir
= DECODE_FILE (tem
);
1117 newdir
= SSDATA (hdir
);
1121 collapse_newdir
= 0;
1125 /* If we don't find a user of that name, leave the name
1126 unchanged; don't move nm forward to p. */
1131 /* On DOS and Windows, nm is absolute if a drive name was specified;
1132 use the drive's current directory as the prefix if needed. */
1133 if (!newdir
&& drive
)
1135 /* Get default directory if needed to make nm absolute. */
1137 if (!IS_DIRECTORY_SEP (nm
[0]))
1139 adir
= alloca (MAXPATHLEN
+ 1);
1140 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1144 Lisp_Object tem
= build_string (adir
);
1146 tem
= DECODE_FILE (tem
);
1147 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1152 /* Either nm starts with /, or drive isn't mounted. */
1154 adir
[0] = DRIVE_LETTER (drive
);
1163 /* Finally, if no prefix has been specified and nm is not absolute,
1164 then it must be expanded relative to default_directory. */
1168 /* /... alone is not absolute on DOS and Windows. */
1169 && !IS_DIRECTORY_SEP (nm
[0])
1172 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1176 newdir
= SSDATA (default_directory
);
1178 /* Note if special escape prefix is present, but remove for now. */
1179 if (newdir
[0] == '/' && newdir
[1] == ':')
1190 /* First ensure newdir is an absolute name. */
1192 /* Detect MSDOS file names with drive specifiers. */
1193 ! (IS_DRIVE (newdir
[0])
1194 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1196 /* Detect Windows file names in UNC format. */
1197 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1201 /* Effectively, let newdir be (expand-file-name newdir cwd).
1202 Because of the admonition against calling expand-file-name
1203 when we have pointers into lisp strings, we accomplish this
1204 indirectly by prepending newdir to nm if necessary, and using
1205 cwd (or the wd of newdir's drive) as the new newdir. */
1208 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1210 drive
= (unsigned char) newdir
[0];
1213 if (!IS_DIRECTORY_SEP (nm
[0]))
1215 ptrdiff_t newlen
= strlen (newdir
);
1216 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1217 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1221 adir
= alloca (MAXPATHLEN
+ 1);
1224 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1228 getcwd (adir
, MAXPATHLEN
+ 1);
1231 Lisp_Object tem
= build_string (adir
);
1233 tem
= DECODE_FILE (tem
);
1234 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1239 /* Strip off drive name from prefix, if present. */
1240 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1246 /* Keep only a prefix from newdir if nm starts with slash
1247 (//server/share for UNC, nothing otherwise). */
1248 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1251 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1253 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1255 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1257 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1270 /* Get rid of any slash at the end of newdir, unless newdir is
1271 just / or // (an incomplete UNC name). */
1272 length
= strlen (newdir
);
1274 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1276 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1280 char *temp
= alloca (length
);
1281 memcpy (temp
, newdir
, length
- 1);
1282 temp
[length
- 1] = 0;
1293 /* Now concatenate the directory and name to new space in the stack frame. */
1294 tlen
+= strlen (nm
) + 1;
1296 /* Reserve space for drive specifier and escape prefix, since either
1297 or both may need to be inserted. (The Microsoft x86 compiler
1298 produces incorrect code if the following two lines are combined.) */
1299 target
= alloca (tlen
+ 4);
1301 #else /* not DOS_NT */
1302 target
= alloca (tlen
);
1303 #endif /* not DOS_NT */
1308 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1311 /* If newdir is effectively "C:/", then the drive letter will have
1312 been stripped and newdir will be "/". Concatenating with an
1313 absolute directory in nm produces "//", which will then be
1314 incorrectly treated as a network share. Ignore newdir in
1315 this case (keeping the drive letter). */
1316 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1317 && newdir
[1] == '\0'))
1319 strcpy (target
, newdir
);
1322 file_name_as_directory (target
, newdir
, length
, multibyte
);
1325 strcat (target
, nm
);
1327 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1335 if (!IS_DIRECTORY_SEP (*p
))
1339 else if (p
[1] == '.'
1340 && (IS_DIRECTORY_SEP (p
[2])
1343 /* If "/." is the entire filename, keep the "/". Otherwise,
1344 just delete the whole "/.". */
1345 if (o
== target
&& p
[2] == '\0')
1349 else if (p
[1] == '.' && p
[2] == '.'
1350 /* `/../' is the "superroot" on certain file systems.
1351 Turned off on DOS_NT systems because they have no
1352 "superroot" and because this causes us to produce
1353 file names like "d:/../foo" which fail file-related
1354 functions of the underlying OS. (To reproduce, try a
1355 long series of "../../" in default_directory, longer
1356 than the number of levels from the root.) */
1360 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1365 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1368 /* Don't go below server level in UNC filenames. */
1369 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1370 && IS_DIRECTORY_SEP (*target
))
1374 /* Keep initial / only if this is the whole name. */
1375 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1379 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1380 /* Collapse multiple `/' in a row. */
1389 /* At last, set drive name. */
1391 /* Except for network file name. */
1392 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1393 #endif /* WINDOWSNT */
1395 if (!drive
) emacs_abort ();
1397 target
[0] = DRIVE_LETTER (drive
);
1400 /* Reinsert the escape prefix if required. */
1407 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1408 dostounix_filename (SSDATA (result
), multibyte
);
1410 if (!NILP (Vw32_downcase_file_names
))
1411 result
= Fdowncase (result
);
1414 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1415 #endif /* !DOS_NT */
1418 /* Again look to see if the file name has special constructs in it
1419 and perhaps call the corresponding file handler. This is needed
1420 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1421 the ".." component gives us "/user@host:/bar/../baz" which needs
1422 to be expanded again. */
1423 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1424 if (!NILP (handler
))
1426 handled_name
= call3 (handler
, Qexpand_file_name
,
1427 result
, default_directory
);
1428 if (STRINGP (handled_name
))
1429 return handled_name
;
1430 error ("Invalid handler in `file-name-handler-alist'");
1437 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1438 This is the old version of expand-file-name, before it was thoroughly
1439 rewritten for Emacs 10.31. We leave this version here commented-out,
1440 because the code is very complex and likely to have subtle bugs. If
1441 bugs _are_ found, it might be of interest to look at the old code and
1442 see what did it do in the relevant situation.
1444 Don't remove this code: it's true that it will be accessible
1445 from the repository, but a few years from deletion, people will
1446 forget it is there. */
1448 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1449 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1450 "Convert FILENAME to absolute, and canonicalize it.\n\
1451 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1452 \(does not start with slash); if DEFAULT is nil or missing,\n\
1453 the current buffer's value of default-directory is used.\n\
1454 Filenames containing `.' or `..' as components are simplified;\n\
1455 initial `~/' expands to your home directory.\n\
1456 See also the function `substitute-in-file-name'.")
1458 Lisp_Object name
, defalt
;
1462 register unsigned char *newdir
, *p
, *o
;
1464 unsigned char *target
;
1467 CHECK_STRING (name
);
1470 /* If nm is absolute, flush ...// and detect /./ and /../.
1471 If no /./ or /../ we can return right away. */
1478 if (p
[0] == '/' && p
[1] == '/')
1480 if (p
[0] == '/' && p
[1] == '~')
1481 nm
= p
+ 1, lose
= 1;
1482 if (p
[0] == '/' && p
[1] == '.'
1483 && (p
[2] == '/' || p
[2] == 0
1484 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1490 if (nm
== SDATA (name
))
1492 return build_string (nm
);
1496 /* Now determine directory to start with and put it in NEWDIR. */
1500 if (nm
[0] == '~') /* prefix ~ */
1501 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1503 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1504 newdir
= (unsigned char *) "";
1507 else /* ~user/filename */
1509 /* Get past ~ to user. */
1510 unsigned char *user
= nm
+ 1;
1511 /* Find end of name. */
1512 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1513 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1514 /* Copy the user name into temp storage. */
1515 o
= alloca (len
+ 1);
1516 memcpy (o
, user
, len
);
1519 /* Look up the user name. */
1521 pw
= (struct passwd
*) getpwnam (o
+ 1);
1524 error ("\"%s\" isn't a registered user", o
+ 1);
1526 newdir
= (unsigned char *) pw
->pw_dir
;
1528 /* Discard the user name from NM. */
1532 if (nm
[0] != '/' && !newdir
)
1535 defalt
= current_buffer
->directory
;
1536 CHECK_STRING (defalt
);
1537 newdir
= SDATA (defalt
);
1540 /* Now concatenate the directory and name to new space in the stack frame. */
1542 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1543 target
= alloca (tlen
);
1548 if (nm
[0] == 0 || nm
[0] == '/')
1549 strcpy (target
, newdir
);
1551 file_name_as_directory (target
, newdir
);
1554 strcat (target
, nm
);
1556 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1567 else if (!strncmp (p
, "//", 2)
1573 else if (p
[0] == '/' && p
[1] == '.'
1574 && (p
[2] == '/' || p
[2] == 0))
1576 else if (!strncmp (p
, "/..", 3)
1577 /* `/../' is the "superroot" on certain file systems. */
1579 && (p
[3] == '/' || p
[3] == 0))
1581 while (o
!= target
&& *--o
!= '/')
1583 if (o
== target
&& *o
== '/')
1593 return make_string (target
, o
- target
);
1597 /* If /~ or // appears, discard everything through first slash. */
1599 file_name_absolute_p (const char *filename
)
1602 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1604 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1605 && IS_DIRECTORY_SEP (filename
[2]))
1611 search_embedded_absfilename (char *nm
, char *endp
)
1615 for (p
= nm
+ 1; p
< endp
; p
++)
1617 if (IS_DIRECTORY_SEP (p
[-1])
1618 && file_name_absolute_p (p
)
1619 #if defined (WINDOWSNT) || defined (CYGWIN)
1620 /* // at start of file name is meaningful in Apollo,
1621 WindowsNT and Cygwin systems. */
1622 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1623 #endif /* not (WINDOWSNT || CYGWIN) */
1626 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1627 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1629 char *o
= alloca (s
- p
+ 1);
1631 memcpy (o
, p
, s
- p
);
1634 /* If we have ~user and `user' exists, discard
1635 everything up to ~. But if `user' does not exist, leave
1636 ~user alone, it might be a literal file name. */
1638 pw
= getpwnam (o
+ 1);
1650 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1651 Ssubstitute_in_file_name
, 1, 1, 0,
1652 doc
: /* Substitute environment variables referred to in FILENAME.
1653 `$FOO' where FOO is an environment variable name means to substitute
1654 the value of that variable. The variable name should be terminated
1655 with a character not a letter, digit or underscore; otherwise, enclose
1656 the entire variable name in braces.
1658 If `/~' appears, all of FILENAME through that `/' is discarded.
1659 If `//' appears, everything up to and including the first of
1660 those `/' is discarded. */)
1661 (Lisp_Object filename
)
1663 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1664 char *target
= NULL
;
1665 ptrdiff_t total
= 0;
1666 bool substituted
= 0;
1669 Lisp_Object handler
;
1671 CHECK_STRING (filename
);
1673 multibyte
= STRING_MULTIBYTE (filename
);
1675 /* If the file name has special constructs in it,
1676 call the corresponding file handler. */
1677 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1678 if (!NILP (handler
))
1680 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1682 if (STRINGP (handled_name
))
1683 return handled_name
;
1684 error ("Invalid handler in `file-name-handler-alist'");
1687 /* Always work on a copy of the string, in case GC happens during
1688 decode of environment variables, causing the original Lisp_String
1689 data to be relocated. */
1690 nm
= alloca (SBYTES (filename
) + 1);
1691 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1694 dostounix_filename (nm
, multibyte
);
1695 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1697 endp
= nm
+ SBYTES (filename
);
1699 /* If /~ or // appears, discard everything through first slash. */
1700 p
= search_embedded_absfilename (nm
, endp
);
1702 /* Start over with the new string, so we check the file-name-handler
1703 again. Important with filenames like "/home/foo//:/hello///there"
1704 which would substitute to "/:/hello///there" rather than "/there". */
1705 return Fsubstitute_in_file_name
1706 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1708 /* See if any variables are substituted into the string
1709 and find the total length of their values in `total'. */
1711 for (p
= nm
; p
!= endp
;)
1721 /* "$$" means a single "$". */
1730 p
= memchr (p
, '}', endp
- p
);
1738 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1742 /* Copy out the variable name. */
1743 target
= alloca (s
- o
+ 1);
1744 memcpy (target
, o
, s
- o
);
1747 strupr (target
); /* $home == $HOME etc. */
1750 /* Get variable value. */
1751 o
= egetenv (target
);
1754 /* Don't try to guess a maximum length - UTF8 can use up to
1755 four bytes per character. This code is unlikely to run
1756 in a situation that requires performance, so decoding the
1757 env variables twice should be acceptable. Note that
1758 decoding may cause a garbage collect. */
1759 Lisp_Object orig
, decoded
;
1760 orig
= build_unibyte_string (o
);
1761 decoded
= DECODE_FILE (orig
);
1762 total
+= SBYTES (decoded
);
1772 if (!NILP (Vw32_downcase_file_names
))
1773 filename
= Fdowncase (filename
);
1778 /* If substitution required, recopy the string and do it. */
1779 /* Make space in stack frame for the new copy. */
1780 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1783 /* Copy the rest of the name through, replacing $ constructs with values. */
1800 p
= memchr (p
, '}', endp
- p
);
1808 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1812 /* Copy out the variable name. */
1813 target
= alloca (s
- o
+ 1);
1814 memcpy (target
, o
, s
- o
);
1817 /* Get variable value. */
1818 o
= egetenv (target
);
1822 strcpy (x
, target
); x
+= strlen (target
);
1826 Lisp_Object orig
, decoded
;
1827 ptrdiff_t orig_length
, decoded_length
;
1828 orig_length
= strlen (o
);
1829 orig
= make_unibyte_string (o
, orig_length
);
1830 decoded
= DECODE_FILE (orig
);
1831 decoded_length
= SBYTES (decoded
);
1832 memcpy (x
, SDATA (decoded
), decoded_length
);
1833 x
+= decoded_length
;
1835 /* If environment variable needed decoding, return value
1836 needs to be multibyte. */
1837 if (decoded_length
!= orig_length
1838 || memcmp (SDATA (decoded
), o
, orig_length
))
1845 /* If /~ or // appears, discard everything through first slash. */
1846 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1847 /* This time we do not start over because we've already expanded envvars
1848 and replaced $$ with $. Maybe we should start over as well, but we'd
1849 need to quote some $ to $$ first. */
1853 if (!NILP (Vw32_downcase_file_names
))
1855 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1857 xname
= Fdowncase (xname
);
1862 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1865 error ("Bad format environment-variable substitution");
1867 error ("Missing \"}\" in environment-variable substitution");
1869 error ("Substituting nonexistent environment variable \"%s\"", target
);
1872 /* A slightly faster and more convenient way to get
1873 (directory-file-name (expand-file-name FOO)). */
1876 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1878 register Lisp_Object absname
;
1880 absname
= Fexpand_file_name (filename
, defdir
);
1882 /* Remove final slash, if any (unless this is the root dir).
1883 stat behaves differently depending! */
1884 if (SCHARS (absname
) > 1
1885 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1886 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1887 /* We cannot take shortcuts; they might be wrong for magic file names. */
1888 absname
= Fdirectory_file_name (absname
);
1892 /* Signal an error if the file ABSNAME already exists.
1893 If INTERACTIVE, ask the user whether to proceed,
1894 and bypass the error if the user says to go ahead.
1895 QUERYSTRING is a name for the action that is being considered
1898 *STATPTR is used to store the stat information if the file exists.
1899 If the file does not exist, STATPTR->st_mode is set to 0.
1900 If STATPTR is null, we don't store into it.
1902 If QUICK, ask for y or n, not yes or no. */
1905 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1906 bool interactive
, struct stat
*statptr
,
1909 Lisp_Object tem
, encoded_filename
;
1910 struct stat statbuf
;
1911 struct gcpro gcpro1
;
1913 encoded_filename
= ENCODE_FILE (absname
);
1915 /* `stat' is a good way to tell whether the file exists,
1916 regardless of what access permissions it has. */
1917 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1919 if (S_ISDIR (statbuf
.st_mode
))
1920 xsignal2 (Qfile_error
,
1921 build_string ("File is a directory"), absname
);
1924 xsignal2 (Qfile_already_exists
,
1925 build_string ("File already exists"), absname
);
1927 tem
= format2 ("File %s already exists; %s anyway? ",
1928 absname
, build_string (querystring
));
1930 tem
= call1 (intern ("y-or-n-p"), tem
);
1932 tem
= do_yes_or_no_p (tem
);
1935 xsignal2 (Qfile_already_exists
,
1936 build_string ("File already exists"), absname
);
1943 statptr
->st_mode
= 0;
1948 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1949 "fCopy file: \nGCopy %s to file: \np\nP",
1950 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1951 If NEWNAME names a directory, copy FILE there.
1953 This function always sets the file modes of the output file to match
1956 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1957 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1958 signal a `file-already-exists' error without overwriting. If
1959 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1960 about overwriting; this is what happens in interactive use with M-x.
1961 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1964 Fourth arg KEEP-TIME non-nil means give the output file the same
1965 last-modified time as the old one. (This works on only some systems.)
1967 A prefix arg makes KEEP-TIME non-nil.
1969 If PRESERVE-UID-GID is non-nil, we try to transfer the
1970 uid and gid of FILE to NEWNAME.
1972 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1973 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1974 entries (depending on how Emacs was built). */)
1975 (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
)
1979 char buf
[16 * 1024];
1980 struct stat st
, out_st
;
1981 Lisp_Object handler
;
1982 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1983 ptrdiff_t count
= SPECPDL_INDEX ();
1984 Lisp_Object encoded_file
, encoded_newname
;
1986 security_context_t con
;
1989 #ifdef HAVE_POSIX_ACL
1993 encoded_file
= encoded_newname
= Qnil
;
1994 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1995 CHECK_STRING (file
);
1996 CHECK_STRING (newname
);
1998 if (!NILP (Ffile_directory_p (newname
)))
1999 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2001 newname
= Fexpand_file_name (newname
, Qnil
);
2003 file
= Fexpand_file_name (file
, Qnil
);
2005 /* If the input file name has special constructs in it,
2006 call the corresponding file handler. */
2007 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2008 /* Likewise for output file name. */
2010 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2011 if (!NILP (handler
))
2012 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
2013 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
2014 preserve_extended_attributes
));
2016 encoded_file
= ENCODE_FILE (file
);
2017 encoded_newname
= ENCODE_FILE (newname
);
2019 if (NILP (ok_if_already_exists
)
2020 || INTEGERP (ok_if_already_exists
))
2021 barf_or_query_if_file_exists (newname
, "copy to it",
2022 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2023 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
2027 if (!NILP (preserve_extended_attributes
))
2029 #ifdef HAVE_POSIX_ACL
2030 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2031 if (acl
== NULL
&& !ACL_NOT_WELL_SUPPORTED (errno
))
2032 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2035 if (!CopyFile (SDATA (encoded_file
),
2036 SDATA (encoded_newname
),
2039 /* CopyFile doesn't set errno when it fails. By far the most
2040 "popular" reason is that the target is read-only. */
2041 if (GetLastError () == 5)
2045 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2047 /* CopyFile retains the timestamp by default. */
2048 else if (NILP (keep_time
))
2054 filename
= SDATA (encoded_newname
);
2056 /* Ensure file is writable while its modified time is set. */
2057 attributes
= GetFileAttributes (filename
);
2058 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2059 now
= current_emacs_time ();
2060 if (set_file_times (-1, filename
, now
, now
))
2062 /* Restore original attributes. */
2063 SetFileAttributes (filename
, attributes
);
2064 xsignal2 (Qfile_date_error
,
2065 build_string ("Cannot set file date"), newname
);
2067 /* Restore original attributes. */
2068 SetFileAttributes (filename
, attributes
);
2070 #ifdef HAVE_POSIX_ACL
2074 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2075 if (fail
&& !ACL_NOT_WELL_SUPPORTED (errno
))
2076 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2081 #else /* not WINDOWSNT */
2083 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2087 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2089 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2091 if (fstat (ifd
, &st
) != 0)
2092 report_file_error ("Input file status", Fcons (file
, Qnil
));
2094 if (!NILP (preserve_extended_attributes
))
2097 if (is_selinux_enabled ())
2099 conlength
= fgetfilecon (ifd
, &con
);
2100 if (conlength
== -1)
2101 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
2105 #ifdef HAVE_POSIX_ACL
2106 acl
= acl_get_fd (ifd
);
2107 if (acl
== NULL
&& !ACL_NOT_WELL_SUPPORTED (errno
))
2108 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2112 if (out_st
.st_mode
!= 0
2113 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2116 report_file_error ("Input and output files are the same",
2117 Fcons (file
, Fcons (newname
, Qnil
)));
2120 /* We can copy only regular files. */
2121 if (!S_ISREG (st
.st_mode
))
2123 /* Get a better looking error message. */
2124 errno
= S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
;
2125 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2129 /* System's default file type was set to binary by _fmode in emacs.c. */
2130 ofd
= emacs_open (SDATA (encoded_newname
),
2131 O_WRONLY
| O_TRUNC
| O_CREAT
2132 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2133 S_IREAD
| S_IWRITE
);
2134 #else /* not MSDOS */
2136 mode_t new_mask
= !NILP (preserve_uid_gid
) ? 0600 : 0666;
2137 new_mask
&= st
.st_mode
;
2138 ofd
= emacs_open (SSDATA (encoded_newname
),
2139 (O_WRONLY
| O_TRUNC
| O_CREAT
2140 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2143 #endif /* not MSDOS */
2145 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2147 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2151 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2152 if (emacs_write (ofd
, buf
, n
) != n
)
2153 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2157 /* Preserve the original file modes, and if requested, also its
2160 mode_t mode_mask
= 07777;
2161 if (!NILP (preserve_uid_gid
))
2163 /* Attempt to change owner and group. If that doesn't work
2164 attempt to change just the group, as that is sometimes allowed.
2165 Adjust the mode mask to eliminate setuid or setgid bits
2166 that are inappropriate if the owner and group are wrong. */
2167 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2169 mode_mask
&= ~06000;
2170 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2174 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2175 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2177 #endif /* not MSDOS */
2182 /* Set the modified context back to the file. */
2183 bool fail
= fsetfilecon (ofd
, con
) != 0;
2184 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2185 if (fail
&& errno
!= ENOTSUP
)
2186 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2192 #ifdef HAVE_POSIX_ACL
2195 bool fail
= acl_set_fd (ofd
, acl
) != 0;
2196 if (fail
&& !ACL_NOT_WELL_SUPPORTED (errno
))
2197 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2203 if (!NILP (keep_time
))
2205 EMACS_TIME atime
= get_stat_atime (&st
);
2206 EMACS_TIME mtime
= get_stat_mtime (&st
);
2207 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2208 xsignal2 (Qfile_date_error
,
2209 build_string ("Cannot set file date"), newname
);
2212 if (emacs_close (ofd
) < 0)
2213 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2218 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2219 and if it can't, it tells so. Otherwise, under MSDOS we usually
2220 get only the READ bit, which will make the copied file read-only,
2221 so it's better not to chmod at all. */
2222 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2223 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2225 #endif /* not WINDOWSNT */
2227 /* Discard the unwind protects. */
2228 specpdl_ptr
= specpdl
+ count
;
2234 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2235 Smake_directory_internal
, 1, 1, 0,
2236 doc
: /* Create a new directory named DIRECTORY. */)
2237 (Lisp_Object directory
)
2240 Lisp_Object handler
;
2241 Lisp_Object encoded_dir
;
2243 CHECK_STRING (directory
);
2244 directory
= Fexpand_file_name (directory
, Qnil
);
2246 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2247 if (!NILP (handler
))
2248 return call2 (handler
, Qmake_directory_internal
, directory
);
2250 encoded_dir
= ENCODE_FILE (directory
);
2252 dir
= SSDATA (encoded_dir
);
2255 if (mkdir (dir
) != 0)
2257 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2259 report_file_error ("Creating directory", list1 (directory
));
2264 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2265 Sdelete_directory_internal
, 1, 1, 0,
2266 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2267 (Lisp_Object directory
)
2270 Lisp_Object encoded_dir
;
2272 CHECK_STRING (directory
);
2273 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2274 encoded_dir
= ENCODE_FILE (directory
);
2275 dir
= SSDATA (encoded_dir
);
2277 if (rmdir (dir
) != 0)
2278 report_file_error ("Removing directory", list1 (directory
));
2283 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2284 "(list (read-file-name \
2285 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2286 \"Move file to trash: \" \"Delete file: \") \
2287 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2288 (null current-prefix-arg))",
2289 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2290 If file has multiple names, it continues to exist with the other names.
2291 TRASH non-nil means to trash the file instead of deleting, provided
2292 `delete-by-moving-to-trash' is non-nil.
2294 When called interactively, TRASH is t if no prefix argument is given.
2295 With a prefix argument, TRASH is nil. */)
2296 (Lisp_Object filename
, Lisp_Object trash
)
2298 Lisp_Object handler
;
2299 Lisp_Object encoded_file
;
2300 struct gcpro gcpro1
;
2303 if (!NILP (Ffile_directory_p (filename
))
2304 && NILP (Ffile_symlink_p (filename
)))
2305 xsignal2 (Qfile_error
,
2306 build_string ("Removing old name: is a directory"),
2309 filename
= Fexpand_file_name (filename
, Qnil
);
2311 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2312 if (!NILP (handler
))
2313 return call3 (handler
, Qdelete_file
, filename
, trash
);
2315 if (delete_by_moving_to_trash
&& !NILP (trash
))
2316 return call1 (Qmove_file_to_trash
, filename
);
2318 encoded_file
= ENCODE_FILE (filename
);
2320 if (unlink (SSDATA (encoded_file
)) < 0)
2321 report_file_error ("Removing old name", list1 (filename
));
2326 internal_delete_file_1 (Lisp_Object ignore
)
2331 /* Delete file FILENAME, returning true if successful.
2332 This ignores `delete-by-moving-to-trash'. */
2335 internal_delete_file (Lisp_Object filename
)
2339 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2340 Qt
, internal_delete_file_1
);
2344 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2345 "fRename file: \nGRename %s to file: \np",
2346 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2347 If file has names other than FILE, it continues to have those names.
2348 Signals a `file-already-exists' error if a file NEWNAME already exists
2349 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2350 A number as third arg means request confirmation if NEWNAME already exists.
2351 This is what happens in interactive use with M-x. */)
2352 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2354 Lisp_Object handler
;
2355 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2356 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2358 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2359 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2360 CHECK_STRING (file
);
2361 CHECK_STRING (newname
);
2362 file
= Fexpand_file_name (file
, Qnil
);
2364 if ((!NILP (Ffile_directory_p (newname
)))
2366 /* If the file names are identical but for the case,
2367 don't attempt to move directory to itself. */
2368 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2372 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2373 ? file
: Fdirectory_file_name (file
));
2374 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2377 newname
= Fexpand_file_name (newname
, Qnil
);
2379 /* If the file name has special constructs in it,
2380 call the corresponding file handler. */
2381 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2383 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2384 if (!NILP (handler
))
2385 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2386 file
, newname
, ok_if_already_exists
));
2388 encoded_file
= ENCODE_FILE (file
);
2389 encoded_newname
= ENCODE_FILE (newname
);
2392 /* If the file names are identical but for the case, don't ask for
2393 confirmation: they simply want to change the letter-case of the
2395 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2397 if (NILP (ok_if_already_exists
)
2398 || INTEGERP (ok_if_already_exists
))
2399 barf_or_query_if_file_exists (newname
, "rename to it",
2400 INTEGERP (ok_if_already_exists
), 0, 0);
2401 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2406 symlink_target
= Ffile_symlink_p (file
);
2407 if (! NILP (symlink_target
))
2408 Fmake_symbolic_link (symlink_target
, newname
,
2409 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2410 else if (!NILP (Ffile_directory_p (file
)))
2411 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2413 /* We have already prompted if it was an integer, so don't
2414 have copy-file prompt again. */
2415 Fcopy_file (file
, newname
,
2416 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2419 count
= SPECPDL_INDEX ();
2420 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2422 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2423 call2 (Qdelete_directory
, file
, Qt
);
2425 Fdelete_file (file
, Qnil
);
2426 unbind_to (count
, Qnil
);
2429 report_file_error ("Renaming", list2 (file
, newname
));
2435 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2436 "fAdd name to file: \nGName to add to %s: \np",
2437 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2438 Signals a `file-already-exists' error if a file NEWNAME already exists
2439 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2440 A number as third arg means request confirmation if NEWNAME already exists.
2441 This is what happens in interactive use with M-x. */)
2442 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2444 Lisp_Object handler
;
2445 Lisp_Object encoded_file
, encoded_newname
;
2446 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2448 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2449 encoded_file
= encoded_newname
= Qnil
;
2450 CHECK_STRING (file
);
2451 CHECK_STRING (newname
);
2452 file
= Fexpand_file_name (file
, Qnil
);
2454 if (!NILP (Ffile_directory_p (newname
)))
2455 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2457 newname
= Fexpand_file_name (newname
, Qnil
);
2459 /* If the file name has special constructs in it,
2460 call the corresponding file handler. */
2461 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2462 if (!NILP (handler
))
2463 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2464 newname
, ok_if_already_exists
));
2466 /* If the new name has special constructs in it,
2467 call the corresponding file handler. */
2468 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2469 if (!NILP (handler
))
2470 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2471 newname
, ok_if_already_exists
));
2473 encoded_file
= ENCODE_FILE (file
);
2474 encoded_newname
= ENCODE_FILE (newname
);
2476 if (NILP (ok_if_already_exists
)
2477 || INTEGERP (ok_if_already_exists
))
2478 barf_or_query_if_file_exists (newname
, "make it a new name",
2479 INTEGERP (ok_if_already_exists
), 0, 0);
2481 unlink (SSDATA (newname
));
2482 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2483 report_file_error ("Adding new name", list2 (file
, newname
));
2489 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2490 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2491 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2492 Both args must be strings.
2493 Signals a `file-already-exists' error if a file LINKNAME already exists
2494 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2495 A number as third arg means request confirmation if LINKNAME already exists.
2496 This happens for interactive use with M-x. */)
2497 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2499 Lisp_Object handler
;
2500 Lisp_Object encoded_filename
, encoded_linkname
;
2501 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2503 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2504 encoded_filename
= encoded_linkname
= Qnil
;
2505 CHECK_STRING (filename
);
2506 CHECK_STRING (linkname
);
2507 /* If the link target has a ~, we must expand it to get
2508 a truly valid file name. Otherwise, do not expand;
2509 we want to permit links to relative file names. */
2510 if (SREF (filename
, 0) == '~')
2511 filename
= Fexpand_file_name (filename
, Qnil
);
2513 if (!NILP (Ffile_directory_p (linkname
)))
2514 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2516 linkname
= Fexpand_file_name (linkname
, Qnil
);
2518 /* If the file name has special constructs in it,
2519 call the corresponding file handler. */
2520 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2521 if (!NILP (handler
))
2522 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2523 linkname
, ok_if_already_exists
));
2525 /* If the new link name has special constructs in it,
2526 call the corresponding file handler. */
2527 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2528 if (!NILP (handler
))
2529 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2530 linkname
, ok_if_already_exists
));
2532 encoded_filename
= ENCODE_FILE (filename
);
2533 encoded_linkname
= ENCODE_FILE (linkname
);
2535 if (NILP (ok_if_already_exists
)
2536 || INTEGERP (ok_if_already_exists
))
2537 barf_or_query_if_file_exists (linkname
, "make it a link",
2538 INTEGERP (ok_if_already_exists
), 0, 0);
2539 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2541 /* If we didn't complain already, silently delete existing file. */
2542 if (errno
== EEXIST
)
2544 unlink (SSDATA (encoded_linkname
));
2545 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2552 if (errno
== ENOSYS
)
2555 xsignal1 (Qfile_error
,
2556 build_string ("Symbolic links are not supported"));
2559 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2566 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2568 doc
: /* Return t if file FILENAME specifies an absolute file name.
2569 On Unix, this is a name starting with a `/' or a `~'. */)
2570 (Lisp_Object filename
)
2572 CHECK_STRING (filename
);
2573 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2576 /* Return true if FILENAME exists. */
2578 check_existing (const char *filename
)
2580 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2583 /* Return true if file FILENAME exists and can be executed. */
2586 check_executable (char *filename
)
2588 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2591 /* Return true if file FILENAME exists and can be accessed
2592 according to AMODE, which should include W_OK.
2593 On failure, return false and set errno. */
2596 check_writable (const char *filename
, int amode
)
2599 /* FIXME: an faccessat implementation should be added to the
2600 DOS/Windows ports and this #ifdef branch should be removed. */
2602 if (stat (filename
, &st
) < 0)
2605 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2606 #else /* not MSDOS */
2607 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2609 /* faccessat may have returned failure because Cygwin couldn't
2610 determine the file's UID or GID; if so, we return success. */
2613 int faccessat_errno
= errno
;
2615 if (stat (filename
, &st
) < 0)
2617 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2618 errno
= faccessat_errno
;
2622 #endif /* not MSDOS */
2625 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2626 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2627 See also `file-readable-p' and `file-attributes'.
2628 This returns nil for a symlink to a nonexistent file.
2629 Use `file-symlink-p' to test for such links. */)
2630 (Lisp_Object filename
)
2632 Lisp_Object absname
;
2633 Lisp_Object handler
;
2635 CHECK_STRING (filename
);
2636 absname
= Fexpand_file_name (filename
, Qnil
);
2638 /* If the file name has special constructs in it,
2639 call the corresponding file handler. */
2640 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2641 if (!NILP (handler
))
2642 return call2 (handler
, Qfile_exists_p
, absname
);
2644 absname
= ENCODE_FILE (absname
);
2646 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2649 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2650 doc
: /* Return t if FILENAME can be executed by you.
2651 For a directory, this means you can access files in that directory. */)
2652 (Lisp_Object filename
)
2654 Lisp_Object absname
;
2655 Lisp_Object handler
;
2657 CHECK_STRING (filename
);
2658 absname
= Fexpand_file_name (filename
, Qnil
);
2660 /* If the file name has special constructs in it,
2661 call the corresponding file handler. */
2662 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2663 if (!NILP (handler
))
2664 return call2 (handler
, Qfile_executable_p
, absname
);
2666 absname
= ENCODE_FILE (absname
);
2668 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2671 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2672 doc
: /* Return t if file FILENAME exists and you can read it.
2673 See also `file-exists-p' and `file-attributes'. */)
2674 (Lisp_Object filename
)
2676 Lisp_Object absname
;
2677 Lisp_Object handler
;
2679 CHECK_STRING (filename
);
2680 absname
= Fexpand_file_name (filename
, Qnil
);
2682 /* If the file name has special constructs in it,
2683 call the corresponding file handler. */
2684 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2685 if (!NILP (handler
))
2686 return call2 (handler
, Qfile_readable_p
, absname
);
2688 absname
= ENCODE_FILE (absname
);
2689 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2693 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2694 doc
: /* Return t if file FILENAME can be written or created by you. */)
2695 (Lisp_Object filename
)
2697 Lisp_Object absname
, dir
, encoded
;
2698 Lisp_Object handler
;
2700 CHECK_STRING (filename
);
2701 absname
= Fexpand_file_name (filename
, Qnil
);
2703 /* If the file name has special constructs in it,
2704 call the corresponding file handler. */
2705 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2706 if (!NILP (handler
))
2707 return call2 (handler
, Qfile_writable_p
, absname
);
2709 encoded
= ENCODE_FILE (absname
);
2710 if (check_writable (SSDATA (encoded
), W_OK
))
2712 if (errno
!= ENOENT
)
2715 dir
= Ffile_name_directory (absname
);
2716 eassert (!NILP (dir
));
2718 dir
= Fdirectory_file_name (dir
);
2721 dir
= ENCODE_FILE (dir
);
2723 /* The read-only attribute of the parent directory doesn't affect
2724 whether a file or directory can be created within it. Some day we
2725 should check ACLs though, which do affect this. */
2726 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2728 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2732 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2733 doc
: /* Access file FILENAME, and get an error if that does not work.
2734 The second argument STRING is used in the error message.
2735 If there is no error, returns nil. */)
2736 (Lisp_Object filename
, Lisp_Object string
)
2738 Lisp_Object handler
, encoded_filename
, absname
;
2741 CHECK_STRING (filename
);
2742 absname
= Fexpand_file_name (filename
, Qnil
);
2744 CHECK_STRING (string
);
2746 /* If the file name has special constructs in it,
2747 call the corresponding file handler. */
2748 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2749 if (!NILP (handler
))
2750 return call3 (handler
, Qaccess_file
, absname
, string
);
2752 encoded_filename
= ENCODE_FILE (absname
);
2754 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2756 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2762 /* Relative to directory FD, return the symbolic link value of FILENAME.
2763 On failure, return nil. */
2765 emacs_readlinkat (int fd
, char const *filename
)
2767 static struct allocator
const emacs_norealloc_allocator
=
2768 { xmalloc
, NULL
, xfree
, memory_full
};
2770 char readlink_buf
[1024];
2771 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2772 &emacs_norealloc_allocator
, readlinkat
);
2776 val
= build_string (buf
);
2777 if (buf
[0] == '/' && strchr (buf
, ':'))
2778 val
= concat2 (build_string ("/:"), val
);
2779 if (buf
!= readlink_buf
)
2781 val
= DECODE_FILE (val
);
2785 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2786 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2787 The value is the link target, as a string.
2788 Otherwise it returns nil.
2790 This function returns t when given the name of a symlink that
2791 points to a nonexistent file. */)
2792 (Lisp_Object filename
)
2794 Lisp_Object handler
;
2796 CHECK_STRING (filename
);
2797 filename
= Fexpand_file_name (filename
, Qnil
);
2799 /* If the file name has special constructs in it,
2800 call the corresponding file handler. */
2801 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2802 if (!NILP (handler
))
2803 return call2 (handler
, Qfile_symlink_p
, filename
);
2805 filename
= ENCODE_FILE (filename
);
2807 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2810 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2811 doc
: /* Return t if FILENAME names an existing directory.
2812 Symbolic links to directories count as directories.
2813 See `file-symlink-p' to distinguish symlinks. */)
2814 (Lisp_Object filename
)
2816 Lisp_Object absname
;
2817 Lisp_Object handler
;
2819 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2821 /* If the file name has special constructs in it,
2822 call the corresponding file handler. */
2823 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2824 if (!NILP (handler
))
2825 return call2 (handler
, Qfile_directory_p
, absname
);
2827 absname
= ENCODE_FILE (absname
);
2829 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2832 /* Return true if FILE is a directory or a symlink to a directory. */
2834 file_directory_p (char const *file
)
2837 /* This is cheaper than 'stat'. */
2838 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2841 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2845 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2846 Sfile_accessible_directory_p
, 1, 1, 0,
2847 doc
: /* Return t if file FILENAME names a directory you can open.
2848 For the value to be t, FILENAME must specify the name of a directory as a file,
2849 and the directory must allow you to open files in it. In order to use a
2850 directory as a buffer's current directory, this predicate must return true.
2851 A directory name spec may be given instead; then the value is t
2852 if the directory so specified exists and really is a readable and
2853 searchable directory. */)
2854 (Lisp_Object filename
)
2856 Lisp_Object absname
;
2857 Lisp_Object handler
;
2859 CHECK_STRING (filename
);
2860 absname
= Fexpand_file_name (filename
, Qnil
);
2862 /* If the file name has special constructs in it,
2863 call the corresponding file handler. */
2864 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2865 if (!NILP (handler
))
2866 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2868 absname
= ENCODE_FILE (absname
);
2869 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2872 /* If FILE is a searchable directory or a symlink to a
2873 searchable directory, return true. Otherwise return
2874 false and set errno to an error number. */
2876 file_accessible_directory_p (char const *file
)
2879 /* There's no need to test whether FILE is searchable, as the
2880 searchable/executable bit is invented on DOS_NT platforms. */
2881 return file_directory_p (file
);
2883 /* On POSIXish platforms, use just one system call; this avoids a
2884 race and is typically faster. */
2885 ptrdiff_t len
= strlen (file
);
2891 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2892 There are three exceptions: "", "/", and "//". Leave "" alone,
2893 as it's invalid. Append only "." to the other two exceptions as
2894 "/" and "//" are distinct on some platforms, whereas "/", "///",
2895 "////", etc. are all equivalent. */
2900 /* Just check for trailing '/' when deciding whether to append '/'.
2901 That's simpler than testing the two special cases "/" and "//",
2902 and it's a safe optimization here. */
2903 char *buf
= SAFE_ALLOCA (len
+ 3);
2904 memcpy (buf
, file
, len
);
2905 strcpy (buf
+ len
, "/." + (file
[len
- 1] == '/'));
2909 ok
= check_existing (dir
);
2910 saved_errno
= errno
;
2912 errno
= saved_errno
;
2917 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2918 doc
: /* Return t if FILENAME names a regular file.
2919 This is the sort of file that holds an ordinary stream of data bytes.
2920 Symbolic links to regular files count as regular files.
2921 See `file-symlink-p' to distinguish symlinks. */)
2922 (Lisp_Object filename
)
2924 register Lisp_Object absname
;
2926 Lisp_Object handler
;
2928 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2930 /* If the file name has special constructs in it,
2931 call the corresponding file handler. */
2932 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2933 if (!NILP (handler
))
2934 return call2 (handler
, Qfile_regular_p
, absname
);
2936 absname
= ENCODE_FILE (absname
);
2941 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2943 /* Tell stat to use expensive method to get accurate info. */
2944 Vw32_get_true_file_attributes
= Qt
;
2945 result
= stat (SDATA (absname
), &st
);
2946 Vw32_get_true_file_attributes
= tem
;
2950 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2953 if (stat (SSDATA (absname
), &st
) < 0)
2955 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2959 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2960 Sfile_selinux_context
, 1, 1, 0,
2961 doc
: /* Return SELinux context of file named FILENAME.
2962 The return value is a list (USER ROLE TYPE RANGE), where the list
2963 elements are strings naming the user, role, type, and range of the
2964 file's SELinux security context.
2966 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2967 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2968 (Lisp_Object filename
)
2970 Lisp_Object absname
;
2971 Lisp_Object values
[4];
2972 Lisp_Object handler
;
2974 security_context_t con
;
2979 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2981 /* If the file name has special constructs in it,
2982 call the corresponding file handler. */
2983 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2984 if (!NILP (handler
))
2985 return call2 (handler
, Qfile_selinux_context
, absname
);
2987 absname
= ENCODE_FILE (absname
);
2994 if (is_selinux_enabled ())
2996 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2999 context
= context_new (con
);
3000 if (context_user_get (context
))
3001 values
[0] = build_string (context_user_get (context
));
3002 if (context_role_get (context
))
3003 values
[1] = build_string (context_role_get (context
));
3004 if (context_type_get (context
))
3005 values
[2] = build_string (context_type_get (context
));
3006 if (context_range_get (context
))
3007 values
[3] = build_string (context_range_get (context
));
3008 context_free (context
);
3014 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
3017 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
3018 Sset_file_selinux_context
, 2, 2, 0,
3019 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
3020 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
3021 elements are strings naming the components of a SELinux context.
3023 Value is t if setting of SELinux context was successful, nil otherwise.
3025 This function does nothing and returns nil if SELinux is disabled,
3026 or if Emacs was not compiled with SELinux support. */)
3027 (Lisp_Object filename
, Lisp_Object context
)
3029 Lisp_Object absname
;
3030 Lisp_Object handler
;
3032 Lisp_Object encoded_absname
;
3033 Lisp_Object user
= CAR_SAFE (context
);
3034 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
3035 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
3036 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
3037 security_context_t con
;
3040 context_t parsed_con
;
3043 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3045 /* If the file name has special constructs in it,
3046 call the corresponding file handler. */
3047 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
3048 if (!NILP (handler
))
3049 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
3052 if (is_selinux_enabled ())
3054 /* Get current file context. */
3055 encoded_absname
= ENCODE_FILE (absname
);
3056 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
3059 parsed_con
= context_new (con
);
3060 /* Change the parts defined in the parameter.*/
3063 if (context_user_set (parsed_con
, SSDATA (user
)))
3064 error ("Doing context_user_set");
3068 if (context_role_set (parsed_con
, SSDATA (role
)))
3069 error ("Doing context_role_set");
3073 if (context_type_set (parsed_con
, SSDATA (type
)))
3074 error ("Doing context_type_set");
3076 if (STRINGP (range
))
3078 if (context_range_set (parsed_con
, SSDATA (range
)))
3079 error ("Doing context_range_set");
3082 /* Set the modified context back to the file. */
3083 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3084 context_str (parsed_con
))
3086 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3087 if (fail
&& errno
!= ENOTSUP
)
3088 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
3090 context_free (parsed_con
);
3092 return fail
? Qnil
: Qt
;
3095 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
3102 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3103 doc
: /* Return ACL entries of file named FILENAME.
3104 The entries are returned in a format suitable for use in `set-file-acl'
3105 but is otherwise undocumented and subject to change.
3106 Return nil if file does not exist or is not accessible, or if Emacs
3107 was unable to determine the ACL entries. */)
3108 (Lisp_Object filename
)
3110 Lisp_Object absname
;
3111 Lisp_Object handler
;
3112 #ifdef HAVE_POSIX_ACL
3114 Lisp_Object acl_string
;
3118 absname
= expand_and_dir_to_file (filename
,
3119 BVAR (current_buffer
, directory
));
3121 /* If the file name has special constructs in it,
3122 call the corresponding file handler. */
3123 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3124 if (!NILP (handler
))
3125 return call2 (handler
, Qfile_acl
, absname
);
3127 #ifdef HAVE_POSIX_ACL
3128 absname
= ENCODE_FILE (absname
);
3130 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3134 str
= acl_to_text (acl
, NULL
);
3141 acl_string
= build_string (str
);
3151 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3153 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3154 ACL-STRING should contain the textual representation of the ACL
3155 entries in a format suitable for the platform.
3157 Value is t if setting of ACL was successful, nil otherwise.
3159 Setting ACL for local files requires Emacs to be built with ACL
3161 (Lisp_Object filename
, Lisp_Object acl_string
)
3163 Lisp_Object absname
;
3164 Lisp_Object handler
;
3165 #ifdef HAVE_POSIX_ACL
3166 Lisp_Object encoded_absname
;
3171 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3173 /* If the file name has special constructs in it,
3174 call the corresponding file handler. */
3175 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3176 if (!NILP (handler
))
3177 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3179 #ifdef HAVE_POSIX_ACL
3180 if (STRINGP (acl_string
))
3182 acl
= acl_from_text (SSDATA (acl_string
));
3185 report_file_error ("Converting ACL", Fcons (absname
, Qnil
));
3189 encoded_absname
= ENCODE_FILE (absname
);
3191 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3194 if (fail
&& !ACL_NOT_WELL_SUPPORTED (errno
))
3195 report_file_error ("Setting ACL", Fcons (absname
, Qnil
));
3198 return fail
? Qnil
: Qt
;
3205 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3206 doc
: /* Return mode bits of file named FILENAME, as an integer.
3207 Return nil, if file does not exist or is not accessible. */)
3208 (Lisp_Object filename
)
3210 Lisp_Object absname
;
3212 Lisp_Object handler
;
3214 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3216 /* If the file name has special constructs in it,
3217 call the corresponding file handler. */
3218 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3219 if (!NILP (handler
))
3220 return call2 (handler
, Qfile_modes
, absname
);
3222 absname
= ENCODE_FILE (absname
);
3224 if (stat (SSDATA (absname
), &st
) < 0)
3227 return make_number (st
.st_mode
& 07777);
3230 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3231 "(let ((file (read-file-name \"File: \"))) \
3232 (list file (read-file-modes nil file)))",
3233 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3234 Only the 12 low bits of MODE are used.
3236 Interactively, mode bits are read by `read-file-modes', which accepts
3237 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3238 (Lisp_Object filename
, Lisp_Object mode
)
3240 Lisp_Object absname
, encoded_absname
;
3241 Lisp_Object handler
;
3243 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3244 CHECK_NUMBER (mode
);
3246 /* If the file name has special constructs in it,
3247 call the corresponding file handler. */
3248 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3249 if (!NILP (handler
))
3250 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3252 encoded_absname
= ENCODE_FILE (absname
);
3254 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3255 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3260 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3261 doc
: /* Set the file permission bits for newly created files.
3262 The argument MODE should be an integer; only the low 9 bits are used.
3263 This setting is inherited by subprocesses. */)
3266 CHECK_NUMBER (mode
);
3268 umask ((~ XINT (mode
)) & 0777);
3273 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3274 doc
: /* Return the default file protection for created files.
3275 The value is an integer. */)
3282 realmask
= umask (0);
3286 XSETINT (value
, (~ realmask
) & 0777);
3291 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3292 doc
: /* Set times of file FILENAME to TIMESTAMP.
3293 Set both access and modification times.
3294 Return t on success, else nil.
3295 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3297 (Lisp_Object filename
, Lisp_Object timestamp
)
3299 Lisp_Object absname
, encoded_absname
;
3300 Lisp_Object handler
;
3301 EMACS_TIME t
= lisp_time_argument (timestamp
);
3303 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3305 /* If the file name has special constructs in it,
3306 call the corresponding file handler. */
3307 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3308 if (!NILP (handler
))
3309 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3311 encoded_absname
= ENCODE_FILE (absname
);
3314 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3317 /* Setting times on a directory always fails. */
3318 if (file_directory_p (SSDATA (encoded_absname
)))
3321 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3329 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3330 doc
: /* Tell Unix to finish all pending disk updates. */)
3337 #endif /* HAVE_SYNC */
3339 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3340 doc
: /* Return t if file FILE1 is newer than file FILE2.
3341 If FILE1 does not exist, the answer is nil;
3342 otherwise, if FILE2 does not exist, the answer is t. */)
3343 (Lisp_Object file1
, Lisp_Object file2
)
3345 Lisp_Object absname1
, absname2
;
3346 struct stat st1
, st2
;
3347 Lisp_Object handler
;
3348 struct gcpro gcpro1
, gcpro2
;
3350 CHECK_STRING (file1
);
3351 CHECK_STRING (file2
);
3354 GCPRO2 (absname1
, file2
);
3355 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3356 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3359 /* If the file name has special constructs in it,
3360 call the corresponding file handler. */
3361 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3363 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3364 if (!NILP (handler
))
3365 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3367 GCPRO2 (absname1
, absname2
);
3368 absname1
= ENCODE_FILE (absname1
);
3369 absname2
= ENCODE_FILE (absname2
);
3372 if (stat (SSDATA (absname1
), &st1
) < 0)
3375 if (stat (SSDATA (absname2
), &st2
) < 0)
3378 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3382 #ifndef READ_BUF_SIZE
3383 #define READ_BUF_SIZE (64 << 10)
3385 /* Some buffer offsets are stored in 'int' variables. */
3386 verify (READ_BUF_SIZE
<= INT_MAX
);
3388 /* This function is called after Lisp functions to decide a coding
3389 system are called, or when they cause an error. Before they are
3390 called, the current buffer is set unibyte and it contains only a
3391 newly inserted text (thus the buffer was empty before the
3394 The functions may set markers, overlays, text properties, or even
3395 alter the buffer contents, change the current buffer.
3397 Here, we reset all those changes by:
3398 o set back the current buffer.
3399 o move all markers and overlays to BEG.
3400 o remove all text properties.
3401 o set back the buffer multibyteness. */
3404 decide_coding_unwind (Lisp_Object unwind_data
)
3406 Lisp_Object multibyte
, undo_list
, buffer
;
3408 multibyte
= XCAR (unwind_data
);
3409 unwind_data
= XCDR (unwind_data
);
3410 undo_list
= XCAR (unwind_data
);
3411 buffer
= XCDR (unwind_data
);
3413 set_buffer_internal (XBUFFER (buffer
));
3414 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3415 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3416 set_buffer_intervals (current_buffer
, NULL
);
3417 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3419 /* Now we are safe to change the buffer's multibyteness directly. */
3420 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3421 bset_undo_list (current_buffer
, undo_list
);
3426 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3427 object where slot 0 is the file descriptor, slot 1 specifies
3428 an offset to put the read bytes, and slot 2 is the maximum
3429 amount of bytes to read. Value is the number of bytes read. */
3432 read_non_regular (Lisp_Object state
)
3438 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3439 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3440 + XSAVE_INTEGER (state
, 1)),
3441 XSAVE_INTEGER (state
, 2));
3443 /* Fast recycle this object for the likely next call. */
3445 return make_number (nbytes
);
3449 /* Condition-case handler used when reading from non-regular files
3450 in insert-file-contents. */
3453 read_non_regular_quit (Lisp_Object ignore
)
3458 /* Return the file offset that VAL represents, checking for type
3459 errors and overflow. */
3461 file_offset (Lisp_Object val
)
3463 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3468 double v
= XFLOAT_DATA (val
);
3470 && (sizeof (off_t
) < sizeof v
3471 ? v
<= TYPE_MAXIMUM (off_t
)
3472 : v
< TYPE_MAXIMUM (off_t
)))
3476 wrong_type_argument (intern ("file-offset"), val
);
3479 /* Return a special time value indicating the error number ERRNUM. */
3481 time_error_value (int errnum
)
3483 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3484 ? NONEXISTENT_MODTIME_NSECS
3485 : UNKNOWN_MODTIME_NSECS
);
3486 return make_emacs_time (0, ns
);
3489 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3491 doc
: /* Insert contents of file FILENAME after point.
3492 Returns list of absolute file name and number of characters inserted.
3493 If second argument VISIT is non-nil, the buffer's visited filename and
3494 last save file modtime are set, and it is marked unmodified. If
3495 visiting and the file does not exist, visiting is completed before the
3498 The optional third and fourth arguments BEG and END specify what portion
3499 of the file to insert. These arguments count bytes in the file, not
3500 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3502 If optional fifth argument REPLACE is non-nil, replace the current
3503 buffer contents (in the accessible portion) with the file contents.
3504 This is better than simply deleting and inserting the whole thing
3505 because (1) it preserves some marker positions and (2) it puts less data
3506 in the undo list. When REPLACE is non-nil, the second return value is
3507 the number of characters that replace previous buffer contents.
3509 This function does code conversion according to the value of
3510 `coding-system-for-read' or `file-coding-system-alist', and sets the
3511 variable `last-coding-system-used' to the coding system actually used.
3513 In addition, this function decodes the inserted text from known formats
3514 by calling `format-decode', which see. */)
3515 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3520 ptrdiff_t inserted
= 0;
3523 off_t beg_offset
, end_offset
;
3525 ptrdiff_t count
= SPECPDL_INDEX ();
3526 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3527 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3529 ptrdiff_t total
= 0;
3530 bool not_regular
= 0;
3532 char read_buf
[READ_BUF_SIZE
];
3533 struct coding_system coding
;
3534 bool replace_handled
= 0;
3535 bool set_coding_system
= 0;
3536 Lisp_Object coding_system
;
3538 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3539 bool we_locked_file
= 0;
3540 bool deferred_remove_unwind_protect
= 0;
3542 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3543 error ("Cannot do file visiting in an indirect buffer");
3545 if (!NILP (BVAR (current_buffer
, read_only
)))
3546 Fbarf_if_buffer_read_only ();
3550 orig_filename
= Qnil
;
3553 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3555 CHECK_STRING (filename
);
3556 filename
= Fexpand_file_name (filename
, Qnil
);
3558 /* The value Qnil means that the coding system is not yet
3560 coding_system
= Qnil
;
3562 /* If the file name has special constructs in it,
3563 call the corresponding file handler. */
3564 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3565 if (!NILP (handler
))
3567 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3568 visit
, beg
, end
, replace
);
3569 if (CONSP (val
) && CONSP (XCDR (val
))
3570 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3571 inserted
= XINT (XCAR (XCDR (val
)));
3575 orig_filename
= filename
;
3576 filename
= ENCODE_FILE (filename
);
3578 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3583 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3584 mtime
= time_error_value (save_errno
);
3586 if (!NILP (Vcoding_system_for_read
))
3587 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3591 /* Replacement should preserve point as it preserves markers. */
3592 if (!NILP (replace
))
3593 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3595 record_unwind_protect (close_file_unwind
, make_number (fd
));
3597 if (fstat (fd
, &st
) != 0)
3598 report_file_error ("Input file status", Fcons (orig_filename
, Qnil
));
3599 mtime
= get_stat_mtime (&st
);
3601 /* This code will need to be changed in order to work on named
3602 pipes, and it's probably just not worth it. So we should at
3603 least signal an error. */
3604 if (!S_ISREG (st
.st_mode
))
3611 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3612 xsignal2 (Qfile_error
,
3613 build_string ("not a regular file"), orig_filename
);
3618 if (!NILP (beg
) || !NILP (end
))
3619 error ("Attempt to visit less than an entire file");
3620 if (BEG
< Z
&& NILP (replace
))
3621 error ("Cannot do file visiting in a non-empty buffer");
3625 beg_offset
= file_offset (beg
);
3630 end_offset
= file_offset (end
);
3634 end_offset
= TYPE_MAXIMUM (off_t
);
3637 end_offset
= st
.st_size
;
3639 /* A negative size can happen on a platform that allows file
3640 sizes greater than the maximum off_t value. */
3644 /* The file size returned from stat may be zero, but data
3645 may be readable nonetheless, for example when this is a
3646 file in the /proc filesystem. */
3647 if (end_offset
== 0)
3648 end_offset
= READ_BUF_SIZE
;
3652 /* Check now whether the buffer will become too large,
3653 in the likely case where the file's length is not changing.
3654 This saves a lot of needless work before a buffer overflow. */
3657 /* The likely offset where we will stop reading. We could read
3658 more (or less), if the file grows (or shrinks) as we read it. */
3659 off_t likely_end
= min (end_offset
, st
.st_size
);
3661 if (beg_offset
< likely_end
)
3664 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3665 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3666 off_t likely_growth
= likely_end
- beg_offset
;
3667 if (buf_growth_max
< likely_growth
)
3672 /* Prevent redisplay optimizations. */
3673 current_buffer
->clip_changed
= 1;
3675 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3677 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3678 setup_coding_system (coding_system
, &coding
);
3679 /* Ensure we set Vlast_coding_system_used. */
3680 set_coding_system
= 1;
3684 /* Decide the coding system to use for reading the file now
3685 because we can't use an optimized method for handling
3686 `coding:' tag if the current buffer is not empty. */
3687 if (!NILP (Vcoding_system_for_read
))
3688 coding_system
= Vcoding_system_for_read
;
3691 /* Don't try looking inside a file for a coding system
3692 specification if it is not seekable. */
3693 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3695 /* Find a coding system specified in the heading two
3696 lines or in the tailing several lines of the file.
3697 We assume that the 1K-byte and 3K-byte for heading
3698 and tailing respectively are sufficient for this
3702 if (st
.st_size
<= (1024 * 4))
3703 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3706 nread
= emacs_read (fd
, read_buf
, 1024);
3710 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3711 report_file_error ("Setting file position",
3712 Fcons (orig_filename
, Qnil
));
3713 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3714 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3719 error ("IO error reading %s: %s",
3720 SDATA (orig_filename
), emacs_strerror (errno
));
3723 struct buffer
*prev
= current_buffer
;
3724 Lisp_Object workbuf
;
3727 record_unwind_current_buffer ();
3729 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3730 buf
= XBUFFER (workbuf
);
3732 delete_all_overlays (buf
);
3733 bset_directory (buf
, BVAR (current_buffer
, directory
));
3734 bset_read_only (buf
, Qnil
);
3735 bset_filename (buf
, Qnil
);
3736 bset_undo_list (buf
, Qt
);
3737 eassert (buf
->overlays_before
== NULL
);
3738 eassert (buf
->overlays_after
== NULL
);
3740 set_buffer_internal (buf
);
3742 bset_enable_multibyte_characters (buf
, Qnil
);
3744 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3745 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3746 coding_system
= call2 (Vset_auto_coding_function
,
3747 filename
, make_number (nread
));
3748 set_buffer_internal (prev
);
3750 /* Discard the unwind protect for recovering the
3754 /* Rewind the file for the actual read done later. */
3755 if (lseek (fd
, 0, SEEK_SET
) < 0)
3756 report_file_error ("Setting file position",
3757 Fcons (orig_filename
, Qnil
));
3761 if (NILP (coding_system
))
3763 /* If we have not yet decided a coding system, check
3764 file-coding-system-alist. */
3765 Lisp_Object args
[6];
3767 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3768 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3769 coding_system
= Ffind_operation_coding_system (6, args
);
3770 if (CONSP (coding_system
))
3771 coding_system
= XCAR (coding_system
);
3775 if (NILP (coding_system
))
3776 coding_system
= Qundecided
;
3778 CHECK_CODING_SYSTEM (coding_system
);
3780 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3781 /* We must suppress all character code conversion except for
3782 end-of-line conversion. */
3783 coding_system
= raw_text_coding_system (coding_system
);
3785 setup_coding_system (coding_system
, &coding
);
3786 /* Ensure we set Vlast_coding_system_used. */
3787 set_coding_system
= 1;
3790 /* If requested, replace the accessible part of the buffer
3791 with the file contents. Avoid replacing text at the
3792 beginning or end of the buffer that matches the file contents;
3793 that preserves markers pointing to the unchanged parts.
3795 Here we implement this feature in an optimized way
3796 for the case where code conversion is NOT needed.
3797 The following if-statement handles the case of conversion
3798 in a less optimal way.
3800 If the code conversion is "automatic" then we try using this
3801 method and hope for the best.
3802 But if we discover the need for conversion, we give up on this method
3803 and let the following if-statement handle the replace job. */
3806 && (NILP (coding_system
)
3807 || ! CODING_REQUIRE_DECODING (&coding
)))
3809 /* same_at_start and same_at_end count bytes,
3810 because file access counts bytes
3811 and BEG and END count bytes. */
3812 ptrdiff_t same_at_start
= BEGV_BYTE
;
3813 ptrdiff_t same_at_end
= ZV_BYTE
;
3815 /* There is still a possibility we will find the need to do code
3816 conversion. If that happens, set this variable to
3817 give up on handling REPLACE in the optimized way. */
3818 bool giveup_match_end
= 0;
3820 if (beg_offset
!= 0)
3822 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3823 report_file_error ("Setting file position",
3824 Fcons (orig_filename
, Qnil
));
3829 /* Count how many chars at the start of the file
3830 match the text at the beginning of the buffer. */
3835 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3837 error ("IO error reading %s: %s",
3838 SSDATA (orig_filename
), emacs_strerror (errno
));
3839 else if (nread
== 0)
3842 if (CODING_REQUIRE_DETECTION (&coding
))
3844 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3847 setup_coding_system (coding_system
, &coding
);
3850 if (CODING_REQUIRE_DECODING (&coding
))
3851 /* We found that the file should be decoded somehow.
3852 Let's give up here. */
3854 giveup_match_end
= 1;
3859 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3860 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3861 same_at_start
++, bufpos
++;
3862 /* If we found a discrepancy, stop the scan.
3863 Otherwise loop around and scan the next bufferful. */
3864 if (bufpos
!= nread
)
3868 /* If the file matches the buffer completely,
3869 there's no need to replace anything. */
3870 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3874 /* Truncate the buffer to the size of the file. */
3875 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3880 /* Count how many chars at the end of the file
3881 match the text at the end of the buffer. But, if we have
3882 already found that decoding is necessary, don't waste time. */
3883 while (!giveup_match_end
)
3885 int total_read
, nread
, bufpos
, trial
;
3888 /* At what file position are we now scanning? */
3889 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3890 /* If the entire file matches the buffer tail, stop the scan. */
3893 /* How much can we scan in the next step? */
3894 trial
= min (curpos
, sizeof read_buf
);
3895 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3896 report_file_error ("Setting file position",
3897 Fcons (orig_filename
, Qnil
));
3899 total_read
= nread
= 0;
3900 while (total_read
< trial
)
3902 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3904 error ("IO error reading %s: %s",
3905 SDATA (orig_filename
), emacs_strerror (errno
));
3906 else if (nread
== 0)
3908 total_read
+= nread
;
3911 /* Scan this bufferful from the end, comparing with
3912 the Emacs buffer. */
3913 bufpos
= total_read
;
3915 /* Compare with same_at_start to avoid counting some buffer text
3916 as matching both at the file's beginning and at the end. */
3917 while (bufpos
> 0 && same_at_end
> same_at_start
3918 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3919 same_at_end
--, bufpos
--;
3921 /* If we found a discrepancy, stop the scan.
3922 Otherwise loop around and scan the preceding bufferful. */
3925 /* If this discrepancy is because of code conversion,
3926 we cannot use this method; giveup and try the other. */
3927 if (same_at_end
> same_at_start
3928 && FETCH_BYTE (same_at_end
- 1) >= 0200
3929 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3930 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3931 giveup_match_end
= 1;
3940 if (! giveup_match_end
)
3944 /* We win! We can handle REPLACE the optimized way. */
3946 /* Extend the start of non-matching text area to multibyte
3947 character boundary. */
3948 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3949 while (same_at_start
> BEGV_BYTE
3950 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3953 /* Extend the end of non-matching text area to multibyte
3954 character boundary. */
3955 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3956 while (same_at_end
< ZV_BYTE
3957 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3960 /* Don't try to reuse the same piece of text twice. */
3961 overlap
= (same_at_start
- BEGV_BYTE
3963 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3965 same_at_end
+= overlap
;
3967 /* Arrange to read only the nonmatching middle part of the file. */
3968 beg_offset
+= same_at_start
- BEGV_BYTE
;
3969 end_offset
-= ZV_BYTE
- same_at_end
;
3971 del_range_byte (same_at_start
, same_at_end
, 0);
3972 /* Insert from the file at the proper position. */
3973 temp
= BYTE_TO_CHAR (same_at_start
);
3974 SET_PT_BOTH (temp
, same_at_start
);
3976 /* If display currently starts at beginning of line,
3977 keep it that way. */
3978 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3979 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3981 replace_handled
= 1;
3985 /* If requested, replace the accessible part of the buffer
3986 with the file contents. Avoid replacing text at the
3987 beginning or end of the buffer that matches the file contents;
3988 that preserves markers pointing to the unchanged parts.
3990 Here we implement this feature for the case where code conversion
3991 is needed, in a simple way that needs a lot of memory.
3992 The preceding if-statement handles the case of no conversion
3993 in a more optimized way. */
3994 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3996 ptrdiff_t same_at_start
= BEGV_BYTE
;
3997 ptrdiff_t same_at_end
= ZV_BYTE
;
3998 ptrdiff_t same_at_start_charpos
;
3999 ptrdiff_t inserted_chars
;
4002 unsigned char *decoded
;
4005 ptrdiff_t this_count
= SPECPDL_INDEX ();
4007 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4008 Lisp_Object conversion_buffer
;
4009 struct gcpro gcpro1
;
4011 conversion_buffer
= code_conversion_save (1, multibyte
);
4013 /* First read the whole file, performing code conversion into
4014 CONVERSION_BUFFER. */
4016 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4017 report_file_error ("Setting file position",
4018 Fcons (orig_filename
, Qnil
));
4020 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4021 unprocessed
= 0; /* Bytes not processed in previous loop. */
4023 GCPRO1 (conversion_buffer
);
4026 /* Read at most READ_BUF_SIZE bytes at a time, to allow
4027 quitting while reading a huge file. */
4029 /* Allow quitting out of the actual I/O. */
4032 this = emacs_read (fd
, read_buf
+ unprocessed
,
4033 READ_BUF_SIZE
- unprocessed
);
4039 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
4040 BUF_Z (XBUFFER (conversion_buffer
)));
4041 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4042 unprocessed
+ this, conversion_buffer
);
4043 unprocessed
= coding
.carryover_bytes
;
4044 if (coding
.carryover_bytes
> 0)
4045 memcpy (read_buf
, coding
.carryover
, unprocessed
);
4050 /* We should remove the unwind_protect calling
4051 close_file_unwind, but other stuff has been added the stack,
4052 so defer the removal till we reach the `handled' label. */
4053 deferred_remove_unwind_protect
= 1;
4056 error ("IO error reading %s: %s",
4057 SDATA (orig_filename
), emacs_strerror (errno
));
4059 if (unprocessed
> 0)
4061 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4062 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4063 unprocessed
, conversion_buffer
);
4064 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4067 coding_system
= CODING_ID_NAME (coding
.id
);
4068 set_coding_system
= 1;
4069 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4070 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4071 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4073 /* Compare the beginning of the converted string with the buffer
4077 while (bufpos
< inserted
&& same_at_start
< same_at_end
4078 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4079 same_at_start
++, bufpos
++;
4081 /* If the file matches the head of buffer completely,
4082 there's no need to replace anything. */
4084 if (bufpos
== inserted
)
4086 /* Truncate the buffer to the size of the file. */
4087 if (same_at_start
== same_at_end
)
4090 del_range_byte (same_at_start
, same_at_end
, 0);
4093 unbind_to (this_count
, Qnil
);
4097 /* Extend the start of non-matching text area to the previous
4098 multibyte character boundary. */
4099 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4100 while (same_at_start
> BEGV_BYTE
4101 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4104 /* Scan this bufferful from the end, comparing with
4105 the Emacs buffer. */
4108 /* Compare with same_at_start to avoid counting some buffer text
4109 as matching both at the file's beginning and at the end. */
4110 while (bufpos
> 0 && same_at_end
> same_at_start
4111 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4112 same_at_end
--, bufpos
--;
4114 /* Extend the end of non-matching text area to the next
4115 multibyte character boundary. */
4116 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4117 while (same_at_end
< ZV_BYTE
4118 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4121 /* Don't try to reuse the same piece of text twice. */
4122 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4124 same_at_end
+= overlap
;
4126 /* If display currently starts at beginning of line,
4127 keep it that way. */
4128 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4129 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4131 /* Replace the chars that we need to replace,
4132 and update INSERTED to equal the number of bytes
4133 we are taking from the decoded string. */
4134 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4136 if (same_at_end
!= same_at_start
)
4138 del_range_byte (same_at_start
, same_at_end
, 0);
4140 same_at_start
= GPT_BYTE
;
4144 temp
= BYTE_TO_CHAR (same_at_start
);
4146 /* Insert from the file at the proper position. */
4147 SET_PT_BOTH (temp
, same_at_start
);
4148 same_at_start_charpos
4149 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4150 same_at_start
- BEGV_BYTE
4151 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4153 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4154 same_at_start
+ inserted
- BEGV_BYTE
4155 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4156 - same_at_start_charpos
);
4157 /* This binding is to avoid ask-user-about-supersession-threat
4158 being called in insert_from_buffer (via in
4159 prepare_to_modify_buffer). */
4160 specbind (intern ("buffer-file-name"), Qnil
);
4161 insert_from_buffer (XBUFFER (conversion_buffer
),
4162 same_at_start_charpos
, inserted_chars
, 0);
4163 /* Set `inserted' to the number of inserted characters. */
4164 inserted
= PT
- temp
;
4165 /* Set point before the inserted characters. */
4166 SET_PT_BOTH (temp
, same_at_start
);
4168 unbind_to (this_count
, Qnil
);
4174 total
= end_offset
- beg_offset
;
4176 /* For a special file, all we can do is guess. */
4177 total
= READ_BUF_SIZE
;
4179 if (NILP (visit
) && total
> 0)
4181 #ifdef CLASH_DETECTION
4182 if (!NILP (BVAR (current_buffer
, file_truename
))
4183 /* Make binding buffer-file-name to nil effective. */
4184 && !NILP (BVAR (current_buffer
, filename
))
4185 && SAVE_MODIFF
>= MODIFF
)
4187 #endif /* CLASH_DETECTION */
4188 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4191 move_gap_both (PT
, PT_BYTE
);
4192 if (GAP_SIZE
< total
)
4193 make_gap (total
- GAP_SIZE
);
4195 if (beg_offset
!= 0 || !NILP (replace
))
4197 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4198 report_file_error ("Setting file position",
4199 Fcons (orig_filename
, Qnil
));
4202 /* In the following loop, HOW_MUCH contains the total bytes read so
4203 far for a regular file, and not changed for a special file. But,
4204 before exiting the loop, it is set to a negative value if I/O
4208 /* Total bytes inserted. */
4211 /* Here, we don't do code conversion in the loop. It is done by
4212 decode_coding_gap after all data are read into the buffer. */
4214 ptrdiff_t gap_size
= GAP_SIZE
;
4216 while (how_much
< total
)
4218 /* try is reserved in some compilers (Microsoft C) */
4219 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4226 /* Maybe make more room. */
4227 if (gap_size
< trytry
)
4229 make_gap (trytry
- gap_size
);
4230 gap_size
= GAP_SIZE
- inserted
;
4233 /* Read from the file, capturing `quit'. When an
4234 error occurs, end the loop, and arrange for a quit
4235 to be signaled after decoding the text we read. */
4236 nbytes
= internal_condition_case_1
4238 make_save_value (SAVE_TYPE_INT_INT_INT
, (ptrdiff_t) fd
,
4240 Qerror
, read_non_regular_quit
);
4248 this = XINT (nbytes
);
4252 /* Allow quitting out of the actual I/O. We don't make text
4253 part of the buffer until all the reading is done, so a C-g
4254 here doesn't do any harm. */
4257 this = emacs_read (fd
,
4258 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4272 /* For a regular file, where TOTAL is the real size,
4273 count HOW_MUCH to compare with it.
4274 For a special file, where TOTAL is just a buffer size,
4275 so don't bother counting in HOW_MUCH.
4276 (INSERTED is where we count the number of characters inserted.) */
4283 /* Now we have either read all the file data into the gap,
4284 or stop reading on I/O error or quit. If nothing was
4285 read, undo marking the buffer modified. */
4289 #ifdef CLASH_DETECTION
4291 unlock_file (BVAR (current_buffer
, file_truename
));
4293 Vdeactivate_mark
= old_Vdeactivate_mark
;
4296 Vdeactivate_mark
= Qt
;
4300 /* Discard the unwind protect for closing the file. */
4304 error ("IO error reading %s: %s",
4305 SDATA (orig_filename
), emacs_strerror (errno
));
4307 /* Make the text read part of the buffer. */
4308 GAP_SIZE
-= inserted
;
4310 GPT_BYTE
+= inserted
;
4312 ZV_BYTE
+= inserted
;
4317 /* Put an anchor to ensure multi-byte form ends at gap. */
4322 if (NILP (coding_system
))
4324 /* The coding system is not yet decided. Decide it by an
4325 optimized method for handling `coding:' tag.
4327 Note that we can get here only if the buffer was empty
4328 before the insertion. */
4330 if (!NILP (Vcoding_system_for_read
))
4331 coding_system
= Vcoding_system_for_read
;
4334 /* Since we are sure that the current buffer was empty
4335 before the insertion, we can toggle
4336 enable-multibyte-characters directly here without taking
4337 care of marker adjustment. By this way, we can run Lisp
4338 program safely before decoding the inserted text. */
4339 Lisp_Object unwind_data
;
4340 ptrdiff_t count1
= SPECPDL_INDEX ();
4342 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4343 Fcons (BVAR (current_buffer
, undo_list
),
4344 Fcurrent_buffer ()));
4345 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4346 bset_undo_list (current_buffer
, Qt
);
4347 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4349 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4351 coding_system
= call2 (Vset_auto_coding_function
,
4352 filename
, make_number (inserted
));
4355 if (NILP (coding_system
))
4357 /* If the coding system is not yet decided, check
4358 file-coding-system-alist. */
4359 Lisp_Object args
[6];
4361 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4362 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4363 coding_system
= Ffind_operation_coding_system (6, args
);
4364 if (CONSP (coding_system
))
4365 coding_system
= XCAR (coding_system
);
4367 unbind_to (count1
, Qnil
);
4368 inserted
= Z_BYTE
- BEG_BYTE
;
4371 if (NILP (coding_system
))
4372 coding_system
= Qundecided
;
4374 CHECK_CODING_SYSTEM (coding_system
);
4376 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4377 /* We must suppress all character code conversion except for
4378 end-of-line conversion. */
4379 coding_system
= raw_text_coding_system (coding_system
);
4380 setup_coding_system (coding_system
, &coding
);
4381 /* Ensure we set Vlast_coding_system_used. */
4382 set_coding_system
= 1;
4387 /* When we visit a file by raw-text, we change the buffer to
4389 if (CODING_FOR_UNIBYTE (&coding
)
4390 /* Can't do this if part of the buffer might be preserved. */
4392 /* Visiting a file with these coding system makes the buffer
4394 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4397 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4398 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4399 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4401 move_gap_both (PT
, PT_BYTE
);
4402 GAP_SIZE
+= inserted
;
4403 ZV_BYTE
-= inserted
;
4407 decode_coding_gap (&coding
, inserted
, inserted
);
4408 inserted
= coding
.produced_char
;
4409 coding_system
= CODING_ID_NAME (coding
.id
);
4411 else if (inserted
> 0)
4412 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4415 /* Call after-change hooks for the inserted text, aside from the case
4416 of normal visiting (not with REPLACE), which is done in a new buffer
4417 "before" the buffer is changed. */
4418 if (inserted
> 0 && total
> 0
4419 && (NILP (visit
) || !NILP (replace
)))
4421 signal_after_change (PT
, 0, inserted
);
4422 update_compositions (PT
, PT
, CHECK_BORDER
);
4425 /* Now INSERTED is measured in characters. */
4429 if (deferred_remove_unwind_protect
)
4430 /* If requested above, discard the unwind protect for closing the
4436 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4437 bset_undo_list (current_buffer
, Qnil
);
4441 current_buffer
->modtime
= mtime
;
4442 current_buffer
->modtime_size
= st
.st_size
;
4443 bset_filename (current_buffer
, orig_filename
);
4446 SAVE_MODIFF
= MODIFF
;
4447 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4448 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4449 #ifdef CLASH_DETECTION
4452 if (!NILP (BVAR (current_buffer
, file_truename
)))
4453 unlock_file (BVAR (current_buffer
, file_truename
));
4454 unlock_file (filename
);
4456 #endif /* CLASH_DETECTION */
4458 xsignal2 (Qfile_error
,
4459 build_string ("not a regular file"), orig_filename
);
4462 if (set_coding_system
)
4463 Vlast_coding_system_used
= coding_system
;
4465 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4467 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4469 if (! NILP (insval
))
4471 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4472 wrong_type_argument (intern ("inserted-chars"), insval
);
4473 inserted
= XFASTINT (insval
);
4477 /* Decode file format. */
4480 /* Don't run point motion or modification hooks when decoding. */
4481 ptrdiff_t count1
= SPECPDL_INDEX ();
4482 ptrdiff_t old_inserted
= inserted
;
4483 specbind (Qinhibit_point_motion_hooks
, Qt
);
4484 specbind (Qinhibit_modification_hooks
, Qt
);
4486 /* Save old undo list and don't record undo for decoding. */
4487 old_undo
= BVAR (current_buffer
, undo_list
);
4488 bset_undo_list (current_buffer
, Qt
);
4492 insval
= call3 (Qformat_decode
,
4493 Qnil
, make_number (inserted
), visit
);
4494 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4495 wrong_type_argument (intern ("inserted-chars"), insval
);
4496 inserted
= XFASTINT (insval
);
4500 /* If REPLACE is non-nil and we succeeded in not replacing the
4501 beginning or end of the buffer text with the file's contents,
4502 call format-decode with `point' positioned at the beginning
4503 of the buffer and `inserted' equaling the number of
4504 characters in the buffer. Otherwise, format-decode might
4505 fail to correctly analyze the beginning or end of the buffer.
4506 Hence we temporarily save `point' and `inserted' here and
4507 restore `point' iff format-decode did not insert or delete
4508 any text. Otherwise we leave `point' at point-min. */
4509 ptrdiff_t opoint
= PT
;
4510 ptrdiff_t opoint_byte
= PT_BYTE
;
4511 ptrdiff_t oinserted
= ZV
- BEGV
;
4512 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4514 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4515 insval
= call3 (Qformat_decode
,
4516 Qnil
, make_number (oinserted
), visit
);
4517 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4518 wrong_type_argument (intern ("inserted-chars"), insval
);
4519 if (ochars_modiff
== CHARS_MODIFF
)
4520 /* format_decode didn't modify buffer's characters => move
4521 point back to position before inserted text and leave
4522 value of inserted alone. */
4523 SET_PT_BOTH (opoint
, opoint_byte
);
4525 /* format_decode modified buffer's characters => consider
4526 entire buffer changed and leave point at point-min. */
4527 inserted
= XFASTINT (insval
);
4530 /* For consistency with format-decode call these now iff inserted > 0
4531 (martin 2007-06-28). */
4532 p
= Vafter_insert_file_functions
;
4537 insval
= call1 (XCAR (p
), make_number (inserted
));
4540 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4541 wrong_type_argument (intern ("inserted-chars"), insval
);
4542 inserted
= XFASTINT (insval
);
4547 /* For the rationale of this see the comment on
4548 format-decode above. */
4549 ptrdiff_t opoint
= PT
;
4550 ptrdiff_t opoint_byte
= PT_BYTE
;
4551 ptrdiff_t oinserted
= ZV
- BEGV
;
4552 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4554 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4555 insval
= call1 (XCAR (p
), make_number (oinserted
));
4558 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4559 wrong_type_argument (intern ("inserted-chars"), insval
);
4560 if (ochars_modiff
== CHARS_MODIFF
)
4561 /* after_insert_file_functions didn't modify
4562 buffer's characters => move point back to
4563 position before inserted text and leave value of
4565 SET_PT_BOTH (opoint
, opoint_byte
);
4567 /* after_insert_file_functions did modify buffer's
4568 characters => consider entire buffer changed and
4569 leave point at point-min. */
4570 inserted
= XFASTINT (insval
);
4580 bset_undo_list (current_buffer
, old_undo
);
4581 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4583 /* Adjust the last undo record for the size change during
4584 the format conversion. */
4585 Lisp_Object tem
= XCAR (old_undo
);
4586 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4587 && INTEGERP (XCDR (tem
))
4588 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4589 XSETCDR (tem
, make_number (PT
+ inserted
));
4593 /* If undo_list was Qt before, keep it that way.
4594 Otherwise start with an empty undo_list. */
4595 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4597 unbind_to (count1
, Qnil
);
4601 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4603 /* If visiting nonexistent file, return nil. */
4605 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4609 Fsignal (Qquit
, Qnil
);
4611 /* Retval needs to be dealt with in all cases consistently. */
4613 val
= list2 (orig_filename
, make_number (inserted
));
4615 RETURN_UNGCPRO (unbind_to (count
, val
));
4618 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4621 build_annotations_unwind (Lisp_Object arg
)
4623 Vwrite_region_annotation_buffers
= arg
;
4627 /* Decide the coding-system to encode the data with. */
4629 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4630 Schoose_write_coding_system
, 3, 6, 0,
4631 doc
: /* Choose the coding system for writing a file.
4632 Arguments are as for `write-region'.
4633 This function is for internal use only. It may prompt the user. */ )
4634 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4635 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4638 Lisp_Object eol_parent
= Qnil
;
4640 /* Mimic write-region behavior. */
4643 XSETFASTINT (start
, BEGV
);
4644 XSETFASTINT (end
, ZV
);
4648 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4649 BVAR (current_buffer
, auto_save_file_name
))))
4654 else if (!NILP (Vcoding_system_for_write
))
4656 val
= Vcoding_system_for_write
;
4657 if (coding_system_require_warning
4658 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4659 /* Confirm that VAL can surely encode the current region. */
4660 val
= call5 (Vselect_safe_coding_system_function
,
4661 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4666 /* If the variable `buffer-file-coding-system' is set locally,
4667 it means that the file was read with some kind of code
4668 conversion or the variable is explicitly set by users. We
4669 had better write it out with the same coding system even if
4670 `enable-multibyte-characters' is nil.
4672 If it is not set locally, we anyway have to convert EOL
4673 format if the default value of `buffer-file-coding-system'
4674 tells that it is not Unix-like (LF only) format. */
4675 bool using_default_coding
= 0;
4676 bool force_raw_text
= 0;
4678 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4680 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4683 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4689 /* Check file-coding-system-alist. */
4690 Lisp_Object args
[7], coding_systems
;
4692 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4693 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4695 coding_systems
= Ffind_operation_coding_system (7, args
);
4696 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4697 val
= XCDR (coding_systems
);
4702 /* If we still have not decided a coding system, use the
4703 default value of buffer-file-coding-system. */
4704 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4705 using_default_coding
= 1;
4708 if (! NILP (val
) && ! force_raw_text
)
4710 Lisp_Object spec
, attrs
;
4712 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4713 attrs
= AREF (spec
, 0);
4714 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4719 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4720 /* Confirm that VAL can surely encode the current region. */
4721 val
= call5 (Vselect_safe_coding_system_function
,
4722 start
, end
, val
, Qnil
, filename
);
4724 /* If the decided coding-system doesn't specify end-of-line
4725 format, we use that of
4726 `default-buffer-file-coding-system'. */
4727 if (! using_default_coding
4728 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4729 val
= (coding_inherit_eol_type
4730 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4732 /* If we decide not to encode text, use `raw-text' or one of its
4735 val
= raw_text_coding_system (val
);
4738 val
= coding_inherit_eol_type (val
, eol_parent
);
4742 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4743 "r\nFWrite region to file: \ni\ni\ni\np",
4744 doc
: /* Write current region into specified file.
4745 When called from a program, requires three arguments:
4746 START, END and FILENAME. START and END are normally buffer positions
4747 specifying the part of the buffer to write.
4748 If START is nil, that means to use the entire buffer contents.
4749 If START is a string, then output that string to the file
4750 instead of any buffer contents; END is ignored.
4752 Optional fourth argument APPEND if non-nil means
4753 append to existing file contents (if any). If it is a number,
4754 seek to that offset in the file before writing.
4755 Optional fifth argument VISIT, if t or a string, means
4756 set the last-save-file-modtime of buffer to this file's modtime
4757 and mark buffer not modified.
4758 If VISIT is a string, it is a second file name;
4759 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4760 VISIT is also the file name to lock and unlock for clash detection.
4761 If VISIT is neither t nor nil nor a string,
4762 that means do not display the \"Wrote file\" message.
4763 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4764 use for locking and unlocking, overriding FILENAME and VISIT.
4765 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4766 for an existing file with the same name. If MUSTBENEW is `excl',
4767 that means to get an error if the file already exists; never overwrite.
4768 If MUSTBENEW is neither nil nor `excl', that means ask for
4769 confirmation before overwriting, but do go ahead and overwrite the file
4770 if the user confirms.
4772 This does code conversion according to the value of
4773 `coding-system-for-write', `buffer-file-coding-system', or
4774 `file-coding-system-alist', and sets the variable
4775 `last-coding-system-used' to the coding system actually used.
4777 This calls `write-region-annotate-functions' at the start, and
4778 `write-region-post-annotation-function' at the end. */)
4779 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4784 off_t offset
IF_LINT (= 0);
4790 ptrdiff_t count
= SPECPDL_INDEX ();
4792 Lisp_Object handler
;
4793 Lisp_Object visit_file
;
4794 Lisp_Object annotations
;
4795 Lisp_Object encoded_filename
;
4796 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4797 bool quietly
= !NILP (visit
);
4798 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4799 struct buffer
*given_buffer
;
4800 struct coding_system coding
;
4802 if (current_buffer
->base_buffer
&& visiting
)
4803 error ("Cannot do file visiting in an indirect buffer");
4805 if (!NILP (start
) && !STRINGP (start
))
4806 validate_region (&start
, &end
);
4809 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4811 filename
= Fexpand_file_name (filename
, Qnil
);
4813 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4814 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4816 if (STRINGP (visit
))
4817 visit_file
= Fexpand_file_name (visit
, Qnil
);
4819 visit_file
= filename
;
4821 if (NILP (lockname
))
4822 lockname
= visit_file
;
4826 /* If the file name has special constructs in it,
4827 call the corresponding file handler. */
4828 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4829 /* If FILENAME has no handler, see if VISIT has one. */
4830 if (NILP (handler
) && STRINGP (visit
))
4831 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4833 if (!NILP (handler
))
4836 val
= call6 (handler
, Qwrite_region
, start
, end
,
4837 filename
, append
, visit
);
4841 SAVE_MODIFF
= MODIFF
;
4842 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4843 bset_filename (current_buffer
, visit_file
);
4849 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4851 /* Special kludge to simplify auto-saving. */
4854 /* Do it later, so write-region-annotate-function can work differently
4855 if we save "the buffer" vs "a region".
4856 This is useful in tar-mode. --Stef
4857 XSETFASTINT (start, BEG);
4858 XSETFASTINT (end, Z); */
4862 record_unwind_protect (build_annotations_unwind
,
4863 Vwrite_region_annotation_buffers
);
4864 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4865 count1
= SPECPDL_INDEX ();
4867 given_buffer
= current_buffer
;
4869 if (!STRINGP (start
))
4871 annotations
= build_annotations (start
, end
);
4873 if (current_buffer
!= given_buffer
)
4875 XSETFASTINT (start
, BEGV
);
4876 XSETFASTINT (end
, ZV
);
4882 XSETFASTINT (start
, BEGV
);
4883 XSETFASTINT (end
, ZV
);
4888 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4890 /* Decide the coding-system to encode the data with.
4891 We used to make this choice before calling build_annotations, but that
4892 leads to problems when a write-annotate-function takes care of
4893 unsavable chars (as was the case with X-Symbol). */
4894 Vlast_coding_system_used
=
4895 Fchoose_write_coding_system (start
, end
, filename
,
4896 append
, visit
, lockname
);
4898 setup_coding_system (Vlast_coding_system_used
, &coding
);
4900 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4901 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4903 #ifdef CLASH_DETECTION
4905 lock_file (lockname
);
4906 #endif /* CLASH_DETECTION */
4908 encoded_filename
= ENCODE_FILE (filename
);
4909 fn
= SSDATA (encoded_filename
);
4910 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4911 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4912 if (NUMBERP (append
))
4913 offset
= file_offset (append
);
4914 else if (!NILP (append
))
4915 open_flags
|= O_APPEND
;
4917 mode
= S_IREAD
| S_IWRITE
;
4919 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4922 desc
= emacs_open (fn
, open_flags
, mode
);
4926 #ifdef CLASH_DETECTION
4928 if (!auto_saving
) unlock_file (lockname
);
4930 #endif /* CLASH_DETECTION */
4932 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4935 record_unwind_protect (close_file_unwind
, make_number (desc
));
4937 if (NUMBERP (append
))
4939 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4942 #ifdef CLASH_DETECTION
4944 if (!auto_saving
) unlock_file (lockname
);
4946 #endif /* CLASH_DETECTION */
4948 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4956 if (STRINGP (start
))
4957 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4958 else if (XINT (start
) != XINT (end
))
4959 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4960 &annotations
, &coding
);
4963 /* If file was empty, still need to write the annotations. */
4964 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4965 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4969 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4970 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4972 /* We have to flush out a data. */
4973 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4974 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4980 /* fsync appears to change the modtime on BSD4.2.
4981 Disk full in NFS may be reported here. */
4982 /* mib says that closing the file will try to write as fast as NFS can do
4983 it, and that means the fsync here is not crucial for autosave files. */
4984 if (!auto_saving
&& !write_region_inhibit_fsync
)
4986 /* Transfer data and metadata to disk, retrying if interrupted. Also,
4987 ignore EINVAL which happens when fsync is not supported on this
4989 while (fsync (desc
) != 0)
4992 if (errno
!= EINVAL
)
4993 ok
= 0, save_errno
= errno
;
4998 modtime
= invalid_emacs_time ();
5001 if (fstat (desc
, &st
) == 0)
5002 modtime
= get_stat_mtime (&st
);
5004 ok
= 0, save_errno
= errno
;
5007 /* NFS can report a write failure now. */
5008 if (emacs_close (desc
) < 0)
5009 ok
= 0, save_errno
= errno
;
5011 /* Discard the unwind protect for close_file_unwind. */
5012 specpdl_ptr
= specpdl
+ count1
;
5014 /* Some file systems have a bug where st_mtime is not updated
5015 properly after a write. For example, CIFS might not see the
5016 st_mtime change until after the file is opened again.
5018 Attempt to detect this file system bug, and update MODTIME to the
5019 newer st_mtime if the bug appears to be present. This introduces
5020 a race condition, so to avoid most instances of the race condition
5021 on non-buggy file systems, skip this check if the most recently
5022 encountered non-buggy file system was the current file system.
5024 A race condition can occur if some other process modifies the
5025 file between the fstat above and the fstat below, but the race is
5026 unlikely and a similar race between the last write and the fstat
5027 above cannot possibly be closed anyway. */
5029 if (EMACS_TIME_VALID_P (modtime
)
5030 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
5032 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
5036 if (fstat (desc1
, &st1
) == 0
5037 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
5039 /* Use the heuristic if it appears to be valid. With neither
5040 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
5041 file, the time stamp won't change. Also, some non-POSIX
5042 systems don't update an empty file's time stamp when
5043 truncating it. Finally, file systems with 100 ns or worse
5044 resolution sometimes seem to have bugs: on a system with ns
5045 resolution, checking ns % 100 incorrectly avoids the heuristic
5046 1% of the time, but the problem should be temporary as we will
5047 try again on the next time stamp. */
5049 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
5051 && EMACS_NSECS (modtime
) % 100 != 0);
5053 EMACS_TIME modtime1
= get_stat_mtime (&st1
);
5055 && EMACS_TIME_EQ (modtime
, modtime1
)
5056 && st
.st_size
== st1
.st_size
)
5058 timestamp_file_system
= st
.st_dev
;
5059 valid_timestamp_file_system
= 1;
5063 st
.st_size
= st1
.st_size
;
5067 emacs_close (desc1
);
5071 /* Call write-region-post-annotation-function. */
5072 while (CONSP (Vwrite_region_annotation_buffers
))
5074 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5075 if (!NILP (Fbuffer_live_p (buf
)))
5078 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5079 call0 (Vwrite_region_post_annotation_function
);
5081 Vwrite_region_annotation_buffers
5082 = XCDR (Vwrite_region_annotation_buffers
);
5085 unbind_to (count
, Qnil
);
5087 #ifdef CLASH_DETECTION
5089 unlock_file (lockname
);
5090 #endif /* CLASH_DETECTION */
5092 /* Do this before reporting IO error
5093 to avoid a "file has changed on disk" warning on
5094 next attempt to save. */
5095 if (EMACS_TIME_VALID_P (modtime
))
5097 current_buffer
->modtime
= modtime
;
5098 current_buffer
->modtime_size
= st
.st_size
;
5102 error ("IO error writing %s: %s", SDATA (filename
),
5103 emacs_strerror (save_errno
));
5107 SAVE_MODIFF
= MODIFF
;
5108 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5109 bset_filename (current_buffer
, visit_file
);
5110 update_mode_lines
++;
5115 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5116 BVAR (current_buffer
, auto_save_file_name
))))
5117 SAVE_MODIFF
= MODIFF
;
5123 message_with_string ((NUMBERP (append
)
5133 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
5135 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5136 doc
: /* Return t if (car A) is numerically less than (car B). */)
5137 (Lisp_Object a
, Lisp_Object b
)
5139 return Flss (Fcar (a
), Fcar (b
));
5142 /* Build the complete list of annotations appropriate for writing out
5143 the text between START and END, by calling all the functions in
5144 write-region-annotate-functions and merging the lists they return.
5145 If one of these functions switches to a different buffer, we assume
5146 that buffer contains altered text. Therefore, the caller must
5147 make sure to restore the current buffer in all cases,
5148 as save-excursion would do. */
5151 build_annotations (Lisp_Object start
, Lisp_Object end
)
5153 Lisp_Object annotations
;
5155 struct gcpro gcpro1
, gcpro2
;
5156 Lisp_Object original_buffer
;
5158 bool used_global
= 0;
5160 XSETBUFFER (original_buffer
, current_buffer
);
5163 p
= Vwrite_region_annotate_functions
;
5164 GCPRO2 (annotations
, p
);
5167 struct buffer
*given_buffer
= current_buffer
;
5168 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5169 { /* Use the global value of the hook. */
5172 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5174 p
= Fappend (2, arg
);
5177 Vwrite_region_annotations_so_far
= annotations
;
5178 res
= call2 (XCAR (p
), start
, end
);
5179 /* If the function makes a different buffer current,
5180 assume that means this buffer contains altered text to be output.
5181 Reset START and END from the buffer bounds
5182 and discard all previous annotations because they should have
5183 been dealt with by this function. */
5184 if (current_buffer
!= given_buffer
)
5186 Vwrite_region_annotation_buffers
5187 = Fcons (Fcurrent_buffer (),
5188 Vwrite_region_annotation_buffers
);
5189 XSETFASTINT (start
, BEGV
);
5190 XSETFASTINT (end
, ZV
);
5193 Flength (res
); /* Check basic validity of return value */
5194 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5198 /* Now do the same for annotation functions implied by the file-format */
5199 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5200 p
= BVAR (current_buffer
, auto_save_file_format
);
5202 p
= BVAR (current_buffer
, file_format
);
5203 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5205 struct buffer
*given_buffer
= current_buffer
;
5207 Vwrite_region_annotations_so_far
= annotations
;
5209 /* Value is either a list of annotations or nil if the function
5210 has written annotations to a temporary buffer, which is now
5212 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5213 original_buffer
, make_number (i
));
5214 if (current_buffer
!= given_buffer
)
5216 XSETFASTINT (start
, BEGV
);
5217 XSETFASTINT (end
, ZV
);
5222 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5230 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5231 If STRING is nil, POS is the character position in the current buffer.
5232 Intersperse with them the annotations from *ANNOT
5233 which fall within the range of POS to POS + NCHARS,
5234 each at its appropriate position.
5236 We modify *ANNOT by discarding elements as we use them up.
5238 Return true if successful. */
5241 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5242 ptrdiff_t nchars
, Lisp_Object
*annot
,
5243 struct coding_system
*coding
)
5247 ptrdiff_t lastpos
= pos
+ nchars
;
5249 while (NILP (*annot
) || CONSP (*annot
))
5251 tem
= Fcar_safe (Fcar (*annot
));
5254 nextpos
= XFASTINT (tem
);
5256 /* If there are no more annotations in this range,
5257 output the rest of the range all at once. */
5258 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5259 return e_write (desc
, string
, pos
, lastpos
, coding
);
5261 /* Output buffer text up to the next annotation's position. */
5264 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5268 /* Output the annotation. */
5269 tem
= Fcdr (Fcar (*annot
));
5272 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5275 *annot
= Fcdr (*annot
);
5281 /* Write text in the range START and END into descriptor DESC,
5282 encoding them with coding system CODING. If STRING is nil, START
5283 and END are character positions of the current buffer, else they
5284 are indexes to the string STRING. Return true if successful. */
5287 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5288 struct coding_system
*coding
)
5290 if (STRINGP (string
))
5293 end
= SCHARS (string
);
5296 /* We used to have a code for handling selective display here. But,
5297 now it is handled within encode_coding. */
5301 if (STRINGP (string
))
5303 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5304 if (CODING_REQUIRE_ENCODING (coding
))
5306 encode_coding_object (coding
, string
,
5307 start
, string_char_to_byte (string
, start
),
5308 end
, string_char_to_byte (string
, end
), Qt
);
5312 coding
->dst_object
= string
;
5313 coding
->consumed_char
= SCHARS (string
);
5314 coding
->produced
= SBYTES (string
);
5319 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5320 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5322 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5323 if (CODING_REQUIRE_ENCODING (coding
))
5325 encode_coding_object (coding
, Fcurrent_buffer (),
5326 start
, start_byte
, end
, end_byte
, Qt
);
5330 coding
->dst_object
= Qnil
;
5331 coding
->dst_pos_byte
= start_byte
;
5332 if (start
>= GPT
|| end
<= GPT
)
5334 coding
->consumed_char
= end
- start
;
5335 coding
->produced
= end_byte
- start_byte
;
5339 coding
->consumed_char
= GPT
- start
;
5340 coding
->produced
= GPT_BYTE
- start_byte
;
5345 if (coding
->produced
> 0)
5348 -= emacs_write (desc
,
5349 STRINGP (coding
->dst_object
)
5350 ? SSDATA (coding
->dst_object
)
5351 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5354 if (coding
->produced
)
5357 start
+= coding
->consumed_char
;
5363 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5364 Sverify_visited_file_modtime
, 0, 1, 0,
5365 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5366 This means that the file has not been changed since it was visited or saved.
5367 If BUF is omitted or nil, it defaults to the current buffer.
5368 See Info node `(elisp)Modification Time' for more details. */)
5373 Lisp_Object handler
;
5374 Lisp_Object filename
;
5385 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5386 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5388 /* If the file name has special constructs in it,
5389 call the corresponding file handler. */
5390 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5391 Qverify_visited_file_modtime
);
5392 if (!NILP (handler
))
5393 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5395 filename
= ENCODE_FILE (BVAR (b
, filename
));
5397 mtime
= (stat (SSDATA (filename
), &st
) == 0
5398 ? get_stat_mtime (&st
)
5399 : time_error_value (errno
));
5400 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5401 && (b
->modtime_size
< 0
5402 || st
.st_size
== b
->modtime_size
))
5407 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5408 Sclear_visited_file_modtime
, 0, 0, 0,
5409 doc
: /* Clear out records of last mod time of visited file.
5410 Next attempt to save will certainly not complain of a discrepancy. */)
5413 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5414 current_buffer
->modtime_size
= -1;
5418 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5419 Svisited_file_modtime
, 0, 0, 0,
5420 doc
: /* Return the current buffer's recorded visited file modification time.
5421 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5422 `file-attributes' returns. If the current buffer has no recorded file
5423 modification time, this function returns 0. If the visited file
5424 doesn't exist, HIGH will be -1.
5425 See Info node `(elisp)Modification Time' for more details. */)
5428 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5430 if (EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
5432 /* make_lisp_time won't work here if time_t is unsigned. */
5433 return list4i (-1, 65535, 0, 0);
5435 return make_number (0);
5437 return make_lisp_time (current_buffer
->modtime
);
5440 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5441 Sset_visited_file_modtime
, 0, 1, 0,
5442 doc
: /* Update buffer's recorded modification time from the visited file's time.
5443 Useful if the buffer was not read from the file normally
5444 or if the file itself has been changed for some known benign reason.
5445 An argument specifies the modification time value to use
5446 \(instead of that of the visited file), in the form of a list
5447 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5448 (Lisp_Object time_list
)
5450 if (!NILP (time_list
))
5452 current_buffer
->modtime
= lisp_time_argument (time_list
);
5453 current_buffer
->modtime_size
= -1;
5457 register Lisp_Object filename
;
5459 Lisp_Object handler
;
5461 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5463 /* If the file name has special constructs in it,
5464 call the corresponding file handler. */
5465 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5466 if (!NILP (handler
))
5467 /* The handler can find the file name the same way we did. */
5468 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5470 filename
= ENCODE_FILE (filename
);
5472 if (stat (SSDATA (filename
), &st
) >= 0)
5474 current_buffer
->modtime
= get_stat_mtime (&st
);
5475 current_buffer
->modtime_size
= st
.st_size
;
5483 auto_save_error (Lisp_Object error_val
)
5485 Lisp_Object args
[3], msg
;
5487 struct gcpro gcpro1
;
5489 auto_save_error_occurred
= 1;
5491 ring_bell (XFRAME (selected_frame
));
5493 args
[0] = build_string ("Auto-saving %s: %s");
5494 args
[1] = BVAR (current_buffer
, name
);
5495 args
[2] = Ferror_message_string (error_val
);
5496 msg
= Fformat (3, args
);
5499 for (i
= 0; i
< 3; ++i
)
5504 message3_nolog (msg
);
5505 Fsleep_for (make_number (1), Qnil
);
5518 auto_save_mode_bits
= 0666;
5520 /* Get visited file's mode to become the auto save file's mode. */
5521 if (! NILP (BVAR (current_buffer
, filename
)))
5523 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5524 /* But make sure we can overwrite it later! */
5525 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5526 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5528 /* Remote files don't cooperate with stat. */
5529 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5533 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5534 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5539 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5542 FILE *stream
= XSAVE_POINTER (arg
, 0);
5554 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5557 minibuffer_auto_raise
= XINT (value
);
5562 do_auto_save_make_dir (Lisp_Object dir
)
5566 auto_saving_dir_umask
= 077;
5567 result
= call2 (Qmake_directory
, dir
, Qt
);
5568 auto_saving_dir_umask
= 0;
5573 do_auto_save_eh (Lisp_Object ignore
)
5575 auto_saving_dir_umask
= 0;
5579 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5580 doc
: /* Auto-save all buffers that need it.
5581 This is all buffers that have auto-saving enabled
5582 and are changed since last auto-saved.
5583 Auto-saving writes the buffer into a file
5584 so that your editing is not lost if the system crashes.
5585 This file is not the file you visited; that changes only when you save.
5586 Normally we run the normal hook `auto-save-hook' before saving.
5588 A non-nil NO-MESSAGE argument means do not print any message if successful.
5589 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5590 (Lisp_Object no_message
, Lisp_Object current_only
)
5592 struct buffer
*old
= current_buffer
, *b
;
5593 Lisp_Object tail
, buf
, hook
;
5594 bool auto_saved
= 0;
5595 int do_handled_files
;
5597 FILE *stream
= NULL
;
5598 ptrdiff_t count
= SPECPDL_INDEX ();
5599 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5600 bool old_message_p
= 0;
5601 struct gcpro gcpro1
, gcpro2
;
5603 if (max_specpdl_size
< specpdl_size
+ 40)
5604 max_specpdl_size
= specpdl_size
+ 40;
5609 if (NILP (no_message
))
5611 old_message_p
= push_message ();
5612 record_unwind_protect (pop_message_unwind
, Qnil
);
5615 /* Ordinarily don't quit within this function,
5616 but don't make it impossible to quit (in case we get hung in I/O). */
5620 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5621 point to non-strings reached from Vbuffer_alist. */
5623 hook
= intern ("auto-save-hook");
5624 Frun_hooks (1, &hook
);
5626 if (STRINGP (Vauto_save_list_file_name
))
5628 Lisp_Object listfile
;
5630 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5632 /* Don't try to create the directory when shutting down Emacs,
5633 because creating the directory might signal an error, and
5634 that would leave Emacs in a strange state. */
5635 if (!NILP (Vrun_hooks
))
5639 GCPRO2 (dir
, listfile
);
5640 dir
= Ffile_name_directory (listfile
);
5641 if (NILP (Ffile_directory_p (dir
)))
5642 internal_condition_case_1 (do_auto_save_make_dir
,
5648 stream
= fopen (SSDATA (listfile
), "w");
5651 record_unwind_protect (do_auto_save_unwind
,
5652 make_save_pointer (stream
));
5653 record_unwind_protect (do_auto_save_unwind_1
,
5654 make_number (minibuffer_auto_raise
));
5655 minibuffer_auto_raise
= 0;
5657 auto_save_error_occurred
= 0;
5659 /* On first pass, save all files that don't have handlers.
5660 On second pass, save all files that do have handlers.
5662 If Emacs is crashing, the handlers may tweak what is causing
5663 Emacs to crash in the first place, and it would be a shame if
5664 Emacs failed to autosave perfectly ordinary files because it
5665 couldn't handle some ange-ftp'd file. */
5667 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5668 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5670 buf
= XCDR (XCAR (tail
));
5673 /* Record all the buffers that have auto save mode
5674 in the special file that lists them. For each of these buffers,
5675 Record visited name (if any) and auto save name. */
5676 if (STRINGP (BVAR (b
, auto_save_file_name
))
5677 && stream
!= NULL
&& do_handled_files
== 0)
5680 if (!NILP (BVAR (b
, filename
)))
5682 fwrite (SDATA (BVAR (b
, filename
)), 1,
5683 SBYTES (BVAR (b
, filename
)), stream
);
5685 putc ('\n', stream
);
5686 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5687 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5688 putc ('\n', stream
);
5692 if (!NILP (current_only
)
5693 && b
!= current_buffer
)
5696 /* Don't auto-save indirect buffers.
5697 The base buffer takes care of it. */
5701 /* Check for auto save enabled
5702 and file changed since last auto save
5703 and file changed since last real save. */
5704 if (STRINGP (BVAR (b
, auto_save_file_name
))
5705 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5706 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5707 /* -1 means we've turned off autosaving for a while--see below. */
5708 && XINT (BVAR (b
, save_length
)) >= 0
5709 && (do_handled_files
5710 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5713 EMACS_TIME before_time
= current_emacs_time ();
5714 EMACS_TIME after_time
;
5716 /* If we had a failure, don't try again for 20 minutes. */
5717 if (b
->auto_save_failure_time
> 0
5718 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5721 set_buffer_internal (b
);
5722 if (NILP (Vauto_save_include_big_deletions
)
5723 && (XFASTINT (BVAR (b
, save_length
)) * 10
5724 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5725 /* A short file is likely to change a large fraction;
5726 spare the user annoying messages. */
5727 && XFASTINT (BVAR (b
, save_length
)) > 5000
5728 /* These messages are frequent and annoying for `*mail*'. */
5729 && !EQ (BVAR (b
, filename
), Qnil
)
5730 && NILP (no_message
))
5732 /* It has shrunk too much; turn off auto-saving here. */
5733 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5734 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5736 minibuffer_auto_raise
= 0;
5737 /* Turn off auto-saving until there's a real save,
5738 and prevent any more warnings. */
5739 XSETINT (BVAR (b
, save_length
), -1);
5740 Fsleep_for (make_number (1), Qnil
);
5743 if (!auto_saved
&& NILP (no_message
))
5744 message1 ("Auto-saving...");
5745 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5747 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5748 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5749 set_buffer_internal (old
);
5751 after_time
= current_emacs_time ();
5753 /* If auto-save took more than 60 seconds,
5754 assume it was an NFS failure that got a timeout. */
5755 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5756 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5760 /* Prevent another auto save till enough input events come in. */
5761 record_auto_save ();
5763 if (auto_saved
&& NILP (no_message
))
5767 /* If we are going to restore an old message,
5768 give time to read ours. */
5769 sit_for (make_number (1), 0, 0);
5772 else if (!auto_save_error_occurred
)
5773 /* Don't overwrite the error message if an error occurred.
5774 If we displayed a message and then restored a state
5775 with no message, leave a "done" message on the screen. */
5776 message1 ("Auto-saving...done");
5781 /* This restores the message-stack status. */
5782 unbind_to (count
, Qnil
);
5786 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5787 Sset_buffer_auto_saved
, 0, 0, 0,
5788 doc
: /* Mark current buffer as auto-saved with its current text.
5789 No auto-save file will be written until the buffer changes again. */)
5792 /* FIXME: This should not be called in indirect buffers, since
5793 they're not autosaved. */
5794 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5795 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5796 current_buffer
->auto_save_failure_time
= 0;
5800 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5801 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5802 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5805 current_buffer
->auto_save_failure_time
= 0;
5809 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5811 doc
: /* Return t if current buffer has been auto-saved recently.
5812 More precisely, if it has been auto-saved since last read from or saved
5813 in the visited file. If the buffer has no visited file,
5814 then any auto-save counts as "recent". */)
5817 /* FIXME: maybe we should return nil for indirect buffers since
5818 they're never autosaved. */
5819 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5822 /* Reading and completing file names */
5824 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5825 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5826 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5827 The return value is only relevant for a call to `read-file-name' that happens
5828 before any other event (mouse or keypress) is handled. */)
5831 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5832 || defined (HAVE_NS)
5833 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5836 && window_system_available (SELECTED_FRAME ()))
5843 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5845 struct gcpro gcpro1
;
5846 Lisp_Object args
[7];
5848 GCPRO1 (default_filename
);
5849 args
[0] = intern ("read-file-name");
5852 args
[3] = default_filename
;
5853 args
[4] = mustmatch
;
5855 args
[6] = predicate
;
5856 RETURN_UNGCPRO (Ffuncall (7, args
));
5863 valid_timestamp_file_system
= 0;
5867 syms_of_fileio (void)
5869 DEFSYM (Qoperations
, "operations");
5870 DEFSYM (Qexpand_file_name
, "expand-file-name");
5871 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5872 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5873 DEFSYM (Qfile_name_directory
, "file-name-directory");
5874 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5875 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5876 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5877 DEFSYM (Qcopy_file
, "copy-file");
5878 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5879 DEFSYM (Qmake_directory
, "make-directory");
5880 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5881 DEFSYM (Qdelete_file
, "delete-file");
5882 DEFSYM (Qrename_file
, "rename-file");
5883 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5884 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5885 DEFSYM (Qfile_exists_p
, "file-exists-p");
5886 DEFSYM (Qfile_executable_p
, "file-executable-p");
5887 DEFSYM (Qfile_readable_p
, "file-readable-p");
5888 DEFSYM (Qfile_writable_p
, "file-writable-p");
5889 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5890 DEFSYM (Qaccess_file
, "access-file");
5891 DEFSYM (Qfile_directory_p
, "file-directory-p");
5892 DEFSYM (Qfile_regular_p
, "file-regular-p");
5893 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5894 DEFSYM (Qfile_modes
, "file-modes");
5895 DEFSYM (Qset_file_modes
, "set-file-modes");
5896 DEFSYM (Qset_file_times
, "set-file-times");
5897 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5898 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5899 DEFSYM (Qfile_acl
, "file-acl");
5900 DEFSYM (Qset_file_acl
, "set-file-acl");
5901 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5902 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5903 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5904 DEFSYM (Qwrite_region
, "write-region");
5905 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5906 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5907 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5909 DEFSYM (Qfile_name_history
, "file-name-history");
5910 Fset (Qfile_name_history
, Qnil
);
5912 DEFSYM (Qfile_error
, "file-error");
5913 DEFSYM (Qfile_already_exists
, "file-already-exists");
5914 DEFSYM (Qfile_date_error
, "file-date-error");
5915 DEFSYM (Qexcl
, "excl");
5917 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5918 doc
: /* Coding system for encoding file names.
5919 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5920 Vfile_name_coding_system
= Qnil
;
5922 DEFVAR_LISP ("default-file-name-coding-system",
5923 Vdefault_file_name_coding_system
,
5924 doc
: /* Default coding system for encoding file names.
5925 This variable is used only when `file-name-coding-system' is nil.
5927 This variable is set/changed by the command `set-language-environment'.
5928 User should not set this variable manually,
5929 instead use `file-name-coding-system' to get a constant encoding
5930 of file names regardless of the current language environment. */);
5931 Vdefault_file_name_coding_system
= Qnil
;
5933 DEFSYM (Qformat_decode
, "format-decode");
5934 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5935 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5936 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5938 Fput (Qfile_error
, Qerror_conditions
,
5939 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5940 Fput (Qfile_error
, Qerror_message
,
5941 build_pure_c_string ("File error"));
5943 Fput (Qfile_already_exists
, Qerror_conditions
,
5944 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5945 Fput (Qfile_already_exists
, Qerror_message
,
5946 build_pure_c_string ("File already exists"));
5948 Fput (Qfile_date_error
, Qerror_conditions
,
5949 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5950 Fput (Qfile_date_error
, Qerror_message
,
5951 build_pure_c_string ("Cannot set file date"));
5953 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5954 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5955 If a file name matches REGEXP, all I/O on that file is done by calling
5956 HANDLER. If a file name matches more than one handler, the handler
5957 whose match starts last in the file name gets precedence. The
5958 function `find-file-name-handler' checks this list for a handler for
5961 HANDLER should be a function. The first argument given to it is the
5962 name of the I/O primitive to be handled; the remaining arguments are
5963 the arguments that were passed to that primitive. For example, if you
5964 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5965 HANDLER is called like this:
5967 (funcall HANDLER 'file-exists-p FILENAME)
5969 Note that HANDLER must be able to handle all I/O primitives; if it has
5970 nothing special to do for a primitive, it should reinvoke the
5971 primitive to handle the operation \"the usual way\".
5972 See Info node `(elisp)Magic File Names' for more details. */);
5973 Vfile_name_handler_alist
= Qnil
;
5975 DEFVAR_LISP ("set-auto-coding-function",
5976 Vset_auto_coding_function
,
5977 doc
: /* If non-nil, a function to call to decide a coding system of file.
5978 Two arguments are passed to this function: the file name
5979 and the length of a file contents following the point.
5980 This function should return a coding system to decode the file contents.
5981 It should check the file name against `auto-coding-alist'.
5982 If no coding system is decided, it should check a coding system
5983 specified in the heading lines with the format:
5984 -*- ... coding: CODING-SYSTEM; ... -*-
5985 or local variable spec of the tailing lines with `coding:' tag. */);
5986 Vset_auto_coding_function
= Qnil
;
5988 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5989 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5990 Each is passed one argument, the number of characters inserted,
5991 with point at the start of the inserted text. Each function
5992 should leave point the same, and return the new character count.
5993 If `insert-file-contents' is intercepted by a handler from
5994 `file-name-handler-alist', that handler is responsible for calling the
5995 functions in `after-insert-file-functions' if appropriate. */);
5996 Vafter_insert_file_functions
= Qnil
;
5998 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5999 doc
: /* A list of functions to be called at the start of `write-region'.
6000 Each is passed two arguments, START and END as for `write-region'.
6001 These are usually two numbers but not always; see the documentation
6002 for `write-region'. The function should return a list of pairs
6003 of the form (POSITION . STRING), consisting of strings to be effectively
6004 inserted at the specified positions of the file being written (1 means to
6005 insert before the first byte written). The POSITIONs must be sorted into
6008 If there are several annotation functions, the lists returned by these
6009 functions are merged destructively. As each annotation function runs,
6010 the variable `write-region-annotations-so-far' contains a list of all
6011 annotations returned by previous annotation functions.
6013 An annotation function can return with a different buffer current.
6014 Doing so removes the annotations returned by previous functions, and
6015 resets START and END to `point-min' and `point-max' of the new buffer.
6017 After `write-region' completes, Emacs calls the function stored in
6018 `write-region-post-annotation-function', once for each buffer that was
6019 current when building the annotations (i.e., at least once), with that
6020 buffer current. */);
6021 Vwrite_region_annotate_functions
= Qnil
;
6022 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
6024 DEFVAR_LISP ("write-region-post-annotation-function",
6025 Vwrite_region_post_annotation_function
,
6026 doc
: /* Function to call after `write-region' completes.
6027 The function is called with no arguments. If one or more of the
6028 annotation functions in `write-region-annotate-functions' changed the
6029 current buffer, the function stored in this variable is called for
6030 each of those additional buffers as well, in addition to the original
6031 buffer. The relevant buffer is current during each function call. */);
6032 Vwrite_region_post_annotation_function
= Qnil
;
6033 staticpro (&Vwrite_region_annotation_buffers
);
6035 DEFVAR_LISP ("write-region-annotations-so-far",
6036 Vwrite_region_annotations_so_far
,
6037 doc
: /* When an annotation function is called, this holds the previous annotations.
6038 These are the annotations made by other annotation functions
6039 that were already called. See also `write-region-annotate-functions'. */);
6040 Vwrite_region_annotations_so_far
= Qnil
;
6042 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6043 doc
: /* A list of file name handlers that temporarily should not be used.
6044 This applies only to the operation `inhibit-file-name-operation'. */);
6045 Vinhibit_file_name_handlers
= Qnil
;
6047 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6048 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6049 Vinhibit_file_name_operation
= Qnil
;
6051 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6052 doc
: /* File name in which we write a list of all auto save file names.
6053 This variable is initialized automatically from `auto-save-list-file-prefix'
6054 shortly after Emacs reads your init file, if you have not yet given it
6055 a non-nil value. */);
6056 Vauto_save_list_file_name
= Qnil
;
6058 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6059 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6060 Normally auto-save files are written under other names. */);
6061 Vauto_save_visited_file_name
= Qnil
;
6063 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6064 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6065 If nil, deleting a substantial portion of the text disables auto-save
6066 in the buffer; this is the default behavior, because the auto-save
6067 file is usually more useful if it contains the deleted text. */);
6068 Vauto_save_include_big_deletions
= Qnil
;
6070 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6071 doc
: /* Non-nil means don't call fsync in `write-region'.
6072 This variable affects calls to `write-region' as well as save commands.
6073 A non-nil value may result in data loss! */);
6074 write_region_inhibit_fsync
= 0;
6076 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6077 doc
: /* Specifies whether to use the system's trash can.
6078 When non-nil, certain file deletion commands use the function
6079 `move-file-to-trash' instead of deleting files outright.
6080 This includes interactive calls to `delete-file' and
6081 `delete-directory' and the Dired deletion commands. */);
6082 delete_by_moving_to_trash
= 0;
6083 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6085 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6086 DEFSYM (Qcopy_directory
, "copy-directory");
6087 DEFSYM (Qdelete_directory
, "delete-directory");
6089 defsubr (&Sfind_file_name_handler
);
6090 defsubr (&Sfile_name_directory
);
6091 defsubr (&Sfile_name_nondirectory
);
6092 defsubr (&Sunhandled_file_name_directory
);
6093 defsubr (&Sfile_name_as_directory
);
6094 defsubr (&Sdirectory_file_name
);
6095 defsubr (&Smake_temp_name
);
6096 defsubr (&Sexpand_file_name
);
6097 defsubr (&Ssubstitute_in_file_name
);
6098 defsubr (&Scopy_file
);
6099 defsubr (&Smake_directory_internal
);
6100 defsubr (&Sdelete_directory_internal
);
6101 defsubr (&Sdelete_file
);
6102 defsubr (&Srename_file
);
6103 defsubr (&Sadd_name_to_file
);
6104 defsubr (&Smake_symbolic_link
);
6105 defsubr (&Sfile_name_absolute_p
);
6106 defsubr (&Sfile_exists_p
);
6107 defsubr (&Sfile_executable_p
);
6108 defsubr (&Sfile_readable_p
);
6109 defsubr (&Sfile_writable_p
);
6110 defsubr (&Saccess_file
);
6111 defsubr (&Sfile_symlink_p
);
6112 defsubr (&Sfile_directory_p
);
6113 defsubr (&Sfile_accessible_directory_p
);
6114 defsubr (&Sfile_regular_p
);
6115 defsubr (&Sfile_modes
);
6116 defsubr (&Sset_file_modes
);
6117 defsubr (&Sset_file_times
);
6118 defsubr (&Sfile_selinux_context
);
6119 defsubr (&Sfile_acl
);
6120 defsubr (&Sset_file_acl
);
6121 defsubr (&Sset_file_selinux_context
);
6122 defsubr (&Sset_default_file_modes
);
6123 defsubr (&Sdefault_file_modes
);
6124 defsubr (&Sfile_newer_than_file_p
);
6125 defsubr (&Sinsert_file_contents
);
6126 defsubr (&Schoose_write_coding_system
);
6127 defsubr (&Swrite_region
);
6128 defsubr (&Scar_less_than_car
);
6129 defsubr (&Sverify_visited_file_modtime
);
6130 defsubr (&Sclear_visited_file_modtime
);
6131 defsubr (&Svisited_file_modtime
);
6132 defsubr (&Sset_visited_file_modtime
);
6133 defsubr (&Sdo_auto_save
);
6134 defsubr (&Sset_buffer_auto_saved
);
6135 defsubr (&Sclear_buffer_auto_save_failure
);
6136 defsubr (&Srecent_auto_save_p
);
6138 defsubr (&Snext_read_file_uses_dialog_p
);
6141 defsubr (&Sunix_sync
);