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>
39 #ifdef HAVE_ACL_SET_FILE
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
53 #include "dispextern.h"
60 #endif /* not WINDOWSNT */
64 #include <sys/param.h>
68 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
69 redirector allows the six letters between 'Z' and 'a' as well. */
71 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
74 #define IS_DRIVE(x) c_isalpha (x)
76 /* Need to lower-case the drive letter, or else expanded
77 filenames will sometimes compare unequal, because
78 `expand-file-name' doesn't always down-case the drive letter. */
79 #define DRIVE_LETTER(x) c_tolower (x)
84 #include <allocator.h>
85 #include <careadlinkat.h>
86 #include <stat-time.h>
94 /* True during writing of auto-save files. */
95 static bool auto_saving
;
97 /* Nonzero umask during creation of auto-save directories. */
98 static mode_t auto_saving_dir_umask
;
100 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
101 a new file with the same mode as the original. */
102 static mode_t auto_save_mode_bits
;
104 /* Set by auto_save_1 if an error occurred during the last auto-save. */
105 static bool auto_save_error_occurred
;
107 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
108 number of a file system where time stamps were observed to to work. */
109 static bool valid_timestamp_file_system
;
110 static dev_t timestamp_file_system
;
112 /* The symbol bound to coding-system-for-read when
113 insert-file-contents is called for recovering a file. This is not
114 an actual coding system name, but just an indicator to tell
115 insert-file-contents to use `emacs-mule' with a special flag for
116 auto saving and recovering a file. */
117 static Lisp_Object Qauto_save_coding
;
119 /* Property name of a file name handler,
120 which gives a list of operations it handles.. */
121 static Lisp_Object Qoperations
;
123 /* Lisp functions for translating file formats. */
124 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
126 /* Lisp function for setting buffer-file-coding-system and the
127 multibyteness of the current buffer after inserting a file. */
128 static Lisp_Object Qafter_insert_file_set_coding
;
130 static Lisp_Object Qwrite_region_annotate_functions
;
131 /* Each time an annotation function changes the buffer, the new buffer
133 static Lisp_Object Vwrite_region_annotation_buffers
;
135 static Lisp_Object Qdelete_by_moving_to_trash
;
137 /* Lisp function for moving files to trash. */
138 static Lisp_Object Qmove_file_to_trash
;
140 /* Lisp function for recursively copying directories. */
141 static Lisp_Object Qcopy_directory
;
143 /* Lisp function for recursively deleting directories. */
144 static Lisp_Object Qdelete_directory
;
149 Lisp_Object Qfile_error
, Qfile_notify_error
;
150 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
151 static Lisp_Object Qexcl
;
152 Lisp_Object Qfile_name_history
;
154 static Lisp_Object Qcar_less_than_car
;
156 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
157 Lisp_Object
*, struct coding_system
*);
158 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
159 struct coding_system
*);
162 /* Signal a file-access failure. STRING describes the failure,
163 NAME the file involved, and ERRORNO the errno value.
165 If NAME is neither null nor a pair, package it up as a singleton
166 list before reporting it; this saves report_file_errno's caller the
167 trouble of preserving errno before calling list1. */
170 report_file_errno (char const *string
, Lisp_Object name
, int errorno
)
172 Lisp_Object data
= CONSP (name
) || NILP (name
) ? name
: list1 (name
);
173 Lisp_Object errstring
;
176 synchronize_system_messages_locale ();
177 str
= strerror (errorno
);
178 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
179 Vlocale_coding_system
, 0);
185 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
188 /* System error messages are capitalized. Downcase the initial
189 unless it is followed by a slash. (The slash case caters to
190 error messages that begin with "I/O" or, in German, "E/A".) */
191 if (STRING_MULTIBYTE (errstring
)
192 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
196 str
= SSDATA (errstring
);
197 c
= STRING_CHAR ((unsigned char *) str
);
198 Faset (errstring
, make_number (0), make_number (downcase (c
)));
201 xsignal (Qfile_error
,
202 Fcons (build_string (string
), Fcons (errstring
, data
)));
206 /* Signal a file-access failure that set errno. STRING describes the
207 failure, NAME the file involved. When invoking this function, take
208 care to not use arguments such as build_string ("foo") that involve
209 side effects that may set errno. */
212 report_file_error (char const *string
, Lisp_Object name
)
214 report_file_errno (string
, name
, errno
);
218 close_file_unwind (int fd
)
224 fclose_unwind (void *arg
)
230 /* Restore point, having saved it as a marker. */
233 restore_point_unwind (Lisp_Object location
)
235 Fgoto_char (location
);
236 unchain_marker (XMARKER (location
));
240 static Lisp_Object Qexpand_file_name
;
241 static Lisp_Object Qsubstitute_in_file_name
;
242 static Lisp_Object Qdirectory_file_name
;
243 static Lisp_Object Qfile_name_directory
;
244 static Lisp_Object Qfile_name_nondirectory
;
245 static Lisp_Object Qunhandled_file_name_directory
;
246 static Lisp_Object Qfile_name_as_directory
;
247 static Lisp_Object Qcopy_file
;
248 static Lisp_Object Qmake_directory_internal
;
249 static Lisp_Object Qmake_directory
;
250 static Lisp_Object Qdelete_directory_internal
;
251 Lisp_Object Qdelete_file
;
252 static Lisp_Object Qrename_file
;
253 static Lisp_Object Qadd_name_to_file
;
254 static Lisp_Object Qmake_symbolic_link
;
255 Lisp_Object Qfile_exists_p
;
256 static Lisp_Object Qfile_executable_p
;
257 static Lisp_Object Qfile_readable_p
;
258 static Lisp_Object Qfile_writable_p
;
259 static Lisp_Object Qfile_symlink_p
;
260 static Lisp_Object Qaccess_file
;
261 Lisp_Object Qfile_directory_p
;
262 static Lisp_Object Qfile_regular_p
;
263 static Lisp_Object Qfile_accessible_directory_p
;
264 static Lisp_Object Qfile_modes
;
265 static Lisp_Object Qset_file_modes
;
266 static Lisp_Object Qset_file_times
;
267 static Lisp_Object Qfile_selinux_context
;
268 static Lisp_Object Qset_file_selinux_context
;
269 static Lisp_Object Qfile_acl
;
270 static Lisp_Object Qset_file_acl
;
271 static Lisp_Object Qfile_newer_than_file_p
;
272 Lisp_Object Qinsert_file_contents
;
273 static Lisp_Object Qchoose_write_coding_system
;
274 Lisp_Object Qwrite_region
;
275 static Lisp_Object Qverify_visited_file_modtime
;
276 static Lisp_Object Qset_visited_file_modtime
;
278 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
279 Sfind_file_name_handler
, 2, 2, 0,
280 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
281 Otherwise, return nil.
282 A file name is handled if one of the regular expressions in
283 `file-name-handler-alist' matches it.
285 If OPERATION equals `inhibit-file-name-operation', then we ignore
286 any handlers that are members of `inhibit-file-name-handlers',
287 but we still do run any other handlers. This lets handlers
288 use the standard functions without calling themselves recursively. */)
289 (Lisp_Object filename
, Lisp_Object operation
)
291 /* This function must not munge the match data. */
292 Lisp_Object chain
, inhibited_handlers
, result
;
296 CHECK_STRING (filename
);
298 if (EQ (operation
, Vinhibit_file_name_operation
))
299 inhibited_handlers
= Vinhibit_file_name_handlers
;
301 inhibited_handlers
= Qnil
;
303 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
304 chain
= XCDR (chain
))
310 Lisp_Object string
= XCAR (elt
);
312 Lisp_Object handler
= XCDR (elt
);
313 Lisp_Object operations
= Qnil
;
315 if (SYMBOLP (handler
))
316 operations
= Fget (handler
, Qoperations
);
319 && (match_pos
= fast_string_match (string
, filename
)) > pos
320 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
324 handler
= XCDR (elt
);
325 tem
= Fmemq (handler
, inhibited_handlers
);
339 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
341 doc
: /* Return the directory component in file name FILENAME.
342 Return nil if FILENAME does not include a directory.
343 Otherwise return a directory name.
344 Given a Unix syntax file name, returns a string ending in slash. */)
345 (Lisp_Object filename
)
348 register const char *beg
;
353 register const char *p
;
356 CHECK_STRING (filename
);
358 /* If the file name has special constructs in it,
359 call the corresponding file handler. */
360 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
363 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
365 return STRINGP (handled_name
) ? handled_name
: Qnil
;
369 beg
= xlispstrdupa (filename
);
371 beg
= SSDATA (filename
);
373 p
= beg
+ SBYTES (filename
);
375 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
377 /* only recognize drive specifier at the beginning */
379 /* handle the "/:d:foo" and "/:foo" cases correctly */
380 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
381 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
388 /* Expansion of "c:" to drive and default directory. */
391 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
392 char *res
= alloca (MAXPATHLEN
+ 1);
395 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
397 memcpy (res
, beg
, 2);
402 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
404 size_t l
= strlen (res
);
406 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
409 p
= beg
+ strlen (beg
);
410 dostounix_filename (beg
, 0);
411 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
412 STRING_MULTIBYTE (filename
));
415 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
416 STRING_MULTIBYTE (filename
));
418 else if (STRING_MULTIBYTE (filename
))
420 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
421 dostounix_filename (SSDATA (tem_fn
), 1);
423 if (!NILP (Vw32_downcase_file_names
))
424 tem_fn
= Fdowncase (tem_fn
);
429 dostounix_filename (beg
, 0);
430 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
434 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
438 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
439 Sfile_name_nondirectory
, 1, 1, 0,
440 doc
: /* Return file name FILENAME sans its directory.
441 For example, in a Unix-syntax file name,
442 this is everything after the last slash,
443 or the entire name if it contains no slash. */)
444 (Lisp_Object filename
)
446 register const char *beg
, *p
, *end
;
449 CHECK_STRING (filename
);
451 /* If the file name has special constructs in it,
452 call the corresponding file handler. */
453 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
456 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
458 if (STRINGP (handled_name
))
460 error ("Invalid handler in `file-name-handler-alist'");
463 beg
= SSDATA (filename
);
464 end
= p
= beg
+ SBYTES (filename
);
466 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
468 /* only recognize drive specifier at beginning */
470 /* handle the "/:d:foo" case correctly */
471 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
476 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
479 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
480 Sunhandled_file_name_directory
, 1, 1, 0,
481 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
482 A `directly usable' directory name is one that may be used without the
483 intervention of any file handler.
484 If FILENAME is a directly usable file itself, return
485 \(file-name-directory FILENAME).
486 If FILENAME refers to a file which is not accessible from a local process,
487 then this should return nil.
488 The `call-process' and `start-process' functions use this function to
489 get a current directory to run processes in. */)
490 (Lisp_Object filename
)
494 /* If the file name has special constructs in it,
495 call the corresponding file handler. */
496 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
499 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
501 return STRINGP (handled_name
) ? handled_name
: Qnil
;
504 return Ffile_name_directory (filename
);
507 /* Maximum number of bytes that DST will be longer than SRC
508 in file_name_as_directory. This occurs when SRCLEN == 0. */
509 enum { file_name_as_directory_slop
= 2 };
511 /* Convert from file name SRC of length SRCLEN to directory name in
512 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
513 string. On UNIX, just make sure there is a terminating /. Return
514 the length of DST in bytes. */
517 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
528 memcpy (dst
, src
, srclen
);
529 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
530 dst
[srclen
++] = DIRECTORY_SEP
;
533 dostounix_filename (dst
, multibyte
);
538 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
539 Sfile_name_as_directory
, 1, 1, 0,
540 doc
: /* Return a string representing the file name FILE interpreted as a directory.
541 This operation exists because a directory is also a file, but its name as
542 a directory is different from its name as a file.
543 The result can be used as the value of `default-directory'
544 or passed as second argument to `expand-file-name'.
545 For a Unix-syntax file name, just appends a slash. */)
550 Lisp_Object handler
, val
;
557 /* If the file name has special constructs in it,
558 call the corresponding file handler. */
559 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
562 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
564 if (STRINGP (handled_name
))
566 error ("Invalid handler in `file-name-handler-alist'");
570 if (!NILP (Vw32_downcase_file_names
))
571 file
= Fdowncase (file
);
573 buf
= SAFE_ALLOCA (SBYTES (file
) + file_name_as_directory_slop
+ 1);
574 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
575 STRING_MULTIBYTE (file
));
576 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
581 /* Convert from directory name SRC of length SRCLEN to file name in
582 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
583 string. On UNIX, just make sure there isn't a terminating /.
584 Return the length of DST in bytes. */
587 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
589 /* Process as Unix format: just remove any final slash.
590 But leave "/" and "//" unchanged. */
593 && !IS_ANY_SEP (src
[srclen
- 2])
595 && IS_DIRECTORY_SEP (src
[srclen
- 1])
596 && ! (srclen
== 2 && IS_DIRECTORY_SEP (src
[0])))
599 memcpy (dst
, src
, srclen
);
602 dostounix_filename (dst
, multibyte
);
607 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
609 doc
: /* Returns the file name of the directory named DIRECTORY.
610 This is the name of the file that holds the data for the directory DIRECTORY.
611 This operation exists because a directory is also a file, but its name as
612 a directory is different from its name as a file.
613 In Unix-syntax, this function just removes the final slash. */)
614 (Lisp_Object directory
)
618 Lisp_Object handler
, val
;
621 CHECK_STRING (directory
);
623 if (NILP (directory
))
626 /* If the file name has special constructs in it,
627 call the corresponding file handler. */
628 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
631 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
633 if (STRINGP (handled_name
))
635 error ("Invalid handler in `file-name-handler-alist'");
639 if (!NILP (Vw32_downcase_file_names
))
640 directory
= Fdowncase (directory
);
642 buf
= SAFE_ALLOCA (SBYTES (directory
) + 1);
643 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
644 STRING_MULTIBYTE (directory
));
645 val
= make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
650 static const char make_temp_name_tbl
[64] =
652 'A','B','C','D','E','F','G','H',
653 'I','J','K','L','M','N','O','P',
654 'Q','R','S','T','U','V','W','X',
655 'Y','Z','a','b','c','d','e','f',
656 'g','h','i','j','k','l','m','n',
657 'o','p','q','r','s','t','u','v',
658 'w','x','y','z','0','1','2','3',
659 '4','5','6','7','8','9','-','_'
662 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
664 /* Value is a temporary file name starting with PREFIX, a string.
666 The Emacs process number forms part of the result, so there is
667 no danger of generating a name being used by another process.
668 In addition, this function makes an attempt to choose a name
669 which has no existing file. To make this work, PREFIX should be
670 an absolute file name.
672 BASE64_P means add the pid as 3 characters in base64
673 encoding. In this case, 6 characters will be added to PREFIX to
674 form the file name. Otherwise, if Emacs is running on a system
675 with long file names, add the pid as a decimal number.
677 This function signals an error if no unique file name could be
681 make_temp_name (Lisp_Object prefix
, bool base64_p
)
687 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
690 CHECK_STRING (prefix
);
692 /* VAL is created by adding 6 characters to PREFIX. The first
693 three are the PID of this process, in base 64, and the second
694 three are incremented if the file already exists. This ensures
695 262144 unique file names per PID per PREFIX. */
701 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
702 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
703 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
708 #ifdef HAVE_LONG_FILE_NAMES
709 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
711 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
712 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
713 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
718 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
719 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
720 if (!STRING_MULTIBYTE (prefix
))
721 STRING_SET_UNIBYTE (val
);
723 memcpy (data
, SSDATA (prefix
), len
);
726 memcpy (p
, pidbuf
, pidlen
);
729 /* Here we try to minimize useless stat'ing when this function is
730 invoked many times successively with the same PREFIX. We achieve
731 this by initializing count to a random value, and incrementing it
734 We don't want make-temp-name to be called while dumping,
735 because then make_temp_name_count_initialized_p would get set
736 and then make_temp_name_count would not be set when Emacs starts. */
738 if (!make_temp_name_count_initialized_p
)
740 make_temp_name_count
= time (NULL
);
741 make_temp_name_count_initialized_p
= 1;
746 unsigned num
= make_temp_name_count
;
748 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
749 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
750 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
752 /* Poor man's congruential RN generator. Replace with
753 ++make_temp_name_count for debugging. */
754 make_temp_name_count
+= 25229;
755 make_temp_name_count
%= 225307;
757 if (!check_existing (data
))
759 /* We want to return only if errno is ENOENT. */
763 /* The error here is dubious, but there is little else we
764 can do. The alternatives are to return nil, which is
765 as bad as (and in many cases worse than) throwing the
766 error, or to ignore the error, which will likely result
767 in looping through 225307 stat's, which is not only
768 dog-slow, but also useless since eventually nil would
769 have to be returned anyway. */
770 report_file_error ("Cannot create temporary name for prefix",
778 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
779 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
780 The Emacs process number forms part of the result,
781 so there is no danger of generating a name being used by another process.
783 In addition, this function makes an attempt to choose a name
784 which has no existing file. To make this work,
785 PREFIX should be an absolute file name.
787 There is a race condition between calling `make-temp-name' and creating the
788 file which opens all kinds of security holes. For that reason, you should
789 probably use `make-temp-file' instead, except in three circumstances:
791 * If you are creating the file in the user's home directory.
792 * If you are creating a directory rather than an ordinary file.
793 * If you are taking special precautions as `make-temp-file' does. */)
796 return make_temp_name (prefix
, 0);
801 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
802 doc
: /* Convert filename NAME to absolute, and canonicalize it.
803 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
804 \(does not start with slash or tilde); both the directory name and
805 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
806 missing, the current buffer's value of `default-directory' is used.
807 NAME should be a string that is a valid file name for the underlying
809 File name components that are `.' are removed, and
810 so are file name components followed by `..', along with the `..' itself;
811 note that these simplifications are done without checking the resulting
812 file names in the file system.
813 Multiple consecutive slashes are collapsed into a single slash,
814 except at the beginning of the file name when they are significant (e.g.,
815 UNC file names on MS-Windows.)
816 An initial `~/' expands to your home directory.
817 An initial `~USER/' expands to USER's home directory.
818 See also the function `substitute-in-file-name'.
820 For technical reasons, this function can return correct but
821 non-intuitive results for the root directory; for instance,
822 \(expand-file-name ".." "/") returns "/..". For this reason, use
823 \(directory-file-name (file-name-directory dirname)) to traverse a
824 filesystem tree, not (expand-file-name ".." dirname). */)
825 (Lisp_Object name
, Lisp_Object default_directory
)
827 /* These point to SDATA and need to be careful with string-relocation
828 during GC (via DECODE_FILE). */
831 /* This should only point to alloca'd data. */
838 bool collapse_newdir
= 1;
842 Lisp_Object handler
, result
, handled_name
;
849 /* If the file name has special constructs in it,
850 call the corresponding file handler. */
851 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
854 handled_name
= call3 (handler
, Qexpand_file_name
,
855 name
, default_directory
);
856 if (STRINGP (handled_name
))
858 error ("Invalid handler in `file-name-handler-alist'");
862 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
863 if (NILP (default_directory
))
864 default_directory
= BVAR (current_buffer
, directory
);
865 if (! STRINGP (default_directory
))
868 /* "/" is not considered a root directory on DOS_NT, so using "/"
869 here causes an infinite recursion in, e.g., the following:
871 (let (default-directory)
872 (expand-file-name "a"))
874 To avoid this, we set default_directory to the root of the
876 default_directory
= build_string (emacs_root_dir ());
878 default_directory
= build_string ("/");
882 if (!NILP (default_directory
))
884 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
887 handled_name
= call3 (handler
, Qexpand_file_name
,
888 name
, default_directory
);
889 if (STRINGP (handled_name
))
891 error ("Invalid handler in `file-name-handler-alist'");
896 char *o
= SSDATA (default_directory
);
898 /* Make sure DEFAULT_DIRECTORY is properly expanded.
899 It would be better to do this down below where we actually use
900 default_directory. Unfortunately, calling Fexpand_file_name recursively
901 could invoke GC, and the strings might be relocated. This would
902 be annoying because we have pointers into strings lying around
903 that would need adjusting, and people would add new pointers to
904 the code and forget to adjust them, resulting in intermittent bugs.
905 Putting this call here avoids all that crud.
907 The EQ test avoids infinite recursion. */
908 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
909 /* Save time in some common cases - as long as default_directory
910 is not relative, it can be canonicalized with name below (if it
911 is needed at all) without requiring it to be expanded now. */
913 /* Detect MSDOS file names with drive specifiers. */
914 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
915 && IS_DIRECTORY_SEP (o
[2]))
917 /* Detect Windows file names in UNC format. */
918 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
920 #else /* not DOS_NT */
921 /* Detect Unix absolute file names (/... alone is not absolute on
923 && ! (IS_DIRECTORY_SEP (o
[0]))
924 #endif /* not DOS_NT */
930 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
934 multibyte
= STRING_MULTIBYTE (name
);
935 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
938 default_directory
= string_to_multibyte (default_directory
);
941 name
= string_to_multibyte (name
);
947 if (!NILP (Vw32_downcase_file_names
))
948 default_directory
= Fdowncase (default_directory
);
951 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
952 nm
= xlispstrdupa (name
);
955 /* Note if special escape prefix is present, but remove for now. */
956 if (nm
[0] == '/' && nm
[1] == ':')
962 /* Find and remove drive specifier if present; this makes nm absolute
963 even if the rest of the name appears to be relative. Only look for
964 drive specifier at the beginning. */
965 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
967 drive
= (unsigned char) nm
[0];
972 /* If we see "c://somedir", we want to strip the first slash after the
973 colon when stripping the drive letter. Otherwise, this expands to
975 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
978 /* Discard any previous drive specifier if nm is now in UNC format. */
979 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
983 #endif /* WINDOWSNT */
986 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
987 none are found, we can probably return right away. We will avoid
988 allocating a new string if name is already fully expanded. */
990 IS_DIRECTORY_SEP (nm
[0])
992 && drive
&& !is_escaped
995 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
999 /* If it turns out that the filename we want to return is just a
1000 suffix of FILENAME, we don't need to go through and edit
1001 things; we just need to construct a new string using data
1002 starting at the middle of FILENAME. If we set LOSE, that
1003 means we've discovered that we can't do that cool trick. */
1009 /* Since we know the name is absolute, we can assume that each
1010 element starts with a "/". */
1012 /* "." and ".." are hairy. */
1013 if (IS_DIRECTORY_SEP (p
[0])
1015 && (IS_DIRECTORY_SEP (p
[2])
1017 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1020 /* Replace multiple slashes with a single one, except
1021 leave leading "//" alone. */
1022 else if (IS_DIRECTORY_SEP (p
[0])
1023 && IS_DIRECTORY_SEP (p
[1])
1024 && (p
!= nm
|| IS_DIRECTORY_SEP (p
[2])))
1031 /* Make sure directories are all separated with /, but
1032 avoid allocation of a new string when not required. */
1033 dostounix_filename (nm
, multibyte
);
1035 if (IS_DIRECTORY_SEP (nm
[1]))
1037 if (strcmp (nm
, SSDATA (name
)) != 0)
1038 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1042 /* Drive must be set, so this is okay. */
1043 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1047 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1048 temp
[0] = DRIVE_LETTER (drive
);
1049 name
= concat2 (build_string (temp
), name
);
1052 if (!NILP (Vw32_downcase_file_names
))
1053 name
= Fdowncase (name
);
1056 #else /* not DOS_NT */
1057 if (strcmp (nm
, SSDATA (name
)) == 0)
1059 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1060 #endif /* not DOS_NT */
1064 /* At this point, nm might or might not be an absolute file name. We
1065 need to expand ~ or ~user if present, otherwise prefix nm with
1066 default_directory if nm is not absolute, and finally collapse /./
1067 and /foo/../ sequences.
1069 We set newdir to be the appropriate prefix if one is needed:
1070 - the relevant user directory if nm starts with ~ or ~user
1071 - the specified drive's working dir (DOS/NT only) if nm does not
1073 - the value of default_directory.
1075 Note that these prefixes are not guaranteed to be absolute (except
1076 for the working dir of a drive). Therefore, to ensure we always
1077 return an absolute name, if the final prefix is not absolute we
1078 append it to the current working directory. */
1082 if (nm
[0] == '~') /* prefix ~ */
1084 if (IS_DIRECTORY_SEP (nm
[1])
1085 || nm
[1] == 0) /* ~ by itself */
1089 if (!(newdir
= egetenv ("HOME")))
1092 /* `egetenv' may return a unibyte string, which will bite us since
1093 we expect the directory to be multibyte. */
1094 tem
= build_string (newdir
);
1095 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1097 hdir
= DECODE_FILE (tem
);
1098 newdir
= SSDATA (hdir
);
1101 collapse_newdir
= 0;
1104 else /* ~user/filename */
1107 for (p
= nm
; *p
&& !IS_DIRECTORY_SEP (*p
); p
++)
1109 o
= SAFE_ALLOCA (p
- nm
+ 1);
1110 memcpy (o
, nm
, p
- nm
);
1114 pw
= getpwnam (o
+ 1);
1120 newdir
= pw
->pw_dir
;
1121 /* `getpwnam' may return a unibyte string, which will
1122 bite us since we expect the directory to be
1124 tem
= build_string (newdir
);
1125 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1127 hdir
= DECODE_FILE (tem
);
1128 newdir
= SSDATA (hdir
);
1132 collapse_newdir
= 0;
1136 /* If we don't find a user of that name, leave the name
1137 unchanged; don't move nm forward to p. */
1142 /* On DOS and Windows, nm is absolute if a drive name was specified;
1143 use the drive's current directory as the prefix if needed. */
1144 if (!newdir
&& drive
)
1146 /* Get default directory if needed to make nm absolute. */
1148 if (!IS_DIRECTORY_SEP (nm
[0]))
1150 adir
= alloca (MAXPATHLEN
+ 1);
1151 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1155 Lisp_Object tem
= build_string (adir
);
1157 tem
= DECODE_FILE (tem
);
1158 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1163 /* Either nm starts with /, or drive isn't mounted. */
1165 adir
[0] = DRIVE_LETTER (drive
);
1174 /* Finally, if no prefix has been specified and nm is not absolute,
1175 then it must be expanded relative to default_directory. */
1179 /* /... alone is not absolute on DOS and Windows. */
1180 && !IS_DIRECTORY_SEP (nm
[0])
1183 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1187 newdir
= SSDATA (default_directory
);
1189 /* Note if special escape prefix is present, but remove for now. */
1190 if (newdir
[0] == '/' && newdir
[1] == ':')
1201 /* First ensure newdir is an absolute name. */
1203 /* Detect MSDOS file names with drive specifiers. */
1204 ! (IS_DRIVE (newdir
[0])
1205 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1207 /* Detect Windows file names in UNC format. */
1208 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1212 /* Effectively, let newdir be (expand-file-name newdir cwd).
1213 Because of the admonition against calling expand-file-name
1214 when we have pointers into lisp strings, we accomplish this
1215 indirectly by prepending newdir to nm if necessary, and using
1216 cwd (or the wd of newdir's drive) as the new newdir. */
1219 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1221 drive
= (unsigned char) newdir
[0];
1224 if (!IS_DIRECTORY_SEP (nm
[0]))
1226 ptrdiff_t newlen
= strlen (newdir
);
1227 char *tmp
= alloca (newlen
+ file_name_as_directory_slop
1229 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1233 adir
= alloca (MAXPATHLEN
+ 1);
1236 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1240 getcwd (adir
, MAXPATHLEN
+ 1);
1243 Lisp_Object tem
= build_string (adir
);
1245 tem
= DECODE_FILE (tem
);
1246 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1251 /* Strip off drive name from prefix, if present. */
1252 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1258 /* Keep only a prefix from newdir if nm starts with slash
1259 (//server/share for UNC, nothing otherwise). */
1260 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1263 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1265 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1267 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1269 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1282 /* Ignore any slash at the end of newdir, unless newdir is
1283 just "/" or "//". */
1284 length
= strlen (newdir
);
1285 while (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1286 && ! (length
== 2 && IS_DIRECTORY_SEP (newdir
[0])))
1292 /* Now concatenate the directory and name to new space in the stack frame. */
1293 tlen
= length
+ file_name_as_directory_slop
+ strlen (nm
) + 1;
1295 /* Reserve space for drive specifier and escape prefix, since either
1296 or both may need to be inserted. (The Microsoft x86 compiler
1297 produces incorrect code if the following two lines are combined.) */
1298 target
= alloca (tlen
+ 4);
1300 #else /* not DOS_NT */
1301 target
= SAFE_ALLOCA (tlen
);
1302 #endif /* not DOS_NT */
1307 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1310 /* If newdir is effectively "C:/", then the drive letter will have
1311 been stripped and newdir will be "/". Concatenating with an
1312 absolute directory in nm produces "//", which will then be
1313 incorrectly treated as a network share. Ignore newdir in
1314 this case (keeping the drive letter). */
1315 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1316 && newdir
[1] == '\0'))
1319 memcpy (target
, newdir
, length
);
1324 file_name_as_directory (target
, newdir
, length
, multibyte
);
1327 strcat (target
, nm
);
1329 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1337 if (!IS_DIRECTORY_SEP (*p
))
1341 else if (p
[1] == '.'
1342 && (IS_DIRECTORY_SEP (p
[2])
1345 /* If "/." is the entire filename, keep the "/". Otherwise,
1346 just delete the whole "/.". */
1347 if (o
== target
&& p
[2] == '\0')
1351 else if (p
[1] == '.' && p
[2] == '.'
1352 /* `/../' is the "superroot" on certain file systems.
1353 Turned off on DOS_NT systems because they have no
1354 "superroot" and because this causes us to produce
1355 file names like "d:/../foo" which fail file-related
1356 functions of the underlying OS. (To reproduce, try a
1357 long series of "../../" in default_directory, longer
1358 than the number of levels from the root.) */
1362 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1367 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1370 /* Don't go below server level in UNC filenames. */
1371 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1372 && IS_DIRECTORY_SEP (*target
))
1376 /* Keep initial / only if this is the whole name. */
1377 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1381 else if (IS_DIRECTORY_SEP (p
[1])
1382 && (p
!= target
|| IS_DIRECTORY_SEP (p
[2])))
1383 /* Collapse multiple "/", except leave leading "//" alone. */
1392 /* At last, set drive name. */
1394 /* Except for network file name. */
1395 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1396 #endif /* WINDOWSNT */
1398 if (!drive
) emacs_abort ();
1400 target
[0] = DRIVE_LETTER (drive
);
1403 /* Reinsert the escape prefix if required. */
1410 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1411 dostounix_filename (SSDATA (result
), multibyte
);
1413 if (!NILP (Vw32_downcase_file_names
))
1414 result
= Fdowncase (result
);
1417 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1418 #endif /* !DOS_NT */
1421 /* Again look to see if the file name has special constructs in it
1422 and perhaps call the corresponding file handler. This is needed
1423 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1424 the ".." component gives us "/user@host:/bar/../baz" which needs
1425 to be expanded again. */
1426 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1427 if (!NILP (handler
))
1429 handled_name
= call3 (handler
, Qexpand_file_name
,
1430 result
, default_directory
);
1431 if (! STRINGP (handled_name
))
1432 error ("Invalid handler in `file-name-handler-alist'");
1433 result
= handled_name
;
1441 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1442 This is the old version of expand-file-name, before it was thoroughly
1443 rewritten for Emacs 10.31. We leave this version here commented-out,
1444 because the code is very complex and likely to have subtle bugs. If
1445 bugs _are_ found, it might be of interest to look at the old code and
1446 see what did it do in the relevant situation.
1448 Don't remove this code: it's true that it will be accessible
1449 from the repository, but a few years from deletion, people will
1450 forget it is there. */
1452 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1453 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1454 "Convert FILENAME to absolute, and canonicalize it.\n\
1455 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1456 \(does not start with slash); if DEFAULT is nil or missing,\n\
1457 the current buffer's value of default-directory is used.\n\
1458 Filenames containing `.' or `..' as components are simplified;\n\
1459 initial `~/' expands to your home directory.\n\
1460 See also the function `substitute-in-file-name'.")
1462 Lisp_Object name
, defalt
;
1466 register unsigned char *newdir
, *p
, *o
;
1468 unsigned char *target
;
1471 CHECK_STRING (name
);
1474 /* If nm is absolute, flush ...// and detect /./ and /../.
1475 If no /./ or /../ we can return right away. */
1482 if (p
[0] == '/' && p
[1] == '/')
1484 if (p
[0] == '/' && p
[1] == '~')
1485 nm
= p
+ 1, lose
= 1;
1486 if (p
[0] == '/' && p
[1] == '.'
1487 && (p
[2] == '/' || p
[2] == 0
1488 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1494 if (nm
== SDATA (name
))
1496 return build_string (nm
);
1500 /* Now determine directory to start with and put it in NEWDIR. */
1504 if (nm
[0] == '~') /* prefix ~ */
1505 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1507 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1508 newdir
= (unsigned char *) "";
1511 else /* ~user/filename */
1513 /* Get past ~ to user. */
1514 unsigned char *user
= nm
+ 1;
1515 /* Find end of name. */
1516 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1517 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1518 /* Copy the user name into temp storage. */
1519 o
= alloca (len
+ 1);
1520 memcpy (o
, user
, len
);
1523 /* Look up the user name. */
1525 pw
= (struct passwd
*) getpwnam (o
+ 1);
1528 error ("\"%s\" isn't a registered user", o
+ 1);
1530 newdir
= (unsigned char *) pw
->pw_dir
;
1532 /* Discard the user name from NM. */
1536 if (nm
[0] != '/' && !newdir
)
1539 defalt
= current_buffer
->directory
;
1540 CHECK_STRING (defalt
);
1541 newdir
= SDATA (defalt
);
1544 /* Now concatenate the directory and name to new space in the stack frame. */
1546 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1547 target
= alloca (tlen
);
1552 if (nm
[0] == 0 || nm
[0] == '/')
1553 strcpy (target
, newdir
);
1555 file_name_as_directory (target
, newdir
);
1558 strcat (target
, nm
);
1560 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1571 else if (!strncmp (p
, "//", 2)
1577 else if (p
[0] == '/' && p
[1] == '.'
1578 && (p
[2] == '/' || p
[2] == 0))
1580 else if (!strncmp (p
, "/..", 3)
1581 /* `/../' is the "superroot" on certain file systems. */
1583 && (p
[3] == '/' || p
[3] == 0))
1585 while (o
!= target
&& *--o
!= '/')
1587 if (o
== target
&& *o
== '/')
1597 return make_string (target
, o
- target
);
1601 /* If /~ or // appears, discard everything through first slash. */
1603 file_name_absolute_p (const char *filename
)
1606 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1608 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1609 && IS_DIRECTORY_SEP (filename
[2]))
1615 search_embedded_absfilename (char *nm
, char *endp
)
1619 for (p
= nm
+ 1; p
< endp
; p
++)
1621 if (IS_DIRECTORY_SEP (p
[-1])
1622 && file_name_absolute_p (p
)
1623 #if defined (WINDOWSNT) || defined (CYGWIN)
1624 /* // at start of file name is meaningful in Apollo,
1625 WindowsNT and Cygwin systems. */
1626 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1627 #endif /* not (WINDOWSNT || CYGWIN) */
1630 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1631 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1633 char *o
= alloca (s
- p
+ 1);
1635 memcpy (o
, p
, s
- p
);
1638 /* If we have ~user and `user' exists, discard
1639 everything up to ~. But if `user' does not exist, leave
1640 ~user alone, it might be a literal file name. */
1642 pw
= getpwnam (o
+ 1);
1654 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1655 Ssubstitute_in_file_name
, 1, 1, 0,
1656 doc
: /* Substitute environment variables referred to in FILENAME.
1657 `$FOO' where FOO is an environment variable name means to substitute
1658 the value of that variable. The variable name should be terminated
1659 with a character not a letter, digit or underscore; otherwise, enclose
1660 the entire variable name in braces.
1662 If `/~' appears, all of FILENAME through that `/' is discarded.
1663 If `//' appears, everything up to and including the first of
1664 those `/' is discarded. */)
1665 (Lisp_Object filename
)
1667 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1668 char *target
= NULL
;
1669 ptrdiff_t total
= 0;
1670 bool substituted
= 0;
1673 Lisp_Object handler
;
1675 CHECK_STRING (filename
);
1677 multibyte
= STRING_MULTIBYTE (filename
);
1679 /* If the file name has special constructs in it,
1680 call the corresponding file handler. */
1681 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1682 if (!NILP (handler
))
1684 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1686 if (STRINGP (handled_name
))
1687 return handled_name
;
1688 error ("Invalid handler in `file-name-handler-alist'");
1691 /* Always work on a copy of the string, in case GC happens during
1692 decode of environment variables, causing the original Lisp_String
1693 data to be relocated. */
1694 nm
= xlispstrdupa (filename
);
1697 dostounix_filename (nm
, multibyte
);
1698 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1700 endp
= nm
+ SBYTES (filename
);
1702 /* If /~ or // appears, discard everything through first slash. */
1703 p
= search_embedded_absfilename (nm
, endp
);
1705 /* Start over with the new string, so we check the file-name-handler
1706 again. Important with filenames like "/home/foo//:/hello///there"
1707 which would substitute to "/:/hello///there" rather than "/there". */
1708 return Fsubstitute_in_file_name
1709 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1711 /* See if any variables are substituted into the string
1712 and find the total length of their values in `total'. */
1714 for (p
= nm
; p
!= endp
;)
1724 /* "$$" means a single "$". */
1733 p
= memchr (p
, '}', endp
- p
);
1741 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1745 /* Copy out the variable name. */
1746 target
= alloca (s
- o
+ 1);
1747 memcpy (target
, o
, s
- o
);
1750 strupr (target
); /* $home == $HOME etc. */
1753 /* Get variable value. */
1754 o
= egetenv (target
);
1757 /* Don't try to guess a maximum length - UTF8 can use up to
1758 four bytes per character. This code is unlikely to run
1759 in a situation that requires performance, so decoding the
1760 env variables twice should be acceptable. Note that
1761 decoding may cause a garbage collect. */
1762 Lisp_Object orig
, decoded
;
1763 orig
= build_unibyte_string (o
);
1764 decoded
= DECODE_FILE (orig
);
1765 total
+= SBYTES (decoded
);
1775 if (!NILP (Vw32_downcase_file_names
))
1776 filename
= Fdowncase (filename
);
1781 /* If substitution required, recopy the string and do it. */
1782 /* Make space in stack frame for the new copy. */
1783 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1786 /* Copy the rest of the name through, replacing $ constructs with values. */
1803 p
= memchr (p
, '}', endp
- p
);
1811 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1815 /* Copy out the variable name. */
1816 target
= alloca (s
- o
+ 1);
1817 memcpy (target
, o
, s
- o
);
1820 /* Get variable value. */
1821 o
= egetenv (target
);
1825 strcpy (x
, target
); x
+= strlen (target
);
1829 Lisp_Object orig
, decoded
;
1830 ptrdiff_t orig_length
, decoded_length
;
1831 orig_length
= strlen (o
);
1832 orig
= make_unibyte_string (o
, orig_length
);
1833 decoded
= DECODE_FILE (orig
);
1834 decoded_length
= SBYTES (decoded
);
1835 memcpy (x
, SDATA (decoded
), decoded_length
);
1836 x
+= decoded_length
;
1838 /* If environment variable needed decoding, return value
1839 needs to be multibyte. */
1840 if (decoded_length
!= orig_length
1841 || memcmp (SDATA (decoded
), o
, orig_length
))
1848 /* If /~ or // appears, discard everything through first slash. */
1849 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1850 /* This time we do not start over because we've already expanded envvars
1851 and replaced $$ with $. Maybe we should start over as well, but we'd
1852 need to quote some $ to $$ first. */
1856 if (!NILP (Vw32_downcase_file_names
))
1858 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1860 xname
= Fdowncase (xname
);
1865 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1868 error ("Bad format environment-variable substitution");
1870 error ("Missing \"}\" in environment-variable substitution");
1872 error ("Substituting nonexistent environment variable \"%s\"", target
);
1875 /* A slightly faster and more convenient way to get
1876 (directory-file-name (expand-file-name FOO)). */
1879 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1881 register Lisp_Object absname
;
1883 absname
= Fexpand_file_name (filename
, defdir
);
1885 /* Remove final slash, if any (unless this is the root dir).
1886 stat behaves differently depending! */
1887 if (SCHARS (absname
) > 1
1888 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1889 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1890 /* We cannot take shortcuts; they might be wrong for magic file names. */
1891 absname
= Fdirectory_file_name (absname
);
1895 /* Signal an error if the file ABSNAME already exists.
1896 If INTERACTIVE, ask the user whether to proceed,
1897 and bypass the error if the user says to go ahead.
1898 QUERYSTRING is a name for the action that is being considered
1901 *STATPTR is used to store the stat information if the file exists.
1902 If the file does not exist, STATPTR->st_mode is set to 0.
1903 If STATPTR is null, we don't store into it.
1905 If QUICK, ask for y or n, not yes or no. */
1908 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1909 bool interactive
, struct stat
*statptr
,
1912 Lisp_Object tem
, encoded_filename
;
1913 struct stat statbuf
;
1914 struct gcpro gcpro1
;
1916 encoded_filename
= ENCODE_FILE (absname
);
1918 /* `stat' is a good way to tell whether the file exists,
1919 regardless of what access permissions it has. */
1920 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1922 if (S_ISDIR (statbuf
.st_mode
))
1923 xsignal2 (Qfile_error
,
1924 build_string ("File is a directory"), absname
);
1927 xsignal2 (Qfile_already_exists
,
1928 build_string ("File already exists"), absname
);
1930 tem
= format2 ("File %s already exists; %s anyway? ",
1931 absname
, build_string (querystring
));
1933 tem
= call1 (intern ("y-or-n-p"), tem
);
1935 tem
= do_yes_or_no_p (tem
);
1938 xsignal2 (Qfile_already_exists
,
1939 build_string ("File already exists"), absname
);
1946 statptr
->st_mode
= 0;
1951 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1952 "fCopy file: \nGCopy %s to file: \np\nP",
1953 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1954 If NEWNAME names a directory, copy FILE there.
1956 This function always sets the file modes of the output file to match
1959 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1960 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1961 signal a `file-already-exists' error without overwriting. If
1962 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1963 about overwriting; this is what happens in interactive use with M-x.
1964 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1967 Fourth arg KEEP-TIME non-nil means give the output file the same
1968 last-modified time as the old one. (This works on only some systems.)
1970 A prefix arg makes KEEP-TIME non-nil.
1972 If PRESERVE-UID-GID is non-nil, we try to transfer the
1973 uid and gid of FILE to NEWNAME.
1975 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1976 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1977 entries (depending on how Emacs was built). */)
1978 (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
)
1982 char buf
[16 * 1024];
1983 struct stat st
, out_st
;
1984 Lisp_Object handler
;
1985 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1986 ptrdiff_t count
= SPECPDL_INDEX ();
1987 Lisp_Object encoded_file
, encoded_newname
;
1989 security_context_t con
;
1996 encoded_file
= encoded_newname
= Qnil
;
1997 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1998 CHECK_STRING (file
);
1999 CHECK_STRING (newname
);
2001 if (!NILP (Ffile_directory_p (newname
)))
2002 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2004 newname
= Fexpand_file_name (newname
, Qnil
);
2006 file
= Fexpand_file_name (file
, Qnil
);
2008 /* If the input file name has special constructs in it,
2009 call the corresponding file handler. */
2010 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2011 /* Likewise for output file name. */
2013 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2014 if (!NILP (handler
))
2015 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
2016 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
2017 preserve_extended_attributes
));
2019 encoded_file
= ENCODE_FILE (file
);
2020 encoded_newname
= ENCODE_FILE (newname
);
2022 if (NILP (ok_if_already_exists
)
2023 || INTEGERP (ok_if_already_exists
))
2024 barf_or_query_if_file_exists (newname
, "copy to it",
2025 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2026 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
2030 if (!NILP (preserve_extended_attributes
))
2032 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2033 if (acl
== NULL
&& acl_errno_valid (errno
))
2034 report_file_error ("Getting ACL", file
);
2036 if (!CopyFile (SDATA (encoded_file
),
2037 SDATA (encoded_newname
),
2040 /* CopyFile doesn't set errno when it fails. By far the most
2041 "popular" reason is that the target is read-only. */
2042 report_file_errno ("Copying file", list2 (file
, newname
),
2043 GetLastError () == 5 ? EACCES
: EPERM
);
2045 /* CopyFile retains the timestamp by default. */
2046 else if (NILP (keep_time
))
2048 struct timespec now
;
2052 filename
= SDATA (encoded_newname
);
2054 /* Ensure file is writable while its modified time is set. */
2055 attributes
= GetFileAttributes (filename
);
2056 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2057 now
= current_timespec ();
2058 if (set_file_times (-1, filename
, now
, now
))
2060 /* Restore original attributes. */
2061 SetFileAttributes (filename
, attributes
);
2062 xsignal2 (Qfile_date_error
,
2063 build_string ("Cannot set file date"), newname
);
2065 /* Restore original attributes. */
2066 SetFileAttributes (filename
, attributes
);
2071 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2072 if (fail
&& acl_errno_valid (errno
))
2073 report_file_error ("Setting ACL", newname
);
2077 #else /* not WINDOWSNT */
2079 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2083 report_file_error ("Opening input file", file
);
2085 record_unwind_protect_int (close_file_unwind
, ifd
);
2087 if (fstat (ifd
, &st
) != 0)
2088 report_file_error ("Input file status", file
);
2090 if (!NILP (preserve_extended_attributes
))
2093 if (is_selinux_enabled ())
2095 conlength
= fgetfilecon (ifd
, &con
);
2096 if (conlength
== -1)
2097 report_file_error ("Doing fgetfilecon", file
);
2102 if (out_st
.st_mode
!= 0
2103 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2104 report_file_errno ("Input and output files are the same",
2105 list2 (file
, newname
), 0);
2107 /* We can copy only regular files. */
2108 if (!S_ISREG (st
.st_mode
))
2109 report_file_errno ("Non-regular file", file
,
2110 S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
);
2114 int new_mask
= st
.st_mode
& (!NILP (preserve_uid_gid
) ? 0600 : 0666);
2116 int new_mask
= S_IREAD
| S_IWRITE
;
2118 ofd
= emacs_open (SSDATA (encoded_newname
),
2119 (O_WRONLY
| O_TRUNC
| O_CREAT
2120 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2124 report_file_error ("Opening output file", newname
);
2126 record_unwind_protect_int (close_file_unwind
, ofd
);
2130 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2131 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2132 report_file_error ("Write error", newname
);
2136 /* Preserve the original file permissions, and if requested, also its
2139 mode_t mode_mask
= 07777;
2140 if (!NILP (preserve_uid_gid
))
2142 /* Attempt to change owner and group. If that doesn't work
2143 attempt to change just the group, as that is sometimes allowed.
2144 Adjust the mode mask to eliminate setuid or setgid bits
2145 that are inappropriate if the owner and group are wrong. */
2146 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2148 mode_mask
&= ~06000;
2149 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2154 switch (!NILP (preserve_extended_attributes
)
2155 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2156 SSDATA (encoded_newname
), ofd
,
2157 st
.st_mode
& mode_mask
)
2158 : fchmod (ofd
, st
.st_mode
& mode_mask
))
2160 case -2: report_file_error ("Copying permissions from", file
);
2161 case -1: report_file_error ("Copying permissions to", newname
);
2164 #endif /* not MSDOS */
2169 /* Set the modified context back to the file. */
2170 bool fail
= fsetfilecon (ofd
, con
) != 0;
2171 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2172 if (fail
&& errno
!= ENOTSUP
)
2173 report_file_error ("Doing fsetfilecon", newname
);
2179 if (!NILP (keep_time
))
2181 struct timespec atime
= get_stat_atime (&st
);
2182 struct timespec mtime
= get_stat_mtime (&st
);
2183 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2184 xsignal2 (Qfile_date_error
,
2185 build_string ("Cannot set file date"), newname
);
2188 if (emacs_close (ofd
) < 0)
2189 report_file_error ("Write error", newname
);
2194 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2195 and if it can't, it tells so. Otherwise, under MSDOS we usually
2196 get only the READ bit, which will make the copied file read-only,
2197 so it's better not to chmod at all. */
2198 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2199 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2201 #endif /* not WINDOWSNT */
2203 /* Discard the unwind protects. */
2204 specpdl_ptr
= specpdl
+ count
;
2210 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2211 Smake_directory_internal
, 1, 1, 0,
2212 doc
: /* Create a new directory named DIRECTORY. */)
2213 (Lisp_Object directory
)
2216 Lisp_Object handler
;
2217 Lisp_Object encoded_dir
;
2219 CHECK_STRING (directory
);
2220 directory
= Fexpand_file_name (directory
, Qnil
);
2222 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2223 if (!NILP (handler
))
2224 return call2 (handler
, Qmake_directory_internal
, directory
);
2226 encoded_dir
= ENCODE_FILE (directory
);
2228 dir
= SSDATA (encoded_dir
);
2231 if (mkdir (dir
) != 0)
2233 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2235 report_file_error ("Creating directory", directory
);
2240 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2241 Sdelete_directory_internal
, 1, 1, 0,
2242 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2243 (Lisp_Object directory
)
2246 Lisp_Object encoded_dir
;
2248 CHECK_STRING (directory
);
2249 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2250 encoded_dir
= ENCODE_FILE (directory
);
2251 dir
= SSDATA (encoded_dir
);
2253 if (rmdir (dir
) != 0)
2254 report_file_error ("Removing directory", directory
);
2259 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2260 "(list (read-file-name \
2261 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2262 \"Move file to trash: \" \"Delete file: \") \
2263 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2264 (null current-prefix-arg))",
2265 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2266 If file has multiple names, it continues to exist with the other names.
2267 TRASH non-nil means to trash the file instead of deleting, provided
2268 `delete-by-moving-to-trash' is non-nil.
2270 When called interactively, TRASH is t if no prefix argument is given.
2271 With a prefix argument, TRASH is nil. */)
2272 (Lisp_Object filename
, Lisp_Object trash
)
2274 Lisp_Object handler
;
2275 Lisp_Object encoded_file
;
2276 struct gcpro gcpro1
;
2279 if (!NILP (Ffile_directory_p (filename
))
2280 && NILP (Ffile_symlink_p (filename
)))
2281 xsignal2 (Qfile_error
,
2282 build_string ("Removing old name: is a directory"),
2285 filename
= Fexpand_file_name (filename
, Qnil
);
2287 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2288 if (!NILP (handler
))
2289 return call3 (handler
, Qdelete_file
, filename
, trash
);
2291 if (delete_by_moving_to_trash
&& !NILP (trash
))
2292 return call1 (Qmove_file_to_trash
, filename
);
2294 encoded_file
= ENCODE_FILE (filename
);
2296 if (unlink (SSDATA (encoded_file
)) < 0)
2297 report_file_error ("Removing old name", filename
);
2302 internal_delete_file_1 (Lisp_Object ignore
)
2307 /* Delete file FILENAME, returning true if successful.
2308 This ignores `delete-by-moving-to-trash'. */
2311 internal_delete_file (Lisp_Object filename
)
2315 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2316 Qt
, internal_delete_file_1
);
2320 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2321 "fRename file: \nGRename %s to file: \np",
2322 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2323 If file has names other than FILE, it continues to have those names.
2324 Signals a `file-already-exists' error if a file NEWNAME already exists
2325 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2326 A number as third arg means request confirmation if NEWNAME already exists.
2327 This is what happens in interactive use with M-x. */)
2328 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2330 Lisp_Object handler
;
2331 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2332 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2334 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2335 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2336 CHECK_STRING (file
);
2337 CHECK_STRING (newname
);
2338 file
= Fexpand_file_name (file
, Qnil
);
2340 if ((!NILP (Ffile_directory_p (newname
)))
2342 /* If the file names are identical but for the case,
2343 don't attempt to move directory to itself. */
2344 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2348 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2349 ? file
: Fdirectory_file_name (file
));
2350 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2353 newname
= Fexpand_file_name (newname
, Qnil
);
2355 /* If the file name has special constructs in it,
2356 call the corresponding file handler. */
2357 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2359 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2360 if (!NILP (handler
))
2361 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2362 file
, newname
, ok_if_already_exists
));
2364 encoded_file
= ENCODE_FILE (file
);
2365 encoded_newname
= ENCODE_FILE (newname
);
2368 /* If the file names are identical but for the case, don't ask for
2369 confirmation: they simply want to change the letter-case of the
2371 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2373 if (NILP (ok_if_already_exists
)
2374 || INTEGERP (ok_if_already_exists
))
2375 barf_or_query_if_file_exists (newname
, "rename to it",
2376 INTEGERP (ok_if_already_exists
), 0, 0);
2377 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2379 int rename_errno
= errno
;
2380 if (rename_errno
== EXDEV
)
2383 symlink_target
= Ffile_symlink_p (file
);
2384 if (! NILP (symlink_target
))
2385 Fmake_symbolic_link (symlink_target
, newname
,
2386 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2387 else if (!NILP (Ffile_directory_p (file
)))
2388 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2390 /* We have already prompted if it was an integer, so don't
2391 have copy-file prompt again. */
2392 Fcopy_file (file
, newname
,
2393 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2396 count
= SPECPDL_INDEX ();
2397 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2399 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2400 call2 (Qdelete_directory
, file
, Qt
);
2402 Fdelete_file (file
, Qnil
);
2403 unbind_to (count
, Qnil
);
2406 report_file_errno ("Renaming", list2 (file
, newname
), rename_errno
);
2412 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2413 "fAdd name to file: \nGName to add to %s: \np",
2414 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2415 Signals a `file-already-exists' error if a file NEWNAME already exists
2416 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2417 A number as third arg means request confirmation if NEWNAME already exists.
2418 This is what happens in interactive use with M-x. */)
2419 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2421 Lisp_Object handler
;
2422 Lisp_Object encoded_file
, encoded_newname
;
2423 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2425 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2426 encoded_file
= encoded_newname
= Qnil
;
2427 CHECK_STRING (file
);
2428 CHECK_STRING (newname
);
2429 file
= Fexpand_file_name (file
, Qnil
);
2431 if (!NILP (Ffile_directory_p (newname
)))
2432 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2434 newname
= Fexpand_file_name (newname
, Qnil
);
2436 /* If the file name has special constructs in it,
2437 call the corresponding file handler. */
2438 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2439 if (!NILP (handler
))
2440 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2441 newname
, ok_if_already_exists
));
2443 /* If the new name has special constructs in it,
2444 call the corresponding file handler. */
2445 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2446 if (!NILP (handler
))
2447 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2448 newname
, ok_if_already_exists
));
2450 encoded_file
= ENCODE_FILE (file
);
2451 encoded_newname
= ENCODE_FILE (newname
);
2453 if (NILP (ok_if_already_exists
)
2454 || INTEGERP (ok_if_already_exists
))
2455 barf_or_query_if_file_exists (newname
, "make it a new name",
2456 INTEGERP (ok_if_already_exists
), 0, 0);
2458 unlink (SSDATA (newname
));
2459 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2461 int link_errno
= errno
;
2462 report_file_errno ("Adding new name", list2 (file
, newname
), link_errno
);
2469 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2470 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2471 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2472 Both args must be strings.
2473 Signals a `file-already-exists' error if a file LINKNAME already exists
2474 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2475 A number as third arg means request confirmation if LINKNAME already exists.
2476 This happens for interactive use with M-x. */)
2477 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2479 Lisp_Object handler
;
2480 Lisp_Object encoded_filename
, encoded_linkname
;
2481 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2483 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2484 encoded_filename
= encoded_linkname
= Qnil
;
2485 CHECK_STRING (filename
);
2486 CHECK_STRING (linkname
);
2487 /* If the link target has a ~, we must expand it to get
2488 a truly valid file name. Otherwise, do not expand;
2489 we want to permit links to relative file names. */
2490 if (SREF (filename
, 0) == '~')
2491 filename
= Fexpand_file_name (filename
, Qnil
);
2493 if (!NILP (Ffile_directory_p (linkname
)))
2494 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2496 linkname
= Fexpand_file_name (linkname
, Qnil
);
2498 /* If the file name has special constructs in it,
2499 call the corresponding file handler. */
2500 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2501 if (!NILP (handler
))
2502 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2503 linkname
, ok_if_already_exists
));
2505 /* If the new link name has special constructs in it,
2506 call the corresponding file handler. */
2507 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2508 if (!NILP (handler
))
2509 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2510 linkname
, ok_if_already_exists
));
2512 encoded_filename
= ENCODE_FILE (filename
);
2513 encoded_linkname
= ENCODE_FILE (linkname
);
2515 if (NILP (ok_if_already_exists
)
2516 || INTEGERP (ok_if_already_exists
))
2517 barf_or_query_if_file_exists (linkname
, "make it a link",
2518 INTEGERP (ok_if_already_exists
), 0, 0);
2519 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2521 /* If we didn't complain already, silently delete existing file. */
2523 if (errno
== EEXIST
)
2525 unlink (SSDATA (encoded_linkname
));
2526 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2533 if (errno
== ENOSYS
)
2536 xsignal1 (Qfile_error
,
2537 build_string ("Symbolic links are not supported"));
2540 symlink_errno
= errno
;
2541 report_file_errno ("Making symbolic link", list2 (filename
, linkname
),
2549 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2551 doc
: /* Return t if file FILENAME specifies an absolute file name.
2552 On Unix, this is a name starting with a `/' or a `~'. */)
2553 (Lisp_Object filename
)
2555 CHECK_STRING (filename
);
2556 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2559 /* Return true if FILENAME exists. */
2561 check_existing (const char *filename
)
2563 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2566 /* Return true if file FILENAME exists and can be executed. */
2569 check_executable (char *filename
)
2571 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2574 /* Return true if file FILENAME exists and can be accessed
2575 according to AMODE, which should include W_OK.
2576 On failure, return false and set errno. */
2579 check_writable (const char *filename
, int amode
)
2582 /* FIXME: an faccessat implementation should be added to the
2583 DOS/Windows ports and this #ifdef branch should be removed. */
2585 if (stat (filename
, &st
) < 0)
2588 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2589 #else /* not MSDOS */
2590 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2592 /* faccessat may have returned failure because Cygwin couldn't
2593 determine the file's UID or GID; if so, we return success. */
2596 int faccessat_errno
= errno
;
2598 if (stat (filename
, &st
) < 0)
2600 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2601 errno
= faccessat_errno
;
2605 #endif /* not MSDOS */
2608 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2609 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2610 See also `file-readable-p' and `file-attributes'.
2611 This returns nil for a symlink to a nonexistent file.
2612 Use `file-symlink-p' to test for such links. */)
2613 (Lisp_Object filename
)
2615 Lisp_Object absname
;
2616 Lisp_Object handler
;
2618 CHECK_STRING (filename
);
2619 absname
= Fexpand_file_name (filename
, Qnil
);
2621 /* If the file name has special constructs in it,
2622 call the corresponding file handler. */
2623 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2624 if (!NILP (handler
))
2626 Lisp_Object result
= call2 (handler
, Qfile_exists_p
, absname
);
2631 absname
= ENCODE_FILE (absname
);
2633 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2636 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2637 doc
: /* Return t if FILENAME can be executed by you.
2638 For a directory, this means you can access files in that directory. */)
2639 (Lisp_Object filename
)
2641 Lisp_Object absname
;
2642 Lisp_Object handler
;
2644 CHECK_STRING (filename
);
2645 absname
= Fexpand_file_name (filename
, Qnil
);
2647 /* If the file name has special constructs in it,
2648 call the corresponding file handler. */
2649 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2650 if (!NILP (handler
))
2651 return call2 (handler
, Qfile_executable_p
, absname
);
2653 absname
= ENCODE_FILE (absname
);
2655 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2658 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2659 doc
: /* Return t if file FILENAME exists and you can read it.
2660 See also `file-exists-p' and `file-attributes'. */)
2661 (Lisp_Object filename
)
2663 Lisp_Object absname
;
2664 Lisp_Object handler
;
2666 CHECK_STRING (filename
);
2667 absname
= Fexpand_file_name (filename
, Qnil
);
2669 /* If the file name has special constructs in it,
2670 call the corresponding file handler. */
2671 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2672 if (!NILP (handler
))
2673 return call2 (handler
, Qfile_readable_p
, absname
);
2675 absname
= ENCODE_FILE (absname
);
2676 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2680 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2681 doc
: /* Return t if file FILENAME can be written or created by you. */)
2682 (Lisp_Object filename
)
2684 Lisp_Object absname
, dir
, encoded
;
2685 Lisp_Object handler
;
2687 CHECK_STRING (filename
);
2688 absname
= Fexpand_file_name (filename
, Qnil
);
2690 /* If the file name has special constructs in it,
2691 call the corresponding file handler. */
2692 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2693 if (!NILP (handler
))
2694 return call2 (handler
, Qfile_writable_p
, absname
);
2696 encoded
= ENCODE_FILE (absname
);
2697 if (check_writable (SSDATA (encoded
), W_OK
))
2699 if (errno
!= ENOENT
)
2702 dir
= Ffile_name_directory (absname
);
2703 eassert (!NILP (dir
));
2705 dir
= Fdirectory_file_name (dir
);
2708 dir
= ENCODE_FILE (dir
);
2710 /* The read-only attribute of the parent directory doesn't affect
2711 whether a file or directory can be created within it. Some day we
2712 should check ACLs though, which do affect this. */
2713 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2715 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2719 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2720 doc
: /* Access file FILENAME, and get an error if that does not work.
2721 The second argument STRING is used in the error message.
2722 If there is no error, returns nil. */)
2723 (Lisp_Object filename
, Lisp_Object string
)
2725 Lisp_Object handler
, encoded_filename
, absname
;
2727 CHECK_STRING (filename
);
2728 absname
= Fexpand_file_name (filename
, Qnil
);
2730 CHECK_STRING (string
);
2732 /* If the file name has special constructs in it,
2733 call the corresponding file handler. */
2734 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2735 if (!NILP (handler
))
2736 return call3 (handler
, Qaccess_file
, absname
, string
);
2738 encoded_filename
= ENCODE_FILE (absname
);
2740 if (faccessat (AT_FDCWD
, SSDATA (encoded_filename
), R_OK
, AT_EACCESS
) != 0)
2741 report_file_error (SSDATA (string
), filename
);
2746 /* Relative to directory FD, return the symbolic link value of FILENAME.
2747 On failure, return nil. */
2749 emacs_readlinkat (int fd
, char const *filename
)
2751 static struct allocator
const emacs_norealloc_allocator
=
2752 { xmalloc
, NULL
, xfree
, memory_full
};
2754 char readlink_buf
[1024];
2755 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2756 &emacs_norealloc_allocator
, readlinkat
);
2760 val
= build_string (buf
);
2761 if (buf
[0] == '/' && strchr (buf
, ':'))
2762 val
= concat2 (build_string ("/:"), val
);
2763 if (buf
!= readlink_buf
)
2765 val
= DECODE_FILE (val
);
2769 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2770 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2771 The value is the link target, as a string.
2772 Otherwise it returns nil.
2774 This function returns t when given the name of a symlink that
2775 points to a nonexistent file. */)
2776 (Lisp_Object filename
)
2778 Lisp_Object handler
;
2780 CHECK_STRING (filename
);
2781 filename
= Fexpand_file_name (filename
, Qnil
);
2783 /* If the file name has special constructs in it,
2784 call the corresponding file handler. */
2785 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2786 if (!NILP (handler
))
2787 return call2 (handler
, Qfile_symlink_p
, filename
);
2789 filename
= ENCODE_FILE (filename
);
2791 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2794 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2795 doc
: /* Return t if FILENAME names an existing directory.
2796 Symbolic links to directories count as directories.
2797 See `file-symlink-p' to distinguish symlinks. */)
2798 (Lisp_Object filename
)
2800 Lisp_Object absname
;
2801 Lisp_Object handler
;
2803 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2805 /* If the file name has special constructs in it,
2806 call the corresponding file handler. */
2807 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2808 if (!NILP (handler
))
2809 return call2 (handler
, Qfile_directory_p
, absname
);
2811 absname
= ENCODE_FILE (absname
);
2813 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2816 /* Return true if FILE is a directory or a symlink to a directory. */
2818 file_directory_p (char const *file
)
2821 /* This is cheaper than 'stat'. */
2822 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2825 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2829 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2830 Sfile_accessible_directory_p
, 1, 1, 0,
2831 doc
: /* Return t if file FILENAME names a directory you can open.
2832 For the value to be t, FILENAME must specify the name of a directory as a file,
2833 and the directory must allow you to open files in it. In order to use a
2834 directory as a buffer's current directory, this predicate must return true.
2835 A directory name spec may be given instead; then the value is t
2836 if the directory so specified exists and really is a readable and
2837 searchable directory. */)
2838 (Lisp_Object filename
)
2840 Lisp_Object absname
;
2841 Lisp_Object handler
;
2843 CHECK_STRING (filename
);
2844 absname
= Fexpand_file_name (filename
, Qnil
);
2846 /* If the file name has special constructs in it,
2847 call the corresponding file handler. */
2848 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2849 if (!NILP (handler
))
2851 Lisp_Object r
= call2 (handler
, Qfile_accessible_directory_p
, absname
);
2856 absname
= ENCODE_FILE (absname
);
2857 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2860 /* If FILE is a searchable directory or a symlink to a
2861 searchable directory, return true. Otherwise return
2862 false and set errno to an error number. */
2864 file_accessible_directory_p (char const *file
)
2867 /* There's no need to test whether FILE is searchable, as the
2868 searchable/executable bit is invented on DOS_NT platforms. */
2869 return file_directory_p (file
);
2871 /* On POSIXish platforms, use just one system call; this avoids a
2872 race and is typically faster. */
2873 ptrdiff_t len
= strlen (file
);
2879 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2880 There are three exceptions: "", "/", and "//". Leave "" alone,
2881 as it's invalid. Append only "." to the other two exceptions as
2882 "/" and "//" are distinct on some platforms, whereas "/", "///",
2883 "////", etc. are all equivalent. */
2888 /* Just check for trailing '/' when deciding whether to append '/'.
2889 That's simpler than testing the two special cases "/" and "//",
2890 and it's a safe optimization here. */
2891 char *buf
= SAFE_ALLOCA (len
+ 3);
2892 memcpy (buf
, file
, len
);
2893 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2897 ok
= check_existing (dir
);
2898 saved_errno
= errno
;
2900 errno
= saved_errno
;
2905 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2906 doc
: /* Return t if FILENAME names a regular file.
2907 This is the sort of file that holds an ordinary stream of data bytes.
2908 Symbolic links to regular files count as regular files.
2909 See `file-symlink-p' to distinguish symlinks. */)
2910 (Lisp_Object filename
)
2912 register Lisp_Object absname
;
2914 Lisp_Object handler
;
2916 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2918 /* If the file name has special constructs in it,
2919 call the corresponding file handler. */
2920 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2921 if (!NILP (handler
))
2922 return call2 (handler
, Qfile_regular_p
, absname
);
2924 absname
= ENCODE_FILE (absname
);
2929 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2931 /* Tell stat to use expensive method to get accurate info. */
2932 Vw32_get_true_file_attributes
= Qt
;
2933 result
= stat (SDATA (absname
), &st
);
2934 Vw32_get_true_file_attributes
= tem
;
2938 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2941 if (stat (SSDATA (absname
), &st
) < 0)
2943 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2947 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2948 Sfile_selinux_context
, 1, 1, 0,
2949 doc
: /* Return SELinux context of file named FILENAME.
2950 The return value is a list (USER ROLE TYPE RANGE), where the list
2951 elements are strings naming the user, role, type, and range of the
2952 file's SELinux security context.
2954 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2955 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2956 (Lisp_Object filename
)
2958 Lisp_Object absname
;
2959 Lisp_Object values
[4];
2960 Lisp_Object handler
;
2962 security_context_t con
;
2967 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2969 /* If the file name has special constructs in it,
2970 call the corresponding file handler. */
2971 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2972 if (!NILP (handler
))
2973 return call2 (handler
, Qfile_selinux_context
, absname
);
2975 absname
= ENCODE_FILE (absname
);
2982 if (is_selinux_enabled ())
2984 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2987 context
= context_new (con
);
2988 if (context_user_get (context
))
2989 values
[0] = build_string (context_user_get (context
));
2990 if (context_role_get (context
))
2991 values
[1] = build_string (context_role_get (context
));
2992 if (context_type_get (context
))
2993 values
[2] = build_string (context_type_get (context
));
2994 if (context_range_get (context
))
2995 values
[3] = build_string (context_range_get (context
));
2996 context_free (context
);
3002 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
3005 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
3006 Sset_file_selinux_context
, 2, 2, 0,
3007 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
3008 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
3009 elements are strings naming the components of a SELinux context.
3011 Value is t if setting of SELinux context was successful, nil otherwise.
3013 This function does nothing and returns nil if SELinux is disabled,
3014 or if Emacs was not compiled with SELinux support. */)
3015 (Lisp_Object filename
, Lisp_Object context
)
3017 Lisp_Object absname
;
3018 Lisp_Object handler
;
3020 Lisp_Object encoded_absname
;
3021 Lisp_Object user
= CAR_SAFE (context
);
3022 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
3023 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
3024 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
3025 security_context_t con
;
3028 context_t parsed_con
;
3031 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3033 /* If the file name has special constructs in it,
3034 call the corresponding file handler. */
3035 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
3036 if (!NILP (handler
))
3037 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
3040 if (is_selinux_enabled ())
3042 /* Get current file context. */
3043 encoded_absname
= ENCODE_FILE (absname
);
3044 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
3047 parsed_con
= context_new (con
);
3048 /* Change the parts defined in the parameter.*/
3051 if (context_user_set (parsed_con
, SSDATA (user
)))
3052 error ("Doing context_user_set");
3056 if (context_role_set (parsed_con
, SSDATA (role
)))
3057 error ("Doing context_role_set");
3061 if (context_type_set (parsed_con
, SSDATA (type
)))
3062 error ("Doing context_type_set");
3064 if (STRINGP (range
))
3066 if (context_range_set (parsed_con
, SSDATA (range
)))
3067 error ("Doing context_range_set");
3070 /* Set the modified context back to the file. */
3071 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3072 context_str (parsed_con
))
3074 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3075 if (fail
&& errno
!= ENOTSUP
)
3076 report_file_error ("Doing lsetfilecon", absname
);
3078 context_free (parsed_con
);
3080 return fail
? Qnil
: Qt
;
3083 report_file_error ("Doing lgetfilecon", absname
);
3090 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3091 doc
: /* Return ACL entries of file named FILENAME.
3092 The entries are returned in a format suitable for use in `set-file-acl'
3093 but is otherwise undocumented and subject to change.
3094 Return nil if file does not exist or is not accessible, or if Emacs
3095 was unable to determine the ACL entries. */)
3096 (Lisp_Object filename
)
3098 Lisp_Object absname
;
3099 Lisp_Object handler
;
3100 #ifdef HAVE_ACL_SET_FILE
3102 Lisp_Object acl_string
;
3106 absname
= expand_and_dir_to_file (filename
,
3107 BVAR (current_buffer
, directory
));
3109 /* If the file name has special constructs in it,
3110 call the corresponding file handler. */
3111 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3112 if (!NILP (handler
))
3113 return call2 (handler
, Qfile_acl
, absname
);
3115 #ifdef HAVE_ACL_SET_FILE
3116 absname
= ENCODE_FILE (absname
);
3118 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3122 str
= acl_to_text (acl
, NULL
);
3129 acl_string
= build_string (str
);
3139 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3141 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3142 ACL-STRING should contain the textual representation of the ACL
3143 entries in a format suitable for the platform.
3145 Value is t if setting of ACL was successful, nil otherwise.
3147 Setting ACL for local files requires Emacs to be built with ACL
3149 (Lisp_Object filename
, Lisp_Object acl_string
)
3151 Lisp_Object absname
;
3152 Lisp_Object handler
;
3153 #ifdef HAVE_ACL_SET_FILE
3154 Lisp_Object encoded_absname
;
3159 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3161 /* If the file name has special constructs in it,
3162 call the corresponding file handler. */
3163 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3164 if (!NILP (handler
))
3165 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3167 #ifdef HAVE_ACL_SET_FILE
3168 if (STRINGP (acl_string
))
3170 acl
= acl_from_text (SSDATA (acl_string
));
3173 report_file_error ("Converting ACL", absname
);
3177 encoded_absname
= ENCODE_FILE (absname
);
3179 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3182 if (fail
&& acl_errno_valid (errno
))
3183 report_file_error ("Setting ACL", absname
);
3186 return fail
? Qnil
: Qt
;
3193 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3194 doc
: /* Return mode bits of file named FILENAME, as an integer.
3195 Return nil, if file does not exist or is not accessible. */)
3196 (Lisp_Object filename
)
3198 Lisp_Object absname
;
3200 Lisp_Object handler
;
3202 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3204 /* If the file name has special constructs in it,
3205 call the corresponding file handler. */
3206 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3207 if (!NILP (handler
))
3208 return call2 (handler
, Qfile_modes
, absname
);
3210 absname
= ENCODE_FILE (absname
);
3212 if (stat (SSDATA (absname
), &st
) < 0)
3215 return make_number (st
.st_mode
& 07777);
3218 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3219 "(let ((file (read-file-name \"File: \"))) \
3220 (list file (read-file-modes nil file)))",
3221 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3222 Only the 12 low bits of MODE are used.
3224 Interactively, mode bits are read by `read-file-modes', which accepts
3225 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3226 (Lisp_Object filename
, Lisp_Object mode
)
3228 Lisp_Object absname
, encoded_absname
;
3229 Lisp_Object handler
;
3231 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3232 CHECK_NUMBER (mode
);
3234 /* If the file name has special constructs in it,
3235 call the corresponding file handler. */
3236 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3237 if (!NILP (handler
))
3238 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3240 encoded_absname
= ENCODE_FILE (absname
);
3242 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3243 report_file_error ("Doing chmod", absname
);
3248 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3249 doc
: /* Set the file permission bits for newly created files.
3250 The argument MODE should be an integer; only the low 9 bits are used.
3251 This setting is inherited by subprocesses. */)
3254 CHECK_NUMBER (mode
);
3256 umask ((~ XINT (mode
)) & 0777);
3261 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3262 doc
: /* Return the default file protection for created files.
3263 The value is an integer. */)
3270 realmask
= umask (0);
3274 XSETINT (value
, (~ realmask
) & 0777);
3279 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3280 doc
: /* Set times of file FILENAME to TIMESTAMP.
3281 Set both access and modification times.
3282 Return t on success, else nil.
3283 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3285 (Lisp_Object filename
, Lisp_Object timestamp
)
3287 Lisp_Object absname
, encoded_absname
;
3288 Lisp_Object handler
;
3289 struct timespec t
= lisp_time_argument (timestamp
);
3291 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3293 /* If the file name has special constructs in it,
3294 call the corresponding file handler. */
3295 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3296 if (!NILP (handler
))
3297 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3299 encoded_absname
= ENCODE_FILE (absname
);
3302 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3305 /* Setting times on a directory always fails. */
3306 if (file_directory_p (SSDATA (encoded_absname
)))
3309 report_file_error ("Setting file times", absname
);
3317 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3318 doc
: /* Tell Unix to finish all pending disk updates. */)
3325 #endif /* HAVE_SYNC */
3327 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3328 doc
: /* Return t if file FILE1 is newer than file FILE2.
3329 If FILE1 does not exist, the answer is nil;
3330 otherwise, if FILE2 does not exist, the answer is t. */)
3331 (Lisp_Object file1
, Lisp_Object file2
)
3333 Lisp_Object absname1
, absname2
;
3334 struct stat st1
, st2
;
3335 Lisp_Object handler
;
3336 struct gcpro gcpro1
, gcpro2
;
3338 CHECK_STRING (file1
);
3339 CHECK_STRING (file2
);
3342 GCPRO2 (absname1
, file2
);
3343 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3344 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3347 /* If the file name has special constructs in it,
3348 call the corresponding file handler. */
3349 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3351 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3352 if (!NILP (handler
))
3353 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3355 GCPRO2 (absname1
, absname2
);
3356 absname1
= ENCODE_FILE (absname1
);
3357 absname2
= ENCODE_FILE (absname2
);
3360 if (stat (SSDATA (absname1
), &st1
) < 0)
3363 if (stat (SSDATA (absname2
), &st2
) < 0)
3366 return (timespec_cmp (get_stat_mtime (&st2
), get_stat_mtime (&st1
)) < 0
3370 #ifndef READ_BUF_SIZE
3371 #define READ_BUF_SIZE (64 << 10)
3373 /* Some buffer offsets are stored in 'int' variables. */
3374 verify (READ_BUF_SIZE
<= INT_MAX
);
3376 /* This function is called after Lisp functions to decide a coding
3377 system are called, or when they cause an error. Before they are
3378 called, the current buffer is set unibyte and it contains only a
3379 newly inserted text (thus the buffer was empty before the
3382 The functions may set markers, overlays, text properties, or even
3383 alter the buffer contents, change the current buffer.
3385 Here, we reset all those changes by:
3386 o set back the current buffer.
3387 o move all markers and overlays to BEG.
3388 o remove all text properties.
3389 o set back the buffer multibyteness. */
3392 decide_coding_unwind (Lisp_Object unwind_data
)
3394 Lisp_Object multibyte
, undo_list
, buffer
;
3396 multibyte
= XCAR (unwind_data
);
3397 unwind_data
= XCDR (unwind_data
);
3398 undo_list
= XCAR (unwind_data
);
3399 buffer
= XCDR (unwind_data
);
3401 set_buffer_internal (XBUFFER (buffer
));
3402 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3403 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3404 set_buffer_intervals (current_buffer
, NULL
);
3405 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3407 /* Now we are safe to change the buffer's multibyteness directly. */
3408 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3409 bset_undo_list (current_buffer
, undo_list
);
3412 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3413 object where slot 0 is the file descriptor, slot 1 specifies
3414 an offset to put the read bytes, and slot 2 is the maximum
3415 amount of bytes to read. Value is the number of bytes read. */
3418 read_non_regular (Lisp_Object state
)
3424 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3425 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3426 + XSAVE_INTEGER (state
, 1)),
3427 XSAVE_INTEGER (state
, 2));
3429 /* Fast recycle this object for the likely next call. */
3431 return make_number (nbytes
);
3435 /* Condition-case handler used when reading from non-regular files
3436 in insert-file-contents. */
3439 read_non_regular_quit (Lisp_Object ignore
)
3444 /* Return the file offset that VAL represents, checking for type
3445 errors and overflow. */
3447 file_offset (Lisp_Object val
)
3449 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3454 double v
= XFLOAT_DATA (val
);
3456 && (sizeof (off_t
) < sizeof v
3457 ? v
<= TYPE_MAXIMUM (off_t
)
3458 : v
< TYPE_MAXIMUM (off_t
)))
3462 wrong_type_argument (intern ("file-offset"), val
);
3465 /* Return a special time value indicating the error number ERRNUM. */
3466 static struct timespec
3467 time_error_value (int errnum
)
3469 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3470 ? NONEXISTENT_MODTIME_NSECS
3471 : UNKNOWN_MODTIME_NSECS
);
3472 return make_timespec (0, ns
);
3475 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3477 doc
: /* Insert contents of file FILENAME after point.
3478 Returns list of absolute file name and number of characters inserted.
3479 If second argument VISIT is non-nil, the buffer's visited filename and
3480 last save file modtime are set, and it is marked unmodified. If
3481 visiting and the file does not exist, visiting is completed before the
3484 The optional third and fourth arguments BEG and END specify what portion
3485 of the file to insert. These arguments count bytes in the file, not
3486 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3488 If optional fifth argument REPLACE is non-nil, replace the current
3489 buffer contents (in the accessible portion) with the file contents.
3490 This is better than simply deleting and inserting the whole thing
3491 because (1) it preserves some marker positions and (2) it puts less data
3492 in the undo list. When REPLACE is non-nil, the second return value is
3493 the number of characters that replace previous buffer contents.
3495 This function does code conversion according to the value of
3496 `coding-system-for-read' or `file-coding-system-alist', and sets the
3497 variable `last-coding-system-used' to the coding system actually used.
3499 In addition, this function decodes the inserted text from known formats
3500 by calling `format-decode', which see. */)
3501 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3504 struct timespec mtime
;
3506 ptrdiff_t inserted
= 0;
3508 off_t beg_offset
, end_offset
;
3510 ptrdiff_t count
= SPECPDL_INDEX ();
3511 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3512 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3514 ptrdiff_t total
= 0;
3515 bool not_regular
= 0;
3517 char read_buf
[READ_BUF_SIZE
];
3518 struct coding_system coding
;
3519 bool replace_handled
= 0;
3520 bool set_coding_system
= 0;
3521 Lisp_Object coding_system
;
3523 /* If the undo log only contains the insertion, there's no point
3524 keeping it. It's typically when we first fill a file-buffer. */
3525 bool empty_undo_list_p
3526 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3528 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3529 bool we_locked_file
= 0;
3532 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3533 error ("Cannot do file visiting in an indirect buffer");
3535 if (!NILP (BVAR (current_buffer
, read_only
)))
3536 Fbarf_if_buffer_read_only ();
3540 orig_filename
= Qnil
;
3543 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3545 CHECK_STRING (filename
);
3546 filename
= Fexpand_file_name (filename
, Qnil
);
3548 /* The value Qnil means that the coding system is not yet
3550 coding_system
= Qnil
;
3552 /* If the file name has special constructs in it,
3553 call the corresponding file handler. */
3554 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3555 if (!NILP (handler
))
3557 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3558 visit
, beg
, end
, replace
);
3559 if (CONSP (val
) && CONSP (XCDR (val
))
3560 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3561 inserted
= XINT (XCAR (XCDR (val
)));
3565 orig_filename
= filename
;
3566 filename
= ENCODE_FILE (filename
);
3568 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3573 report_file_error ("Opening input file", orig_filename
);
3574 mtime
= time_error_value (save_errno
);
3576 if (!NILP (Vcoding_system_for_read
))
3577 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3581 fd_index
= SPECPDL_INDEX ();
3582 record_unwind_protect_int (close_file_unwind
, fd
);
3584 /* Replacement should preserve point as it preserves markers. */
3585 if (!NILP (replace
))
3586 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3588 if (fstat (fd
, &st
) != 0)
3589 report_file_error ("Input file status", orig_filename
);
3590 mtime
= get_stat_mtime (&st
);
3592 /* This code will need to be changed in order to work on named
3593 pipes, and it's probably just not worth it. So we should at
3594 least signal an error. */
3595 if (!S_ISREG (st
.st_mode
))
3602 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3603 xsignal2 (Qfile_error
,
3604 build_string ("not a regular file"), orig_filename
);
3609 if (!NILP (beg
) || !NILP (end
))
3610 error ("Attempt to visit less than an entire file");
3611 if (BEG
< Z
&& NILP (replace
))
3612 error ("Cannot do file visiting in a non-empty buffer");
3616 beg_offset
= file_offset (beg
);
3621 end_offset
= file_offset (end
);
3625 end_offset
= TYPE_MAXIMUM (off_t
);
3628 end_offset
= st
.st_size
;
3630 /* A negative size can happen on a platform that allows file
3631 sizes greater than the maximum off_t value. */
3635 /* The file size returned from stat may be zero, but data
3636 may be readable nonetheless, for example when this is a
3637 file in the /proc filesystem. */
3638 if (end_offset
== 0)
3639 end_offset
= READ_BUF_SIZE
;
3643 /* Check now whether the buffer will become too large,
3644 in the likely case where the file's length is not changing.
3645 This saves a lot of needless work before a buffer overflow. */
3648 /* The likely offset where we will stop reading. We could read
3649 more (or less), if the file grows (or shrinks) as we read it. */
3650 off_t likely_end
= min (end_offset
, st
.st_size
);
3652 if (beg_offset
< likely_end
)
3655 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3656 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3657 off_t likely_growth
= likely_end
- beg_offset
;
3658 if (buf_growth_max
< likely_growth
)
3663 /* Prevent redisplay optimizations. */
3664 current_buffer
->clip_changed
= 1;
3666 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3668 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3669 setup_coding_system (coding_system
, &coding
);
3670 /* Ensure we set Vlast_coding_system_used. */
3671 set_coding_system
= 1;
3675 /* Decide the coding system to use for reading the file now
3676 because we can't use an optimized method for handling
3677 `coding:' tag if the current buffer is not empty. */
3678 if (!NILP (Vcoding_system_for_read
))
3679 coding_system
= Vcoding_system_for_read
;
3682 /* Don't try looking inside a file for a coding system
3683 specification if it is not seekable. */
3684 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3686 /* Find a coding system specified in the heading two
3687 lines or in the tailing several lines of the file.
3688 We assume that the 1K-byte and 3K-byte for heading
3689 and tailing respectively are sufficient for this
3693 if (st
.st_size
<= (1024 * 4))
3694 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3697 nread
= emacs_read (fd
, read_buf
, 1024);
3701 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3702 report_file_error ("Setting file position",
3704 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3705 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3710 report_file_error ("Read error", orig_filename
);
3713 struct buffer
*prev
= current_buffer
;
3714 Lisp_Object workbuf
;
3717 record_unwind_current_buffer ();
3719 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3720 buf
= XBUFFER (workbuf
);
3722 delete_all_overlays (buf
);
3723 bset_directory (buf
, BVAR (current_buffer
, directory
));
3724 bset_read_only (buf
, Qnil
);
3725 bset_filename (buf
, Qnil
);
3726 bset_undo_list (buf
, Qt
);
3727 eassert (buf
->overlays_before
== NULL
);
3728 eassert (buf
->overlays_after
== NULL
);
3730 set_buffer_internal (buf
);
3732 bset_enable_multibyte_characters (buf
, Qnil
);
3734 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3735 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3736 coding_system
= call2 (Vset_auto_coding_function
,
3737 filename
, make_number (nread
));
3738 set_buffer_internal (prev
);
3740 /* Discard the unwind protect for recovering the
3744 /* Rewind the file for the actual read done later. */
3745 if (lseek (fd
, 0, SEEK_SET
) < 0)
3746 report_file_error ("Setting file position", orig_filename
);
3750 if (NILP (coding_system
))
3752 /* If we have not yet decided a coding system, check
3753 file-coding-system-alist. */
3754 Lisp_Object args
[6];
3756 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3757 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3758 coding_system
= Ffind_operation_coding_system (6, args
);
3759 if (CONSP (coding_system
))
3760 coding_system
= XCAR (coding_system
);
3764 if (NILP (coding_system
))
3765 coding_system
= Qundecided
;
3767 CHECK_CODING_SYSTEM (coding_system
);
3769 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3770 /* We must suppress all character code conversion except for
3771 end-of-line conversion. */
3772 coding_system
= raw_text_coding_system (coding_system
);
3774 setup_coding_system (coding_system
, &coding
);
3775 /* Ensure we set Vlast_coding_system_used. */
3776 set_coding_system
= 1;
3779 /* If requested, replace the accessible part of the buffer
3780 with the file contents. Avoid replacing text at the
3781 beginning or end of the buffer that matches the file contents;
3782 that preserves markers pointing to the unchanged parts.
3784 Here we implement this feature in an optimized way
3785 for the case where code conversion is NOT needed.
3786 The following if-statement handles the case of conversion
3787 in a less optimal way.
3789 If the code conversion is "automatic" then we try using this
3790 method and hope for the best.
3791 But if we discover the need for conversion, we give up on this method
3792 and let the following if-statement handle the replace job. */
3795 && (NILP (coding_system
)
3796 || ! CODING_REQUIRE_DECODING (&coding
)))
3798 /* same_at_start and same_at_end count bytes,
3799 because file access counts bytes
3800 and BEG and END count bytes. */
3801 ptrdiff_t same_at_start
= BEGV_BYTE
;
3802 ptrdiff_t same_at_end
= ZV_BYTE
;
3804 /* There is still a possibility we will find the need to do code
3805 conversion. If that happens, set this variable to
3806 give up on handling REPLACE in the optimized way. */
3807 bool giveup_match_end
= 0;
3809 if (beg_offset
!= 0)
3811 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3812 report_file_error ("Setting file position", orig_filename
);
3817 /* Count how many chars at the start of the file
3818 match the text at the beginning of the buffer. */
3823 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3825 report_file_error ("Read error", orig_filename
);
3826 else if (nread
== 0)
3829 if (CODING_REQUIRE_DETECTION (&coding
))
3831 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3834 setup_coding_system (coding_system
, &coding
);
3837 if (CODING_REQUIRE_DECODING (&coding
))
3838 /* We found that the file should be decoded somehow.
3839 Let's give up here. */
3841 giveup_match_end
= 1;
3846 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3847 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3848 same_at_start
++, bufpos
++;
3849 /* If we found a discrepancy, stop the scan.
3850 Otherwise loop around and scan the next bufferful. */
3851 if (bufpos
!= nread
)
3855 /* If the file matches the buffer completely,
3856 there's no need to replace anything. */
3857 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3860 clear_unwind_protect (fd_index
);
3862 /* Truncate the buffer to the size of the file. */
3863 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3868 /* Count how many chars at the end of the file
3869 match the text at the end of the buffer. But, if we have
3870 already found that decoding is necessary, don't waste time. */
3871 while (!giveup_match_end
)
3873 int total_read
, nread
, bufpos
, trial
;
3876 /* At what file position are we now scanning? */
3877 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3878 /* If the entire file matches the buffer tail, stop the scan. */
3881 /* How much can we scan in the next step? */
3882 trial
= min (curpos
, sizeof read_buf
);
3883 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3884 report_file_error ("Setting file position", orig_filename
);
3886 total_read
= nread
= 0;
3887 while (total_read
< trial
)
3889 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3891 report_file_error ("Read error", orig_filename
);
3892 else if (nread
== 0)
3894 total_read
+= nread
;
3897 /* Scan this bufferful from the end, comparing with
3898 the Emacs buffer. */
3899 bufpos
= total_read
;
3901 /* Compare with same_at_start to avoid counting some buffer text
3902 as matching both at the file's beginning and at the end. */
3903 while (bufpos
> 0 && same_at_end
> same_at_start
3904 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3905 same_at_end
--, bufpos
--;
3907 /* If we found a discrepancy, stop the scan.
3908 Otherwise loop around and scan the preceding bufferful. */
3911 /* If this discrepancy is because of code conversion,
3912 we cannot use this method; giveup and try the other. */
3913 if (same_at_end
> same_at_start
3914 && FETCH_BYTE (same_at_end
- 1) >= 0200
3915 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3916 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3917 giveup_match_end
= 1;
3926 if (! giveup_match_end
)
3930 /* We win! We can handle REPLACE the optimized way. */
3932 /* Extend the start of non-matching text area to multibyte
3933 character boundary. */
3934 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3935 while (same_at_start
> BEGV_BYTE
3936 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3939 /* Extend the end of non-matching text area to multibyte
3940 character boundary. */
3941 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3942 while (same_at_end
< ZV_BYTE
3943 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3946 /* Don't try to reuse the same piece of text twice. */
3947 overlap
= (same_at_start
- BEGV_BYTE
3949 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3951 same_at_end
+= overlap
;
3953 /* Arrange to read only the nonmatching middle part of the file. */
3954 beg_offset
+= same_at_start
- BEGV_BYTE
;
3955 end_offset
-= ZV_BYTE
- same_at_end
;
3957 del_range_byte (same_at_start
, same_at_end
, 0);
3958 /* Insert from the file at the proper position. */
3959 temp
= BYTE_TO_CHAR (same_at_start
);
3960 SET_PT_BOTH (temp
, same_at_start
);
3962 /* If display currently starts at beginning of line,
3963 keep it that way. */
3964 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3965 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3967 replace_handled
= 1;
3971 /* If requested, replace the accessible part of the buffer
3972 with the file contents. Avoid replacing text at the
3973 beginning or end of the buffer that matches the file contents;
3974 that preserves markers pointing to the unchanged parts.
3976 Here we implement this feature for the case where code conversion
3977 is needed, in a simple way that needs a lot of memory.
3978 The preceding if-statement handles the case of no conversion
3979 in a more optimized way. */
3980 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3982 ptrdiff_t same_at_start
= BEGV_BYTE
;
3983 ptrdiff_t same_at_end
= ZV_BYTE
;
3984 ptrdiff_t same_at_start_charpos
;
3985 ptrdiff_t inserted_chars
;
3988 unsigned char *decoded
;
3991 ptrdiff_t this_count
= SPECPDL_INDEX ();
3993 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3994 Lisp_Object conversion_buffer
;
3995 struct gcpro gcpro1
;
3997 conversion_buffer
= code_conversion_save (1, multibyte
);
3999 /* First read the whole file, performing code conversion into
4000 CONVERSION_BUFFER. */
4002 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4003 report_file_error ("Setting file position", orig_filename
);
4005 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4006 unprocessed
= 0; /* Bytes not processed in previous loop. */
4008 GCPRO1 (conversion_buffer
);
4011 /* Read at most READ_BUF_SIZE bytes at a time, to allow
4012 quitting while reading a huge file. */
4014 /* Allow quitting out of the actual I/O. */
4017 this = emacs_read (fd
, read_buf
+ unprocessed
,
4018 READ_BUF_SIZE
- unprocessed
);
4024 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
4025 BUF_Z (XBUFFER (conversion_buffer
)));
4026 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4027 unprocessed
+ this, conversion_buffer
);
4028 unprocessed
= coding
.carryover_bytes
;
4029 if (coding
.carryover_bytes
> 0)
4030 memcpy (read_buf
, coding
.carryover
, unprocessed
);
4034 report_file_error ("Read error", orig_filename
);
4036 clear_unwind_protect (fd_index
);
4038 if (unprocessed
> 0)
4040 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4041 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4042 unprocessed
, conversion_buffer
);
4043 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4046 coding_system
= CODING_ID_NAME (coding
.id
);
4047 set_coding_system
= 1;
4048 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4049 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4050 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4052 /* Compare the beginning of the converted string with the buffer
4056 while (bufpos
< inserted
&& same_at_start
< same_at_end
4057 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4058 same_at_start
++, bufpos
++;
4060 /* If the file matches the head of buffer completely,
4061 there's no need to replace anything. */
4063 if (bufpos
== inserted
)
4065 /* Truncate the buffer to the size of the file. */
4066 if (same_at_start
!= same_at_end
)
4067 del_range_byte (same_at_start
, same_at_end
, 0);
4070 unbind_to (this_count
, Qnil
);
4074 /* Extend the start of non-matching text area to the previous
4075 multibyte character boundary. */
4076 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4077 while (same_at_start
> BEGV_BYTE
4078 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4081 /* Scan this bufferful from the end, comparing with
4082 the Emacs buffer. */
4085 /* Compare with same_at_start to avoid counting some buffer text
4086 as matching both at the file's beginning and at the end. */
4087 while (bufpos
> 0 && same_at_end
> same_at_start
4088 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4089 same_at_end
--, bufpos
--;
4091 /* Extend the end of non-matching text area to the next
4092 multibyte character boundary. */
4093 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4094 while (same_at_end
< ZV_BYTE
4095 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4098 /* Don't try to reuse the same piece of text twice. */
4099 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4101 same_at_end
+= overlap
;
4103 /* If display currently starts at beginning of line,
4104 keep it that way. */
4105 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4106 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4108 /* Replace the chars that we need to replace,
4109 and update INSERTED to equal the number of bytes
4110 we are taking from the decoded string. */
4111 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4113 if (same_at_end
!= same_at_start
)
4115 del_range_byte (same_at_start
, same_at_end
, 0);
4117 eassert (same_at_start
== GPT_BYTE
);
4118 same_at_start
= GPT_BYTE
;
4122 temp
= BYTE_TO_CHAR (same_at_start
);
4124 /* Insert from the file at the proper position. */
4125 SET_PT_BOTH (temp
, same_at_start
);
4126 same_at_start_charpos
4127 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4128 same_at_start
- BEGV_BYTE
4129 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4130 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4132 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4133 same_at_start
+ inserted
- BEGV_BYTE
4134 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4135 - same_at_start_charpos
);
4136 /* This binding is to avoid ask-user-about-supersession-threat
4137 being called in insert_from_buffer (via in
4138 prepare_to_modify_buffer). */
4139 specbind (intern ("buffer-file-name"), Qnil
);
4140 insert_from_buffer (XBUFFER (conversion_buffer
),
4141 same_at_start_charpos
, inserted_chars
, 0);
4142 /* Set `inserted' to the number of inserted characters. */
4143 inserted
= PT
- temp
;
4144 /* Set point before the inserted characters. */
4145 SET_PT_BOTH (temp
, same_at_start
);
4147 unbind_to (this_count
, Qnil
);
4153 total
= end_offset
- beg_offset
;
4155 /* For a special file, all we can do is guess. */
4156 total
= READ_BUF_SIZE
;
4158 if (NILP (visit
) && total
> 0)
4160 #ifdef CLASH_DETECTION
4161 if (!NILP (BVAR (current_buffer
, file_truename
))
4162 /* Make binding buffer-file-name to nil effective. */
4163 && !NILP (BVAR (current_buffer
, filename
))
4164 && SAVE_MODIFF
>= MODIFF
)
4166 #endif /* CLASH_DETECTION */
4167 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4170 move_gap_both (PT
, PT_BYTE
);
4171 if (GAP_SIZE
< total
)
4172 make_gap (total
- GAP_SIZE
);
4174 if (beg_offset
!= 0 || !NILP (replace
))
4176 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4177 report_file_error ("Setting file position", orig_filename
);
4180 /* In the following loop, HOW_MUCH contains the total bytes read so
4181 far for a regular file, and not changed for a special file. But,
4182 before exiting the loop, it is set to a negative value if I/O
4186 /* Total bytes inserted. */
4189 /* Here, we don't do code conversion in the loop. It is done by
4190 decode_coding_gap after all data are read into the buffer. */
4192 ptrdiff_t gap_size
= GAP_SIZE
;
4194 while (how_much
< total
)
4196 /* try is reserved in some compilers (Microsoft C) */
4197 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4204 /* Maybe make more room. */
4205 if (gap_size
< trytry
)
4207 make_gap (trytry
- gap_size
);
4208 gap_size
= GAP_SIZE
- inserted
;
4211 /* Read from the file, capturing `quit'. When an
4212 error occurs, end the loop, and arrange for a quit
4213 to be signaled after decoding the text we read. */
4214 nbytes
= internal_condition_case_1
4216 make_save_int_int_int (fd
, inserted
, trytry
),
4217 Qerror
, read_non_regular_quit
);
4225 this = XINT (nbytes
);
4229 /* Allow quitting out of the actual I/O. We don't make text
4230 part of the buffer until all the reading is done, so a C-g
4231 here doesn't do any harm. */
4234 this = emacs_read (fd
,
4235 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4249 /* For a regular file, where TOTAL is the real size,
4250 count HOW_MUCH to compare with it.
4251 For a special file, where TOTAL is just a buffer size,
4252 so don't bother counting in HOW_MUCH.
4253 (INSERTED is where we count the number of characters inserted.) */
4260 /* Now we have either read all the file data into the gap,
4261 or stop reading on I/O error or quit. If nothing was
4262 read, undo marking the buffer modified. */
4266 #ifdef CLASH_DETECTION
4268 unlock_file (BVAR (current_buffer
, file_truename
));
4270 Vdeactivate_mark
= old_Vdeactivate_mark
;
4273 Vdeactivate_mark
= Qt
;
4276 clear_unwind_protect (fd_index
);
4279 report_file_error ("Read error", orig_filename
);
4281 /* Make the text read part of the buffer. */
4282 GAP_SIZE
-= inserted
;
4284 GPT_BYTE
+= inserted
;
4286 ZV_BYTE
+= inserted
;
4291 /* Put an anchor to ensure multi-byte form ends at gap. */
4296 if (NILP (coding_system
))
4298 /* The coding system is not yet decided. Decide it by an
4299 optimized method for handling `coding:' tag.
4301 Note that we can get here only if the buffer was empty
4302 before the insertion. */
4304 if (!NILP (Vcoding_system_for_read
))
4305 coding_system
= Vcoding_system_for_read
;
4308 /* Since we are sure that the current buffer was empty
4309 before the insertion, we can toggle
4310 enable-multibyte-characters directly here without taking
4311 care of marker adjustment. By this way, we can run Lisp
4312 program safely before decoding the inserted text. */
4313 Lisp_Object unwind_data
;
4314 ptrdiff_t count1
= SPECPDL_INDEX ();
4316 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4317 Fcons (BVAR (current_buffer
, undo_list
),
4318 Fcurrent_buffer ()));
4319 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4320 bset_undo_list (current_buffer
, Qt
);
4321 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4323 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4325 coding_system
= call2 (Vset_auto_coding_function
,
4326 filename
, make_number (inserted
));
4329 if (NILP (coding_system
))
4331 /* If the coding system is not yet decided, check
4332 file-coding-system-alist. */
4333 Lisp_Object args
[6];
4335 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4336 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4337 coding_system
= Ffind_operation_coding_system (6, args
);
4338 if (CONSP (coding_system
))
4339 coding_system
= XCAR (coding_system
);
4341 unbind_to (count1
, Qnil
);
4342 inserted
= Z_BYTE
- BEG_BYTE
;
4345 if (NILP (coding_system
))
4346 coding_system
= Qundecided
;
4348 CHECK_CODING_SYSTEM (coding_system
);
4350 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4351 /* We must suppress all character code conversion except for
4352 end-of-line conversion. */
4353 coding_system
= raw_text_coding_system (coding_system
);
4354 setup_coding_system (coding_system
, &coding
);
4355 /* Ensure we set Vlast_coding_system_used. */
4356 set_coding_system
= 1;
4361 /* When we visit a file by raw-text, we change the buffer to
4363 if (CODING_FOR_UNIBYTE (&coding
)
4364 /* Can't do this if part of the buffer might be preserved. */
4366 /* Visiting a file with these coding system makes the buffer
4368 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4371 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4372 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4373 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4375 move_gap_both (PT
, PT_BYTE
);
4376 GAP_SIZE
+= inserted
;
4377 ZV_BYTE
-= inserted
;
4381 decode_coding_gap (&coding
, inserted
, inserted
);
4382 inserted
= coding
.produced_char
;
4383 coding_system
= CODING_ID_NAME (coding
.id
);
4385 else if (inserted
> 0)
4386 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4389 /* Call after-change hooks for the inserted text, aside from the case
4390 of normal visiting (not with REPLACE), which is done in a new buffer
4391 "before" the buffer is changed. */
4392 if (inserted
> 0 && total
> 0
4393 && (NILP (visit
) || !NILP (replace
)))
4395 signal_after_change (PT
, 0, inserted
);
4396 update_compositions (PT
, PT
, CHECK_BORDER
);
4399 /* Now INSERTED is measured in characters. */
4405 if (empty_undo_list_p
)
4406 bset_undo_list (current_buffer
, Qnil
);
4410 current_buffer
->modtime
= mtime
;
4411 current_buffer
->modtime_size
= st
.st_size
;
4412 bset_filename (current_buffer
, orig_filename
);
4415 SAVE_MODIFF
= MODIFF
;
4416 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4417 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4418 #ifdef CLASH_DETECTION
4421 if (!NILP (BVAR (current_buffer
, file_truename
)))
4422 unlock_file (BVAR (current_buffer
, file_truename
));
4423 unlock_file (filename
);
4425 #endif /* CLASH_DETECTION */
4427 xsignal2 (Qfile_error
,
4428 build_string ("not a regular file"), orig_filename
);
4431 if (set_coding_system
)
4432 Vlast_coding_system_used
= coding_system
;
4434 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4436 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4438 if (! NILP (insval
))
4440 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4441 wrong_type_argument (intern ("inserted-chars"), insval
);
4442 inserted
= XFASTINT (insval
);
4446 /* Decode file format. */
4449 /* Don't run point motion or modification hooks when decoding. */
4450 ptrdiff_t count1
= SPECPDL_INDEX ();
4451 ptrdiff_t old_inserted
= inserted
;
4452 specbind (Qinhibit_point_motion_hooks
, Qt
);
4453 specbind (Qinhibit_modification_hooks
, Qt
);
4455 /* Save old undo list and don't record undo for decoding. */
4456 old_undo
= BVAR (current_buffer
, undo_list
);
4457 bset_undo_list (current_buffer
, Qt
);
4461 insval
= call3 (Qformat_decode
,
4462 Qnil
, make_number (inserted
), visit
);
4463 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4464 wrong_type_argument (intern ("inserted-chars"), insval
);
4465 inserted
= XFASTINT (insval
);
4469 /* If REPLACE is non-nil and we succeeded in not replacing the
4470 beginning or end of the buffer text with the file's contents,
4471 call format-decode with `point' positioned at the beginning
4472 of the buffer and `inserted' equaling the number of
4473 characters in the buffer. Otherwise, format-decode might
4474 fail to correctly analyze the beginning or end of the buffer.
4475 Hence we temporarily save `point' and `inserted' here and
4476 restore `point' iff format-decode did not insert or delete
4477 any text. Otherwise we leave `point' at point-min. */
4478 ptrdiff_t opoint
= PT
;
4479 ptrdiff_t opoint_byte
= PT_BYTE
;
4480 ptrdiff_t oinserted
= ZV
- BEGV
;
4481 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4483 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4484 insval
= call3 (Qformat_decode
,
4485 Qnil
, make_number (oinserted
), visit
);
4486 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4487 wrong_type_argument (intern ("inserted-chars"), insval
);
4488 if (ochars_modiff
== CHARS_MODIFF
)
4489 /* format_decode didn't modify buffer's characters => move
4490 point back to position before inserted text and leave
4491 value of inserted alone. */
4492 SET_PT_BOTH (opoint
, opoint_byte
);
4494 /* format_decode modified buffer's characters => consider
4495 entire buffer changed and leave point at point-min. */
4496 inserted
= XFASTINT (insval
);
4499 /* For consistency with format-decode call these now iff inserted > 0
4500 (martin 2007-06-28). */
4501 p
= Vafter_insert_file_functions
;
4506 insval
= call1 (XCAR (p
), make_number (inserted
));
4509 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4510 wrong_type_argument (intern ("inserted-chars"), insval
);
4511 inserted
= XFASTINT (insval
);
4516 /* For the rationale of this see the comment on
4517 format-decode above. */
4518 ptrdiff_t opoint
= PT
;
4519 ptrdiff_t opoint_byte
= PT_BYTE
;
4520 ptrdiff_t oinserted
= ZV
- BEGV
;
4521 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4523 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4524 insval
= call1 (XCAR (p
), make_number (oinserted
));
4527 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4528 wrong_type_argument (intern ("inserted-chars"), insval
);
4529 if (ochars_modiff
== CHARS_MODIFF
)
4530 /* after_insert_file_functions didn't modify
4531 buffer's characters => move point back to
4532 position before inserted text and leave value of
4534 SET_PT_BOTH (opoint
, opoint_byte
);
4536 /* after_insert_file_functions did modify buffer's
4537 characters => consider entire buffer changed and
4538 leave point at point-min. */
4539 inserted
= XFASTINT (insval
);
4547 if (!empty_undo_list_p
)
4549 bset_undo_list (current_buffer
, old_undo
);
4550 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4552 /* Adjust the last undo record for the size change during
4553 the format conversion. */
4554 Lisp_Object tem
= XCAR (old_undo
);
4555 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4556 && INTEGERP (XCDR (tem
))
4557 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4558 XSETCDR (tem
, make_number (PT
+ inserted
));
4562 /* If undo_list was Qt before, keep it that way.
4563 Otherwise start with an empty undo_list. */
4564 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4566 unbind_to (count1
, Qnil
);
4570 && current_buffer
->modtime
.tv_nsec
== NONEXISTENT_MODTIME_NSECS
)
4572 /* If visiting nonexistent file, return nil. */
4573 report_file_errno ("Opening input file", orig_filename
, save_errno
);
4577 Fsignal (Qquit
, Qnil
);
4579 /* Retval needs to be dealt with in all cases consistently. */
4581 val
= list2 (orig_filename
, make_number (inserted
));
4583 RETURN_UNGCPRO (unbind_to (count
, val
));
4586 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4589 build_annotations_unwind (Lisp_Object arg
)
4591 Vwrite_region_annotation_buffers
= arg
;
4594 /* Decide the coding-system to encode the data with. */
4596 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4597 Schoose_write_coding_system
, 3, 6, 0,
4598 doc
: /* Choose the coding system for writing a file.
4599 Arguments are as for `write-region'.
4600 This function is for internal use only. It may prompt the user. */ )
4601 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4602 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4605 Lisp_Object eol_parent
= Qnil
;
4607 /* Mimic write-region behavior. */
4610 XSETFASTINT (start
, BEGV
);
4611 XSETFASTINT (end
, ZV
);
4615 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4616 BVAR (current_buffer
, auto_save_file_name
))))
4621 else if (!NILP (Vcoding_system_for_write
))
4623 val
= Vcoding_system_for_write
;
4624 if (coding_system_require_warning
4625 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4626 /* Confirm that VAL can surely encode the current region. */
4627 val
= call5 (Vselect_safe_coding_system_function
,
4628 start
, end
, list2 (Qt
, val
),
4633 /* If the variable `buffer-file-coding-system' is set locally,
4634 it means that the file was read with some kind of code
4635 conversion or the variable is explicitly set by users. We
4636 had better write it out with the same coding system even if
4637 `enable-multibyte-characters' is nil.
4639 If it is not set locally, we anyway have to convert EOL
4640 format if the default value of `buffer-file-coding-system'
4641 tells that it is not Unix-like (LF only) format. */
4642 bool using_default_coding
= 0;
4643 bool force_raw_text
= 0;
4645 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4647 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4650 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4656 /* Check file-coding-system-alist. */
4657 Lisp_Object args
[7], coding_systems
;
4659 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4660 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4662 coding_systems
= Ffind_operation_coding_system (7, args
);
4663 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4664 val
= XCDR (coding_systems
);
4669 /* If we still have not decided a coding system, use the
4670 default value of buffer-file-coding-system. */
4671 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4672 using_default_coding
= 1;
4675 if (! NILP (val
) && ! force_raw_text
)
4677 Lisp_Object spec
, attrs
;
4679 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4680 attrs
= AREF (spec
, 0);
4681 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4686 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4687 /* Confirm that VAL can surely encode the current region. */
4688 val
= call5 (Vselect_safe_coding_system_function
,
4689 start
, end
, val
, Qnil
, filename
);
4691 /* If the decided coding-system doesn't specify end-of-line
4692 format, we use that of
4693 `default-buffer-file-coding-system'. */
4694 if (! using_default_coding
4695 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4696 val
= (coding_inherit_eol_type
4697 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4699 /* If we decide not to encode text, use `raw-text' or one of its
4702 val
= raw_text_coding_system (val
);
4705 val
= coding_inherit_eol_type (val
, eol_parent
);
4709 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4710 "r\nFWrite region to file: \ni\ni\ni\np",
4711 doc
: /* Write current region into specified file.
4712 When called from a program, requires three arguments:
4713 START, END and FILENAME. START and END are normally buffer positions
4714 specifying the part of the buffer to write.
4715 If START is nil, that means to use the entire buffer contents.
4716 If START is a string, then output that string to the file
4717 instead of any buffer contents; END is ignored.
4719 Optional fourth argument APPEND if non-nil means
4720 append to existing file contents (if any). If it is a number,
4721 seek to that offset in the file before writing.
4722 Optional fifth argument VISIT, if t or a string, means
4723 set the last-save-file-modtime of buffer to this file's modtime
4724 and mark buffer not modified.
4725 If VISIT is a string, it is a second file name;
4726 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4727 VISIT is also the file name to lock and unlock for clash detection.
4728 If VISIT is neither t nor nil nor a string,
4729 that means do not display the \"Wrote file\" message.
4730 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4731 use for locking and unlocking, overriding FILENAME and VISIT.
4732 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4733 for an existing file with the same name. If MUSTBENEW is `excl',
4734 that means to get an error if the file already exists; never overwrite.
4735 If MUSTBENEW is neither nil nor `excl', that means ask for
4736 confirmation before overwriting, but do go ahead and overwrite the file
4737 if the user confirms.
4739 This does code conversion according to the value of
4740 `coding-system-for-write', `buffer-file-coding-system', or
4741 `file-coding-system-alist', and sets the variable
4742 `last-coding-system-used' to the coding system actually used.
4744 This calls `write-region-annotate-functions' at the start, and
4745 `write-region-post-annotation-function' at the end. */)
4746 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
,
4747 Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4749 return write_region (start
, end
, filename
, append
, visit
, lockname
, mustbenew
,
4753 /* Like Fwrite_region, except that if DESC is nonnegative, it is a file
4754 descriptor for FILENAME, so do not open or close FILENAME. */
4757 write_region (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4758 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4759 Lisp_Object mustbenew
, int desc
)
4763 off_t offset
IF_LINT (= 0);
4764 bool open_and_close_file
= desc
< 0;
4769 struct timespec modtime
;
4770 ptrdiff_t count
= SPECPDL_INDEX ();
4771 ptrdiff_t count1
IF_LINT (= 0);
4772 Lisp_Object handler
;
4773 Lisp_Object visit_file
;
4774 Lisp_Object annotations
;
4775 Lisp_Object encoded_filename
;
4776 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4777 bool quietly
= !NILP (visit
);
4778 bool file_locked
= 0;
4779 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4780 struct buffer
*given_buffer
;
4781 struct coding_system coding
;
4783 if (current_buffer
->base_buffer
&& visiting
)
4784 error ("Cannot do file visiting in an indirect buffer");
4786 if (!NILP (start
) && !STRINGP (start
))
4787 validate_region (&start
, &end
);
4790 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4792 filename
= Fexpand_file_name (filename
, Qnil
);
4794 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4795 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4797 if (STRINGP (visit
))
4798 visit_file
= Fexpand_file_name (visit
, Qnil
);
4800 visit_file
= filename
;
4802 if (NILP (lockname
))
4803 lockname
= visit_file
;
4807 /* If the file name has special constructs in it,
4808 call the corresponding file handler. */
4809 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4810 /* If FILENAME has no handler, see if VISIT has one. */
4811 if (NILP (handler
) && STRINGP (visit
))
4812 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4814 if (!NILP (handler
))
4817 val
= call6 (handler
, Qwrite_region
, start
, end
,
4818 filename
, append
, visit
);
4822 SAVE_MODIFF
= MODIFF
;
4823 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4824 bset_filename (current_buffer
, visit_file
);
4830 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4832 /* Special kludge to simplify auto-saving. */
4835 /* Do it later, so write-region-annotate-function can work differently
4836 if we save "the buffer" vs "a region".
4837 This is useful in tar-mode. --Stef
4838 XSETFASTINT (start, BEG);
4839 XSETFASTINT (end, Z); */
4843 record_unwind_protect (build_annotations_unwind
,
4844 Vwrite_region_annotation_buffers
);
4845 Vwrite_region_annotation_buffers
= list1 (Fcurrent_buffer ());
4847 given_buffer
= current_buffer
;
4849 if (!STRINGP (start
))
4851 annotations
= build_annotations (start
, end
);
4853 if (current_buffer
!= given_buffer
)
4855 XSETFASTINT (start
, BEGV
);
4856 XSETFASTINT (end
, ZV
);
4862 XSETFASTINT (start
, BEGV
);
4863 XSETFASTINT (end
, ZV
);
4868 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4870 /* Decide the coding-system to encode the data with.
4871 We used to make this choice before calling build_annotations, but that
4872 leads to problems when a write-annotate-function takes care of
4873 unsavable chars (as was the case with X-Symbol). */
4874 Vlast_coding_system_used
=
4875 Fchoose_write_coding_system (start
, end
, filename
,
4876 append
, visit
, lockname
);
4878 setup_coding_system (Vlast_coding_system_used
, &coding
);
4880 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4881 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4883 #ifdef CLASH_DETECTION
4884 if (open_and_close_file
&& !auto_saving
)
4886 lock_file (lockname
);
4889 #endif /* CLASH_DETECTION */
4891 encoded_filename
= ENCODE_FILE (filename
);
4892 fn
= SSDATA (encoded_filename
);
4893 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4894 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4895 if (NUMBERP (append
))
4896 offset
= file_offset (append
);
4897 else if (!NILP (append
))
4898 open_flags
|= O_APPEND
;
4900 mode
= S_IREAD
| S_IWRITE
;
4902 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4905 if (open_and_close_file
)
4907 desc
= emacs_open (fn
, open_flags
, mode
);
4910 int open_errno
= errno
;
4911 #ifdef CLASH_DETECTION
4913 unlock_file (lockname
);
4914 #endif /* CLASH_DETECTION */
4916 report_file_errno ("Opening output file", filename
, open_errno
);
4919 count1
= SPECPDL_INDEX ();
4920 record_unwind_protect_int (close_file_unwind
, desc
);
4923 if (NUMBERP (append
))
4925 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4928 int lseek_errno
= errno
;
4929 #ifdef CLASH_DETECTION
4931 unlock_file (lockname
);
4932 #endif /* CLASH_DETECTION */
4934 report_file_errno ("Lseek error", filename
, lseek_errno
);
4942 if (STRINGP (start
))
4943 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4944 else if (XINT (start
) != XINT (end
))
4945 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4946 &annotations
, &coding
);
4949 /* If file was empty, still need to write the annotations. */
4950 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4951 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4955 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4956 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4958 /* We have to flush out a data. */
4959 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4960 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4966 /* fsync is not crucial for temporary files. Nor for auto-save
4967 files, since they might lose some work anyway. */
4968 if (open_and_close_file
&& !auto_saving
&& !write_region_inhibit_fsync
)
4970 /* Transfer data and metadata to disk, retrying if interrupted.
4971 fsync can report a write failure here, e.g., due to disk full
4972 under NFS. But ignore EINVAL, which means fsync is not
4973 supported on this file. */
4974 while (fsync (desc
) != 0)
4977 if (errno
!= EINVAL
)
4978 ok
= 0, save_errno
= errno
;
4983 modtime
= invalid_timespec ();
4986 if (fstat (desc
, &st
) == 0)
4987 modtime
= get_stat_mtime (&st
);
4989 ok
= 0, save_errno
= errno
;
4992 if (open_and_close_file
)
4994 /* NFS can report a write failure now. */
4995 if (emacs_close (desc
) < 0)
4996 ok
= 0, save_errno
= errno
;
4998 /* Discard the unwind protect for close_file_unwind. */
4999 specpdl_ptr
= specpdl
+ count1
;
5002 /* Some file systems have a bug where st_mtime is not updated
5003 properly after a write. For example, CIFS might not see the
5004 st_mtime change until after the file is opened again.
5006 Attempt to detect this file system bug, and update MODTIME to the
5007 newer st_mtime if the bug appears to be present. This introduces
5008 a race condition, so to avoid most instances of the race condition
5009 on non-buggy file systems, skip this check if the most recently
5010 encountered non-buggy file system was the current file system.
5012 A race condition can occur if some other process modifies the
5013 file between the fstat above and the fstat below, but the race is
5014 unlikely and a similar race between the last write and the fstat
5015 above cannot possibly be closed anyway. */
5017 if (timespec_valid_p (modtime
)
5018 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
5020 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
5024 if (fstat (desc1
, &st1
) == 0
5025 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
5027 /* Use the heuristic if it appears to be valid. With neither
5028 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
5029 file, the time stamp won't change. Also, some non-POSIX
5030 systems don't update an empty file's time stamp when
5031 truncating it. Finally, file systems with 100 ns or worse
5032 resolution sometimes seem to have bugs: on a system with ns
5033 resolution, checking ns % 100 incorrectly avoids the heuristic
5034 1% of the time, but the problem should be temporary as we will
5035 try again on the next time stamp. */
5037 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
5039 && modtime
.tv_nsec
% 100 != 0);
5041 struct timespec modtime1
= get_stat_mtime (&st1
);
5043 && timespec_cmp (modtime
, modtime1
) == 0
5044 && st
.st_size
== st1
.st_size
)
5046 timestamp_file_system
= st
.st_dev
;
5047 valid_timestamp_file_system
= 1;
5051 st
.st_size
= st1
.st_size
;
5055 emacs_close (desc1
);
5059 /* Call write-region-post-annotation-function. */
5060 while (CONSP (Vwrite_region_annotation_buffers
))
5062 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5063 if (!NILP (Fbuffer_live_p (buf
)))
5066 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5067 call0 (Vwrite_region_post_annotation_function
);
5069 Vwrite_region_annotation_buffers
5070 = XCDR (Vwrite_region_annotation_buffers
);
5073 unbind_to (count
, Qnil
);
5075 #ifdef CLASH_DETECTION
5077 unlock_file (lockname
);
5078 #endif /* CLASH_DETECTION */
5080 /* Do this before reporting IO error
5081 to avoid a "file has changed on disk" warning on
5082 next attempt to save. */
5083 if (timespec_valid_p (modtime
))
5085 current_buffer
->modtime
= modtime
;
5086 current_buffer
->modtime_size
= st
.st_size
;
5090 report_file_errno ("Write error", filename
, save_errno
);
5094 SAVE_MODIFF
= MODIFF
;
5095 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5096 bset_filename (current_buffer
, visit_file
);
5097 update_mode_lines
++;
5102 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5103 BVAR (current_buffer
, auto_save_file_name
))))
5104 SAVE_MODIFF
= MODIFF
;
5110 message_with_string ((NUMBERP (append
)
5120 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5121 doc
: /* Return t if (car A) is numerically less than (car B). */)
5122 (Lisp_Object a
, Lisp_Object b
)
5124 Lisp_Object args
[2] = { Fcar (a
), Fcar (b
), };
5125 return Flss (2, args
);
5128 /* Build the complete list of annotations appropriate for writing out
5129 the text between START and END, by calling all the functions in
5130 write-region-annotate-functions and merging the lists they return.
5131 If one of these functions switches to a different buffer, we assume
5132 that buffer contains altered text. Therefore, the caller must
5133 make sure to restore the current buffer in all cases,
5134 as save-excursion would do. */
5137 build_annotations (Lisp_Object start
, Lisp_Object end
)
5139 Lisp_Object annotations
;
5141 struct gcpro gcpro1
, gcpro2
;
5142 Lisp_Object original_buffer
;
5144 bool used_global
= 0;
5146 XSETBUFFER (original_buffer
, current_buffer
);
5149 p
= Vwrite_region_annotate_functions
;
5150 GCPRO2 (annotations
, p
);
5153 struct buffer
*given_buffer
= current_buffer
;
5154 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5155 { /* Use the global value of the hook. */
5158 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5160 p
= Fappend (2, arg
);
5163 Vwrite_region_annotations_so_far
= annotations
;
5164 res
= call2 (XCAR (p
), start
, end
);
5165 /* If the function makes a different buffer current,
5166 assume that means this buffer contains altered text to be output.
5167 Reset START and END from the buffer bounds
5168 and discard all previous annotations because they should have
5169 been dealt with by this function. */
5170 if (current_buffer
!= given_buffer
)
5172 Vwrite_region_annotation_buffers
5173 = Fcons (Fcurrent_buffer (),
5174 Vwrite_region_annotation_buffers
);
5175 XSETFASTINT (start
, BEGV
);
5176 XSETFASTINT (end
, ZV
);
5179 Flength (res
); /* Check basic validity of return value */
5180 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5184 /* Now do the same for annotation functions implied by the file-format */
5185 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5186 p
= BVAR (current_buffer
, auto_save_file_format
);
5188 p
= BVAR (current_buffer
, file_format
);
5189 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5191 struct buffer
*given_buffer
= current_buffer
;
5193 Vwrite_region_annotations_so_far
= annotations
;
5195 /* Value is either a list of annotations or nil if the function
5196 has written annotations to a temporary buffer, which is now
5198 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5199 original_buffer
, make_number (i
));
5200 if (current_buffer
!= given_buffer
)
5202 XSETFASTINT (start
, BEGV
);
5203 XSETFASTINT (end
, ZV
);
5208 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5216 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5217 If STRING is nil, POS is the character position in the current buffer.
5218 Intersperse with them the annotations from *ANNOT
5219 which fall within the range of POS to POS + NCHARS,
5220 each at its appropriate position.
5222 We modify *ANNOT by discarding elements as we use them up.
5224 Return true if successful. */
5227 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5228 ptrdiff_t nchars
, Lisp_Object
*annot
,
5229 struct coding_system
*coding
)
5233 ptrdiff_t lastpos
= pos
+ nchars
;
5235 while (NILP (*annot
) || CONSP (*annot
))
5237 tem
= Fcar_safe (Fcar (*annot
));
5240 nextpos
= XFASTINT (tem
);
5242 /* If there are no more annotations in this range,
5243 output the rest of the range all at once. */
5244 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5245 return e_write (desc
, string
, pos
, lastpos
, coding
);
5247 /* Output buffer text up to the next annotation's position. */
5250 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5254 /* Output the annotation. */
5255 tem
= Fcdr (Fcar (*annot
));
5258 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5261 *annot
= Fcdr (*annot
);
5267 /* Write text in the range START and END into descriptor DESC,
5268 encoding them with coding system CODING. If STRING is nil, START
5269 and END are character positions of the current buffer, else they
5270 are indexes to the string STRING. Return true if successful. */
5273 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5274 struct coding_system
*coding
)
5276 if (STRINGP (string
))
5279 end
= SCHARS (string
);
5282 /* We used to have a code for handling selective display here. But,
5283 now it is handled within encode_coding. */
5287 if (STRINGP (string
))
5289 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5290 if (CODING_REQUIRE_ENCODING (coding
))
5292 encode_coding_object (coding
, string
,
5293 start
, string_char_to_byte (string
, start
),
5294 end
, string_char_to_byte (string
, end
), Qt
);
5298 coding
->dst_object
= string
;
5299 coding
->consumed_char
= SCHARS (string
);
5300 coding
->produced
= SBYTES (string
);
5305 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5306 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5308 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5309 if (CODING_REQUIRE_ENCODING (coding
))
5311 encode_coding_object (coding
, Fcurrent_buffer (),
5312 start
, start_byte
, end
, end_byte
, Qt
);
5316 coding
->dst_object
= Qnil
;
5317 coding
->dst_pos_byte
= start_byte
;
5318 if (start
>= GPT
|| end
<= GPT
)
5320 coding
->consumed_char
= end
- start
;
5321 coding
->produced
= end_byte
- start_byte
;
5325 coding
->consumed_char
= GPT
- start
;
5326 coding
->produced
= GPT_BYTE
- start_byte
;
5331 if (coding
->produced
> 0)
5333 char *buf
= (STRINGP (coding
->dst_object
)
5334 ? SSDATA (coding
->dst_object
)
5335 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
));
5336 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5338 if (coding
->produced
)
5341 start
+= coding
->consumed_char
;
5347 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5348 Sverify_visited_file_modtime
, 0, 1, 0,
5349 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5350 This means that the file has not been changed since it was visited or saved.
5351 If BUF is omitted or nil, it defaults to the current buffer.
5352 See Info node `(elisp)Modification Time' for more details. */)
5357 Lisp_Object handler
;
5358 Lisp_Object filename
;
5359 struct timespec mtime
;
5369 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5370 if (b
->modtime
.tv_nsec
== UNKNOWN_MODTIME_NSECS
) return Qt
;
5372 /* If the file name has special constructs in it,
5373 call the corresponding file handler. */
5374 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5375 Qverify_visited_file_modtime
);
5376 if (!NILP (handler
))
5377 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5379 filename
= ENCODE_FILE (BVAR (b
, filename
));
5381 mtime
= (stat (SSDATA (filename
), &st
) == 0
5382 ? get_stat_mtime (&st
)
5383 : time_error_value (errno
));
5384 if (timespec_cmp (mtime
, b
->modtime
) == 0
5385 && (b
->modtime_size
< 0
5386 || st
.st_size
== b
->modtime_size
))
5391 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5392 Svisited_file_modtime
, 0, 0, 0,
5393 doc
: /* Return the current buffer's recorded visited file modification time.
5394 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5395 `file-attributes' returns. If the current buffer has no recorded file
5396 modification time, this function returns 0. If the visited file
5397 doesn't exist, return -1.
5398 See Info node `(elisp)Modification Time' for more details. */)
5401 int ns
= current_buffer
->modtime
.tv_nsec
;
5403 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5404 return make_lisp_time (current_buffer
->modtime
);
5407 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5408 Sset_visited_file_modtime
, 0, 1, 0,
5409 doc
: /* Update buffer's recorded modification time from the visited file's time.
5410 Useful if the buffer was not read from the file normally
5411 or if the file itself has been changed for some known benign reason.
5412 An argument specifies the modification time value to use
5413 \(instead of that of the visited file), in the form of a list
5414 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5415 `visited-file-modtime'. */)
5416 (Lisp_Object time_flag
)
5418 if (!NILP (time_flag
))
5420 struct timespec mtime
;
5421 if (INTEGERP (time_flag
))
5423 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5424 mtime
= make_timespec (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5427 mtime
= lisp_time_argument (time_flag
);
5429 current_buffer
->modtime
= mtime
;
5430 current_buffer
->modtime_size
= -1;
5434 register Lisp_Object filename
;
5436 Lisp_Object handler
;
5438 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5440 /* If the file name has special constructs in it,
5441 call the corresponding file handler. */
5442 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5443 if (!NILP (handler
))
5444 /* The handler can find the file name the same way we did. */
5445 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5447 filename
= ENCODE_FILE (filename
);
5449 if (stat (SSDATA (filename
), &st
) >= 0)
5451 current_buffer
->modtime
= get_stat_mtime (&st
);
5452 current_buffer
->modtime_size
= st
.st_size
;
5460 auto_save_error (Lisp_Object error_val
)
5462 Lisp_Object args
[3], msg
;
5464 struct gcpro gcpro1
;
5466 auto_save_error_occurred
= 1;
5468 ring_bell (XFRAME (selected_frame
));
5470 args
[0] = build_string ("Auto-saving %s: %s");
5471 args
[1] = BVAR (current_buffer
, name
);
5472 args
[2] = Ferror_message_string (error_val
);
5473 msg
= Fformat (3, args
);
5476 for (i
= 0; i
< 3; ++i
)
5481 message3_nolog (msg
);
5482 Fsleep_for (make_number (1), Qnil
);
5495 auto_save_mode_bits
= 0666;
5497 /* Get visited file's mode to become the auto save file's mode. */
5498 if (! NILP (BVAR (current_buffer
, filename
)))
5500 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5501 /* But make sure we can overwrite it later! */
5502 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5503 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5505 /* Remote files don't cooperate with stat. */
5506 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5510 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5511 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5515 struct auto_save_unwind
5522 do_auto_save_unwind (void *arg
)
5524 struct auto_save_unwind
*p
= arg
;
5525 FILE *stream
= p
->stream
;
5526 minibuffer_auto_raise
= p
->auto_raise
;
5537 do_auto_save_make_dir (Lisp_Object dir
)
5541 auto_saving_dir_umask
= 077;
5542 result
= call2 (Qmake_directory
, dir
, Qt
);
5543 auto_saving_dir_umask
= 0;
5548 do_auto_save_eh (Lisp_Object ignore
)
5550 auto_saving_dir_umask
= 0;
5554 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5555 doc
: /* Auto-save all buffers that need it.
5556 This is all buffers that have auto-saving enabled
5557 and are changed since last auto-saved.
5558 Auto-saving writes the buffer into a file
5559 so that your editing is not lost if the system crashes.
5560 This file is not the file you visited; that changes only when you save.
5561 Normally we run the normal hook `auto-save-hook' before saving.
5563 A non-nil NO-MESSAGE argument means do not print any message if successful.
5564 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5565 (Lisp_Object no_message
, Lisp_Object current_only
)
5567 struct buffer
*old
= current_buffer
, *b
;
5568 Lisp_Object tail
, buf
, hook
;
5569 bool auto_saved
= 0;
5570 int do_handled_files
;
5572 FILE *stream
= NULL
;
5573 ptrdiff_t count
= SPECPDL_INDEX ();
5574 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5575 bool old_message_p
= 0;
5576 struct auto_save_unwind auto_save_unwind
;
5577 struct gcpro gcpro1
, gcpro2
;
5579 if (max_specpdl_size
< specpdl_size
+ 40)
5580 max_specpdl_size
= specpdl_size
+ 40;
5585 if (NILP (no_message
))
5587 old_message_p
= push_message ();
5588 record_unwind_protect_void (pop_message_unwind
);
5591 /* Ordinarily don't quit within this function,
5592 but don't make it impossible to quit (in case we get hung in I/O). */
5596 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5597 point to non-strings reached from Vbuffer_alist. */
5599 hook
= intern ("auto-save-hook");
5600 safe_run_hooks (hook
);
5602 if (STRINGP (Vauto_save_list_file_name
))
5604 Lisp_Object listfile
;
5606 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5608 /* Don't try to create the directory when shutting down Emacs,
5609 because creating the directory might signal an error, and
5610 that would leave Emacs in a strange state. */
5611 if (!NILP (Vrun_hooks
))
5615 GCPRO2 (dir
, listfile
);
5616 dir
= Ffile_name_directory (listfile
);
5617 if (NILP (Ffile_directory_p (dir
)))
5618 internal_condition_case_1 (do_auto_save_make_dir
,
5624 stream
= emacs_fopen (SSDATA (listfile
), "w");
5627 auto_save_unwind
.stream
= stream
;
5628 auto_save_unwind
.auto_raise
= minibuffer_auto_raise
;
5629 record_unwind_protect_ptr (do_auto_save_unwind
, &auto_save_unwind
);
5630 minibuffer_auto_raise
= 0;
5632 auto_save_error_occurred
= 0;
5634 /* On first pass, save all files that don't have handlers.
5635 On second pass, save all files that do have handlers.
5637 If Emacs is crashing, the handlers may tweak what is causing
5638 Emacs to crash in the first place, and it would be a shame if
5639 Emacs failed to autosave perfectly ordinary files because it
5640 couldn't handle some ange-ftp'd file. */
5642 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5643 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5647 /* Record all the buffers that have auto save mode
5648 in the special file that lists them. For each of these buffers,
5649 Record visited name (if any) and auto save name. */
5650 if (STRINGP (BVAR (b
, auto_save_file_name
))
5651 && stream
!= NULL
&& do_handled_files
== 0)
5654 if (!NILP (BVAR (b
, filename
)))
5656 fwrite (SDATA (BVAR (b
, filename
)), 1,
5657 SBYTES (BVAR (b
, filename
)), stream
);
5659 putc ('\n', stream
);
5660 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5661 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5662 putc ('\n', stream
);
5666 if (!NILP (current_only
)
5667 && b
!= current_buffer
)
5670 /* Don't auto-save indirect buffers.
5671 The base buffer takes care of it. */
5675 /* Check for auto save enabled
5676 and file changed since last auto save
5677 and file changed since last real save. */
5678 if (STRINGP (BVAR (b
, auto_save_file_name
))
5679 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5680 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5681 /* -1 means we've turned off autosaving for a while--see below. */
5682 && XINT (BVAR (b
, save_length
)) >= 0
5683 && (do_handled_files
5684 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5687 struct timespec before_time
= current_timespec ();
5688 struct timespec after_time
;
5690 /* If we had a failure, don't try again for 20 minutes. */
5691 if (b
->auto_save_failure_time
> 0
5692 && before_time
.tv_sec
- b
->auto_save_failure_time
< 1200)
5695 set_buffer_internal (b
);
5696 if (NILP (Vauto_save_include_big_deletions
)
5697 && (XFASTINT (BVAR (b
, save_length
)) * 10
5698 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5699 /* A short file is likely to change a large fraction;
5700 spare the user annoying messages. */
5701 && XFASTINT (BVAR (b
, save_length
)) > 5000
5702 /* These messages are frequent and annoying for `*mail*'. */
5703 && !EQ (BVAR (b
, filename
), Qnil
)
5704 && NILP (no_message
))
5706 /* It has shrunk too much; turn off auto-saving here. */
5707 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5708 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5710 minibuffer_auto_raise
= 0;
5711 /* Turn off auto-saving until there's a real save,
5712 and prevent any more warnings. */
5713 XSETINT (BVAR (b
, save_length
), -1);
5714 Fsleep_for (make_number (1), Qnil
);
5717 if (!auto_saved
&& NILP (no_message
))
5718 message1 ("Auto-saving...");
5719 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5721 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5722 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5723 set_buffer_internal (old
);
5725 after_time
= current_timespec ();
5727 /* If auto-save took more than 60 seconds,
5728 assume it was an NFS failure that got a timeout. */
5729 if (after_time
.tv_sec
- before_time
.tv_sec
> 60)
5730 b
->auto_save_failure_time
= after_time
.tv_sec
;
5734 /* Prevent another auto save till enough input events come in. */
5735 record_auto_save ();
5737 if (auto_saved
&& NILP (no_message
))
5741 /* If we are going to restore an old message,
5742 give time to read ours. */
5743 sit_for (make_number (1), 0, 0);
5746 else if (!auto_save_error_occurred
)
5747 /* Don't overwrite the error message if an error occurred.
5748 If we displayed a message and then restored a state
5749 with no message, leave a "done" message on the screen. */
5750 message1 ("Auto-saving...done");
5755 /* This restores the message-stack status. */
5756 unbind_to (count
, Qnil
);
5760 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5761 Sset_buffer_auto_saved
, 0, 0, 0,
5762 doc
: /* Mark current buffer as auto-saved with its current text.
5763 No auto-save file will be written until the buffer changes again. */)
5766 /* FIXME: This should not be called in indirect buffers, since
5767 they're not autosaved. */
5768 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5769 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5770 current_buffer
->auto_save_failure_time
= 0;
5774 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5775 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5776 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5779 current_buffer
->auto_save_failure_time
= 0;
5783 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5785 doc
: /* Return t if current buffer has been auto-saved recently.
5786 More precisely, if it has been auto-saved since last read from or saved
5787 in the visited file. If the buffer has no visited file,
5788 then any auto-save counts as "recent". */)
5791 /* FIXME: maybe we should return nil for indirect buffers since
5792 they're never autosaved. */
5793 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5796 /* Reading and completing file names */
5798 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5799 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5800 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5801 The return value is only relevant for a call to `read-file-name' that happens
5802 before any other event (mouse or keypress) is handled. */)
5805 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5806 || defined (HAVE_NS)
5807 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5810 && window_system_available (SELECTED_FRAME ()))
5817 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5819 struct gcpro gcpro1
;
5820 Lisp_Object args
[7];
5822 GCPRO1 (default_filename
);
5823 args
[0] = intern ("read-file-name");
5826 args
[3] = default_filename
;
5827 args
[4] = mustmatch
;
5829 args
[6] = predicate
;
5830 RETURN_UNGCPRO (Ffuncall (7, args
));
5837 valid_timestamp_file_system
= 0;
5841 syms_of_fileio (void)
5843 DEFSYM (Qoperations
, "operations");
5844 DEFSYM (Qexpand_file_name
, "expand-file-name");
5845 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5846 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5847 DEFSYM (Qfile_name_directory
, "file-name-directory");
5848 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5849 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5850 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5851 DEFSYM (Qcopy_file
, "copy-file");
5852 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5853 DEFSYM (Qmake_directory
, "make-directory");
5854 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5855 DEFSYM (Qdelete_file
, "delete-file");
5856 DEFSYM (Qrename_file
, "rename-file");
5857 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5858 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5859 DEFSYM (Qfile_exists_p
, "file-exists-p");
5860 DEFSYM (Qfile_executable_p
, "file-executable-p");
5861 DEFSYM (Qfile_readable_p
, "file-readable-p");
5862 DEFSYM (Qfile_writable_p
, "file-writable-p");
5863 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5864 DEFSYM (Qaccess_file
, "access-file");
5865 DEFSYM (Qfile_directory_p
, "file-directory-p");
5866 DEFSYM (Qfile_regular_p
, "file-regular-p");
5867 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5868 DEFSYM (Qfile_modes
, "file-modes");
5869 DEFSYM (Qset_file_modes
, "set-file-modes");
5870 DEFSYM (Qset_file_times
, "set-file-times");
5871 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5872 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5873 DEFSYM (Qfile_acl
, "file-acl");
5874 DEFSYM (Qset_file_acl
, "set-file-acl");
5875 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5876 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5877 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5878 DEFSYM (Qwrite_region
, "write-region");
5879 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5880 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5881 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5883 DEFSYM (Qfile_name_history
, "file-name-history");
5884 Fset (Qfile_name_history
, Qnil
);
5886 DEFSYM (Qfile_error
, "file-error");
5887 DEFSYM (Qfile_already_exists
, "file-already-exists");
5888 DEFSYM (Qfile_date_error
, "file-date-error");
5889 DEFSYM (Qfile_notify_error
, "file-notify-error");
5890 DEFSYM (Qexcl
, "excl");
5892 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5893 doc
: /* Coding system for encoding file names.
5894 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5895 Vfile_name_coding_system
= Qnil
;
5897 DEFVAR_LISP ("default-file-name-coding-system",
5898 Vdefault_file_name_coding_system
,
5899 doc
: /* Default coding system for encoding file names.
5900 This variable is used only when `file-name-coding-system' is nil.
5902 This variable is set/changed by the command `set-language-environment'.
5903 User should not set this variable manually,
5904 instead use `file-name-coding-system' to get a constant encoding
5905 of file names regardless of the current language environment. */);
5906 Vdefault_file_name_coding_system
= Qnil
;
5908 DEFSYM (Qformat_decode
, "format-decode");
5909 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5910 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5911 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5913 Fput (Qfile_error
, Qerror_conditions
,
5914 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5915 Fput (Qfile_error
, Qerror_message
,
5916 build_pure_c_string ("File error"));
5918 Fput (Qfile_already_exists
, Qerror_conditions
,
5919 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5920 Fput (Qfile_already_exists
, Qerror_message
,
5921 build_pure_c_string ("File already exists"));
5923 Fput (Qfile_date_error
, Qerror_conditions
,
5924 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5925 Fput (Qfile_date_error
, Qerror_message
,
5926 build_pure_c_string ("Cannot set file date"));
5928 Fput (Qfile_notify_error
, Qerror_conditions
,
5929 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5930 Fput (Qfile_notify_error
, Qerror_message
,
5931 build_pure_c_string ("File notification error"));
5933 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5934 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5935 If a file name matches REGEXP, all I/O on that file is done by calling
5936 HANDLER. If a file name matches more than one handler, the handler
5937 whose match starts last in the file name gets precedence. The
5938 function `find-file-name-handler' checks this list for a handler for
5941 HANDLER should be a function. The first argument given to it is the
5942 name of the I/O primitive to be handled; the remaining arguments are
5943 the arguments that were passed to that primitive. For example, if you
5944 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5945 HANDLER is called like this:
5947 (funcall HANDLER 'file-exists-p FILENAME)
5949 Note that HANDLER must be able to handle all I/O primitives; if it has
5950 nothing special to do for a primitive, it should reinvoke the
5951 primitive to handle the operation \"the usual way\".
5952 See Info node `(elisp)Magic File Names' for more details. */);
5953 Vfile_name_handler_alist
= Qnil
;
5955 DEFVAR_LISP ("set-auto-coding-function",
5956 Vset_auto_coding_function
,
5957 doc
: /* If non-nil, a function to call to decide a coding system of file.
5958 Two arguments are passed to this function: the file name
5959 and the length of a file contents following the point.
5960 This function should return a coding system to decode the file contents.
5961 It should check the file name against `auto-coding-alist'.
5962 If no coding system is decided, it should check a coding system
5963 specified in the heading lines with the format:
5964 -*- ... coding: CODING-SYSTEM; ... -*-
5965 or local variable spec of the tailing lines with `coding:' tag. */);
5966 Vset_auto_coding_function
= Qnil
;
5968 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5969 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5970 Each is passed one argument, the number of characters inserted,
5971 with point at the start of the inserted text. Each function
5972 should leave point the same, and return the new character count.
5973 If `insert-file-contents' is intercepted by a handler from
5974 `file-name-handler-alist', that handler is responsible for calling the
5975 functions in `after-insert-file-functions' if appropriate. */);
5976 Vafter_insert_file_functions
= Qnil
;
5978 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5979 doc
: /* A list of functions to be called at the start of `write-region'.
5980 Each is passed two arguments, START and END as for `write-region'.
5981 These are usually two numbers but not always; see the documentation
5982 for `write-region'. The function should return a list of pairs
5983 of the form (POSITION . STRING), consisting of strings to be effectively
5984 inserted at the specified positions of the file being written (1 means to
5985 insert before the first byte written). The POSITIONs must be sorted into
5988 If there are several annotation functions, the lists returned by these
5989 functions are merged destructively. As each annotation function runs,
5990 the variable `write-region-annotations-so-far' contains a list of all
5991 annotations returned by previous annotation functions.
5993 An annotation function can return with a different buffer current.
5994 Doing so removes the annotations returned by previous functions, and
5995 resets START and END to `point-min' and `point-max' of the new buffer.
5997 After `write-region' completes, Emacs calls the function stored in
5998 `write-region-post-annotation-function', once for each buffer that was
5999 current when building the annotations (i.e., at least once), with that
6000 buffer current. */);
6001 Vwrite_region_annotate_functions
= Qnil
;
6002 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
6004 DEFVAR_LISP ("write-region-post-annotation-function",
6005 Vwrite_region_post_annotation_function
,
6006 doc
: /* Function to call after `write-region' completes.
6007 The function is called with no arguments. If one or more of the
6008 annotation functions in `write-region-annotate-functions' changed the
6009 current buffer, the function stored in this variable is called for
6010 each of those additional buffers as well, in addition to the original
6011 buffer. The relevant buffer is current during each function call. */);
6012 Vwrite_region_post_annotation_function
= Qnil
;
6013 staticpro (&Vwrite_region_annotation_buffers
);
6015 DEFVAR_LISP ("write-region-annotations-so-far",
6016 Vwrite_region_annotations_so_far
,
6017 doc
: /* When an annotation function is called, this holds the previous annotations.
6018 These are the annotations made by other annotation functions
6019 that were already called. See also `write-region-annotate-functions'. */);
6020 Vwrite_region_annotations_so_far
= Qnil
;
6022 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6023 doc
: /* A list of file name handlers that temporarily should not be used.
6024 This applies only to the operation `inhibit-file-name-operation'. */);
6025 Vinhibit_file_name_handlers
= Qnil
;
6027 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6028 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6029 Vinhibit_file_name_operation
= Qnil
;
6031 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6032 doc
: /* File name in which we write a list of all auto save file names.
6033 This variable is initialized automatically from `auto-save-list-file-prefix'
6034 shortly after Emacs reads your init file, if you have not yet given it
6035 a non-nil value. */);
6036 Vauto_save_list_file_name
= Qnil
;
6038 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6039 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6040 Normally auto-save files are written under other names. */);
6041 Vauto_save_visited_file_name
= Qnil
;
6043 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6044 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6045 If nil, deleting a substantial portion of the text disables auto-save
6046 in the buffer; this is the default behavior, because the auto-save
6047 file is usually more useful if it contains the deleted text. */);
6048 Vauto_save_include_big_deletions
= Qnil
;
6050 /* fsync can be a significant performance hit. Often it doesn't
6051 suffice to make the file-save operation survive a crash. For
6052 batch scripts, which are typically part of larger shell commands
6053 that don't fsync other files, its effect on performance can be
6054 significant so its utility is particularly questionable.
6055 Hence, for now by default fsync is used only when interactive.
6057 For more on why fsync often fails to work on today's hardware, see:
6058 Zheng M et al. Understanding the robustness of SSDs under power fault.
6059 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
6060 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
6062 For more on why fsync does not suffice even if it works properly, see:
6063 Roche X. Necessary step(s) to synchronize filename operations on disk.
6064 Austin Group Defect 672, 2013-03-19
6065 http://austingroupbugs.net/view.php?id=672 */
6066 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6067 doc
: /* Non-nil means don't call fsync in `write-region'.
6068 This variable affects calls to `write-region' as well as save commands.
6069 Setting this to nil may avoid data loss if the system loses power or
6070 the operating system crashes. */);
6071 write_region_inhibit_fsync
= noninteractive
;
6073 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6074 doc
: /* Specifies whether to use the system's trash can.
6075 When non-nil, certain file deletion commands use the function
6076 `move-file-to-trash' instead of deleting files outright.
6077 This includes interactive calls to `delete-file' and
6078 `delete-directory' and the Dired deletion commands. */);
6079 delete_by_moving_to_trash
= 0;
6080 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6082 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6083 DEFSYM (Qcopy_directory
, "copy-directory");
6084 DEFSYM (Qdelete_directory
, "delete-directory");
6086 defsubr (&Sfind_file_name_handler
);
6087 defsubr (&Sfile_name_directory
);
6088 defsubr (&Sfile_name_nondirectory
);
6089 defsubr (&Sunhandled_file_name_directory
);
6090 defsubr (&Sfile_name_as_directory
);
6091 defsubr (&Sdirectory_file_name
);
6092 defsubr (&Smake_temp_name
);
6093 defsubr (&Sexpand_file_name
);
6094 defsubr (&Ssubstitute_in_file_name
);
6095 defsubr (&Scopy_file
);
6096 defsubr (&Smake_directory_internal
);
6097 defsubr (&Sdelete_directory_internal
);
6098 defsubr (&Sdelete_file
);
6099 defsubr (&Srename_file
);
6100 defsubr (&Sadd_name_to_file
);
6101 defsubr (&Smake_symbolic_link
);
6102 defsubr (&Sfile_name_absolute_p
);
6103 defsubr (&Sfile_exists_p
);
6104 defsubr (&Sfile_executable_p
);
6105 defsubr (&Sfile_readable_p
);
6106 defsubr (&Sfile_writable_p
);
6107 defsubr (&Saccess_file
);
6108 defsubr (&Sfile_symlink_p
);
6109 defsubr (&Sfile_directory_p
);
6110 defsubr (&Sfile_accessible_directory_p
);
6111 defsubr (&Sfile_regular_p
);
6112 defsubr (&Sfile_modes
);
6113 defsubr (&Sset_file_modes
);
6114 defsubr (&Sset_file_times
);
6115 defsubr (&Sfile_selinux_context
);
6116 defsubr (&Sfile_acl
);
6117 defsubr (&Sset_file_acl
);
6118 defsubr (&Sset_file_selinux_context
);
6119 defsubr (&Sset_default_file_modes
);
6120 defsubr (&Sdefault_file_modes
);
6121 defsubr (&Sfile_newer_than_file_p
);
6122 defsubr (&Sinsert_file_contents
);
6123 defsubr (&Schoose_write_coding_system
);
6124 defsubr (&Swrite_region
);
6125 defsubr (&Scar_less_than_car
);
6126 defsubr (&Sverify_visited_file_modtime
);
6127 defsubr (&Svisited_file_modtime
);
6128 defsubr (&Sset_visited_file_modtime
);
6129 defsubr (&Sdo_auto_save
);
6130 defsubr (&Sset_buffer_auto_saved
);
6131 defsubr (&Sclear_buffer_auto_save_failure
);
6132 defsubr (&Srecent_auto_save_p
);
6134 defsubr (&Snext_read_file_uses_dialog_p
);
6137 defsubr (&Sunix_sync
);