1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
53 #include "dispextern.h"
61 #endif /* not WINDOWSNT */
65 #include <sys/param.h>
70 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
71 redirector allows the six letters between 'Z' and 'a' as well. */
73 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
76 #define IS_DRIVE(x) c_isalpha (x)
78 /* Need to lower-case the drive letter, or else expanded
79 filenames will sometimes compare unequal, because
80 `expand-file-name' doesn't always down-case the drive letter. */
81 #define DRIVE_LETTER(x) c_tolower (x)
85 #include <allocator.h>
86 #include <careadlinkat.h>
87 #include <stat-time.h>
95 /* True during writing of auto-save files. */
96 static bool auto_saving
;
98 /* Nonzero umask during creation of auto-save directories. */
99 static mode_t auto_saving_dir_umask
;
101 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
102 a new file with the same mode as the original. */
103 static mode_t auto_save_mode_bits
;
105 /* Set by auto_save_1 if an error occurred during the last auto-save. */
106 static bool auto_save_error_occurred
;
108 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
109 number of a file system where time stamps were observed to to work. */
110 static bool valid_timestamp_file_system
;
111 static dev_t timestamp_file_system
;
113 /* The symbol bound to coding-system-for-read when
114 insert-file-contents is called for recovering a file. This is not
115 an actual coding system name, but just an indicator to tell
116 insert-file-contents to use `emacs-mule' with a special flag for
117 auto saving and recovering a file. */
118 static Lisp_Object Qauto_save_coding
;
120 /* Property name of a file name handler,
121 which gives a list of operations it handles.. */
122 static Lisp_Object Qoperations
;
124 /* Lisp functions for translating file formats. */
125 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
127 /* Lisp function for setting buffer-file-coding-system and the
128 multibyteness of the current buffer after inserting a file. */
129 static Lisp_Object Qafter_insert_file_set_coding
;
131 static Lisp_Object Qwrite_region_annotate_functions
;
132 /* Each time an annotation function changes the buffer, the new buffer
134 static Lisp_Object Vwrite_region_annotation_buffers
;
136 static Lisp_Object Qdelete_by_moving_to_trash
;
138 /* Lisp function for moving files to trash. */
139 static Lisp_Object Qmove_file_to_trash
;
141 /* Lisp function for recursively copying directories. */
142 static Lisp_Object Qcopy_directory
;
144 /* Lisp function for recursively deleting directories. */
145 static Lisp_Object Qdelete_directory
;
150 Lisp_Object Qfile_error
;
151 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
152 static Lisp_Object Qexcl
;
153 Lisp_Object Qfile_name_history
;
155 static Lisp_Object Qcar_less_than_car
;
157 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
158 Lisp_Object
*, struct coding_system
*);
159 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
160 struct coding_system
*);
164 report_file_error (const char *string
, Lisp_Object data
)
166 Lisp_Object errstring
;
170 synchronize_system_messages_locale ();
171 str
= strerror (errorno
);
172 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
173 Vlocale_coding_system
, 0);
179 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
182 /* System error messages are capitalized. Downcase the initial
183 unless it is followed by a slash. (The slash case caters to
184 error messages that begin with "I/O" or, in German, "E/A".) */
185 if (STRING_MULTIBYTE (errstring
)
186 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
190 str
= SSDATA (errstring
);
191 c
= STRING_CHAR ((unsigned char *) str
);
192 Faset (errstring
, make_number (0), make_number (downcase (c
)));
195 xsignal (Qfile_error
,
196 Fcons (build_string (string
), Fcons (errstring
, data
)));
201 close_file_unwind (Lisp_Object fd
)
203 emacs_close (XFASTINT (fd
));
207 /* Restore point, having saved it as a marker. */
210 restore_point_unwind (Lisp_Object location
)
212 Fgoto_char (location
);
213 Fset_marker (location
, Qnil
, Qnil
);
218 static Lisp_Object Qexpand_file_name
;
219 static Lisp_Object Qsubstitute_in_file_name
;
220 static Lisp_Object Qdirectory_file_name
;
221 static Lisp_Object Qfile_name_directory
;
222 static Lisp_Object Qfile_name_nondirectory
;
223 static Lisp_Object Qunhandled_file_name_directory
;
224 static Lisp_Object Qfile_name_as_directory
;
225 static Lisp_Object Qcopy_file
;
226 static Lisp_Object Qmake_directory_internal
;
227 static Lisp_Object Qmake_directory
;
228 static Lisp_Object Qdelete_directory_internal
;
229 Lisp_Object Qdelete_file
;
230 static Lisp_Object Qrename_file
;
231 static Lisp_Object Qadd_name_to_file
;
232 static Lisp_Object Qmake_symbolic_link
;
233 Lisp_Object Qfile_exists_p
;
234 static Lisp_Object Qfile_executable_p
;
235 static Lisp_Object Qfile_readable_p
;
236 static Lisp_Object Qfile_writable_p
;
237 static Lisp_Object Qfile_symlink_p
;
238 static Lisp_Object Qaccess_file
;
239 Lisp_Object Qfile_directory_p
;
240 static Lisp_Object Qfile_regular_p
;
241 static Lisp_Object Qfile_accessible_directory_p
;
242 static Lisp_Object Qfile_modes
;
243 static Lisp_Object Qset_file_modes
;
244 static Lisp_Object Qset_file_times
;
245 static Lisp_Object Qfile_selinux_context
;
246 static Lisp_Object Qset_file_selinux_context
;
247 static Lisp_Object Qfile_acl
;
248 static Lisp_Object Qset_file_acl
;
249 static Lisp_Object Qfile_newer_than_file_p
;
250 Lisp_Object Qinsert_file_contents
;
251 static Lisp_Object Qchoose_write_coding_system
;
252 Lisp_Object Qwrite_region
;
253 static Lisp_Object Qverify_visited_file_modtime
;
254 static Lisp_Object Qset_visited_file_modtime
;
256 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
257 Sfind_file_name_handler
, 2, 2, 0,
258 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
259 Otherwise, return nil.
260 A file name is handled if one of the regular expressions in
261 `file-name-handler-alist' matches it.
263 If OPERATION equals `inhibit-file-name-operation', then we ignore
264 any handlers that are members of `inhibit-file-name-handlers',
265 but we still do run any other handlers. This lets handlers
266 use the standard functions without calling themselves recursively. */)
267 (Lisp_Object filename
, Lisp_Object operation
)
269 /* This function must not munge the match data. */
270 Lisp_Object chain
, inhibited_handlers
, result
;
274 CHECK_STRING (filename
);
276 if (EQ (operation
, Vinhibit_file_name_operation
))
277 inhibited_handlers
= Vinhibit_file_name_handlers
;
279 inhibited_handlers
= Qnil
;
281 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
282 chain
= XCDR (chain
))
288 Lisp_Object string
= XCAR (elt
);
290 Lisp_Object handler
= XCDR (elt
);
291 Lisp_Object operations
= Qnil
;
293 if (SYMBOLP (handler
))
294 operations
= Fget (handler
, Qoperations
);
297 && (match_pos
= fast_string_match (string
, filename
)) > pos
298 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
302 handler
= XCDR (elt
);
303 tem
= Fmemq (handler
, inhibited_handlers
);
317 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
319 doc
: /* Return the directory component in file name FILENAME.
320 Return nil if FILENAME does not include a directory.
321 Otherwise return a directory name.
322 Given a Unix syntax file name, returns a string ending in slash. */)
323 (Lisp_Object filename
)
326 register const char *beg
;
331 register const char *p
;
334 CHECK_STRING (filename
);
336 /* If the file name has special constructs in it,
337 call the corresponding file handler. */
338 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
341 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
343 return STRINGP (handled_name
) ? handled_name
: Qnil
;
347 beg
= alloca (SBYTES (filename
) + 1);
348 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
350 beg
= SSDATA (filename
);
352 p
= beg
+ SBYTES (filename
);
354 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
356 /* only recognize drive specifier at the beginning */
358 /* handle the "/:d:foo" and "/:foo" cases correctly */
359 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
360 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
367 /* Expansion of "c:" to drive and default directory. */
370 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
371 char *res
= alloca (MAXPATHLEN
+ 1);
374 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
376 memcpy (res
, beg
, 2);
381 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
383 size_t l
= strlen (res
);
385 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
388 p
= beg
+ strlen (beg
);
389 dostounix_filename (beg
, 0);
390 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
391 STRING_MULTIBYTE (filename
));
394 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
395 STRING_MULTIBYTE (filename
));
397 else if (STRING_MULTIBYTE (filename
))
399 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
400 dostounix_filename (SSDATA (tem_fn
), 1);
402 if (!NILP (Vw32_downcase_file_names
))
403 tem_fn
= Fdowncase (tem_fn
);
408 dostounix_filename (beg
, 0);
409 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
413 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
417 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
418 Sfile_name_nondirectory
, 1, 1, 0,
419 doc
: /* Return file name FILENAME sans its directory.
420 For example, in a Unix-syntax file name,
421 this is everything after the last slash,
422 or the entire name if it contains no slash. */)
423 (Lisp_Object filename
)
425 register const char *beg
, *p
, *end
;
428 CHECK_STRING (filename
);
430 /* If the file name has special constructs in it,
431 call the corresponding file handler. */
432 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
435 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
437 if (STRINGP (handled_name
))
439 error ("Invalid handler in `file-name-handler-alist'");
442 beg
= SSDATA (filename
);
443 end
= p
= beg
+ SBYTES (filename
);
445 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
447 /* only recognize drive specifier at beginning */
449 /* handle the "/:d:foo" case correctly */
450 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
455 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
458 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
459 Sunhandled_file_name_directory
, 1, 1, 0,
460 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
461 A `directly usable' directory name is one that may be used without the
462 intervention of any file handler.
463 If FILENAME is a directly usable file itself, return
464 \(file-name-directory FILENAME).
465 If FILENAME refers to a file which is not accessible from a local process,
466 then this should return nil.
467 The `call-process' and `start-process' functions use this function to
468 get a current directory to run processes in. */)
469 (Lisp_Object filename
)
473 /* If the file name has special constructs in it,
474 call the corresponding file handler. */
475 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
478 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
480 return STRINGP (handled_name
) ? handled_name
: Qnil
;
483 return Ffile_name_directory (filename
);
486 /* Convert from file name SRC of length SRCLEN to directory name in
487 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
488 string. On UNIX, just make sure there is a terminating /. Return
489 the length of DST in bytes. */
492 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
505 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
507 dst
[srclen
] = DIRECTORY_SEP
;
508 dst
[srclen
+ 1] = '\0';
512 dostounix_filename (dst
, multibyte
);
517 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
518 Sfile_name_as_directory
, 1, 1, 0,
519 doc
: /* Return a string representing the file name FILE interpreted as a directory.
520 This operation exists because a directory is also a file, but its name as
521 a directory is different from its name as a file.
522 The result can be used as the value of `default-directory'
523 or passed as second argument to `expand-file-name'.
524 For a Unix-syntax file name, just appends a slash. */)
535 /* If the file name has special constructs in it,
536 call the corresponding file handler. */
537 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
540 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
542 if (STRINGP (handled_name
))
544 error ("Invalid handler in `file-name-handler-alist'");
548 if (!NILP (Vw32_downcase_file_names
))
549 file
= Fdowncase (file
);
551 buf
= alloca (SBYTES (file
) + 10);
552 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
553 STRING_MULTIBYTE (file
));
554 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
557 /* Convert from directory name SRC of length SRCLEN to file name in
558 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
559 string. On UNIX, just make sure there isn't a terminating /.
560 Return the length of DST in bytes. */
563 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
565 /* Process as Unix format: just remove any final slash.
566 But leave "/" unchanged; do not change it to "". */
569 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
571 && !IS_ANY_SEP (dst
[srclen
- 2])
579 dostounix_filename (dst
, multibyte
);
584 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
586 doc
: /* Returns the file name of the directory named DIRECTORY.
587 This is the name of the file that holds the data for the directory DIRECTORY.
588 This operation exists because a directory is also a file, but its name as
589 a directory is different from its name as a file.
590 In Unix-syntax, this function just removes the final slash. */)
591 (Lisp_Object directory
)
597 CHECK_STRING (directory
);
599 if (NILP (directory
))
602 /* If the file name has special constructs in it,
603 call the corresponding file handler. */
604 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
607 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
609 if (STRINGP (handled_name
))
611 error ("Invalid handler in `file-name-handler-alist'");
615 if (!NILP (Vw32_downcase_file_names
))
616 directory
= Fdowncase (directory
);
618 buf
= alloca (SBYTES (directory
) + 20);
619 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
620 STRING_MULTIBYTE (directory
));
621 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
624 static const char make_temp_name_tbl
[64] =
626 'A','B','C','D','E','F','G','H',
627 'I','J','K','L','M','N','O','P',
628 'Q','R','S','T','U','V','W','X',
629 'Y','Z','a','b','c','d','e','f',
630 'g','h','i','j','k','l','m','n',
631 'o','p','q','r','s','t','u','v',
632 'w','x','y','z','0','1','2','3',
633 '4','5','6','7','8','9','-','_'
636 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
638 /* Value is a temporary file name starting with PREFIX, a string.
640 The Emacs process number forms part of the result, so there is
641 no danger of generating a name being used by another process.
642 In addition, this function makes an attempt to choose a name
643 which has no existing file. To make this work, PREFIX should be
644 an absolute file name.
646 BASE64_P means add the pid as 3 characters in base64
647 encoding. In this case, 6 characters will be added to PREFIX to
648 form the file name. Otherwise, if Emacs is running on a system
649 with long file names, add the pid as a decimal number.
651 This function signals an error if no unique file name could be
655 make_temp_name (Lisp_Object prefix
, bool base64_p
)
661 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
664 CHECK_STRING (prefix
);
666 /* VAL is created by adding 6 characters to PREFIX. The first
667 three are the PID of this process, in base 64, and the second
668 three are incremented if the file already exists. This ensures
669 262144 unique file names per PID per PREFIX. */
675 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
676 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
677 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
682 #ifdef HAVE_LONG_FILE_NAMES
683 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
685 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
686 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
687 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
692 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
693 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
694 if (!STRING_MULTIBYTE (prefix
))
695 STRING_SET_UNIBYTE (val
);
697 memcpy (data
, SSDATA (prefix
), len
);
700 memcpy (p
, pidbuf
, pidlen
);
703 /* Here we try to minimize useless stat'ing when this function is
704 invoked many times successively with the same PREFIX. We achieve
705 this by initializing count to a random value, and incrementing it
708 We don't want make-temp-name to be called while dumping,
709 because then make_temp_name_count_initialized_p would get set
710 and then make_temp_name_count would not be set when Emacs starts. */
712 if (!make_temp_name_count_initialized_p
)
714 make_temp_name_count
= time (NULL
);
715 make_temp_name_count_initialized_p
= 1;
720 unsigned num
= make_temp_name_count
;
722 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
723 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
724 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
726 /* Poor man's congruential RN generator. Replace with
727 ++make_temp_name_count for debugging. */
728 make_temp_name_count
+= 25229;
729 make_temp_name_count
%= 225307;
731 if (!check_existing (data
))
733 /* We want to return only if errno is ENOENT. */
737 /* The error here is dubious, but there is little else we
738 can do. The alternatives are to return nil, which is
739 as bad as (and in many cases worse than) throwing the
740 error, or to ignore the error, which will likely result
741 in looping through 225307 stat's, which is not only
742 dog-slow, but also useless since eventually nil would
743 have to be returned anyway. */
744 report_file_error ("Cannot create temporary name for prefix",
745 Fcons (prefix
, Qnil
));
752 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
753 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
754 The Emacs process number forms part of the result,
755 so there is no danger of generating a name being used by another process.
757 In addition, this function makes an attempt to choose a name
758 which has no existing file. To make this work,
759 PREFIX should be an absolute file name.
761 There is a race condition between calling `make-temp-name' and creating the
762 file which opens all kinds of security holes. For that reason, you should
763 probably use `make-temp-file' instead, except in three circumstances:
765 * If you are creating the file in the user's home directory.
766 * If you are creating a directory rather than an ordinary file.
767 * If you are taking special precautions as `make-temp-file' does. */)
770 return make_temp_name (prefix
, 0);
775 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
776 doc
: /* Convert filename NAME to absolute, and canonicalize it.
777 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
778 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
779 the current buffer's value of `default-directory' is used.
780 NAME should be a string that is a valid file name for the underlying
782 File name components that are `.' are removed, and
783 so are file name components followed by `..', along with the `..' itself;
784 note that these simplifications are done without checking the resulting
785 file names in the file system.
786 Multiple consecutive slashes are collapsed into a single slash,
787 except at the beginning of the file name when they are significant (e.g.,
788 UNC file names on MS-Windows.)
789 An initial `~/' expands to your home directory.
790 An initial `~USER/' expands to USER's home directory.
791 See also the function `substitute-in-file-name'.
793 For technical reasons, this function can return correct but
794 non-intuitive results for the root directory; for instance,
795 \(expand-file-name ".." "/") returns "/..". For this reason, use
796 \(directory-file-name (file-name-directory dirname)) to traverse a
797 filesystem tree, not (expand-file-name ".." dirname). */)
798 (Lisp_Object name
, Lisp_Object default_directory
)
800 /* These point to SDATA and need to be careful with string-relocation
801 during GC (via DECODE_FILE). */
804 /* This should only point to alloca'd data. */
811 bool collapse_newdir
= 1;
815 Lisp_Object handler
, result
, handled_name
;
821 /* If the file name has special constructs in it,
822 call the corresponding file handler. */
823 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
826 handled_name
= call3 (handler
, Qexpand_file_name
,
827 name
, default_directory
);
828 if (STRINGP (handled_name
))
830 error ("Invalid handler in `file-name-handler-alist'");
834 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
835 if (NILP (default_directory
))
836 default_directory
= BVAR (current_buffer
, directory
);
837 if (! STRINGP (default_directory
))
840 /* "/" is not considered a root directory on DOS_NT, so using "/"
841 here causes an infinite recursion in, e.g., the following:
843 (let (default-directory)
844 (expand-file-name "a"))
846 To avoid this, we set default_directory to the root of the
848 default_directory
= build_string (emacs_root_dir ());
850 default_directory
= build_string ("/");
854 if (!NILP (default_directory
))
856 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
859 handled_name
= call3 (handler
, Qexpand_file_name
,
860 name
, default_directory
);
861 if (STRINGP (handled_name
))
863 error ("Invalid handler in `file-name-handler-alist'");
868 char *o
= SSDATA (default_directory
);
870 /* Make sure DEFAULT_DIRECTORY is properly expanded.
871 It would be better to do this down below where we actually use
872 default_directory. Unfortunately, calling Fexpand_file_name recursively
873 could invoke GC, and the strings might be relocated. This would
874 be annoying because we have pointers into strings lying around
875 that would need adjusting, and people would add new pointers to
876 the code and forget to adjust them, resulting in intermittent bugs.
877 Putting this call here avoids all that crud.
879 The EQ test avoids infinite recursion. */
880 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
881 /* Save time in some common cases - as long as default_directory
882 is not relative, it can be canonicalized with name below (if it
883 is needed at all) without requiring it to be expanded now. */
885 /* Detect MSDOS file names with drive specifiers. */
886 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
887 && IS_DIRECTORY_SEP (o
[2]))
889 /* Detect Windows file names in UNC format. */
890 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
892 #else /* not DOS_NT */
893 /* Detect Unix absolute file names (/... alone is not absolute on
895 && ! (IS_DIRECTORY_SEP (o
[0]))
896 #endif /* not DOS_NT */
902 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
906 multibyte
= STRING_MULTIBYTE (name
);
907 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
910 default_directory
= string_to_multibyte (default_directory
);
913 name
= string_to_multibyte (name
);
919 if (!NILP (Vw32_downcase_file_names
))
920 default_directory
= Fdowncase (default_directory
);
923 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
924 nm
= alloca (SBYTES (name
) + 1);
925 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
928 /* Note if special escape prefix is present, but remove for now. */
929 if (nm
[0] == '/' && nm
[1] == ':')
935 /* Find and remove drive specifier if present; this makes nm absolute
936 even if the rest of the name appears to be relative. Only look for
937 drive specifier at the beginning. */
938 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
940 drive
= (unsigned char) nm
[0];
945 /* If we see "c://somedir", we want to strip the first slash after the
946 colon when stripping the drive letter. Otherwise, this expands to
948 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
951 /* Discard any previous drive specifier if nm is now in UNC format. */
952 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
956 #endif /* WINDOWSNT */
959 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
960 none are found, we can probably return right away. We will avoid
961 allocating a new string if name is already fully expanded. */
963 IS_DIRECTORY_SEP (nm
[0])
965 && drive
&& !is_escaped
968 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
972 /* If it turns out that the filename we want to return is just a
973 suffix of FILENAME, we don't need to go through and edit
974 things; we just need to construct a new string using data
975 starting at the middle of FILENAME. If we set LOSE, that
976 means we've discovered that we can't do that cool trick. */
982 /* Since we know the name is absolute, we can assume that each
983 element starts with a "/". */
985 /* "." and ".." are hairy. */
986 if (IS_DIRECTORY_SEP (p
[0])
988 && (IS_DIRECTORY_SEP (p
[2])
990 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
993 /* We want to replace multiple `/' in a row with a single
996 && IS_DIRECTORY_SEP (p
[0])
997 && IS_DIRECTORY_SEP (p
[1]))
1004 /* Make sure directories are all separated with /, but
1005 avoid allocation of a new string when not required. */
1006 dostounix_filename (nm
, multibyte
);
1008 if (IS_DIRECTORY_SEP (nm
[1]))
1010 if (strcmp (nm
, SSDATA (name
)) != 0)
1011 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1015 /* Drive must be set, so this is okay. */
1016 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1020 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1021 temp
[0] = DRIVE_LETTER (drive
);
1022 name
= concat2 (build_string (temp
), name
);
1025 if (!NILP (Vw32_downcase_file_names
))
1026 name
= Fdowncase (name
);
1029 #else /* not DOS_NT */
1030 if (strcmp (nm
, SSDATA (name
)) == 0)
1032 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1033 #endif /* not DOS_NT */
1037 /* At this point, nm might or might not be an absolute file name. We
1038 need to expand ~ or ~user if present, otherwise prefix nm with
1039 default_directory if nm is not absolute, and finally collapse /./
1040 and /foo/../ sequences.
1042 We set newdir to be the appropriate prefix if one is needed:
1043 - the relevant user directory if nm starts with ~ or ~user
1044 - the specified drive's working dir (DOS/NT only) if nm does not
1046 - the value of default_directory.
1048 Note that these prefixes are not guaranteed to be absolute (except
1049 for the working dir of a drive). Therefore, to ensure we always
1050 return an absolute name, if the final prefix is not absolute we
1051 append it to the current working directory. */
1055 if (nm
[0] == '~') /* prefix ~ */
1057 if (IS_DIRECTORY_SEP (nm
[1])
1058 || nm
[1] == 0) /* ~ by itself */
1062 if (!(newdir
= egetenv ("HOME")))
1065 /* `egetenv' may return a unibyte string, which will bite us since
1066 we expect the directory to be multibyte. */
1067 tem
= build_string (newdir
);
1068 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1070 hdir
= DECODE_FILE (tem
);
1071 newdir
= SSDATA (hdir
);
1074 collapse_newdir
= 0;
1077 else /* ~user/filename */
1080 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1081 o
= alloca (p
- nm
+ 1);
1082 memcpy (o
, nm
, p
- nm
);
1086 pw
= getpwnam (o
+ 1);
1092 newdir
= pw
->pw_dir
;
1093 /* `getpwnam' may return a unibyte string, which will
1094 bite us since we expect the directory to be
1096 tem
= build_string (newdir
);
1097 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1099 hdir
= DECODE_FILE (tem
);
1100 newdir
= SSDATA (hdir
);
1104 collapse_newdir
= 0;
1108 /* If we don't find a user of that name, leave the name
1109 unchanged; don't move nm forward to p. */
1114 /* On DOS and Windows, nm is absolute if a drive name was specified;
1115 use the drive's current directory as the prefix if needed. */
1116 if (!newdir
&& drive
)
1118 /* Get default directory if needed to make nm absolute. */
1120 if (!IS_DIRECTORY_SEP (nm
[0]))
1122 adir
= alloca (MAXPATHLEN
+ 1);
1123 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1127 Lisp_Object tem
= build_string (adir
);
1129 tem
= DECODE_FILE (tem
);
1130 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1135 /* Either nm starts with /, or drive isn't mounted. */
1137 adir
[0] = DRIVE_LETTER (drive
);
1146 /* Finally, if no prefix has been specified and nm is not absolute,
1147 then it must be expanded relative to default_directory. */
1151 /* /... alone is not absolute on DOS and Windows. */
1152 && !IS_DIRECTORY_SEP (nm
[0])
1155 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1159 newdir
= SSDATA (default_directory
);
1161 /* Note if special escape prefix is present, but remove for now. */
1162 if (newdir
[0] == '/' && newdir
[1] == ':')
1173 /* First ensure newdir is an absolute name. */
1175 /* Detect MSDOS file names with drive specifiers. */
1176 ! (IS_DRIVE (newdir
[0])
1177 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1179 /* Detect Windows file names in UNC format. */
1180 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1184 /* Effectively, let newdir be (expand-file-name newdir cwd).
1185 Because of the admonition against calling expand-file-name
1186 when we have pointers into lisp strings, we accomplish this
1187 indirectly by prepending newdir to nm if necessary, and using
1188 cwd (or the wd of newdir's drive) as the new newdir. */
1191 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1193 drive
= (unsigned char) newdir
[0];
1196 if (!IS_DIRECTORY_SEP (nm
[0]))
1198 ptrdiff_t newlen
= strlen (newdir
);
1199 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1200 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1204 adir
= alloca (MAXPATHLEN
+ 1);
1207 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1211 getcwd (adir
, MAXPATHLEN
+ 1);
1214 Lisp_Object tem
= build_string (adir
);
1216 tem
= DECODE_FILE (tem
);
1217 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1222 /* Strip off drive name from prefix, if present. */
1223 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1229 /* Keep only a prefix from newdir if nm starts with slash
1230 (//server/share for UNC, nothing otherwise). */
1231 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1234 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1236 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1238 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1240 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1253 /* Get rid of any slash at the end of newdir, unless newdir is
1254 just / or // (an incomplete UNC name). */
1255 length
= strlen (newdir
);
1257 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1259 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1263 char *temp
= alloca (length
);
1264 memcpy (temp
, newdir
, length
- 1);
1265 temp
[length
- 1] = 0;
1276 /* Now concatenate the directory and name to new space in the stack frame. */
1277 tlen
+= strlen (nm
) + 1;
1279 /* Reserve space for drive specifier and escape prefix, since either
1280 or both may need to be inserted. (The Microsoft x86 compiler
1281 produces incorrect code if the following two lines are combined.) */
1282 target
= alloca (tlen
+ 4);
1284 #else /* not DOS_NT */
1285 target
= alloca (tlen
);
1286 #endif /* not DOS_NT */
1291 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1294 /* If newdir is effectively "C:/", then the drive letter will have
1295 been stripped and newdir will be "/". Concatenating with an
1296 absolute directory in nm produces "//", which will then be
1297 incorrectly treated as a network share. Ignore newdir in
1298 this case (keeping the drive letter). */
1299 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1300 && newdir
[1] == '\0'))
1302 strcpy (target
, newdir
);
1305 file_name_as_directory (target
, newdir
, length
, multibyte
);
1308 strcat (target
, nm
);
1310 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1318 if (!IS_DIRECTORY_SEP (*p
))
1322 else if (p
[1] == '.'
1323 && (IS_DIRECTORY_SEP (p
[2])
1326 /* If "/." is the entire filename, keep the "/". Otherwise,
1327 just delete the whole "/.". */
1328 if (o
== target
&& p
[2] == '\0')
1332 else if (p
[1] == '.' && p
[2] == '.'
1333 /* `/../' is the "superroot" on certain file systems.
1334 Turned off on DOS_NT systems because they have no
1335 "superroot" and because this causes us to produce
1336 file names like "d:/../foo" which fail file-related
1337 functions of the underlying OS. (To reproduce, try a
1338 long series of "../../" in default_directory, longer
1339 than the number of levels from the root.) */
1343 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1348 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1351 /* Don't go below server level in UNC filenames. */
1352 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1353 && IS_DIRECTORY_SEP (*target
))
1357 /* Keep initial / only if this is the whole name. */
1358 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1362 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1363 /* Collapse multiple `/' in a row. */
1372 /* At last, set drive name. */
1374 /* Except for network file name. */
1375 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1376 #endif /* WINDOWSNT */
1378 if (!drive
) emacs_abort ();
1380 target
[0] = DRIVE_LETTER (drive
);
1383 /* Reinsert the escape prefix if required. */
1390 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1391 dostounix_filename (SSDATA (result
), multibyte
);
1393 if (!NILP (Vw32_downcase_file_names
))
1394 result
= Fdowncase (result
);
1397 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1398 #endif /* !DOS_NT */
1401 /* Again look to see if the file name has special constructs in it
1402 and perhaps call the corresponding file handler. This is needed
1403 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1404 the ".." component gives us "/user@host:/bar/../baz" which needs
1405 to be expanded again. */
1406 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1407 if (!NILP (handler
))
1409 handled_name
= call3 (handler
, Qexpand_file_name
,
1410 result
, default_directory
);
1411 if (STRINGP (handled_name
))
1412 return handled_name
;
1413 error ("Invalid handler in `file-name-handler-alist'");
1420 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1421 This is the old version of expand-file-name, before it was thoroughly
1422 rewritten for Emacs 10.31. We leave this version here commented-out,
1423 because the code is very complex and likely to have subtle bugs. If
1424 bugs _are_ found, it might be of interest to look at the old code and
1425 see what did it do in the relevant situation.
1427 Don't remove this code: it's true that it will be accessible
1428 from the repository, but a few years from deletion, people will
1429 forget it is there. */
1431 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1432 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1433 "Convert FILENAME to absolute, and canonicalize it.\n\
1434 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1435 \(does not start with slash); if DEFAULT is nil or missing,\n\
1436 the current buffer's value of default-directory is used.\n\
1437 Filenames containing `.' or `..' as components are simplified;\n\
1438 initial `~/' expands to your home directory.\n\
1439 See also the function `substitute-in-file-name'.")
1441 Lisp_Object name
, defalt
;
1445 register unsigned char *newdir
, *p
, *o
;
1447 unsigned char *target
;
1450 CHECK_STRING (name
);
1453 /* If nm is absolute, flush ...// and detect /./ and /../.
1454 If no /./ or /../ we can return right away. */
1461 if (p
[0] == '/' && p
[1] == '/')
1463 if (p
[0] == '/' && p
[1] == '~')
1464 nm
= p
+ 1, lose
= 1;
1465 if (p
[0] == '/' && p
[1] == '.'
1466 && (p
[2] == '/' || p
[2] == 0
1467 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1473 if (nm
== SDATA (name
))
1475 return build_string (nm
);
1479 /* Now determine directory to start with and put it in NEWDIR. */
1483 if (nm
[0] == '~') /* prefix ~ */
1484 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1486 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1487 newdir
= (unsigned char *) "";
1490 else /* ~user/filename */
1492 /* Get past ~ to user. */
1493 unsigned char *user
= nm
+ 1;
1494 /* Find end of name. */
1495 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1496 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1497 /* Copy the user name into temp storage. */
1498 o
= alloca (len
+ 1);
1499 memcpy (o
, user
, len
);
1502 /* Look up the user name. */
1504 pw
= (struct passwd
*) getpwnam (o
+ 1);
1507 error ("\"%s\" isn't a registered user", o
+ 1);
1509 newdir
= (unsigned char *) pw
->pw_dir
;
1511 /* Discard the user name from NM. */
1515 if (nm
[0] != '/' && !newdir
)
1518 defalt
= current_buffer
->directory
;
1519 CHECK_STRING (defalt
);
1520 newdir
= SDATA (defalt
);
1523 /* Now concatenate the directory and name to new space in the stack frame. */
1525 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1526 target
= alloca (tlen
);
1531 if (nm
[0] == 0 || nm
[0] == '/')
1532 strcpy (target
, newdir
);
1534 file_name_as_directory (target
, newdir
);
1537 strcat (target
, nm
);
1539 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1550 else if (!strncmp (p
, "//", 2)
1556 else if (p
[0] == '/' && p
[1] == '.'
1557 && (p
[2] == '/' || p
[2] == 0))
1559 else if (!strncmp (p
, "/..", 3)
1560 /* `/../' is the "superroot" on certain file systems. */
1562 && (p
[3] == '/' || p
[3] == 0))
1564 while (o
!= target
&& *--o
!= '/')
1566 if (o
== target
&& *o
== '/')
1576 return make_string (target
, o
- target
);
1580 /* If /~ or // appears, discard everything through first slash. */
1582 file_name_absolute_p (const char *filename
)
1585 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1587 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1588 && IS_DIRECTORY_SEP (filename
[2]))
1594 search_embedded_absfilename (char *nm
, char *endp
)
1598 for (p
= nm
+ 1; p
< endp
; p
++)
1600 if (IS_DIRECTORY_SEP (p
[-1])
1601 && file_name_absolute_p (p
)
1602 #if defined (WINDOWSNT) || defined (CYGWIN)
1603 /* // at start of file name is meaningful in Apollo,
1604 WindowsNT and Cygwin systems. */
1605 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1606 #endif /* not (WINDOWSNT || CYGWIN) */
1609 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1610 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1612 char *o
= alloca (s
- p
+ 1);
1614 memcpy (o
, p
, s
- p
);
1617 /* If we have ~user and `user' exists, discard
1618 everything up to ~. But if `user' does not exist, leave
1619 ~user alone, it might be a literal file name. */
1621 pw
= getpwnam (o
+ 1);
1633 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1634 Ssubstitute_in_file_name
, 1, 1, 0,
1635 doc
: /* Substitute environment variables referred to in FILENAME.
1636 `$FOO' where FOO is an environment variable name means to substitute
1637 the value of that variable. The variable name should be terminated
1638 with a character not a letter, digit or underscore; otherwise, enclose
1639 the entire variable name in braces.
1641 If `/~' appears, all of FILENAME through that `/' is discarded.
1642 If `//' appears, everything up to and including the first of
1643 those `/' is discarded. */)
1644 (Lisp_Object filename
)
1646 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1647 char *target
= NULL
;
1648 ptrdiff_t total
= 0;
1649 bool substituted
= 0;
1652 Lisp_Object handler
;
1654 CHECK_STRING (filename
);
1656 multibyte
= STRING_MULTIBYTE (filename
);
1658 /* If the file name has special constructs in it,
1659 call the corresponding file handler. */
1660 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1661 if (!NILP (handler
))
1663 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1665 if (STRINGP (handled_name
))
1666 return handled_name
;
1667 error ("Invalid handler in `file-name-handler-alist'");
1670 /* Always work on a copy of the string, in case GC happens during
1671 decode of environment variables, causing the original Lisp_String
1672 data to be relocated. */
1673 nm
= alloca (SBYTES (filename
) + 1);
1674 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1677 dostounix_filename (nm
, multibyte
);
1678 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1680 endp
= nm
+ SBYTES (filename
);
1682 /* If /~ or // appears, discard everything through first slash. */
1683 p
= search_embedded_absfilename (nm
, endp
);
1685 /* Start over with the new string, so we check the file-name-handler
1686 again. Important with filenames like "/home/foo//:/hello///there"
1687 which would substitute to "/:/hello///there" rather than "/there". */
1688 return Fsubstitute_in_file_name
1689 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1691 /* See if any variables are substituted into the string
1692 and find the total length of their values in `total'. */
1694 for (p
= nm
; p
!= endp
;)
1704 /* "$$" means a single "$". */
1713 p
= memchr (p
, '}', endp
- p
);
1721 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1725 /* Copy out the variable name. */
1726 target
= alloca (s
- o
+ 1);
1727 memcpy (target
, o
, s
- o
);
1730 strupr (target
); /* $home == $HOME etc. */
1733 /* Get variable value. */
1734 o
= egetenv (target
);
1737 /* Don't try to guess a maximum length - UTF8 can use up to
1738 four bytes per character. This code is unlikely to run
1739 in a situation that requires performance, so decoding the
1740 env variables twice should be acceptable. Note that
1741 decoding may cause a garbage collect. */
1742 Lisp_Object orig
, decoded
;
1743 orig
= build_unibyte_string (o
);
1744 decoded
= DECODE_FILE (orig
);
1745 total
+= SBYTES (decoded
);
1755 if (!NILP (Vw32_downcase_file_names
))
1756 filename
= Fdowncase (filename
);
1761 /* If substitution required, recopy the string and do it. */
1762 /* Make space in stack frame for the new copy. */
1763 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1766 /* Copy the rest of the name through, replacing $ constructs with values. */
1783 p
= memchr (p
, '}', endp
- p
);
1791 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1795 /* Copy out the variable name. */
1796 target
= alloca (s
- o
+ 1);
1797 memcpy (target
, o
, s
- o
);
1800 /* Get variable value. */
1801 o
= egetenv (target
);
1805 strcpy (x
, target
); x
+= strlen (target
);
1809 Lisp_Object orig
, decoded
;
1810 ptrdiff_t orig_length
, decoded_length
;
1811 orig_length
= strlen (o
);
1812 orig
= make_unibyte_string (o
, orig_length
);
1813 decoded
= DECODE_FILE (orig
);
1814 decoded_length
= SBYTES (decoded
);
1815 memcpy (x
, SDATA (decoded
), decoded_length
);
1816 x
+= decoded_length
;
1818 /* If environment variable needed decoding, return value
1819 needs to be multibyte. */
1820 if (decoded_length
!= orig_length
1821 || memcmp (SDATA (decoded
), o
, orig_length
))
1828 /* If /~ or // appears, discard everything through first slash. */
1829 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1830 /* This time we do not start over because we've already expanded envvars
1831 and replaced $$ with $. Maybe we should start over as well, but we'd
1832 need to quote some $ to $$ first. */
1836 if (!NILP (Vw32_downcase_file_names
))
1838 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1840 xname
= Fdowncase (xname
);
1845 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1848 error ("Bad format environment-variable substitution");
1850 error ("Missing \"}\" in environment-variable substitution");
1852 error ("Substituting nonexistent environment variable \"%s\"", target
);
1858 /* A slightly faster and more convenient way to get
1859 (directory-file-name (expand-file-name FOO)). */
1862 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1864 register Lisp_Object absname
;
1866 absname
= Fexpand_file_name (filename
, defdir
);
1868 /* Remove final slash, if any (unless this is the root dir).
1869 stat behaves differently depending! */
1870 if (SCHARS (absname
) > 1
1871 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1872 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1873 /* We cannot take shortcuts; they might be wrong for magic file names. */
1874 absname
= Fdirectory_file_name (absname
);
1878 /* Signal an error if the file ABSNAME already exists.
1879 If INTERACTIVE, ask the user whether to proceed,
1880 and bypass the error if the user says to go ahead.
1881 QUERYSTRING is a name for the action that is being considered
1884 *STATPTR is used to store the stat information if the file exists.
1885 If the file does not exist, STATPTR->st_mode is set to 0.
1886 If STATPTR is null, we don't store into it.
1888 If QUICK, ask for y or n, not yes or no. */
1891 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1892 bool interactive
, struct stat
*statptr
,
1895 Lisp_Object tem
, encoded_filename
;
1896 struct stat statbuf
;
1897 struct gcpro gcpro1
;
1899 encoded_filename
= ENCODE_FILE (absname
);
1901 /* `stat' is a good way to tell whether the file exists,
1902 regardless of what access permissions it has. */
1903 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1905 if (S_ISDIR (statbuf
.st_mode
))
1906 xsignal2 (Qfile_error
,
1907 build_string ("File is a directory"), absname
);
1910 xsignal2 (Qfile_already_exists
,
1911 build_string ("File already exists"), absname
);
1913 tem
= format2 ("File %s already exists; %s anyway? ",
1914 absname
, build_string (querystring
));
1916 tem
= call1 (intern ("y-or-n-p"), tem
);
1918 tem
= do_yes_or_no_p (tem
);
1921 xsignal2 (Qfile_already_exists
,
1922 build_string ("File already exists"), absname
);
1929 statptr
->st_mode
= 0;
1934 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1935 "fCopy file: \nGCopy %s to file: \np\nP",
1936 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1937 If NEWNAME names a directory, copy FILE there.
1939 This function always sets the file modes of the output file to match
1942 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1943 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1944 signal a `file-already-exists' error without overwriting. If
1945 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1946 about overwriting; this is what happens in interactive use with M-x.
1947 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1950 Fourth arg KEEP-TIME non-nil means give the output file the same
1951 last-modified time as the old one. (This works on only some systems.)
1953 A prefix arg makes KEEP-TIME non-nil.
1955 If PRESERVE-UID-GID is non-nil, we try to transfer the
1956 uid and gid of FILE to NEWNAME.
1958 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1959 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1960 entries (depending on how Emacs was built). */)
1961 (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
)
1965 char buf
[16 * 1024];
1966 struct stat st
, out_st
;
1967 Lisp_Object handler
;
1968 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1969 ptrdiff_t count
= SPECPDL_INDEX ();
1970 Lisp_Object encoded_file
, encoded_newname
;
1972 security_context_t con
;
1975 #ifdef HAVE_POSIX_ACL
1979 encoded_file
= encoded_newname
= Qnil
;
1980 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1981 CHECK_STRING (file
);
1982 CHECK_STRING (newname
);
1984 if (!NILP (Ffile_directory_p (newname
)))
1985 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1987 newname
= Fexpand_file_name (newname
, Qnil
);
1989 file
= Fexpand_file_name (file
, Qnil
);
1991 /* If the input file name has special constructs in it,
1992 call the corresponding file handler. */
1993 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1994 /* Likewise for output file name. */
1996 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1997 if (!NILP (handler
))
1998 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1999 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
2000 preserve_extended_attributes
));
2002 encoded_file
= ENCODE_FILE (file
);
2003 encoded_newname
= ENCODE_FILE (newname
);
2005 if (NILP (ok_if_already_exists
)
2006 || INTEGERP (ok_if_already_exists
))
2007 barf_or_query_if_file_exists (newname
, "copy to it",
2008 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2009 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
2013 if (!NILP (preserve_extended_attributes
))
2015 #ifdef HAVE_POSIX_ACL
2016 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2017 if (acl
== NULL
&& errno
!= ENOTSUP
)
2018 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2021 if (!CopyFile (SDATA (encoded_file
),
2022 SDATA (encoded_newname
),
2025 /* CopyFile doesn't set errno when it fails. By far the most
2026 "popular" reason is that the target is read-only. */
2027 if (GetLastError () == 5)
2031 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2033 /* CopyFile retains the timestamp by default. */
2034 else if (NILP (keep_time
))
2040 filename
= SDATA (encoded_newname
);
2042 /* Ensure file is writable while its modified time is set. */
2043 attributes
= GetFileAttributes (filename
);
2044 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2045 now
= current_emacs_time ();
2046 if (set_file_times (-1, filename
, now
, now
))
2048 /* Restore original attributes. */
2049 SetFileAttributes (filename
, attributes
);
2050 xsignal2 (Qfile_date_error
,
2051 build_string ("Cannot set file date"), newname
);
2053 /* Restore original attributes. */
2054 SetFileAttributes (filename
, attributes
);
2056 #ifdef HAVE_POSIX_ACL
2060 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2061 if (fail
&& errno
!= ENOTSUP
)
2062 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2067 #else /* not WINDOWSNT */
2069 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2073 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2075 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2077 if (fstat (ifd
, &st
) != 0)
2078 report_file_error ("Input file status", Fcons (file
, Qnil
));
2080 if (!NILP (preserve_extended_attributes
))
2083 if (is_selinux_enabled ())
2085 conlength
= fgetfilecon (ifd
, &con
);
2086 if (conlength
== -1)
2087 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
2091 #ifdef HAVE_POSIX_ACL
2092 acl
= acl_get_fd (ifd
);
2093 if (acl
== NULL
&& errno
!= ENOTSUP
)
2094 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2098 if (out_st
.st_mode
!= 0
2099 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2102 report_file_error ("Input and output files are the same",
2103 Fcons (file
, Fcons (newname
, Qnil
)));
2106 /* We can copy only regular files. */
2107 if (!S_ISREG (st
.st_mode
))
2109 /* Get a better looking error message. */
2110 errno
= S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
;
2111 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2115 /* System's default file type was set to binary by _fmode in emacs.c. */
2116 ofd
= emacs_open (SDATA (encoded_newname
),
2117 O_WRONLY
| O_TRUNC
| O_CREAT
2118 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2119 S_IREAD
| S_IWRITE
);
2120 #else /* not MSDOS */
2122 mode_t new_mask
= !NILP (preserve_uid_gid
) ? 0600 : 0666;
2123 new_mask
&= st
.st_mode
;
2124 ofd
= emacs_open (SSDATA (encoded_newname
),
2125 (O_WRONLY
| O_TRUNC
| O_CREAT
2126 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2129 #endif /* not MSDOS */
2131 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2133 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2137 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2138 if (emacs_write (ofd
, buf
, n
) != n
)
2139 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2143 /* Preserve the original file modes, and if requested, also its
2146 mode_t mode_mask
= 07777;
2147 if (!NILP (preserve_uid_gid
))
2149 /* Attempt to change owner and group. If that doesn't work
2150 attempt to change just the group, as that is sometimes allowed.
2151 Adjust the mode mask to eliminate setuid or setgid bits
2152 that are inappropriate if the owner and group are wrong. */
2153 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2155 mode_mask
&= ~06000;
2156 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2160 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2161 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2163 #endif /* not MSDOS */
2168 /* Set the modified context back to the file. */
2169 bool fail
= fsetfilecon (ofd
, con
) != 0;
2170 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2171 if (fail
&& errno
!= ENOTSUP
)
2172 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2178 #ifdef HAVE_POSIX_ACL
2181 bool fail
= acl_set_fd (ofd
, acl
) != 0;
2182 if (fail
&& errno
!= ENOTSUP
)
2183 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2189 if (!NILP (keep_time
))
2191 EMACS_TIME atime
= get_stat_atime (&st
);
2192 EMACS_TIME mtime
= get_stat_mtime (&st
);
2193 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2194 xsignal2 (Qfile_date_error
,
2195 build_string ("Cannot set file date"), newname
);
2198 if (emacs_close (ofd
) < 0)
2199 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2204 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2205 and if it can't, it tells so. Otherwise, under MSDOS we usually
2206 get only the READ bit, which will make the copied file read-only,
2207 so it's better not to chmod at all. */
2208 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2209 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2211 #endif /* not WINDOWSNT */
2213 /* Discard the unwind protects. */
2214 specpdl_ptr
= specpdl
+ count
;
2220 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2221 Smake_directory_internal
, 1, 1, 0,
2222 doc
: /* Create a new directory named DIRECTORY. */)
2223 (Lisp_Object directory
)
2226 Lisp_Object handler
;
2227 Lisp_Object encoded_dir
;
2229 CHECK_STRING (directory
);
2230 directory
= Fexpand_file_name (directory
, Qnil
);
2232 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2233 if (!NILP (handler
))
2234 return call2 (handler
, Qmake_directory_internal
, directory
);
2236 encoded_dir
= ENCODE_FILE (directory
);
2238 dir
= SSDATA (encoded_dir
);
2241 if (mkdir (dir
) != 0)
2243 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2245 report_file_error ("Creating directory", list1 (directory
));
2250 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2251 Sdelete_directory_internal
, 1, 1, 0,
2252 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2253 (Lisp_Object directory
)
2256 Lisp_Object encoded_dir
;
2258 CHECK_STRING (directory
);
2259 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2260 encoded_dir
= ENCODE_FILE (directory
);
2261 dir
= SSDATA (encoded_dir
);
2263 if (rmdir (dir
) != 0)
2264 report_file_error ("Removing directory", list1 (directory
));
2269 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2270 "(list (read-file-name \
2271 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2272 \"Move file to trash: \" \"Delete file: \") \
2273 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2274 (null current-prefix-arg))",
2275 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2276 If file has multiple names, it continues to exist with the other names.
2277 TRASH non-nil means to trash the file instead of deleting, provided
2278 `delete-by-moving-to-trash' is non-nil.
2280 When called interactively, TRASH is t if no prefix argument is given.
2281 With a prefix argument, TRASH is nil. */)
2282 (Lisp_Object filename
, Lisp_Object trash
)
2284 Lisp_Object handler
;
2285 Lisp_Object encoded_file
;
2286 struct gcpro gcpro1
;
2289 if (!NILP (Ffile_directory_p (filename
))
2290 && NILP (Ffile_symlink_p (filename
)))
2291 xsignal2 (Qfile_error
,
2292 build_string ("Removing old name: is a directory"),
2295 filename
= Fexpand_file_name (filename
, Qnil
);
2297 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2298 if (!NILP (handler
))
2299 return call3 (handler
, Qdelete_file
, filename
, trash
);
2301 if (delete_by_moving_to_trash
&& !NILP (trash
))
2302 return call1 (Qmove_file_to_trash
, filename
);
2304 encoded_file
= ENCODE_FILE (filename
);
2306 if (unlink (SSDATA (encoded_file
)) < 0)
2307 report_file_error ("Removing old name", list1 (filename
));
2312 internal_delete_file_1 (Lisp_Object ignore
)
2317 /* Delete file FILENAME, returning true if successful.
2318 This ignores `delete-by-moving-to-trash'. */
2321 internal_delete_file (Lisp_Object filename
)
2325 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2326 Qt
, internal_delete_file_1
);
2330 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2331 "fRename file: \nGRename %s to file: \np",
2332 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2333 If file has names other than FILE, it continues to have those names.
2334 Signals a `file-already-exists' error if a file NEWNAME already exists
2335 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2336 A number as third arg means request confirmation if NEWNAME already exists.
2337 This is what happens in interactive use with M-x. */)
2338 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2340 Lisp_Object handler
;
2341 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2342 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2344 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2345 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2346 CHECK_STRING (file
);
2347 CHECK_STRING (newname
);
2348 file
= Fexpand_file_name (file
, Qnil
);
2350 if ((!NILP (Ffile_directory_p (newname
)))
2352 /* If the file names are identical but for the case,
2353 don't attempt to move directory to itself. */
2354 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2358 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2359 ? file
: Fdirectory_file_name (file
));
2360 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2363 newname
= Fexpand_file_name (newname
, Qnil
);
2365 /* If the file name has special constructs in it,
2366 call the corresponding file handler. */
2367 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2369 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2370 if (!NILP (handler
))
2371 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2372 file
, newname
, ok_if_already_exists
));
2374 encoded_file
= ENCODE_FILE (file
);
2375 encoded_newname
= ENCODE_FILE (newname
);
2378 /* If the file names are identical but for the case, don't ask for
2379 confirmation: they simply want to change the letter-case of the
2381 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2383 if (NILP (ok_if_already_exists
)
2384 || INTEGERP (ok_if_already_exists
))
2385 barf_or_query_if_file_exists (newname
, "rename to it",
2386 INTEGERP (ok_if_already_exists
), 0, 0);
2387 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2392 symlink_target
= Ffile_symlink_p (file
);
2393 if (! NILP (symlink_target
))
2394 Fmake_symbolic_link (symlink_target
, newname
,
2395 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2396 else if (!NILP (Ffile_directory_p (file
)))
2397 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2399 /* We have already prompted if it was an integer, so don't
2400 have copy-file prompt again. */
2401 Fcopy_file (file
, newname
,
2402 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2405 count
= SPECPDL_INDEX ();
2406 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2408 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2409 call2 (Qdelete_directory
, file
, Qt
);
2411 Fdelete_file (file
, Qnil
);
2412 unbind_to (count
, Qnil
);
2415 report_file_error ("Renaming", list2 (file
, newname
));
2421 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2422 "fAdd name to file: \nGName to add to %s: \np",
2423 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2424 Signals a `file-already-exists' error if a file NEWNAME already exists
2425 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2426 A number as third arg means request confirmation if NEWNAME already exists.
2427 This is what happens in interactive use with M-x. */)
2428 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2430 Lisp_Object handler
;
2431 Lisp_Object encoded_file
, encoded_newname
;
2432 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2434 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2435 encoded_file
= encoded_newname
= Qnil
;
2436 CHECK_STRING (file
);
2437 CHECK_STRING (newname
);
2438 file
= Fexpand_file_name (file
, Qnil
);
2440 if (!NILP (Ffile_directory_p (newname
)))
2441 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2443 newname
= Fexpand_file_name (newname
, Qnil
);
2445 /* If the file name has special constructs in it,
2446 call the corresponding file handler. */
2447 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2448 if (!NILP (handler
))
2449 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2450 newname
, ok_if_already_exists
));
2452 /* If the new name has special constructs in it,
2453 call the corresponding file handler. */
2454 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2455 if (!NILP (handler
))
2456 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2457 newname
, ok_if_already_exists
));
2459 encoded_file
= ENCODE_FILE (file
);
2460 encoded_newname
= ENCODE_FILE (newname
);
2462 if (NILP (ok_if_already_exists
)
2463 || INTEGERP (ok_if_already_exists
))
2464 barf_or_query_if_file_exists (newname
, "make it a new name",
2465 INTEGERP (ok_if_already_exists
), 0, 0);
2467 unlink (SSDATA (newname
));
2468 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2469 report_file_error ("Adding new name", list2 (file
, newname
));
2475 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2476 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2477 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2478 Both args must be strings.
2479 Signals a `file-already-exists' error if a file LINKNAME already exists
2480 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2481 A number as third arg means request confirmation if LINKNAME already exists.
2482 This happens for interactive use with M-x. */)
2483 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2485 Lisp_Object handler
;
2486 Lisp_Object encoded_filename
, encoded_linkname
;
2487 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2489 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2490 encoded_filename
= encoded_linkname
= Qnil
;
2491 CHECK_STRING (filename
);
2492 CHECK_STRING (linkname
);
2493 /* If the link target has a ~, we must expand it to get
2494 a truly valid file name. Otherwise, do not expand;
2495 we want to permit links to relative file names. */
2496 if (SREF (filename
, 0) == '~')
2497 filename
= Fexpand_file_name (filename
, Qnil
);
2499 if (!NILP (Ffile_directory_p (linkname
)))
2500 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2502 linkname
= Fexpand_file_name (linkname
, Qnil
);
2504 /* If the file name has special constructs in it,
2505 call the corresponding file handler. */
2506 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2507 if (!NILP (handler
))
2508 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2509 linkname
, ok_if_already_exists
));
2511 /* If the new link name has special constructs in it,
2512 call the corresponding file handler. */
2513 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2514 if (!NILP (handler
))
2515 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2516 linkname
, ok_if_already_exists
));
2518 encoded_filename
= ENCODE_FILE (filename
);
2519 encoded_linkname
= ENCODE_FILE (linkname
);
2521 if (NILP (ok_if_already_exists
)
2522 || INTEGERP (ok_if_already_exists
))
2523 barf_or_query_if_file_exists (linkname
, "make it a link",
2524 INTEGERP (ok_if_already_exists
), 0, 0);
2525 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2527 /* If we didn't complain already, silently delete existing file. */
2528 if (errno
== EEXIST
)
2530 unlink (SSDATA (encoded_linkname
));
2531 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2538 if (errno
== ENOSYS
)
2541 xsignal1 (Qfile_error
,
2542 build_string ("Symbolic links are not supported"));
2545 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2552 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2554 doc
: /* Return t if file FILENAME specifies an absolute file name.
2555 On Unix, this is a name starting with a `/' or a `~'. */)
2556 (Lisp_Object filename
)
2558 CHECK_STRING (filename
);
2559 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2562 /* Return true if FILENAME exists. */
2564 check_existing (const char *filename
)
2566 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2569 /* Return true if file FILENAME exists and can be executed. */
2572 check_executable (char *filename
)
2574 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2577 /* Return true if file FILENAME exists and can be accessed
2578 according to AMODE, which should include W_OK.
2579 On failure, return false and set errno. */
2582 check_writable (const char *filename
, int amode
)
2585 /* FIXME: an faccessat implementation should be added to the
2586 DOS/Windows ports and this #ifdef branch should be removed. */
2588 if (stat (filename
, &st
) < 0)
2591 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2592 #else /* not MSDOS */
2593 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2595 /* faccessat may have returned failure because Cygwin couldn't
2596 determine the file's UID or GID; if so, we return success. */
2599 int faccessat_errno
= errno
;
2601 if (stat (filename
, &st
) < 0)
2603 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2604 errno
= faccessat_errno
;
2608 #endif /* not MSDOS */
2611 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2612 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2613 See also `file-readable-p' and `file-attributes'.
2614 This returns nil for a symlink to a nonexistent file.
2615 Use `file-symlink-p' to test for such links. */)
2616 (Lisp_Object filename
)
2618 Lisp_Object absname
;
2619 Lisp_Object handler
;
2621 CHECK_STRING (filename
);
2622 absname
= Fexpand_file_name (filename
, Qnil
);
2624 /* If the file name has special constructs in it,
2625 call the corresponding file handler. */
2626 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2627 if (!NILP (handler
))
2628 return call2 (handler
, Qfile_exists_p
, absname
);
2630 absname
= ENCODE_FILE (absname
);
2632 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2635 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2636 doc
: /* Return t if FILENAME can be executed by you.
2637 For a directory, this means you can access files in that directory. */)
2638 (Lisp_Object filename
)
2640 Lisp_Object absname
;
2641 Lisp_Object handler
;
2643 CHECK_STRING (filename
);
2644 absname
= Fexpand_file_name (filename
, Qnil
);
2646 /* If the file name has special constructs in it,
2647 call the corresponding file handler. */
2648 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2649 if (!NILP (handler
))
2650 return call2 (handler
, Qfile_executable_p
, absname
);
2652 absname
= ENCODE_FILE (absname
);
2654 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2657 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2658 doc
: /* Return t if file FILENAME exists and you can read it.
2659 See also `file-exists-p' and `file-attributes'. */)
2660 (Lisp_Object filename
)
2662 Lisp_Object absname
;
2663 Lisp_Object handler
;
2665 CHECK_STRING (filename
);
2666 absname
= Fexpand_file_name (filename
, Qnil
);
2668 /* If the file name has special constructs in it,
2669 call the corresponding file handler. */
2670 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2671 if (!NILP (handler
))
2672 return call2 (handler
, Qfile_readable_p
, absname
);
2674 absname
= ENCODE_FILE (absname
);
2675 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2679 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2680 doc
: /* Return t if file FILENAME can be written or created by you. */)
2681 (Lisp_Object filename
)
2683 Lisp_Object absname
, dir
, encoded
;
2684 Lisp_Object handler
;
2686 CHECK_STRING (filename
);
2687 absname
= Fexpand_file_name (filename
, Qnil
);
2689 /* If the file name has special constructs in it,
2690 call the corresponding file handler. */
2691 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2692 if (!NILP (handler
))
2693 return call2 (handler
, Qfile_writable_p
, absname
);
2695 encoded
= ENCODE_FILE (absname
);
2696 if (check_writable (SSDATA (encoded
), W_OK
))
2698 if (errno
!= ENOENT
)
2701 dir
= Ffile_name_directory (absname
);
2702 eassert (!NILP (dir
));
2704 dir
= Fdirectory_file_name (dir
);
2707 dir
= ENCODE_FILE (dir
);
2709 /* The read-only attribute of the parent directory doesn't affect
2710 whether a file or directory can be created within it. Some day we
2711 should check ACLs though, which do affect this. */
2712 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2714 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2718 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2719 doc
: /* Access file FILENAME, and get an error if that does not work.
2720 The second argument STRING is used in the error message.
2721 If there is no error, returns nil. */)
2722 (Lisp_Object filename
, Lisp_Object string
)
2724 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 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2742 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2748 /* Relative to directory FD, return the symbolic link value of FILENAME.
2749 On failure, return nil. */
2751 emacs_readlinkat (int fd
, char const *filename
)
2753 static struct allocator
const emacs_norealloc_allocator
=
2754 { xmalloc
, NULL
, xfree
, memory_full
};
2756 char readlink_buf
[1024];
2757 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2758 &emacs_norealloc_allocator
, readlinkat
);
2762 val
= build_string (buf
);
2763 if (buf
[0] == '/' && strchr (buf
, ':'))
2764 val
= concat2 (build_string ("/:"), val
);
2765 if (buf
!= readlink_buf
)
2767 val
= DECODE_FILE (val
);
2771 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2772 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2773 The value is the link target, as a string.
2774 Otherwise it returns nil.
2776 This function returns t when given the name of a symlink that
2777 points to a nonexistent file. */)
2778 (Lisp_Object filename
)
2780 Lisp_Object handler
;
2782 CHECK_STRING (filename
);
2783 filename
= Fexpand_file_name (filename
, Qnil
);
2785 /* If the file name has special constructs in it,
2786 call the corresponding file handler. */
2787 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2788 if (!NILP (handler
))
2789 return call2 (handler
, Qfile_symlink_p
, filename
);
2791 filename
= ENCODE_FILE (filename
);
2793 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2796 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2797 doc
: /* Return t if FILENAME names an existing directory.
2798 Symbolic links to directories count as directories.
2799 See `file-symlink-p' to distinguish symlinks. */)
2800 (Lisp_Object filename
)
2802 Lisp_Object absname
;
2803 Lisp_Object handler
;
2805 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2807 /* If the file name has special constructs in it,
2808 call the corresponding file handler. */
2809 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2810 if (!NILP (handler
))
2811 return call2 (handler
, Qfile_directory_p
, absname
);
2813 absname
= ENCODE_FILE (absname
);
2815 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2818 /* Return true if FILE is a directory or a symlink to a directory. */
2820 file_directory_p (char const *file
)
2823 /* This is cheaper than 'stat'. */
2824 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2827 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2831 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2832 Sfile_accessible_directory_p
, 1, 1, 0,
2833 doc
: /* Return t if file FILENAME names a directory you can open.
2834 For the value to be t, FILENAME must specify the name of a directory as a file,
2835 and the directory must allow you to open files in it. In order to use a
2836 directory as a buffer's current directory, this predicate must return true.
2837 A directory name spec may be given instead; then the value is t
2838 if the directory so specified exists and really is a readable and
2839 searchable directory. */)
2840 (Lisp_Object filename
)
2842 Lisp_Object absname
;
2843 Lisp_Object handler
;
2845 CHECK_STRING (filename
);
2846 absname
= Fexpand_file_name (filename
, Qnil
);
2848 /* If the file name has special constructs in it,
2849 call the corresponding file handler. */
2850 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2851 if (!NILP (handler
))
2852 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2854 absname
= ENCODE_FILE (absname
);
2855 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2858 /* If FILE is a searchable directory or a symlink to a
2859 searchable directory, return true. Otherwise return
2860 false and set errno to an error number. */
2862 file_accessible_directory_p (char const *file
)
2865 /* There's no need to test whether FILE is searchable, as the
2866 searchable/executable bit is invented on DOS_NT platforms. */
2867 return file_directory_p (file
);
2869 /* On POSIXish platforms, use just one system call; this avoids a
2870 race and is typically faster. */
2871 ptrdiff_t len
= strlen (file
);
2877 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2878 There are three exceptions: "", "/", and "//". Leave "" alone,
2879 as it's invalid. Append only "." to the other two exceptions as
2880 "/" and "//" are distinct on some platforms, whereas "/", "///",
2881 "////", etc. are all equivalent. */
2886 /* Just check for trailing '/' when deciding whether to append '/'.
2887 That's simpler than testing the two special cases "/" and "//",
2888 and it's a safe optimization here. */
2889 char *buf
= SAFE_ALLOCA (len
+ 3);
2890 memcpy (buf
, file
, len
);
2891 strcpy (buf
+ len
, "/." + (file
[len
- 1] == '/'));
2895 ok
= check_existing (dir
);
2896 saved_errno
= errno
;
2898 errno
= saved_errno
;
2903 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2904 doc
: /* Return t if FILENAME names a regular file.
2905 This is the sort of file that holds an ordinary stream of data bytes.
2906 Symbolic links to regular files count as regular files.
2907 See `file-symlink-p' to distinguish symlinks. */)
2908 (Lisp_Object filename
)
2910 register Lisp_Object absname
;
2912 Lisp_Object handler
;
2914 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2916 /* If the file name has special constructs in it,
2917 call the corresponding file handler. */
2918 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2919 if (!NILP (handler
))
2920 return call2 (handler
, Qfile_regular_p
, absname
);
2922 absname
= ENCODE_FILE (absname
);
2927 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2929 /* Tell stat to use expensive method to get accurate info. */
2930 Vw32_get_true_file_attributes
= Qt
;
2931 result
= stat (SDATA (absname
), &st
);
2932 Vw32_get_true_file_attributes
= tem
;
2936 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2939 if (stat (SSDATA (absname
), &st
) < 0)
2941 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2945 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2946 Sfile_selinux_context
, 1, 1, 0,
2947 doc
: /* Return SELinux context of file named FILENAME.
2948 The return value is a list (USER ROLE TYPE RANGE), where the list
2949 elements are strings naming the user, role, type, and range of the
2950 file's SELinux security context.
2952 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2953 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2954 (Lisp_Object filename
)
2956 Lisp_Object absname
;
2957 Lisp_Object values
[4];
2958 Lisp_Object handler
;
2960 security_context_t con
;
2965 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2967 /* If the file name has special constructs in it,
2968 call the corresponding file handler. */
2969 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2970 if (!NILP (handler
))
2971 return call2 (handler
, Qfile_selinux_context
, absname
);
2973 absname
= ENCODE_FILE (absname
);
2980 if (is_selinux_enabled ())
2982 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2985 context
= context_new (con
);
2986 if (context_user_get (context
))
2987 values
[0] = build_string (context_user_get (context
));
2988 if (context_role_get (context
))
2989 values
[1] = build_string (context_role_get (context
));
2990 if (context_type_get (context
))
2991 values
[2] = build_string (context_type_get (context
));
2992 if (context_range_get (context
))
2993 values
[3] = build_string (context_range_get (context
));
2994 context_free (context
);
3000 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
3003 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
3004 Sset_file_selinux_context
, 2, 2, 0,
3005 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
3006 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
3007 elements are strings naming the components of a SELinux context.
3009 Value is t if setting of SELinux context was successful, nil otherwise.
3011 This function does nothing and returns nil if SELinux is disabled,
3012 or if Emacs was not compiled with SELinux support. */)
3013 (Lisp_Object filename
, Lisp_Object context
)
3015 Lisp_Object absname
;
3016 Lisp_Object handler
;
3018 Lisp_Object encoded_absname
;
3019 Lisp_Object user
= CAR_SAFE (context
);
3020 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
3021 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
3022 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
3023 security_context_t con
;
3026 context_t parsed_con
;
3029 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3031 /* If the file name has special constructs in it,
3032 call the corresponding file handler. */
3033 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
3034 if (!NILP (handler
))
3035 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
3038 if (is_selinux_enabled ())
3040 /* Get current file context. */
3041 encoded_absname
= ENCODE_FILE (absname
);
3042 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
3045 parsed_con
= context_new (con
);
3046 /* Change the parts defined in the parameter.*/
3049 if (context_user_set (parsed_con
, SSDATA (user
)))
3050 error ("Doing context_user_set");
3054 if (context_role_set (parsed_con
, SSDATA (role
)))
3055 error ("Doing context_role_set");
3059 if (context_type_set (parsed_con
, SSDATA (type
)))
3060 error ("Doing context_type_set");
3062 if (STRINGP (range
))
3064 if (context_range_set (parsed_con
, SSDATA (range
)))
3065 error ("Doing context_range_set");
3068 /* Set the modified context back to the file. */
3069 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3070 context_str (parsed_con
))
3072 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3073 if (fail
&& errno
!= ENOTSUP
)
3074 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
3076 context_free (parsed_con
);
3078 return fail
? Qnil
: Qt
;
3081 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
3088 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3089 doc
: /* Return ACL entries of file named FILENAME.
3090 The entries are returned in a format suitable for use in `set-file-acl'
3091 but is otherwise undocumented and subject to change.
3092 Return nil if file does not exist or is not accessible, or if Emacs
3093 was unable to determine the ACL entries. */)
3094 (Lisp_Object filename
)
3096 Lisp_Object absname
;
3097 Lisp_Object handler
;
3098 #ifdef HAVE_POSIX_ACL
3100 Lisp_Object acl_string
;
3104 absname
= expand_and_dir_to_file (filename
,
3105 BVAR (current_buffer
, directory
));
3107 /* If the file name has special constructs in it,
3108 call the corresponding file handler. */
3109 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3110 if (!NILP (handler
))
3111 return call2 (handler
, Qfile_acl
, absname
);
3113 #ifdef HAVE_POSIX_ACL
3114 absname
= ENCODE_FILE (absname
);
3116 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3120 str
= acl_to_text (acl
, NULL
);
3127 acl_string
= build_string (str
);
3137 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3139 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3140 ACL-STRING should contain the textual representation of the ACL
3141 entries in a format suitable for the platform.
3143 Value is t if setting of ACL was successful, nil otherwise.
3145 Setting ACL for local files requires Emacs to be built with ACL
3147 (Lisp_Object filename
, Lisp_Object acl_string
)
3149 Lisp_Object absname
;
3150 Lisp_Object handler
;
3151 #ifdef HAVE_POSIX_ACL
3152 Lisp_Object encoded_absname
;
3157 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3159 /* If the file name has special constructs in it,
3160 call the corresponding file handler. */
3161 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3162 if (!NILP (handler
))
3163 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3165 #ifdef HAVE_POSIX_ACL
3166 if (STRINGP (acl_string
))
3168 acl
= acl_from_text (SSDATA (acl_string
));
3171 report_file_error ("Converting ACL", Fcons (absname
, Qnil
));
3175 encoded_absname
= ENCODE_FILE (absname
);
3177 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3180 if (fail
&& errno
!= ENOTSUP
)
3181 report_file_error ("Setting ACL", Fcons (absname
, Qnil
));
3184 return fail
? Qnil
: Qt
;
3191 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3192 doc
: /* Return mode bits of file named FILENAME, as an integer.
3193 Return nil, if file does not exist or is not accessible. */)
3194 (Lisp_Object filename
)
3196 Lisp_Object absname
;
3198 Lisp_Object handler
;
3200 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3202 /* If the file name has special constructs in it,
3203 call the corresponding file handler. */
3204 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3205 if (!NILP (handler
))
3206 return call2 (handler
, Qfile_modes
, absname
);
3208 absname
= ENCODE_FILE (absname
);
3210 if (stat (SSDATA (absname
), &st
) < 0)
3213 return make_number (st
.st_mode
& 07777);
3216 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3217 "(let ((file (read-file-name \"File: \"))) \
3218 (list file (read-file-modes nil file)))",
3219 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3220 Only the 12 low bits of MODE are used.
3222 Interactively, mode bits are read by `read-file-modes', which accepts
3223 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3224 (Lisp_Object filename
, Lisp_Object mode
)
3226 Lisp_Object absname
, encoded_absname
;
3227 Lisp_Object handler
;
3229 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3230 CHECK_NUMBER (mode
);
3232 /* If the file name has special constructs in it,
3233 call the corresponding file handler. */
3234 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3235 if (!NILP (handler
))
3236 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3238 encoded_absname
= ENCODE_FILE (absname
);
3240 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3241 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3246 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3247 doc
: /* Set the file permission bits for newly created files.
3248 The argument MODE should be an integer; only the low 9 bits are used.
3249 This setting is inherited by subprocesses. */)
3252 CHECK_NUMBER (mode
);
3254 umask ((~ XINT (mode
)) & 0777);
3259 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3260 doc
: /* Return the default file protection for created files.
3261 The value is an integer. */)
3268 realmask
= umask (0);
3272 XSETINT (value
, (~ realmask
) & 0777);
3277 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3278 doc
: /* Set times of file FILENAME to TIMESTAMP.
3279 Set both access and modification times.
3280 Return t on success, else nil.
3281 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3283 (Lisp_Object filename
, Lisp_Object timestamp
)
3285 Lisp_Object absname
, encoded_absname
;
3286 Lisp_Object handler
;
3287 EMACS_TIME t
= lisp_time_argument (timestamp
);
3289 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3291 /* If the file name has special constructs in it,
3292 call the corresponding file handler. */
3293 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3294 if (!NILP (handler
))
3295 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3297 encoded_absname
= ENCODE_FILE (absname
);
3300 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3303 /* Setting times on a directory always fails. */
3304 if (file_directory_p (SSDATA (encoded_absname
)))
3307 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3316 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3317 doc
: /* Tell Unix to finish all pending disk updates. */)
3324 #endif /* HAVE_SYNC */
3326 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3327 doc
: /* Return t if file FILE1 is newer than file FILE2.
3328 If FILE1 does not exist, the answer is nil;
3329 otherwise, if FILE2 does not exist, the answer is t. */)
3330 (Lisp_Object file1
, Lisp_Object file2
)
3332 Lisp_Object absname1
, absname2
;
3333 struct stat st1
, st2
;
3334 Lisp_Object handler
;
3335 struct gcpro gcpro1
, gcpro2
;
3337 CHECK_STRING (file1
);
3338 CHECK_STRING (file2
);
3341 GCPRO2 (absname1
, file2
);
3342 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3343 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3346 /* If the file name has special constructs in it,
3347 call the corresponding file handler. */
3348 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3350 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3351 if (!NILP (handler
))
3352 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3354 GCPRO2 (absname1
, absname2
);
3355 absname1
= ENCODE_FILE (absname1
);
3356 absname2
= ENCODE_FILE (absname2
);
3359 if (stat (SSDATA (absname1
), &st1
) < 0)
3362 if (stat (SSDATA (absname2
), &st2
) < 0)
3365 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3369 #ifndef READ_BUF_SIZE
3370 #define READ_BUF_SIZE (64 << 10)
3372 /* Some buffer offsets are stored in 'int' variables. */
3373 verify (READ_BUF_SIZE
<= INT_MAX
);
3375 /* This function is called after Lisp functions to decide a coding
3376 system are called, or when they cause an error. Before they are
3377 called, the current buffer is set unibyte and it contains only a
3378 newly inserted text (thus the buffer was empty before the
3381 The functions may set markers, overlays, text properties, or even
3382 alter the buffer contents, change the current buffer.
3384 Here, we reset all those changes by:
3385 o set back the current buffer.
3386 o move all markers and overlays to BEG.
3387 o remove all text properties.
3388 o set back the buffer multibyteness. */
3391 decide_coding_unwind (Lisp_Object unwind_data
)
3393 Lisp_Object multibyte
, undo_list
, buffer
;
3395 multibyte
= XCAR (unwind_data
);
3396 unwind_data
= XCDR (unwind_data
);
3397 undo_list
= XCAR (unwind_data
);
3398 buffer
= XCDR (unwind_data
);
3400 set_buffer_internal (XBUFFER (buffer
));
3401 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3402 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3403 set_buffer_intervals (current_buffer
, NULL
);
3404 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3406 /* Now we are safe to change the buffer's multibyteness directly. */
3407 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3408 bset_undo_list (current_buffer
, undo_list
);
3413 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3414 object where slot 0 is the file descriptor, slot 1 specifies
3415 an offset to put the read bytes, and slot 2 is the maximum
3416 amount of bytes to read. Value is the number of bytes read. */
3419 read_non_regular (Lisp_Object state
)
3425 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3426 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3427 + XSAVE_INTEGER (state
, 1)),
3428 XSAVE_INTEGER (state
, 2));
3430 /* Fast recycle this object for the likely next call. */
3432 return make_number (nbytes
);
3436 /* Condition-case handler used when reading from non-regular files
3437 in insert-file-contents. */
3440 read_non_regular_quit (Lisp_Object ignore
)
3445 /* Return the file offset that VAL represents, checking for type
3446 errors and overflow. */
3448 file_offset (Lisp_Object val
)
3450 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3455 double v
= XFLOAT_DATA (val
);
3457 && (sizeof (off_t
) < sizeof v
3458 ? v
<= TYPE_MAXIMUM (off_t
)
3459 : v
< TYPE_MAXIMUM (off_t
)))
3463 wrong_type_argument (intern ("file-offset"), val
);
3466 /* Return a special time value indicating the error number ERRNUM. */
3468 time_error_value (int errnum
)
3470 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3471 ? NONEXISTENT_MODTIME_NSECS
3472 : UNKNOWN_MODTIME_NSECS
);
3473 return make_emacs_time (0, ns
);
3476 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3478 doc
: /* Insert contents of file FILENAME after point.
3479 Returns list of absolute file name and number of characters inserted.
3480 If second argument VISIT is non-nil, the buffer's visited filename and
3481 last save file modtime are set, and it is marked unmodified. If
3482 visiting and the file does not exist, visiting is completed before the
3485 The optional third and fourth arguments BEG and END specify what portion
3486 of the file to insert. These arguments count bytes in the file, not
3487 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3489 If optional fifth argument REPLACE is non-nil, replace the current
3490 buffer contents (in the accessible portion) with the file contents.
3491 This is better than simply deleting and inserting the whole thing
3492 because (1) it preserves some marker positions and (2) it puts less data
3493 in the undo list. When REPLACE is non-nil, the second return value is
3494 the number of characters that replace previous buffer contents.
3496 This function does code conversion according to the value of
3497 `coding-system-for-read' or `file-coding-system-alist', and sets the
3498 variable `last-coding-system-used' to the coding system actually used.
3500 In addition, this function decodes the inserted text from known formats
3501 by calling `format-decode', which see. */)
3502 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3507 ptrdiff_t inserted
= 0;
3510 off_t beg_offset
, end_offset
;
3512 ptrdiff_t count
= SPECPDL_INDEX ();
3513 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3514 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3516 ptrdiff_t total
= 0;
3517 bool not_regular
= 0;
3519 char read_buf
[READ_BUF_SIZE
];
3520 struct coding_system coding
;
3521 bool replace_handled
= 0;
3522 bool set_coding_system
= 0;
3523 Lisp_Object coding_system
;
3525 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3526 bool we_locked_file
= 0;
3527 bool deferred_remove_unwind_protect
= 0;
3529 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3530 error ("Cannot do file visiting in an indirect buffer");
3532 if (!NILP (BVAR (current_buffer
, read_only
)))
3533 Fbarf_if_buffer_read_only ();
3537 orig_filename
= Qnil
;
3540 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3542 CHECK_STRING (filename
);
3543 filename
= Fexpand_file_name (filename
, Qnil
);
3545 /* The value Qnil means that the coding system is not yet
3547 coding_system
= Qnil
;
3549 /* If the file name has special constructs in it,
3550 call the corresponding file handler. */
3551 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3552 if (!NILP (handler
))
3554 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3555 visit
, beg
, end
, replace
);
3556 if (CONSP (val
) && CONSP (XCDR (val
))
3557 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3558 inserted
= XINT (XCAR (XCDR (val
)));
3562 orig_filename
= filename
;
3563 filename
= ENCODE_FILE (filename
);
3565 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3570 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3571 mtime
= time_error_value (save_errno
);
3573 if (!NILP (Vcoding_system_for_read
))
3574 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3578 /* Replacement should preserve point as it preserves markers. */
3579 if (!NILP (replace
))
3580 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3582 record_unwind_protect (close_file_unwind
, make_number (fd
));
3584 if (fstat (fd
, &st
) != 0)
3585 report_file_error ("Input file status", Fcons (orig_filename
, Qnil
));
3586 mtime
= get_stat_mtime (&st
);
3588 /* This code will need to be changed in order to work on named
3589 pipes, and it's probably just not worth it. So we should at
3590 least signal an error. */
3591 if (!S_ISREG (st
.st_mode
))
3598 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3599 xsignal2 (Qfile_error
,
3600 build_string ("not a regular file"), orig_filename
);
3605 if (!NILP (beg
) || !NILP (end
))
3606 error ("Attempt to visit less than an entire file");
3607 if (BEG
< Z
&& NILP (replace
))
3608 error ("Cannot do file visiting in a non-empty buffer");
3612 beg_offset
= file_offset (beg
);
3617 end_offset
= file_offset (end
);
3621 end_offset
= TYPE_MAXIMUM (off_t
);
3624 end_offset
= st
.st_size
;
3626 /* A negative size can happen on a platform that allows file
3627 sizes greater than the maximum off_t value. */
3631 /* The file size returned from stat may be zero, but data
3632 may be readable nonetheless, for example when this is a
3633 file in the /proc filesystem. */
3634 if (end_offset
== 0)
3635 end_offset
= READ_BUF_SIZE
;
3639 /* Check now whether the buffer will become too large,
3640 in the likely case where the file's length is not changing.
3641 This saves a lot of needless work before a buffer overflow. */
3644 /* The likely offset where we will stop reading. We could read
3645 more (or less), if the file grows (or shrinks) as we read it. */
3646 off_t likely_end
= min (end_offset
, st
.st_size
);
3648 if (beg_offset
< likely_end
)
3651 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3652 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3653 off_t likely_growth
= likely_end
- beg_offset
;
3654 if (buf_growth_max
< likely_growth
)
3659 /* Prevent redisplay optimizations. */
3660 current_buffer
->clip_changed
= 1;
3662 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3664 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3665 setup_coding_system (coding_system
, &coding
);
3666 /* Ensure we set Vlast_coding_system_used. */
3667 set_coding_system
= 1;
3671 /* Decide the coding system to use for reading the file now
3672 because we can't use an optimized method for handling
3673 `coding:' tag if the current buffer is not empty. */
3674 if (!NILP (Vcoding_system_for_read
))
3675 coding_system
= Vcoding_system_for_read
;
3678 /* Don't try looking inside a file for a coding system
3679 specification if it is not seekable. */
3680 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3682 /* Find a coding system specified in the heading two
3683 lines or in the tailing several lines of the file.
3684 We assume that the 1K-byte and 3K-byte for heading
3685 and tailing respectively are sufficient for this
3689 if (st
.st_size
<= (1024 * 4))
3690 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3693 nread
= emacs_read (fd
, read_buf
, 1024);
3697 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3698 report_file_error ("Setting file position",
3699 Fcons (orig_filename
, Qnil
));
3700 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3701 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3706 error ("IO error reading %s: %s",
3707 SDATA (orig_filename
), emacs_strerror (errno
));
3710 struct buffer
*prev
= current_buffer
;
3711 Lisp_Object workbuf
;
3714 record_unwind_current_buffer ();
3716 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3717 buf
= XBUFFER (workbuf
);
3719 delete_all_overlays (buf
);
3720 bset_directory (buf
, BVAR (current_buffer
, directory
));
3721 bset_read_only (buf
, Qnil
);
3722 bset_filename (buf
, Qnil
);
3723 bset_undo_list (buf
, Qt
);
3724 eassert (buf
->overlays_before
== NULL
);
3725 eassert (buf
->overlays_after
== NULL
);
3727 set_buffer_internal (buf
);
3729 bset_enable_multibyte_characters (buf
, Qnil
);
3731 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3732 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3733 coding_system
= call2 (Vset_auto_coding_function
,
3734 filename
, make_number (nread
));
3735 set_buffer_internal (prev
);
3737 /* Discard the unwind protect for recovering the
3741 /* Rewind the file for the actual read done later. */
3742 if (lseek (fd
, 0, SEEK_SET
) < 0)
3743 report_file_error ("Setting file position",
3744 Fcons (orig_filename
, Qnil
));
3748 if (NILP (coding_system
))
3750 /* If we have not yet decided a coding system, check
3751 file-coding-system-alist. */
3752 Lisp_Object args
[6];
3754 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3755 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3756 coding_system
= Ffind_operation_coding_system (6, args
);
3757 if (CONSP (coding_system
))
3758 coding_system
= XCAR (coding_system
);
3762 if (NILP (coding_system
))
3763 coding_system
= Qundecided
;
3765 CHECK_CODING_SYSTEM (coding_system
);
3767 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3768 /* We must suppress all character code conversion except for
3769 end-of-line conversion. */
3770 coding_system
= raw_text_coding_system (coding_system
);
3772 setup_coding_system (coding_system
, &coding
);
3773 /* Ensure we set Vlast_coding_system_used. */
3774 set_coding_system
= 1;
3777 /* If requested, replace the accessible part of the buffer
3778 with the file contents. Avoid replacing text at the
3779 beginning or end of the buffer that matches the file contents;
3780 that preserves markers pointing to the unchanged parts.
3782 Here we implement this feature in an optimized way
3783 for the case where code conversion is NOT needed.
3784 The following if-statement handles the case of conversion
3785 in a less optimal way.
3787 If the code conversion is "automatic" then we try using this
3788 method and hope for the best.
3789 But if we discover the need for conversion, we give up on this method
3790 and let the following if-statement handle the replace job. */
3793 && (NILP (coding_system
)
3794 || ! CODING_REQUIRE_DECODING (&coding
)))
3796 /* same_at_start and same_at_end count bytes,
3797 because file access counts bytes
3798 and BEG and END count bytes. */
3799 ptrdiff_t same_at_start
= BEGV_BYTE
;
3800 ptrdiff_t same_at_end
= ZV_BYTE
;
3802 /* There is still a possibility we will find the need to do code
3803 conversion. If that happens, set this variable to
3804 give up on handling REPLACE in the optimized way. */
3805 bool giveup_match_end
= 0;
3807 if (beg_offset
!= 0)
3809 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3810 report_file_error ("Setting file position",
3811 Fcons (orig_filename
, Qnil
));
3816 /* Count how many chars at the start of the file
3817 match the text at the beginning of the buffer. */
3822 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3824 error ("IO error reading %s: %s",
3825 SSDATA (orig_filename
), emacs_strerror (errno
));
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
)
3861 /* Truncate the buffer to the size of the file. */
3862 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3867 /* Count how many chars at the end of the file
3868 match the text at the end of the buffer. But, if we have
3869 already found that decoding is necessary, don't waste time. */
3870 while (!giveup_match_end
)
3872 int total_read
, nread
, bufpos
, trial
;
3875 /* At what file position are we now scanning? */
3876 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3877 /* If the entire file matches the buffer tail, stop the scan. */
3880 /* How much can we scan in the next step? */
3881 trial
= min (curpos
, sizeof read_buf
);
3882 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3883 report_file_error ("Setting file position",
3884 Fcons (orig_filename
, Qnil
));
3886 total_read
= nread
= 0;
3887 while (total_read
< trial
)
3889 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3891 error ("IO error reading %s: %s",
3892 SDATA (orig_filename
), emacs_strerror (errno
));
3893 else if (nread
== 0)
3895 total_read
+= nread
;
3898 /* Scan this bufferful from the end, comparing with
3899 the Emacs buffer. */
3900 bufpos
= total_read
;
3902 /* Compare with same_at_start to avoid counting some buffer text
3903 as matching both at the file's beginning and at the end. */
3904 while (bufpos
> 0 && same_at_end
> same_at_start
3905 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3906 same_at_end
--, bufpos
--;
3908 /* If we found a discrepancy, stop the scan.
3909 Otherwise loop around and scan the preceding bufferful. */
3912 /* If this discrepancy is because of code conversion,
3913 we cannot use this method; giveup and try the other. */
3914 if (same_at_end
> same_at_start
3915 && FETCH_BYTE (same_at_end
- 1) >= 0200
3916 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3917 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3918 giveup_match_end
= 1;
3927 if (! giveup_match_end
)
3931 /* We win! We can handle REPLACE the optimized way. */
3933 /* Extend the start of non-matching text area to multibyte
3934 character boundary. */
3935 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3936 while (same_at_start
> BEGV_BYTE
3937 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3940 /* Extend the end of non-matching text area to multibyte
3941 character boundary. */
3942 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3943 while (same_at_end
< ZV_BYTE
3944 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3947 /* Don't try to reuse the same piece of text twice. */
3948 overlap
= (same_at_start
- BEGV_BYTE
3950 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3952 same_at_end
+= overlap
;
3954 /* Arrange to read only the nonmatching middle part of the file. */
3955 beg_offset
+= same_at_start
- BEGV_BYTE
;
3956 end_offset
-= ZV_BYTE
- same_at_end
;
3958 del_range_byte (same_at_start
, same_at_end
, 0);
3959 /* Insert from the file at the proper position. */
3960 temp
= BYTE_TO_CHAR (same_at_start
);
3961 SET_PT_BOTH (temp
, same_at_start
);
3963 /* If display currently starts at beginning of line,
3964 keep it that way. */
3965 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3966 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3968 replace_handled
= 1;
3972 /* If requested, replace the accessible part of the buffer
3973 with the file contents. Avoid replacing text at the
3974 beginning or end of the buffer that matches the file contents;
3975 that preserves markers pointing to the unchanged parts.
3977 Here we implement this feature for the case where code conversion
3978 is needed, in a simple way that needs a lot of memory.
3979 The preceding if-statement handles the case of no conversion
3980 in a more optimized way. */
3981 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3983 ptrdiff_t same_at_start
= BEGV_BYTE
;
3984 ptrdiff_t same_at_end
= ZV_BYTE
;
3985 ptrdiff_t same_at_start_charpos
;
3986 ptrdiff_t inserted_chars
;
3989 unsigned char *decoded
;
3992 ptrdiff_t this_count
= SPECPDL_INDEX ();
3994 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3995 Lisp_Object conversion_buffer
;
3996 struct gcpro gcpro1
;
3998 conversion_buffer
= code_conversion_save (1, multibyte
);
4000 /* First read the whole file, performing code conversion into
4001 CONVERSION_BUFFER. */
4003 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4004 report_file_error ("Setting file position",
4005 Fcons (orig_filename
, Qnil
));
4007 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4008 unprocessed
= 0; /* Bytes not processed in previous loop. */
4010 GCPRO1 (conversion_buffer
);
4013 /* Read at most READ_BUF_SIZE bytes at a time, to allow
4014 quitting while reading a huge file. */
4016 /* Allow quitting out of the actual I/O. */
4019 this = emacs_read (fd
, read_buf
+ unprocessed
,
4020 READ_BUF_SIZE
- unprocessed
);
4026 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
4027 BUF_Z (XBUFFER (conversion_buffer
)));
4028 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4029 unprocessed
+ this, conversion_buffer
);
4030 unprocessed
= coding
.carryover_bytes
;
4031 if (coding
.carryover_bytes
> 0)
4032 memcpy (read_buf
, coding
.carryover
, unprocessed
);
4037 /* We should remove the unwind_protect calling
4038 close_file_unwind, but other stuff has been added the stack,
4039 so defer the removal till we reach the `handled' label. */
4040 deferred_remove_unwind_protect
= 1;
4043 error ("IO error reading %s: %s",
4044 SDATA (orig_filename
), emacs_strerror (errno
));
4046 if (unprocessed
> 0)
4048 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4049 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4050 unprocessed
, conversion_buffer
);
4051 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4054 coding_system
= CODING_ID_NAME (coding
.id
);
4055 set_coding_system
= 1;
4056 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4057 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4058 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4060 /* Compare the beginning of the converted string with the buffer
4064 while (bufpos
< inserted
&& same_at_start
< same_at_end
4065 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4066 same_at_start
++, bufpos
++;
4068 /* If the file matches the head of buffer completely,
4069 there's no need to replace anything. */
4071 if (bufpos
== inserted
)
4073 /* Truncate the buffer to the size of the file. */
4074 if (same_at_start
== same_at_end
)
4077 del_range_byte (same_at_start
, same_at_end
, 0);
4080 unbind_to (this_count
, Qnil
);
4084 /* Extend the start of non-matching text area to the previous
4085 multibyte character boundary. */
4086 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4087 while (same_at_start
> BEGV_BYTE
4088 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4091 /* Scan this bufferful from the end, comparing with
4092 the Emacs buffer. */
4095 /* Compare with same_at_start to avoid counting some buffer text
4096 as matching both at the file's beginning and at the end. */
4097 while (bufpos
> 0 && same_at_end
> same_at_start
4098 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4099 same_at_end
--, bufpos
--;
4101 /* Extend the end of non-matching text area to the next
4102 multibyte character boundary. */
4103 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4104 while (same_at_end
< ZV_BYTE
4105 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4108 /* Don't try to reuse the same piece of text twice. */
4109 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4111 same_at_end
+= overlap
;
4113 /* If display currently starts at beginning of line,
4114 keep it that way. */
4115 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4116 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4118 /* Replace the chars that we need to replace,
4119 and update INSERTED to equal the number of bytes
4120 we are taking from the decoded string. */
4121 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4123 if (same_at_end
!= same_at_start
)
4125 del_range_byte (same_at_start
, same_at_end
, 0);
4127 same_at_start
= GPT_BYTE
;
4131 temp
= BYTE_TO_CHAR (same_at_start
);
4133 /* Insert from the file at the proper position. */
4134 SET_PT_BOTH (temp
, same_at_start
);
4135 same_at_start_charpos
4136 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4137 same_at_start
- BEGV_BYTE
4138 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4140 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4141 same_at_start
+ inserted
- BEGV_BYTE
4142 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4143 - same_at_start_charpos
);
4144 /* This binding is to avoid ask-user-about-supersession-threat
4145 being called in insert_from_buffer (via in
4146 prepare_to_modify_buffer). */
4147 specbind (intern ("buffer-file-name"), Qnil
);
4148 insert_from_buffer (XBUFFER (conversion_buffer
),
4149 same_at_start_charpos
, inserted_chars
, 0);
4150 /* Set `inserted' to the number of inserted characters. */
4151 inserted
= PT
- temp
;
4152 /* Set point before the inserted characters. */
4153 SET_PT_BOTH (temp
, same_at_start
);
4155 unbind_to (this_count
, Qnil
);
4161 total
= end_offset
- beg_offset
;
4163 /* For a special file, all we can do is guess. */
4164 total
= READ_BUF_SIZE
;
4166 if (NILP (visit
) && total
> 0)
4168 #ifdef CLASH_DETECTION
4169 if (!NILP (BVAR (current_buffer
, file_truename
))
4170 /* Make binding buffer-file-name to nil effective. */
4171 && !NILP (BVAR (current_buffer
, filename
))
4172 && SAVE_MODIFF
>= MODIFF
)
4174 #endif /* CLASH_DETECTION */
4175 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4178 move_gap_both (PT
, PT_BYTE
);
4179 if (GAP_SIZE
< total
)
4180 make_gap (total
- GAP_SIZE
);
4182 if (beg_offset
!= 0 || !NILP (replace
))
4184 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4185 report_file_error ("Setting file position",
4186 Fcons (orig_filename
, Qnil
));
4189 /* In the following loop, HOW_MUCH contains the total bytes read so
4190 far for a regular file, and not changed for a special file. But,
4191 before exiting the loop, it is set to a negative value if I/O
4195 /* Total bytes inserted. */
4198 /* Here, we don't do code conversion in the loop. It is done by
4199 decode_coding_gap after all data are read into the buffer. */
4201 ptrdiff_t gap_size
= GAP_SIZE
;
4203 while (how_much
< total
)
4205 /* try is reserved in some compilers (Microsoft C) */
4206 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4213 /* Maybe make more room. */
4214 if (gap_size
< trytry
)
4216 make_gap (trytry
- gap_size
);
4217 gap_size
= GAP_SIZE
- inserted
;
4220 /* Read from the file, capturing `quit'. When an
4221 error occurs, end the loop, and arrange for a quit
4222 to be signaled after decoding the text we read. */
4223 nbytes
= internal_condition_case_1
4225 make_save_value ("iii", (ptrdiff_t) fd
, inserted
, trytry
),
4226 Qerror
, read_non_regular_quit
);
4234 this = XINT (nbytes
);
4238 /* Allow quitting out of the actual I/O. We don't make text
4239 part of the buffer until all the reading is done, so a C-g
4240 here doesn't do any harm. */
4243 this = emacs_read (fd
,
4244 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4258 /* For a regular file, where TOTAL is the real size,
4259 count HOW_MUCH to compare with it.
4260 For a special file, where TOTAL is just a buffer size,
4261 so don't bother counting in HOW_MUCH.
4262 (INSERTED is where we count the number of characters inserted.) */
4269 /* Now we have either read all the file data into the gap,
4270 or stop reading on I/O error or quit. If nothing was
4271 read, undo marking the buffer modified. */
4275 #ifdef CLASH_DETECTION
4277 unlock_file (BVAR (current_buffer
, file_truename
));
4279 Vdeactivate_mark
= old_Vdeactivate_mark
;
4282 Vdeactivate_mark
= Qt
;
4286 /* Discard the unwind protect for closing the file. */
4290 error ("IO error reading %s: %s",
4291 SDATA (orig_filename
), emacs_strerror (errno
));
4293 /* Make the text read part of the buffer. */
4294 GAP_SIZE
-= inserted
;
4296 GPT_BYTE
+= inserted
;
4298 ZV_BYTE
+= inserted
;
4303 /* Put an anchor to ensure multi-byte form ends at gap. */
4308 if (NILP (coding_system
))
4310 /* The coding system is not yet decided. Decide it by an
4311 optimized method for handling `coding:' tag.
4313 Note that we can get here only if the buffer was empty
4314 before the insertion. */
4316 if (!NILP (Vcoding_system_for_read
))
4317 coding_system
= Vcoding_system_for_read
;
4320 /* Since we are sure that the current buffer was empty
4321 before the insertion, we can toggle
4322 enable-multibyte-characters directly here without taking
4323 care of marker adjustment. By this way, we can run Lisp
4324 program safely before decoding the inserted text. */
4325 Lisp_Object unwind_data
;
4326 ptrdiff_t count1
= SPECPDL_INDEX ();
4328 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4329 Fcons (BVAR (current_buffer
, undo_list
),
4330 Fcurrent_buffer ()));
4331 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4332 bset_undo_list (current_buffer
, Qt
);
4333 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4335 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4337 coding_system
= call2 (Vset_auto_coding_function
,
4338 filename
, make_number (inserted
));
4341 if (NILP (coding_system
))
4343 /* If the coding system is not yet decided, check
4344 file-coding-system-alist. */
4345 Lisp_Object args
[6];
4347 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4348 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4349 coding_system
= Ffind_operation_coding_system (6, args
);
4350 if (CONSP (coding_system
))
4351 coding_system
= XCAR (coding_system
);
4353 unbind_to (count1
, Qnil
);
4354 inserted
= Z_BYTE
- BEG_BYTE
;
4357 if (NILP (coding_system
))
4358 coding_system
= Qundecided
;
4360 CHECK_CODING_SYSTEM (coding_system
);
4362 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4363 /* We must suppress all character code conversion except for
4364 end-of-line conversion. */
4365 coding_system
= raw_text_coding_system (coding_system
);
4366 setup_coding_system (coding_system
, &coding
);
4367 /* Ensure we set Vlast_coding_system_used. */
4368 set_coding_system
= 1;
4373 /* When we visit a file by raw-text, we change the buffer to
4375 if (CODING_FOR_UNIBYTE (&coding
)
4376 /* Can't do this if part of the buffer might be preserved. */
4378 /* Visiting a file with these coding system makes the buffer
4380 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4383 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4384 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4385 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4387 move_gap_both (PT
, PT_BYTE
);
4388 GAP_SIZE
+= inserted
;
4389 ZV_BYTE
-= inserted
;
4393 decode_coding_gap (&coding
, inserted
, inserted
);
4394 inserted
= coding
.produced_char
;
4395 coding_system
= CODING_ID_NAME (coding
.id
);
4397 else if (inserted
> 0)
4398 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4401 /* Call after-change hooks for the inserted text, aside from the case
4402 of normal visiting (not with REPLACE), which is done in a new buffer
4403 "before" the buffer is changed. */
4404 if (inserted
> 0 && total
> 0
4405 && (NILP (visit
) || !NILP (replace
)))
4407 signal_after_change (PT
, 0, inserted
);
4408 update_compositions (PT
, PT
, CHECK_BORDER
);
4411 /* Now INSERTED is measured in characters. */
4415 if (deferred_remove_unwind_protect
)
4416 /* If requested above, discard the unwind protect for closing the
4422 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4423 bset_undo_list (current_buffer
, Qnil
);
4427 current_buffer
->modtime
= mtime
;
4428 current_buffer
->modtime_size
= st
.st_size
;
4429 bset_filename (current_buffer
, orig_filename
);
4432 SAVE_MODIFF
= MODIFF
;
4433 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4434 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4435 #ifdef CLASH_DETECTION
4438 if (!NILP (BVAR (current_buffer
, file_truename
)))
4439 unlock_file (BVAR (current_buffer
, file_truename
));
4440 unlock_file (filename
);
4442 #endif /* CLASH_DETECTION */
4444 xsignal2 (Qfile_error
,
4445 build_string ("not a regular file"), orig_filename
);
4448 if (set_coding_system
)
4449 Vlast_coding_system_used
= coding_system
;
4451 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4453 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4455 if (! NILP (insval
))
4457 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4458 wrong_type_argument (intern ("inserted-chars"), insval
);
4459 inserted
= XFASTINT (insval
);
4463 /* Decode file format. */
4466 /* Don't run point motion or modification hooks when decoding. */
4467 ptrdiff_t count1
= SPECPDL_INDEX ();
4468 ptrdiff_t old_inserted
= inserted
;
4469 specbind (Qinhibit_point_motion_hooks
, Qt
);
4470 specbind (Qinhibit_modification_hooks
, Qt
);
4472 /* Save old undo list and don't record undo for decoding. */
4473 old_undo
= BVAR (current_buffer
, undo_list
);
4474 bset_undo_list (current_buffer
, Qt
);
4478 insval
= call3 (Qformat_decode
,
4479 Qnil
, make_number (inserted
), visit
);
4480 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4481 wrong_type_argument (intern ("inserted-chars"), insval
);
4482 inserted
= XFASTINT (insval
);
4486 /* If REPLACE is non-nil and we succeeded in not replacing the
4487 beginning or end of the buffer text with the file's contents,
4488 call format-decode with `point' positioned at the beginning
4489 of the buffer and `inserted' equaling the number of
4490 characters in the buffer. Otherwise, format-decode might
4491 fail to correctly analyze the beginning or end of the buffer.
4492 Hence we temporarily save `point' and `inserted' here and
4493 restore `point' iff format-decode did not insert or delete
4494 any text. Otherwise we leave `point' at point-min. */
4495 ptrdiff_t opoint
= PT
;
4496 ptrdiff_t opoint_byte
= PT_BYTE
;
4497 ptrdiff_t oinserted
= ZV
- BEGV
;
4498 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4500 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4501 insval
= call3 (Qformat_decode
,
4502 Qnil
, make_number (oinserted
), visit
);
4503 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4504 wrong_type_argument (intern ("inserted-chars"), insval
);
4505 if (ochars_modiff
== CHARS_MODIFF
)
4506 /* format_decode didn't modify buffer's characters => move
4507 point back to position before inserted text and leave
4508 value of inserted alone. */
4509 SET_PT_BOTH (opoint
, opoint_byte
);
4511 /* format_decode modified buffer's characters => consider
4512 entire buffer changed and leave point at point-min. */
4513 inserted
= XFASTINT (insval
);
4516 /* For consistency with format-decode call these now iff inserted > 0
4517 (martin 2007-06-28). */
4518 p
= Vafter_insert_file_functions
;
4523 insval
= call1 (XCAR (p
), make_number (inserted
));
4526 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4527 wrong_type_argument (intern ("inserted-chars"), insval
);
4528 inserted
= XFASTINT (insval
);
4533 /* For the rationale of this see the comment on
4534 format-decode above. */
4535 ptrdiff_t opoint
= PT
;
4536 ptrdiff_t opoint_byte
= PT_BYTE
;
4537 ptrdiff_t oinserted
= ZV
- BEGV
;
4538 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4540 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4541 insval
= call1 (XCAR (p
), make_number (oinserted
));
4544 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4545 wrong_type_argument (intern ("inserted-chars"), insval
);
4546 if (ochars_modiff
== CHARS_MODIFF
)
4547 /* after_insert_file_functions didn't modify
4548 buffer's characters => move point back to
4549 position before inserted text and leave value of
4551 SET_PT_BOTH (opoint
, opoint_byte
);
4553 /* after_insert_file_functions did modify buffer's
4554 characters => consider entire buffer changed and
4555 leave point at point-min. */
4556 inserted
= XFASTINT (insval
);
4566 bset_undo_list (current_buffer
, old_undo
);
4567 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4569 /* Adjust the last undo record for the size change during
4570 the format conversion. */
4571 Lisp_Object tem
= XCAR (old_undo
);
4572 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4573 && INTEGERP (XCDR (tem
))
4574 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4575 XSETCDR (tem
, make_number (PT
+ inserted
));
4579 /* If undo_list was Qt before, keep it that way.
4580 Otherwise start with an empty undo_list. */
4581 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4583 unbind_to (count1
, Qnil
);
4587 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4589 /* If visiting nonexistent file, return nil. */
4591 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4595 Fsignal (Qquit
, Qnil
);
4597 /* Retval needs to be dealt with in all cases consistently. */
4599 val
= list2 (orig_filename
, make_number (inserted
));
4601 RETURN_UNGCPRO (unbind_to (count
, val
));
4604 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4607 build_annotations_unwind (Lisp_Object arg
)
4609 Vwrite_region_annotation_buffers
= arg
;
4613 /* Decide the coding-system to encode the data with. */
4615 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4616 Schoose_write_coding_system
, 3, 6, 0,
4617 doc
: /* Choose the coding system for writing a file.
4618 Arguments are as for `write-region'.
4619 This function is for internal use only. It may prompt the user. */ )
4620 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4621 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4624 Lisp_Object eol_parent
= Qnil
;
4626 /* Mimic write-region behavior. */
4629 XSETFASTINT (start
, BEGV
);
4630 XSETFASTINT (end
, ZV
);
4634 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4635 BVAR (current_buffer
, auto_save_file_name
))))
4640 else if (!NILP (Vcoding_system_for_write
))
4642 val
= Vcoding_system_for_write
;
4643 if (coding_system_require_warning
4644 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4645 /* Confirm that VAL can surely encode the current region. */
4646 val
= call5 (Vselect_safe_coding_system_function
,
4647 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4652 /* If the variable `buffer-file-coding-system' is set locally,
4653 it means that the file was read with some kind of code
4654 conversion or the variable is explicitly set by users. We
4655 had better write it out with the same coding system even if
4656 `enable-multibyte-characters' is nil.
4658 If it is not set locally, we anyway have to convert EOL
4659 format if the default value of `buffer-file-coding-system'
4660 tells that it is not Unix-like (LF only) format. */
4661 bool using_default_coding
= 0;
4662 bool force_raw_text
= 0;
4664 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4666 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4669 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4675 /* Check file-coding-system-alist. */
4676 Lisp_Object args
[7], coding_systems
;
4678 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4679 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4681 coding_systems
= Ffind_operation_coding_system (7, args
);
4682 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4683 val
= XCDR (coding_systems
);
4688 /* If we still have not decided a coding system, use the
4689 default value of buffer-file-coding-system. */
4690 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4691 using_default_coding
= 1;
4694 if (! NILP (val
) && ! force_raw_text
)
4696 Lisp_Object spec
, attrs
;
4698 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4699 attrs
= AREF (spec
, 0);
4700 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4705 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4706 /* Confirm that VAL can surely encode the current region. */
4707 val
= call5 (Vselect_safe_coding_system_function
,
4708 start
, end
, val
, Qnil
, filename
);
4710 /* If the decided coding-system doesn't specify end-of-line
4711 format, we use that of
4712 `default-buffer-file-coding-system'. */
4713 if (! using_default_coding
4714 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4715 val
= (coding_inherit_eol_type
4716 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4718 /* If we decide not to encode text, use `raw-text' or one of its
4721 val
= raw_text_coding_system (val
);
4724 val
= coding_inherit_eol_type (val
, eol_parent
);
4728 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4729 "r\nFWrite region to file: \ni\ni\ni\np",
4730 doc
: /* Write current region into specified file.
4731 When called from a program, requires three arguments:
4732 START, END and FILENAME. START and END are normally buffer positions
4733 specifying the part of the buffer to write.
4734 If START is nil, that means to use the entire buffer contents.
4735 If START is a string, then output that string to the file
4736 instead of any buffer contents; END is ignored.
4738 Optional fourth argument APPEND if non-nil means
4739 append to existing file contents (if any). If it is a number,
4740 seek to that offset in the file before writing.
4741 Optional fifth argument VISIT, if t or a string, means
4742 set the last-save-file-modtime of buffer to this file's modtime
4743 and mark buffer not modified.
4744 If VISIT is a string, it is a second file name;
4745 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4746 VISIT is also the file name to lock and unlock for clash detection.
4747 If VISIT is neither t nor nil nor a string,
4748 that means do not display the \"Wrote file\" message.
4749 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4750 use for locking and unlocking, overriding FILENAME and VISIT.
4751 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4752 for an existing file with the same name. If MUSTBENEW is `excl',
4753 that means to get an error if the file already exists; never overwrite.
4754 If MUSTBENEW is neither nil nor `excl', that means ask for
4755 confirmation before overwriting, but do go ahead and overwrite the file
4756 if the user confirms.
4758 This does code conversion according to the value of
4759 `coding-system-for-write', `buffer-file-coding-system', or
4760 `file-coding-system-alist', and sets the variable
4761 `last-coding-system-used' to the coding system actually used.
4763 This calls `write-region-annotate-functions' at the start, and
4764 `write-region-post-annotation-function' at the end. */)
4765 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4770 off_t offset
IF_LINT (= 0);
4776 ptrdiff_t count
= SPECPDL_INDEX ();
4778 Lisp_Object handler
;
4779 Lisp_Object visit_file
;
4780 Lisp_Object annotations
;
4781 Lisp_Object encoded_filename
;
4782 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4783 bool quietly
= !NILP (visit
);
4784 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4785 struct buffer
*given_buffer
;
4786 struct coding_system coding
;
4788 if (current_buffer
->base_buffer
&& visiting
)
4789 error ("Cannot do file visiting in an indirect buffer");
4791 if (!NILP (start
) && !STRINGP (start
))
4792 validate_region (&start
, &end
);
4795 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4797 filename
= Fexpand_file_name (filename
, Qnil
);
4799 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4800 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4802 if (STRINGP (visit
))
4803 visit_file
= Fexpand_file_name (visit
, Qnil
);
4805 visit_file
= filename
;
4807 if (NILP (lockname
))
4808 lockname
= visit_file
;
4812 /* If the file name has special constructs in it,
4813 call the corresponding file handler. */
4814 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4815 /* If FILENAME has no handler, see if VISIT has one. */
4816 if (NILP (handler
) && STRINGP (visit
))
4817 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4819 if (!NILP (handler
))
4822 val
= call6 (handler
, Qwrite_region
, start
, end
,
4823 filename
, append
, visit
);
4827 SAVE_MODIFF
= MODIFF
;
4828 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4829 bset_filename (current_buffer
, visit_file
);
4835 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4837 /* Special kludge to simplify auto-saving. */
4840 /* Do it later, so write-region-annotate-function can work differently
4841 if we save "the buffer" vs "a region".
4842 This is useful in tar-mode. --Stef
4843 XSETFASTINT (start, BEG);
4844 XSETFASTINT (end, Z); */
4848 record_unwind_protect (build_annotations_unwind
,
4849 Vwrite_region_annotation_buffers
);
4850 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4851 count1
= SPECPDL_INDEX ();
4853 given_buffer
= current_buffer
;
4855 if (!STRINGP (start
))
4857 annotations
= build_annotations (start
, end
);
4859 if (current_buffer
!= given_buffer
)
4861 XSETFASTINT (start
, BEGV
);
4862 XSETFASTINT (end
, ZV
);
4868 XSETFASTINT (start
, BEGV
);
4869 XSETFASTINT (end
, ZV
);
4874 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4876 /* Decide the coding-system to encode the data with.
4877 We used to make this choice before calling build_annotations, but that
4878 leads to problems when a write-annotate-function takes care of
4879 unsavable chars (as was the case with X-Symbol). */
4880 Vlast_coding_system_used
=
4881 Fchoose_write_coding_system (start
, end
, filename
,
4882 append
, visit
, lockname
);
4884 setup_coding_system (Vlast_coding_system_used
, &coding
);
4886 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4887 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4889 #ifdef CLASH_DETECTION
4891 lock_file (lockname
);
4892 #endif /* CLASH_DETECTION */
4894 encoded_filename
= ENCODE_FILE (filename
);
4895 fn
= SSDATA (encoded_filename
);
4896 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4897 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4898 if (NUMBERP (append
))
4899 offset
= file_offset (append
);
4900 else if (!NILP (append
))
4901 open_flags
|= O_APPEND
;
4903 mode
= S_IREAD
| S_IWRITE
;
4905 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4908 desc
= emacs_open (fn
, open_flags
, mode
);
4912 #ifdef CLASH_DETECTION
4914 if (!auto_saving
) unlock_file (lockname
);
4916 #endif /* CLASH_DETECTION */
4918 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4921 record_unwind_protect (close_file_unwind
, make_number (desc
));
4923 if (NUMBERP (append
))
4925 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4928 #ifdef CLASH_DETECTION
4930 if (!auto_saving
) unlock_file (lockname
);
4932 #endif /* CLASH_DETECTION */
4934 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
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
);
4967 /* fsync appears to change the modtime on BSD4.2.
4968 Disk full in NFS may be reported here. */
4969 /* mib says that closing the file will try to write as fast as NFS can do
4970 it, and that means the fsync here is not crucial for autosave files. */
4971 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4973 /* If fsync fails with EINTR, don't treat that as serious. Also
4974 ignore EINVAL which happens when fsync is not supported on this
4976 if (errno
!= EINTR
&& errno
!= EINVAL
)
4977 ok
= 0, save_errno
= errno
;
4981 modtime
= invalid_emacs_time ();
4984 if (fstat (desc
, &st
) == 0)
4985 modtime
= get_stat_mtime (&st
);
4987 ok
= 0, save_errno
= errno
;
4990 /* NFS can report a write failure now. */
4991 if (emacs_close (desc
) < 0)
4992 ok
= 0, save_errno
= errno
;
4994 /* Discard the unwind protect for close_file_unwind. */
4995 specpdl_ptr
= specpdl
+ count1
;
4997 /* Some file systems have a bug where st_mtime is not updated
4998 properly after a write. For example, CIFS might not see the
4999 st_mtime change until after the file is opened again.
5001 Attempt to detect this file system bug, and update MODTIME to the
5002 newer st_mtime if the bug appears to be present. This introduces
5003 a race condition, so to avoid most instances of the race condition
5004 on non-buggy file systems, skip this check if the most recently
5005 encountered non-buggy file system was the current file system.
5007 A race condition can occur if some other process modifies the
5008 file between the fstat above and the fstat below, but the race is
5009 unlikely and a similar race between the last write and the fstat
5010 above cannot possibly be closed anyway. */
5012 if (EMACS_TIME_VALID_P (modtime
)
5013 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
5015 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
5019 if (fstat (desc1
, &st1
) == 0
5020 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
5022 /* Use the heuristic if it appears to be valid. With neither
5023 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
5024 file, the time stamp won't change. Also, some non-POSIX
5025 systems don't update an empty file's time stamp when
5026 truncating it. Finally, file systems with 100 ns or worse
5027 resolution sometimes seem to have bugs: on a system with ns
5028 resolution, checking ns % 100 incorrectly avoids the heuristic
5029 1% of the time, but the problem should be temporary as we will
5030 try again on the next time stamp. */
5032 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
5034 && EMACS_NSECS (modtime
) % 100 != 0);
5036 EMACS_TIME modtime1
= get_stat_mtime (&st1
);
5038 && EMACS_TIME_EQ (modtime
, modtime1
)
5039 && st
.st_size
== st1
.st_size
)
5041 timestamp_file_system
= st
.st_dev
;
5042 valid_timestamp_file_system
= 1;
5046 st
.st_size
= st1
.st_size
;
5050 emacs_close (desc1
);
5054 /* Call write-region-post-annotation-function. */
5055 while (CONSP (Vwrite_region_annotation_buffers
))
5057 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5058 if (!NILP (Fbuffer_live_p (buf
)))
5061 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5062 call0 (Vwrite_region_post_annotation_function
);
5064 Vwrite_region_annotation_buffers
5065 = XCDR (Vwrite_region_annotation_buffers
);
5068 unbind_to (count
, Qnil
);
5070 #ifdef CLASH_DETECTION
5072 unlock_file (lockname
);
5073 #endif /* CLASH_DETECTION */
5075 /* Do this before reporting IO error
5076 to avoid a "file has changed on disk" warning on
5077 next attempt to save. */
5078 if (EMACS_TIME_VALID_P (modtime
))
5080 current_buffer
->modtime
= modtime
;
5081 current_buffer
->modtime_size
= st
.st_size
;
5085 error ("IO error writing %s: %s", SDATA (filename
),
5086 emacs_strerror (save_errno
));
5090 SAVE_MODIFF
= MODIFF
;
5091 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5092 bset_filename (current_buffer
, visit_file
);
5093 update_mode_lines
++;
5098 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5099 BVAR (current_buffer
, auto_save_file_name
))))
5100 SAVE_MODIFF
= MODIFF
;
5106 message_with_string ((NUMBERP (append
)
5116 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
5118 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5119 doc
: /* Return t if (car A) is numerically less than (car B). */)
5120 (Lisp_Object a
, Lisp_Object b
)
5122 return Flss (Fcar (a
), Fcar (b
));
5125 /* Build the complete list of annotations appropriate for writing out
5126 the text between START and END, by calling all the functions in
5127 write-region-annotate-functions and merging the lists they return.
5128 If one of these functions switches to a different buffer, we assume
5129 that buffer contains altered text. Therefore, the caller must
5130 make sure to restore the current buffer in all cases,
5131 as save-excursion would do. */
5134 build_annotations (Lisp_Object start
, Lisp_Object end
)
5136 Lisp_Object annotations
;
5138 struct gcpro gcpro1
, gcpro2
;
5139 Lisp_Object original_buffer
;
5141 bool used_global
= 0;
5143 XSETBUFFER (original_buffer
, current_buffer
);
5146 p
= Vwrite_region_annotate_functions
;
5147 GCPRO2 (annotations
, p
);
5150 struct buffer
*given_buffer
= current_buffer
;
5151 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5152 { /* Use the global value of the hook. */
5155 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5157 p
= Fappend (2, arg
);
5160 Vwrite_region_annotations_so_far
= annotations
;
5161 res
= call2 (XCAR (p
), start
, end
);
5162 /* If the function makes a different buffer current,
5163 assume that means this buffer contains altered text to be output.
5164 Reset START and END from the buffer bounds
5165 and discard all previous annotations because they should have
5166 been dealt with by this function. */
5167 if (current_buffer
!= given_buffer
)
5169 Vwrite_region_annotation_buffers
5170 = Fcons (Fcurrent_buffer (),
5171 Vwrite_region_annotation_buffers
);
5172 XSETFASTINT (start
, BEGV
);
5173 XSETFASTINT (end
, ZV
);
5176 Flength (res
); /* Check basic validity of return value */
5177 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5181 /* Now do the same for annotation functions implied by the file-format */
5182 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5183 p
= BVAR (current_buffer
, auto_save_file_format
);
5185 p
= BVAR (current_buffer
, file_format
);
5186 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5188 struct buffer
*given_buffer
= current_buffer
;
5190 Vwrite_region_annotations_so_far
= annotations
;
5192 /* Value is either a list of annotations or nil if the function
5193 has written annotations to a temporary buffer, which is now
5195 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5196 original_buffer
, make_number (i
));
5197 if (current_buffer
!= given_buffer
)
5199 XSETFASTINT (start
, BEGV
);
5200 XSETFASTINT (end
, ZV
);
5205 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5213 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5214 If STRING is nil, POS is the character position in the current buffer.
5215 Intersperse with them the annotations from *ANNOT
5216 which fall within the range of POS to POS + NCHARS,
5217 each at its appropriate position.
5219 We modify *ANNOT by discarding elements as we use them up.
5221 Return true if successful. */
5224 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5225 ptrdiff_t nchars
, Lisp_Object
*annot
,
5226 struct coding_system
*coding
)
5230 ptrdiff_t lastpos
= pos
+ nchars
;
5232 while (NILP (*annot
) || CONSP (*annot
))
5234 tem
= Fcar_safe (Fcar (*annot
));
5237 nextpos
= XFASTINT (tem
);
5239 /* If there are no more annotations in this range,
5240 output the rest of the range all at once. */
5241 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5242 return e_write (desc
, string
, pos
, lastpos
, coding
);
5244 /* Output buffer text up to the next annotation's position. */
5247 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5251 /* Output the annotation. */
5252 tem
= Fcdr (Fcar (*annot
));
5255 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5258 *annot
= Fcdr (*annot
);
5264 /* Write text in the range START and END into descriptor DESC,
5265 encoding them with coding system CODING. If STRING is nil, START
5266 and END are character positions of the current buffer, else they
5267 are indexes to the string STRING. Return true if successful. */
5270 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5271 struct coding_system
*coding
)
5273 if (STRINGP (string
))
5276 end
= SCHARS (string
);
5279 /* We used to have a code for handling selective display here. But,
5280 now it is handled within encode_coding. */
5284 if (STRINGP (string
))
5286 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5287 if (CODING_REQUIRE_ENCODING (coding
))
5289 encode_coding_object (coding
, string
,
5290 start
, string_char_to_byte (string
, start
),
5291 end
, string_char_to_byte (string
, end
), Qt
);
5295 coding
->dst_object
= string
;
5296 coding
->consumed_char
= SCHARS (string
);
5297 coding
->produced
= SBYTES (string
);
5302 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5303 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5305 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5306 if (CODING_REQUIRE_ENCODING (coding
))
5308 encode_coding_object (coding
, Fcurrent_buffer (),
5309 start
, start_byte
, end
, end_byte
, Qt
);
5313 coding
->dst_object
= Qnil
;
5314 coding
->dst_pos_byte
= start_byte
;
5315 if (start
>= GPT
|| end
<= GPT
)
5317 coding
->consumed_char
= end
- start
;
5318 coding
->produced
= end_byte
- start_byte
;
5322 coding
->consumed_char
= GPT
- start
;
5323 coding
->produced
= GPT_BYTE
- start_byte
;
5328 if (coding
->produced
> 0)
5331 -= emacs_write (desc
,
5332 STRINGP (coding
->dst_object
)
5333 ? SSDATA (coding
->dst_object
)
5334 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5337 if (coding
->produced
)
5340 start
+= coding
->consumed_char
;
5346 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5347 Sverify_visited_file_modtime
, 0, 1, 0,
5348 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5349 This means that the file has not been changed since it was visited or saved.
5350 If BUF is omitted or nil, it defaults to the current buffer.
5351 See Info node `(elisp)Modification Time' for more details. */)
5356 Lisp_Object handler
;
5357 Lisp_Object filename
;
5368 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5369 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5371 /* If the file name has special constructs in it,
5372 call the corresponding file handler. */
5373 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5374 Qverify_visited_file_modtime
);
5375 if (!NILP (handler
))
5376 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5378 filename
= ENCODE_FILE (BVAR (b
, filename
));
5380 mtime
= (stat (SSDATA (filename
), &st
) == 0
5381 ? get_stat_mtime (&st
)
5382 : time_error_value (errno
));
5383 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5384 && (b
->modtime_size
< 0
5385 || st
.st_size
== b
->modtime_size
))
5390 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5391 Sclear_visited_file_modtime
, 0, 0, 0,
5392 doc
: /* Clear out records of last mod time of visited file.
5393 Next attempt to save will certainly not complain of a discrepancy. */)
5396 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5397 current_buffer
->modtime_size
= -1;
5401 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5402 Svisited_file_modtime
, 0, 0, 0,
5403 doc
: /* Return the current buffer's recorded visited file modification time.
5404 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5405 `file-attributes' returns. If the current buffer has no recorded file
5406 modification time, this function returns 0. If the visited file
5407 doesn't exist, HIGH will be -1.
5408 See Info node `(elisp)Modification Time' for more details. */)
5411 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5413 if (EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
5415 /* make_lisp_time won't work here if time_t is unsigned. */
5416 return list4 (make_number (-1), make_number (65535),
5417 make_number (0), make_number (0));
5419 return make_number (0);
5421 return make_lisp_time (current_buffer
->modtime
);
5424 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5425 Sset_visited_file_modtime
, 0, 1, 0,
5426 doc
: /* Update buffer's recorded modification time from the visited file's time.
5427 Useful if the buffer was not read from the file normally
5428 or if the file itself has been changed for some known benign reason.
5429 An argument specifies the modification time value to use
5430 \(instead of that of the visited file), in the form of a list
5431 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5432 (Lisp_Object time_list
)
5434 if (!NILP (time_list
))
5436 current_buffer
->modtime
= lisp_time_argument (time_list
);
5437 current_buffer
->modtime_size
= -1;
5441 register Lisp_Object filename
;
5443 Lisp_Object handler
;
5445 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5447 /* If the file name has special constructs in it,
5448 call the corresponding file handler. */
5449 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5450 if (!NILP (handler
))
5451 /* The handler can find the file name the same way we did. */
5452 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5454 filename
= ENCODE_FILE (filename
);
5456 if (stat (SSDATA (filename
), &st
) >= 0)
5458 current_buffer
->modtime
= get_stat_mtime (&st
);
5459 current_buffer
->modtime_size
= st
.st_size
;
5467 auto_save_error (Lisp_Object error_val
)
5469 Lisp_Object args
[3], msg
;
5471 struct gcpro gcpro1
;
5473 auto_save_error_occurred
= 1;
5475 ring_bell (XFRAME (selected_frame
));
5477 args
[0] = build_string ("Auto-saving %s: %s");
5478 args
[1] = BVAR (current_buffer
, name
);
5479 args
[2] = Ferror_message_string (error_val
);
5480 msg
= Fformat (3, args
);
5483 for (i
= 0; i
< 3; ++i
)
5488 message3_nolog (msg
);
5489 Fsleep_for (make_number (1), Qnil
);
5502 auto_save_mode_bits
= 0666;
5504 /* Get visited file's mode to become the auto save file's mode. */
5505 if (! NILP (BVAR (current_buffer
, filename
)))
5507 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5508 /* But make sure we can overwrite it later! */
5509 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5510 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5512 /* Remote files don't cooperate with stat. */
5513 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5517 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5518 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5523 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5526 FILE *stream
= XSAVE_POINTER (arg
, 0);
5538 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5541 minibuffer_auto_raise
= XINT (value
);
5546 do_auto_save_make_dir (Lisp_Object dir
)
5550 auto_saving_dir_umask
= 077;
5551 result
= call2 (Qmake_directory
, dir
, Qt
);
5552 auto_saving_dir_umask
= 0;
5557 do_auto_save_eh (Lisp_Object ignore
)
5559 auto_saving_dir_umask
= 0;
5563 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5564 doc
: /* Auto-save all buffers that need it.
5565 This is all buffers that have auto-saving enabled
5566 and are changed since last auto-saved.
5567 Auto-saving writes the buffer into a file
5568 so that your editing is not lost if the system crashes.
5569 This file is not the file you visited; that changes only when you save.
5570 Normally we run the normal hook `auto-save-hook' before saving.
5572 A non-nil NO-MESSAGE argument means do not print any message if successful.
5573 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5574 (Lisp_Object no_message
, Lisp_Object current_only
)
5576 struct buffer
*old
= current_buffer
, *b
;
5577 Lisp_Object tail
, buf
, hook
;
5578 bool auto_saved
= 0;
5579 int do_handled_files
;
5581 FILE *stream
= NULL
;
5582 ptrdiff_t count
= SPECPDL_INDEX ();
5583 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5584 bool old_message_p
= 0;
5585 struct gcpro gcpro1
, gcpro2
;
5587 if (max_specpdl_size
< specpdl_size
+ 40)
5588 max_specpdl_size
= specpdl_size
+ 40;
5593 if (NILP (no_message
))
5595 old_message_p
= push_message ();
5596 record_unwind_protect (pop_message_unwind
, Qnil
);
5599 /* Ordinarily don't quit within this function,
5600 but don't make it impossible to quit (in case we get hung in I/O). */
5604 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5605 point to non-strings reached from Vbuffer_alist. */
5607 hook
= intern ("auto-save-hook");
5608 Frun_hooks (1, &hook
);
5610 if (STRINGP (Vauto_save_list_file_name
))
5612 Lisp_Object listfile
;
5614 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5616 /* Don't try to create the directory when shutting down Emacs,
5617 because creating the directory might signal an error, and
5618 that would leave Emacs in a strange state. */
5619 if (!NILP (Vrun_hooks
))
5623 GCPRO2 (dir
, listfile
);
5624 dir
= Ffile_name_directory (listfile
);
5625 if (NILP (Ffile_directory_p (dir
)))
5626 internal_condition_case_1 (do_auto_save_make_dir
,
5632 stream
= fopen (SSDATA (listfile
), "w");
5635 record_unwind_protect (do_auto_save_unwind
,
5636 make_save_pointer (stream
));
5637 record_unwind_protect (do_auto_save_unwind_1
,
5638 make_number (minibuffer_auto_raise
));
5639 minibuffer_auto_raise
= 0;
5641 auto_save_error_occurred
= 0;
5643 /* On first pass, save all files that don't have handlers.
5644 On second pass, save all files that do have handlers.
5646 If Emacs is crashing, the handlers may tweak what is causing
5647 Emacs to crash in the first place, and it would be a shame if
5648 Emacs failed to autosave perfectly ordinary files because it
5649 couldn't handle some ange-ftp'd file. */
5651 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5652 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5654 buf
= XCDR (XCAR (tail
));
5657 /* Record all the buffers that have auto save mode
5658 in the special file that lists them. For each of these buffers,
5659 Record visited name (if any) and auto save name. */
5660 if (STRINGP (BVAR (b
, auto_save_file_name
))
5661 && stream
!= NULL
&& do_handled_files
== 0)
5664 if (!NILP (BVAR (b
, filename
)))
5666 fwrite (SDATA (BVAR (b
, filename
)), 1,
5667 SBYTES (BVAR (b
, filename
)), stream
);
5669 putc ('\n', stream
);
5670 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5671 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5672 putc ('\n', stream
);
5676 if (!NILP (current_only
)
5677 && b
!= current_buffer
)
5680 /* Don't auto-save indirect buffers.
5681 The base buffer takes care of it. */
5685 /* Check for auto save enabled
5686 and file changed since last auto save
5687 and file changed since last real save. */
5688 if (STRINGP (BVAR (b
, auto_save_file_name
))
5689 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5690 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5691 /* -1 means we've turned off autosaving for a while--see below. */
5692 && XINT (BVAR (b
, save_length
)) >= 0
5693 && (do_handled_files
5694 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5697 EMACS_TIME before_time
= current_emacs_time ();
5698 EMACS_TIME after_time
;
5700 /* If we had a failure, don't try again for 20 minutes. */
5701 if (b
->auto_save_failure_time
> 0
5702 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5705 set_buffer_internal (b
);
5706 if (NILP (Vauto_save_include_big_deletions
)
5707 && (XFASTINT (BVAR (b
, save_length
)) * 10
5708 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5709 /* A short file is likely to change a large fraction;
5710 spare the user annoying messages. */
5711 && XFASTINT (BVAR (b
, save_length
)) > 5000
5712 /* These messages are frequent and annoying for `*mail*'. */
5713 && !EQ (BVAR (b
, filename
), Qnil
)
5714 && NILP (no_message
))
5716 /* It has shrunk too much; turn off auto-saving here. */
5717 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5718 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5720 minibuffer_auto_raise
= 0;
5721 /* Turn off auto-saving until there's a real save,
5722 and prevent any more warnings. */
5723 XSETINT (BVAR (b
, save_length
), -1);
5724 Fsleep_for (make_number (1), Qnil
);
5727 if (!auto_saved
&& NILP (no_message
))
5728 message1 ("Auto-saving...");
5729 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5731 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5732 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5733 set_buffer_internal (old
);
5735 after_time
= current_emacs_time ();
5737 /* If auto-save took more than 60 seconds,
5738 assume it was an NFS failure that got a timeout. */
5739 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5740 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5744 /* Prevent another auto save till enough input events come in. */
5745 record_auto_save ();
5747 if (auto_saved
&& NILP (no_message
))
5751 /* If we are going to restore an old message,
5752 give time to read ours. */
5753 sit_for (make_number (1), 0, 0);
5756 else if (!auto_save_error_occurred
)
5757 /* Don't overwrite the error message if an error occurred.
5758 If we displayed a message and then restored a state
5759 with no message, leave a "done" message on the screen. */
5760 message1 ("Auto-saving...done");
5765 /* This restores the message-stack status. */
5766 unbind_to (count
, Qnil
);
5770 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5771 Sset_buffer_auto_saved
, 0, 0, 0,
5772 doc
: /* Mark current buffer as auto-saved with its current text.
5773 No auto-save file will be written until the buffer changes again. */)
5776 /* FIXME: This should not be called in indirect buffers, since
5777 they're not autosaved. */
5778 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5779 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5780 current_buffer
->auto_save_failure_time
= 0;
5784 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5785 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5786 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5789 current_buffer
->auto_save_failure_time
= 0;
5793 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5795 doc
: /* Return t if current buffer has been auto-saved recently.
5796 More precisely, if it has been auto-saved since last read from or saved
5797 in the visited file. If the buffer has no visited file,
5798 then any auto-save counts as "recent". */)
5801 /* FIXME: maybe we should return nil for indirect buffers since
5802 they're never autosaved. */
5803 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5806 /* Reading and completing file names */
5808 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5809 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5810 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5811 The return value is only relevant for a call to `read-file-name' that happens
5812 before any other event (mouse or keypress) is handled. */)
5815 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5816 || defined (HAVE_NS)
5817 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5827 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5829 struct gcpro gcpro1
;
5830 Lisp_Object args
[7];
5832 GCPRO1 (default_filename
);
5833 args
[0] = intern ("read-file-name");
5836 args
[3] = default_filename
;
5837 args
[4] = mustmatch
;
5839 args
[6] = predicate
;
5840 RETURN_UNGCPRO (Ffuncall (7, args
));
5847 valid_timestamp_file_system
= 0;
5851 syms_of_fileio (void)
5853 DEFSYM (Qoperations
, "operations");
5854 DEFSYM (Qexpand_file_name
, "expand-file-name");
5855 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5856 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5857 DEFSYM (Qfile_name_directory
, "file-name-directory");
5858 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5859 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5860 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5861 DEFSYM (Qcopy_file
, "copy-file");
5862 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5863 DEFSYM (Qmake_directory
, "make-directory");
5864 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5865 DEFSYM (Qdelete_file
, "delete-file");
5866 DEFSYM (Qrename_file
, "rename-file");
5867 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5868 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5869 DEFSYM (Qfile_exists_p
, "file-exists-p");
5870 DEFSYM (Qfile_executable_p
, "file-executable-p");
5871 DEFSYM (Qfile_readable_p
, "file-readable-p");
5872 DEFSYM (Qfile_writable_p
, "file-writable-p");
5873 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5874 DEFSYM (Qaccess_file
, "access-file");
5875 DEFSYM (Qfile_directory_p
, "file-directory-p");
5876 DEFSYM (Qfile_regular_p
, "file-regular-p");
5877 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5878 DEFSYM (Qfile_modes
, "file-modes");
5879 DEFSYM (Qset_file_modes
, "set-file-modes");
5880 DEFSYM (Qset_file_times
, "set-file-times");
5881 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5882 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5883 DEFSYM (Qfile_acl
, "file-acl");
5884 DEFSYM (Qset_file_acl
, "set-file-acl");
5885 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5886 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5887 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5888 DEFSYM (Qwrite_region
, "write-region");
5889 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5890 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5891 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5893 DEFSYM (Qfile_name_history
, "file-name-history");
5894 Fset (Qfile_name_history
, Qnil
);
5896 DEFSYM (Qfile_error
, "file-error");
5897 DEFSYM (Qfile_already_exists
, "file-already-exists");
5898 DEFSYM (Qfile_date_error
, "file-date-error");
5899 DEFSYM (Qexcl
, "excl");
5901 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5902 doc
: /* Coding system for encoding file names.
5903 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5904 Vfile_name_coding_system
= Qnil
;
5906 DEFVAR_LISP ("default-file-name-coding-system",
5907 Vdefault_file_name_coding_system
,
5908 doc
: /* Default coding system for encoding file names.
5909 This variable is used only when `file-name-coding-system' is nil.
5911 This variable is set/changed by the command `set-language-environment'.
5912 User should not set this variable manually,
5913 instead use `file-name-coding-system' to get a constant encoding
5914 of file names regardless of the current language environment. */);
5915 Vdefault_file_name_coding_system
= Qnil
;
5917 DEFSYM (Qformat_decode
, "format-decode");
5918 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5919 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5920 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5922 Fput (Qfile_error
, Qerror_conditions
,
5923 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5924 Fput (Qfile_error
, Qerror_message
,
5925 build_pure_c_string ("File error"));
5927 Fput (Qfile_already_exists
, Qerror_conditions
,
5928 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5929 Fput (Qfile_already_exists
, Qerror_message
,
5930 build_pure_c_string ("File already exists"));
5932 Fput (Qfile_date_error
, Qerror_conditions
,
5933 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5934 Fput (Qfile_date_error
, Qerror_message
,
5935 build_pure_c_string ("Cannot set file date"));
5937 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5938 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5939 If a file name matches REGEXP, all I/O on that file is done by calling
5940 HANDLER. If a file name matches more than one handler, the handler
5941 whose match starts last in the file name gets precedence. The
5942 function `find-file-name-handler' checks this list for a handler for
5945 HANDLER should be a function. The first argument given to it is the
5946 name of the I/O primitive to be handled; the remaining arguments are
5947 the arguments that were passed to that primitive. For example, if you
5948 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5949 HANDLER is called like this:
5951 (funcall HANDLER 'file-exists-p FILENAME)
5953 Note that HANDLER must be able to handle all I/O primitives; if it has
5954 nothing special to do for a primitive, it should reinvoke the
5955 primitive to handle the operation \"the usual way\".
5956 See Info node `(elisp)Magic File Names' for more details. */);
5957 Vfile_name_handler_alist
= Qnil
;
5959 DEFVAR_LISP ("set-auto-coding-function",
5960 Vset_auto_coding_function
,
5961 doc
: /* If non-nil, a function to call to decide a coding system of file.
5962 Two arguments are passed to this function: the file name
5963 and the length of a file contents following the point.
5964 This function should return a coding system to decode the file contents.
5965 It should check the file name against `auto-coding-alist'.
5966 If no coding system is decided, it should check a coding system
5967 specified in the heading lines with the format:
5968 -*- ... coding: CODING-SYSTEM; ... -*-
5969 or local variable spec of the tailing lines with `coding:' tag. */);
5970 Vset_auto_coding_function
= Qnil
;
5972 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5973 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5974 Each is passed one argument, the number of characters inserted,
5975 with point at the start of the inserted text. Each function
5976 should leave point the same, and return the new character count.
5977 If `insert-file-contents' is intercepted by a handler from
5978 `file-name-handler-alist', that handler is responsible for calling the
5979 functions in `after-insert-file-functions' if appropriate. */);
5980 Vafter_insert_file_functions
= Qnil
;
5982 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5983 doc
: /* A list of functions to be called at the start of `write-region'.
5984 Each is passed two arguments, START and END as for `write-region'.
5985 These are usually two numbers but not always; see the documentation
5986 for `write-region'. The function should return a list of pairs
5987 of the form (POSITION . STRING), consisting of strings to be effectively
5988 inserted at the specified positions of the file being written (1 means to
5989 insert before the first byte written). The POSITIONs must be sorted into
5992 If there are several annotation functions, the lists returned by these
5993 functions are merged destructively. As each annotation function runs,
5994 the variable `write-region-annotations-so-far' contains a list of all
5995 annotations returned by previous annotation functions.
5997 An annotation function can return with a different buffer current.
5998 Doing so removes the annotations returned by previous functions, and
5999 resets START and END to `point-min' and `point-max' of the new buffer.
6001 After `write-region' completes, Emacs calls the function stored in
6002 `write-region-post-annotation-function', once for each buffer that was
6003 current when building the annotations (i.e., at least once), with that
6004 buffer current. */);
6005 Vwrite_region_annotate_functions
= Qnil
;
6006 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
6008 DEFVAR_LISP ("write-region-post-annotation-function",
6009 Vwrite_region_post_annotation_function
,
6010 doc
: /* Function to call after `write-region' completes.
6011 The function is called with no arguments. If one or more of the
6012 annotation functions in `write-region-annotate-functions' changed the
6013 current buffer, the function stored in this variable is called for
6014 each of those additional buffers as well, in addition to the original
6015 buffer. The relevant buffer is current during each function call. */);
6016 Vwrite_region_post_annotation_function
= Qnil
;
6017 staticpro (&Vwrite_region_annotation_buffers
);
6019 DEFVAR_LISP ("write-region-annotations-so-far",
6020 Vwrite_region_annotations_so_far
,
6021 doc
: /* When an annotation function is called, this holds the previous annotations.
6022 These are the annotations made by other annotation functions
6023 that were already called. See also `write-region-annotate-functions'. */);
6024 Vwrite_region_annotations_so_far
= Qnil
;
6026 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6027 doc
: /* A list of file name handlers that temporarily should not be used.
6028 This applies only to the operation `inhibit-file-name-operation'. */);
6029 Vinhibit_file_name_handlers
= Qnil
;
6031 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6032 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6033 Vinhibit_file_name_operation
= Qnil
;
6035 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6036 doc
: /* File name in which we write a list of all auto save file names.
6037 This variable is initialized automatically from `auto-save-list-file-prefix'
6038 shortly after Emacs reads your init file, if you have not yet given it
6039 a non-nil value. */);
6040 Vauto_save_list_file_name
= Qnil
;
6042 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6043 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6044 Normally auto-save files are written under other names. */);
6045 Vauto_save_visited_file_name
= Qnil
;
6047 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6048 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6049 If nil, deleting a substantial portion of the text disables auto-save
6050 in the buffer; this is the default behavior, because the auto-save
6051 file is usually more useful if it contains the deleted text. */);
6052 Vauto_save_include_big_deletions
= Qnil
;
6055 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6056 doc
: /* Non-nil means don't call fsync in `write-region'.
6057 This variable affects calls to `write-region' as well as save commands.
6058 A non-nil value may result in data loss! */);
6059 write_region_inhibit_fsync
= 0;
6062 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6063 doc
: /* Specifies whether to use the system's trash can.
6064 When non-nil, certain file deletion commands use the function
6065 `move-file-to-trash' instead of deleting files outright.
6066 This includes interactive calls to `delete-file' and
6067 `delete-directory' and the Dired deletion commands. */);
6068 delete_by_moving_to_trash
= 0;
6069 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6071 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6072 DEFSYM (Qcopy_directory
, "copy-directory");
6073 DEFSYM (Qdelete_directory
, "delete-directory");
6075 defsubr (&Sfind_file_name_handler
);
6076 defsubr (&Sfile_name_directory
);
6077 defsubr (&Sfile_name_nondirectory
);
6078 defsubr (&Sunhandled_file_name_directory
);
6079 defsubr (&Sfile_name_as_directory
);
6080 defsubr (&Sdirectory_file_name
);
6081 defsubr (&Smake_temp_name
);
6082 defsubr (&Sexpand_file_name
);
6083 defsubr (&Ssubstitute_in_file_name
);
6084 defsubr (&Scopy_file
);
6085 defsubr (&Smake_directory_internal
);
6086 defsubr (&Sdelete_directory_internal
);
6087 defsubr (&Sdelete_file
);
6088 defsubr (&Srename_file
);
6089 defsubr (&Sadd_name_to_file
);
6090 defsubr (&Smake_symbolic_link
);
6091 defsubr (&Sfile_name_absolute_p
);
6092 defsubr (&Sfile_exists_p
);
6093 defsubr (&Sfile_executable_p
);
6094 defsubr (&Sfile_readable_p
);
6095 defsubr (&Sfile_writable_p
);
6096 defsubr (&Saccess_file
);
6097 defsubr (&Sfile_symlink_p
);
6098 defsubr (&Sfile_directory_p
);
6099 defsubr (&Sfile_accessible_directory_p
);
6100 defsubr (&Sfile_regular_p
);
6101 defsubr (&Sfile_modes
);
6102 defsubr (&Sset_file_modes
);
6103 defsubr (&Sset_file_times
);
6104 defsubr (&Sfile_selinux_context
);
6105 defsubr (&Sfile_acl
);
6106 defsubr (&Sset_file_acl
);
6107 defsubr (&Sset_file_selinux_context
);
6108 defsubr (&Sset_default_file_modes
);
6109 defsubr (&Sdefault_file_modes
);
6110 defsubr (&Sfile_newer_than_file_p
);
6111 defsubr (&Sinsert_file_contents
);
6112 defsubr (&Schoose_write_coding_system
);
6113 defsubr (&Swrite_region
);
6114 defsubr (&Scar_less_than_car
);
6115 defsubr (&Sverify_visited_file_modtime
);
6116 defsubr (&Sclear_visited_file_modtime
);
6117 defsubr (&Svisited_file_modtime
);
6118 defsubr (&Sset_visited_file_modtime
);
6119 defsubr (&Sdo_auto_save
);
6120 defsubr (&Sset_buffer_auto_saved
);
6121 defsubr (&Sclear_buffer_auto_save_failure
);
6122 defsubr (&Srecent_auto_save_p
);
6124 defsubr (&Snext_read_file_uses_dialog_p
);
6127 defsubr (&Sunix_sync
);