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 while (p
!= endp
&& *p
!= '}') p
++;
1714 if (*p
!= '}') goto missingclose
;
1720 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1724 /* Copy out the variable name. */
1725 target
= alloca (s
- o
+ 1);
1726 memcpy (target
, o
, s
- o
);
1729 strupr (target
); /* $home == $HOME etc. */
1732 /* Get variable value. */
1733 o
= egetenv (target
);
1736 /* Don't try to guess a maximum length - UTF8 can use up to
1737 four bytes per character. This code is unlikely to run
1738 in a situation that requires performance, so decoding the
1739 env variables twice should be acceptable. Note that
1740 decoding may cause a garbage collect. */
1741 Lisp_Object orig
, decoded
;
1742 orig
= build_unibyte_string (o
);
1743 decoded
= DECODE_FILE (orig
);
1744 total
+= SBYTES (decoded
);
1754 if (!NILP (Vw32_downcase_file_names
))
1755 filename
= Fdowncase (filename
);
1760 /* If substitution required, recopy the string and do it. */
1761 /* Make space in stack frame for the new copy. */
1762 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1765 /* Copy the rest of the name through, replacing $ constructs with values. */
1782 while (p
!= endp
&& *p
!= '}') p
++;
1783 if (*p
!= '}') goto missingclose
;
1789 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1793 /* Copy out the variable name. */
1794 target
= alloca (s
- o
+ 1);
1795 memcpy (target
, o
, s
- o
);
1798 /* Get variable value. */
1799 o
= egetenv (target
);
1803 strcpy (x
, target
); x
+= strlen (target
);
1807 Lisp_Object orig
, decoded
;
1808 ptrdiff_t orig_length
, decoded_length
;
1809 orig_length
= strlen (o
);
1810 orig
= make_unibyte_string (o
, orig_length
);
1811 decoded
= DECODE_FILE (orig
);
1812 decoded_length
= SBYTES (decoded
);
1813 memcpy (x
, SDATA (decoded
), decoded_length
);
1814 x
+= decoded_length
;
1816 /* If environment variable needed decoding, return value
1817 needs to be multibyte. */
1818 if (decoded_length
!= orig_length
1819 || memcmp (SDATA (decoded
), o
, orig_length
))
1826 /* If /~ or // appears, discard everything through first slash. */
1827 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1828 /* This time we do not start over because we've already expanded envvars
1829 and replaced $$ with $. Maybe we should start over as well, but we'd
1830 need to quote some $ to $$ first. */
1834 if (!NILP (Vw32_downcase_file_names
))
1836 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1838 xname
= Fdowncase (xname
);
1843 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1846 error ("Bad format environment-variable substitution");
1848 error ("Missing \"}\" in environment-variable substitution");
1850 error ("Substituting nonexistent environment variable \"%s\"", target
);
1856 /* A slightly faster and more convenient way to get
1857 (directory-file-name (expand-file-name FOO)). */
1860 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1862 register Lisp_Object absname
;
1864 absname
= Fexpand_file_name (filename
, defdir
);
1866 /* Remove final slash, if any (unless this is the root dir).
1867 stat behaves differently depending! */
1868 if (SCHARS (absname
) > 1
1869 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1870 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1871 /* We cannot take shortcuts; they might be wrong for magic file names. */
1872 absname
= Fdirectory_file_name (absname
);
1876 /* Signal an error if the file ABSNAME already exists.
1877 If INTERACTIVE, ask the user whether to proceed,
1878 and bypass the error if the user says to go ahead.
1879 QUERYSTRING is a name for the action that is being considered
1882 *STATPTR is used to store the stat information if the file exists.
1883 If the file does not exist, STATPTR->st_mode is set to 0.
1884 If STATPTR is null, we don't store into it.
1886 If QUICK, ask for y or n, not yes or no. */
1889 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1890 bool interactive
, struct stat
*statptr
,
1893 Lisp_Object tem
, encoded_filename
;
1894 struct stat statbuf
;
1895 struct gcpro gcpro1
;
1897 encoded_filename
= ENCODE_FILE (absname
);
1899 /* `stat' is a good way to tell whether the file exists,
1900 regardless of what access permissions it has. */
1901 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1903 if (S_ISDIR (statbuf
.st_mode
))
1904 xsignal2 (Qfile_error
,
1905 build_string ("File is a directory"), absname
);
1908 xsignal2 (Qfile_already_exists
,
1909 build_string ("File already exists"), absname
);
1911 tem
= format2 ("File %s already exists; %s anyway? ",
1912 absname
, build_string (querystring
));
1914 tem
= call1 (intern ("y-or-n-p"), tem
);
1916 tem
= do_yes_or_no_p (tem
);
1919 xsignal2 (Qfile_already_exists
,
1920 build_string ("File already exists"), absname
);
1927 statptr
->st_mode
= 0;
1932 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1933 "fCopy file: \nGCopy %s to file: \np\nP",
1934 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1935 If NEWNAME names a directory, copy FILE there.
1937 This function always sets the file modes of the output file to match
1940 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1941 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1942 signal a `file-already-exists' error without overwriting. If
1943 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1944 about overwriting; this is what happens in interactive use with M-x.
1945 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1948 Fourth arg KEEP-TIME non-nil means give the output file the same
1949 last-modified time as the old one. (This works on only some systems.)
1951 A prefix arg makes KEEP-TIME non-nil.
1953 If PRESERVE-UID-GID is non-nil, we try to transfer the
1954 uid and gid of FILE to NEWNAME.
1956 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1957 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1958 entries (depending on how Emacs was built). */)
1959 (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
)
1963 char buf
[16 * 1024];
1964 struct stat st
, out_st
;
1965 Lisp_Object handler
;
1966 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1967 ptrdiff_t count
= SPECPDL_INDEX ();
1968 Lisp_Object encoded_file
, encoded_newname
;
1970 security_context_t con
;
1973 #ifdef HAVE_POSIX_ACL
1977 encoded_file
= encoded_newname
= Qnil
;
1978 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1979 CHECK_STRING (file
);
1980 CHECK_STRING (newname
);
1982 if (!NILP (Ffile_directory_p (newname
)))
1983 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1985 newname
= Fexpand_file_name (newname
, Qnil
);
1987 file
= Fexpand_file_name (file
, Qnil
);
1989 /* If the input file name has special constructs in it,
1990 call the corresponding file handler. */
1991 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1992 /* Likewise for output file name. */
1994 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1995 if (!NILP (handler
))
1996 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1997 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1998 preserve_extended_attributes
));
2000 encoded_file
= ENCODE_FILE (file
);
2001 encoded_newname
= ENCODE_FILE (newname
);
2003 if (NILP (ok_if_already_exists
)
2004 || INTEGERP (ok_if_already_exists
))
2005 barf_or_query_if_file_exists (newname
, "copy to it",
2006 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2007 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
2011 if (!NILP (preserve_extended_attributes
))
2013 #ifdef HAVE_POSIX_ACL
2014 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2015 if (acl
== NULL
&& errno
!= ENOTSUP
)
2016 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2019 if (!CopyFile (SDATA (encoded_file
),
2020 SDATA (encoded_newname
),
2023 /* CopyFile doesn't set errno when it fails. By far the most
2024 "popular" reason is that the target is read-only. */
2025 if (GetLastError () == 5)
2029 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2031 /* CopyFile retains the timestamp by default. */
2032 else if (NILP (keep_time
))
2038 filename
= SDATA (encoded_newname
);
2040 /* Ensure file is writable while its modified time is set. */
2041 attributes
= GetFileAttributes (filename
);
2042 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2043 now
= current_emacs_time ();
2044 if (set_file_times (-1, filename
, now
, now
))
2046 /* Restore original attributes. */
2047 SetFileAttributes (filename
, attributes
);
2048 xsignal2 (Qfile_date_error
,
2049 build_string ("Cannot set file date"), newname
);
2051 /* Restore original attributes. */
2052 SetFileAttributes (filename
, attributes
);
2054 #ifdef HAVE_POSIX_ACL
2058 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2059 if (fail
&& errno
!= ENOTSUP
)
2060 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2065 #else /* not WINDOWSNT */
2067 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2071 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2073 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2075 if (fstat (ifd
, &st
) != 0)
2076 report_file_error ("Input file status", Fcons (file
, Qnil
));
2078 if (!NILP (preserve_extended_attributes
))
2081 if (is_selinux_enabled ())
2083 conlength
= fgetfilecon (ifd
, &con
);
2084 if (conlength
== -1)
2085 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
2089 #ifdef HAVE_POSIX_ACL
2090 acl
= acl_get_fd (ifd
);
2091 if (acl
== NULL
&& errno
!= ENOTSUP
)
2092 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2096 if (out_st
.st_mode
!= 0
2097 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2100 report_file_error ("Input and output files are the same",
2101 Fcons (file
, Fcons (newname
, Qnil
)));
2104 /* We can copy only regular files. */
2105 if (!S_ISREG (st
.st_mode
))
2107 /* Get a better looking error message. */
2108 errno
= S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
;
2109 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2113 /* System's default file type was set to binary by _fmode in emacs.c. */
2114 ofd
= emacs_open (SDATA (encoded_newname
),
2115 O_WRONLY
| O_TRUNC
| O_CREAT
2116 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2117 S_IREAD
| S_IWRITE
);
2118 #else /* not MSDOS */
2120 mode_t new_mask
= !NILP (preserve_uid_gid
) ? 0600 : 0666;
2121 new_mask
&= st
.st_mode
;
2122 ofd
= emacs_open (SSDATA (encoded_newname
),
2123 (O_WRONLY
| O_TRUNC
| O_CREAT
2124 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2127 #endif /* not MSDOS */
2129 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2131 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2135 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2136 if (emacs_write (ofd
, buf
, n
) != n
)
2137 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2141 /* Preserve the original file modes, and if requested, also its
2144 mode_t mode_mask
= 07777;
2145 if (!NILP (preserve_uid_gid
))
2147 /* Attempt to change owner and group. If that doesn't work
2148 attempt to change just the group, as that is sometimes allowed.
2149 Adjust the mode mask to eliminate setuid or setgid bits
2150 that are inappropriate if the owner and group are wrong. */
2151 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2153 mode_mask
&= ~06000;
2154 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2158 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2159 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2161 #endif /* not MSDOS */
2166 /* Set the modified context back to the file. */
2167 bool fail
= fsetfilecon (ofd
, con
) != 0;
2168 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2169 if (fail
&& errno
!= ENOTSUP
)
2170 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2176 #ifdef HAVE_POSIX_ACL
2179 bool fail
= acl_set_fd (ofd
, acl
) != 0;
2180 if (fail
&& errno
!= ENOTSUP
)
2181 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2187 if (!NILP (keep_time
))
2189 EMACS_TIME atime
= get_stat_atime (&st
);
2190 EMACS_TIME mtime
= get_stat_mtime (&st
);
2191 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2192 xsignal2 (Qfile_date_error
,
2193 build_string ("Cannot set file date"), newname
);
2196 if (emacs_close (ofd
) < 0)
2197 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2202 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2203 and if it can't, it tells so. Otherwise, under MSDOS we usually
2204 get only the READ bit, which will make the copied file read-only,
2205 so it's better not to chmod at all. */
2206 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2207 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2209 #endif /* not WINDOWSNT */
2211 /* Discard the unwind protects. */
2212 specpdl_ptr
= specpdl
+ count
;
2218 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2219 Smake_directory_internal
, 1, 1, 0,
2220 doc
: /* Create a new directory named DIRECTORY. */)
2221 (Lisp_Object directory
)
2224 Lisp_Object handler
;
2225 Lisp_Object encoded_dir
;
2227 CHECK_STRING (directory
);
2228 directory
= Fexpand_file_name (directory
, Qnil
);
2230 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2231 if (!NILP (handler
))
2232 return call2 (handler
, Qmake_directory_internal
, directory
);
2234 encoded_dir
= ENCODE_FILE (directory
);
2236 dir
= SSDATA (encoded_dir
);
2239 if (mkdir (dir
) != 0)
2241 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2243 report_file_error ("Creating directory", list1 (directory
));
2248 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2249 Sdelete_directory_internal
, 1, 1, 0,
2250 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2251 (Lisp_Object directory
)
2254 Lisp_Object encoded_dir
;
2256 CHECK_STRING (directory
);
2257 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2258 encoded_dir
= ENCODE_FILE (directory
);
2259 dir
= SSDATA (encoded_dir
);
2261 if (rmdir (dir
) != 0)
2262 report_file_error ("Removing directory", list1 (directory
));
2267 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2268 "(list (read-file-name \
2269 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2270 \"Move file to trash: \" \"Delete file: \") \
2271 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2272 (null current-prefix-arg))",
2273 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2274 If file has multiple names, it continues to exist with the other names.
2275 TRASH non-nil means to trash the file instead of deleting, provided
2276 `delete-by-moving-to-trash' is non-nil.
2278 When called interactively, TRASH is t if no prefix argument is given.
2279 With a prefix argument, TRASH is nil. */)
2280 (Lisp_Object filename
, Lisp_Object trash
)
2282 Lisp_Object handler
;
2283 Lisp_Object encoded_file
;
2284 struct gcpro gcpro1
;
2287 if (!NILP (Ffile_directory_p (filename
))
2288 && NILP (Ffile_symlink_p (filename
)))
2289 xsignal2 (Qfile_error
,
2290 build_string ("Removing old name: is a directory"),
2293 filename
= Fexpand_file_name (filename
, Qnil
);
2295 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2296 if (!NILP (handler
))
2297 return call3 (handler
, Qdelete_file
, filename
, trash
);
2299 if (delete_by_moving_to_trash
&& !NILP (trash
))
2300 return call1 (Qmove_file_to_trash
, filename
);
2302 encoded_file
= ENCODE_FILE (filename
);
2304 if (unlink (SSDATA (encoded_file
)) < 0)
2305 report_file_error ("Removing old name", list1 (filename
));
2310 internal_delete_file_1 (Lisp_Object ignore
)
2315 /* Delete file FILENAME, returning true if successful.
2316 This ignores `delete-by-moving-to-trash'. */
2319 internal_delete_file (Lisp_Object filename
)
2323 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2324 Qt
, internal_delete_file_1
);
2328 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2329 "fRename file: \nGRename %s to file: \np",
2330 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2331 If file has names other than FILE, it continues to have those names.
2332 Signals a `file-already-exists' error if a file NEWNAME already exists
2333 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2334 A number as third arg means request confirmation if NEWNAME already exists.
2335 This is what happens in interactive use with M-x. */)
2336 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2338 Lisp_Object handler
;
2339 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2340 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2342 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2343 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2344 CHECK_STRING (file
);
2345 CHECK_STRING (newname
);
2346 file
= Fexpand_file_name (file
, Qnil
);
2348 if ((!NILP (Ffile_directory_p (newname
)))
2350 /* If the file names are identical but for the case,
2351 don't attempt to move directory to itself. */
2352 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2356 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2357 ? file
: Fdirectory_file_name (file
));
2358 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2361 newname
= Fexpand_file_name (newname
, Qnil
);
2363 /* If the file name has special constructs in it,
2364 call the corresponding file handler. */
2365 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2367 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2368 if (!NILP (handler
))
2369 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2370 file
, newname
, ok_if_already_exists
));
2372 encoded_file
= ENCODE_FILE (file
);
2373 encoded_newname
= ENCODE_FILE (newname
);
2376 /* If the file names are identical but for the case, don't ask for
2377 confirmation: they simply want to change the letter-case of the
2379 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2381 if (NILP (ok_if_already_exists
)
2382 || INTEGERP (ok_if_already_exists
))
2383 barf_or_query_if_file_exists (newname
, "rename to it",
2384 INTEGERP (ok_if_already_exists
), 0, 0);
2385 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2390 symlink_target
= Ffile_symlink_p (file
);
2391 if (! NILP (symlink_target
))
2392 Fmake_symbolic_link (symlink_target
, newname
,
2393 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2394 else if (!NILP (Ffile_directory_p (file
)))
2395 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2397 /* We have already prompted if it was an integer, so don't
2398 have copy-file prompt again. */
2399 Fcopy_file (file
, newname
,
2400 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2403 count
= SPECPDL_INDEX ();
2404 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2406 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2407 call2 (Qdelete_directory
, file
, Qt
);
2409 Fdelete_file (file
, Qnil
);
2410 unbind_to (count
, Qnil
);
2413 report_file_error ("Renaming", list2 (file
, newname
));
2419 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2420 "fAdd name to file: \nGName to add to %s: \np",
2421 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2422 Signals a `file-already-exists' error if a file NEWNAME already exists
2423 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2424 A number as third arg means request confirmation if NEWNAME already exists.
2425 This is what happens in interactive use with M-x. */)
2426 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2428 Lisp_Object handler
;
2429 Lisp_Object encoded_file
, encoded_newname
;
2430 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2432 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2433 encoded_file
= encoded_newname
= Qnil
;
2434 CHECK_STRING (file
);
2435 CHECK_STRING (newname
);
2436 file
= Fexpand_file_name (file
, Qnil
);
2438 if (!NILP (Ffile_directory_p (newname
)))
2439 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2441 newname
= Fexpand_file_name (newname
, Qnil
);
2443 /* If the file name has special constructs in it,
2444 call the corresponding file handler. */
2445 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2446 if (!NILP (handler
))
2447 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2448 newname
, ok_if_already_exists
));
2450 /* If the new name has special constructs in it,
2451 call the corresponding file handler. */
2452 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2453 if (!NILP (handler
))
2454 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2455 newname
, ok_if_already_exists
));
2457 encoded_file
= ENCODE_FILE (file
);
2458 encoded_newname
= ENCODE_FILE (newname
);
2460 if (NILP (ok_if_already_exists
)
2461 || INTEGERP (ok_if_already_exists
))
2462 barf_or_query_if_file_exists (newname
, "make it a new name",
2463 INTEGERP (ok_if_already_exists
), 0, 0);
2465 unlink (SSDATA (newname
));
2466 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2467 report_file_error ("Adding new name", list2 (file
, newname
));
2473 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2474 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2475 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2476 Both args must be strings.
2477 Signals a `file-already-exists' error if a file LINKNAME already exists
2478 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2479 A number as third arg means request confirmation if LINKNAME already exists.
2480 This happens for interactive use with M-x. */)
2481 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2483 Lisp_Object handler
;
2484 Lisp_Object encoded_filename
, encoded_linkname
;
2485 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2487 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2488 encoded_filename
= encoded_linkname
= Qnil
;
2489 CHECK_STRING (filename
);
2490 CHECK_STRING (linkname
);
2491 /* If the link target has a ~, we must expand it to get
2492 a truly valid file name. Otherwise, do not expand;
2493 we want to permit links to relative file names. */
2494 if (SREF (filename
, 0) == '~')
2495 filename
= Fexpand_file_name (filename
, Qnil
);
2497 if (!NILP (Ffile_directory_p (linkname
)))
2498 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2500 linkname
= Fexpand_file_name (linkname
, Qnil
);
2502 /* If the file name has special constructs in it,
2503 call the corresponding file handler. */
2504 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2505 if (!NILP (handler
))
2506 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2507 linkname
, ok_if_already_exists
));
2509 /* If the new link name has special constructs in it,
2510 call the corresponding file handler. */
2511 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2512 if (!NILP (handler
))
2513 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2514 linkname
, ok_if_already_exists
));
2516 encoded_filename
= ENCODE_FILE (filename
);
2517 encoded_linkname
= ENCODE_FILE (linkname
);
2519 if (NILP (ok_if_already_exists
)
2520 || INTEGERP (ok_if_already_exists
))
2521 barf_or_query_if_file_exists (linkname
, "make it a link",
2522 INTEGERP (ok_if_already_exists
), 0, 0);
2523 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2525 /* If we didn't complain already, silently delete existing file. */
2526 if (errno
== EEXIST
)
2528 unlink (SSDATA (encoded_linkname
));
2529 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2536 if (errno
== ENOSYS
)
2539 xsignal1 (Qfile_error
,
2540 build_string ("Symbolic links are not supported"));
2543 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2550 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2552 doc
: /* Return t if file FILENAME specifies an absolute file name.
2553 On Unix, this is a name starting with a `/' or a `~'. */)
2554 (Lisp_Object filename
)
2556 CHECK_STRING (filename
);
2557 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2560 /* Return true if FILENAME exists. */
2562 check_existing (const char *filename
)
2564 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2567 /* Return true if file FILENAME exists and can be executed. */
2570 check_executable (char *filename
)
2572 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2575 /* Return true if file FILENAME exists and can be accessed
2576 according to AMODE, which should include W_OK.
2577 On failure, return false and set errno. */
2580 check_writable (const char *filename
, int amode
)
2583 /* FIXME: an faccessat implementation should be added to the
2584 DOS/Windows ports and this #ifdef branch should be removed. */
2586 if (stat (filename
, &st
) < 0)
2589 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2590 #else /* not MSDOS */
2591 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2593 /* faccessat may have returned failure because Cygwin couldn't
2594 determine the file's UID or GID; if so, we return success. */
2597 int faccessat_errno
= errno
;
2599 if (stat (filename
, &st
) < 0)
2601 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2602 errno
= faccessat_errno
;
2606 #endif /* not MSDOS */
2609 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2610 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2611 See also `file-readable-p' and `file-attributes'.
2612 This returns nil for a symlink to a nonexistent file.
2613 Use `file-symlink-p' to test for such links. */)
2614 (Lisp_Object filename
)
2616 Lisp_Object absname
;
2617 Lisp_Object handler
;
2619 CHECK_STRING (filename
);
2620 absname
= Fexpand_file_name (filename
, Qnil
);
2622 /* If the file name has special constructs in it,
2623 call the corresponding file handler. */
2624 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2625 if (!NILP (handler
))
2626 return call2 (handler
, Qfile_exists_p
, absname
);
2628 absname
= ENCODE_FILE (absname
);
2630 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2633 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2634 doc
: /* Return t if FILENAME can be executed by you.
2635 For a directory, this means you can access files in that directory. */)
2636 (Lisp_Object filename
)
2638 Lisp_Object absname
;
2639 Lisp_Object handler
;
2641 CHECK_STRING (filename
);
2642 absname
= Fexpand_file_name (filename
, Qnil
);
2644 /* If the file name has special constructs in it,
2645 call the corresponding file handler. */
2646 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2647 if (!NILP (handler
))
2648 return call2 (handler
, Qfile_executable_p
, absname
);
2650 absname
= ENCODE_FILE (absname
);
2652 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2655 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2656 doc
: /* Return t if file FILENAME exists and you can read it.
2657 See also `file-exists-p' and `file-attributes'. */)
2658 (Lisp_Object filename
)
2660 Lisp_Object absname
;
2661 Lisp_Object handler
;
2663 CHECK_STRING (filename
);
2664 absname
= Fexpand_file_name (filename
, Qnil
);
2666 /* If the file name has special constructs in it,
2667 call the corresponding file handler. */
2668 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2669 if (!NILP (handler
))
2670 return call2 (handler
, Qfile_readable_p
, absname
);
2672 absname
= ENCODE_FILE (absname
);
2673 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2677 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2678 doc
: /* Return t if file FILENAME can be written or created by you. */)
2679 (Lisp_Object filename
)
2681 Lisp_Object absname
, dir
, encoded
;
2682 Lisp_Object handler
;
2684 CHECK_STRING (filename
);
2685 absname
= Fexpand_file_name (filename
, Qnil
);
2687 /* If the file name has special constructs in it,
2688 call the corresponding file handler. */
2689 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2690 if (!NILP (handler
))
2691 return call2 (handler
, Qfile_writable_p
, absname
);
2693 encoded
= ENCODE_FILE (absname
);
2694 if (check_writable (SSDATA (encoded
), W_OK
))
2696 if (errno
!= ENOENT
)
2699 dir
= Ffile_name_directory (absname
);
2700 eassert (!NILP (dir
));
2702 dir
= Fdirectory_file_name (dir
);
2705 dir
= ENCODE_FILE (dir
);
2707 /* The read-only attribute of the parent directory doesn't affect
2708 whether a file or directory can be created within it. Some day we
2709 should check ACLs though, which do affect this. */
2710 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2712 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2716 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2717 doc
: /* Access file FILENAME, and get an error if that does not work.
2718 The second argument STRING is used in the error message.
2719 If there is no error, returns nil. */)
2720 (Lisp_Object filename
, Lisp_Object string
)
2722 Lisp_Object handler
, encoded_filename
, absname
;
2725 CHECK_STRING (filename
);
2726 absname
= Fexpand_file_name (filename
, Qnil
);
2728 CHECK_STRING (string
);
2730 /* If the file name has special constructs in it,
2731 call the corresponding file handler. */
2732 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2733 if (!NILP (handler
))
2734 return call3 (handler
, Qaccess_file
, absname
, string
);
2736 encoded_filename
= ENCODE_FILE (absname
);
2738 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2740 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2746 /* Relative to directory FD, return the symbolic link value of FILENAME.
2747 On failure, return nil. */
2749 emacs_readlinkat (int fd
, char const *filename
)
2751 static struct allocator
const emacs_norealloc_allocator
=
2752 { xmalloc
, NULL
, xfree
, memory_full
};
2754 char readlink_buf
[1024];
2755 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2756 &emacs_norealloc_allocator
, readlinkat
);
2760 val
= build_string (buf
);
2761 if (buf
[0] == '/' && strchr (buf
, ':'))
2762 val
= concat2 (build_string ("/:"), val
);
2763 if (buf
!= readlink_buf
)
2765 val
= DECODE_FILE (val
);
2769 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2770 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2771 The value is the link target, as a string.
2772 Otherwise it returns nil.
2774 This function returns t when given the name of a symlink that
2775 points to a nonexistent file. */)
2776 (Lisp_Object filename
)
2778 Lisp_Object handler
;
2780 CHECK_STRING (filename
);
2781 filename
= Fexpand_file_name (filename
, Qnil
);
2783 /* If the file name has special constructs in it,
2784 call the corresponding file handler. */
2785 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2786 if (!NILP (handler
))
2787 return call2 (handler
, Qfile_symlink_p
, filename
);
2789 filename
= ENCODE_FILE (filename
);
2791 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2794 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2795 doc
: /* Return t if FILENAME names an existing directory.
2796 Symbolic links to directories count as directories.
2797 See `file-symlink-p' to distinguish symlinks. */)
2798 (Lisp_Object filename
)
2800 Lisp_Object absname
;
2801 Lisp_Object handler
;
2803 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2805 /* If the file name has special constructs in it,
2806 call the corresponding file handler. */
2807 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2808 if (!NILP (handler
))
2809 return call2 (handler
, Qfile_directory_p
, absname
);
2811 absname
= ENCODE_FILE (absname
);
2813 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2816 /* Return true if FILE is a directory or a symlink to a directory. */
2818 file_directory_p (char const *file
)
2821 /* This is cheaper than 'stat'. */
2822 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2825 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2829 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2830 Sfile_accessible_directory_p
, 1, 1, 0,
2831 doc
: /* Return t if file FILENAME names a directory you can open.
2832 For the value to be t, FILENAME must specify the name of a directory as a file,
2833 and the directory must allow you to open files in it. In order to use a
2834 directory as a buffer's current directory, this predicate must return true.
2835 A directory name spec may be given instead; then the value is t
2836 if the directory so specified exists and really is a readable and
2837 searchable directory. */)
2838 (Lisp_Object filename
)
2840 Lisp_Object absname
;
2841 Lisp_Object handler
;
2843 CHECK_STRING (filename
);
2844 absname
= Fexpand_file_name (filename
, Qnil
);
2846 /* If the file name has special constructs in it,
2847 call the corresponding file handler. */
2848 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2849 if (!NILP (handler
))
2850 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2852 absname
= ENCODE_FILE (absname
);
2853 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2856 /* If FILE is a searchable directory or a symlink to a
2857 searchable directory, return true. Otherwise return
2858 false and set errno to an error number. */
2860 file_accessible_directory_p (char const *file
)
2863 /* There's no need to test whether FILE is searchable, as the
2864 searchable/executable bit is invented on DOS_NT platforms. */
2865 return file_directory_p (file
);
2867 /* On POSIXish platforms, use just one system call; this avoids a
2868 race and is typically faster. */
2869 ptrdiff_t len
= strlen (file
);
2875 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2876 There are three exceptions: "", "/", and "//". Leave "" alone,
2877 as it's invalid. Append only "." to the other two exceptions as
2878 "/" and "//" are distinct on some platforms, whereas "/", "///",
2879 "////", etc. are all equivalent. */
2884 /* Just check for trailing '/' when deciding whether to append '/'.
2885 That's simpler than testing the two special cases "/" and "//",
2886 and it's a safe optimization here. */
2887 char *buf
= SAFE_ALLOCA (len
+ 3);
2888 memcpy (buf
, file
, len
);
2889 strcpy (buf
+ len
, "/." + (file
[len
- 1] == '/'));
2893 ok
= check_existing (dir
);
2894 saved_errno
= errno
;
2896 errno
= saved_errno
;
2901 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2902 doc
: /* Return t if FILENAME names a regular file.
2903 This is the sort of file that holds an ordinary stream of data bytes.
2904 Symbolic links to regular files count as regular files.
2905 See `file-symlink-p' to distinguish symlinks. */)
2906 (Lisp_Object filename
)
2908 register Lisp_Object absname
;
2910 Lisp_Object handler
;
2912 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2914 /* If the file name has special constructs in it,
2915 call the corresponding file handler. */
2916 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2917 if (!NILP (handler
))
2918 return call2 (handler
, Qfile_regular_p
, absname
);
2920 absname
= ENCODE_FILE (absname
);
2925 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2927 /* Tell stat to use expensive method to get accurate info. */
2928 Vw32_get_true_file_attributes
= Qt
;
2929 result
= stat (SDATA (absname
), &st
);
2930 Vw32_get_true_file_attributes
= tem
;
2934 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2937 if (stat (SSDATA (absname
), &st
) < 0)
2939 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2943 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2944 Sfile_selinux_context
, 1, 1, 0,
2945 doc
: /* Return SELinux context of file named FILENAME.
2946 The return value is a list (USER ROLE TYPE RANGE), where the list
2947 elements are strings naming the user, role, type, and range of the
2948 file's SELinux security context.
2950 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2951 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2952 (Lisp_Object filename
)
2954 Lisp_Object absname
;
2955 Lisp_Object values
[4];
2956 Lisp_Object handler
;
2958 security_context_t con
;
2963 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2965 /* If the file name has special constructs in it,
2966 call the corresponding file handler. */
2967 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2968 if (!NILP (handler
))
2969 return call2 (handler
, Qfile_selinux_context
, absname
);
2971 absname
= ENCODE_FILE (absname
);
2978 if (is_selinux_enabled ())
2980 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2983 context
= context_new (con
);
2984 if (context_user_get (context
))
2985 values
[0] = build_string (context_user_get (context
));
2986 if (context_role_get (context
))
2987 values
[1] = build_string (context_role_get (context
));
2988 if (context_type_get (context
))
2989 values
[2] = build_string (context_type_get (context
));
2990 if (context_range_get (context
))
2991 values
[3] = build_string (context_range_get (context
));
2992 context_free (context
);
2998 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
3001 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
3002 Sset_file_selinux_context
, 2, 2, 0,
3003 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
3004 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
3005 elements are strings naming the components of a SELinux context.
3007 Value is t if setting of SELinux context was successful, nil otherwise.
3009 This function does nothing and returns nil if SELinux is disabled,
3010 or if Emacs was not compiled with SELinux support. */)
3011 (Lisp_Object filename
, Lisp_Object context
)
3013 Lisp_Object absname
;
3014 Lisp_Object handler
;
3016 Lisp_Object encoded_absname
;
3017 Lisp_Object user
= CAR_SAFE (context
);
3018 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
3019 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
3020 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
3021 security_context_t con
;
3024 context_t parsed_con
;
3027 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3029 /* If the file name has special constructs in it,
3030 call the corresponding file handler. */
3031 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
3032 if (!NILP (handler
))
3033 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
3036 if (is_selinux_enabled ())
3038 /* Get current file context. */
3039 encoded_absname
= ENCODE_FILE (absname
);
3040 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
3043 parsed_con
= context_new (con
);
3044 /* Change the parts defined in the parameter.*/
3047 if (context_user_set (parsed_con
, SSDATA (user
)))
3048 error ("Doing context_user_set");
3052 if (context_role_set (parsed_con
, SSDATA (role
)))
3053 error ("Doing context_role_set");
3057 if (context_type_set (parsed_con
, SSDATA (type
)))
3058 error ("Doing context_type_set");
3060 if (STRINGP (range
))
3062 if (context_range_set (parsed_con
, SSDATA (range
)))
3063 error ("Doing context_range_set");
3066 /* Set the modified context back to the file. */
3067 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3068 context_str (parsed_con
))
3070 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3071 if (fail
&& errno
!= ENOTSUP
)
3072 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
3074 context_free (parsed_con
);
3076 return fail
? Qnil
: Qt
;
3079 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
3086 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3087 doc
: /* Return ACL entries of file named FILENAME.
3088 The entries are returned in a format suitable for use in `set-file-acl'
3089 but is otherwise undocumented and subject to change.
3090 Return nil if file does not exist or is not accessible, or if Emacs
3091 was unable to determine the ACL entries. */)
3092 (Lisp_Object filename
)
3094 Lisp_Object absname
;
3095 Lisp_Object handler
;
3096 #ifdef HAVE_POSIX_ACL
3098 Lisp_Object acl_string
;
3102 absname
= expand_and_dir_to_file (filename
,
3103 BVAR (current_buffer
, directory
));
3105 /* If the file name has special constructs in it,
3106 call the corresponding file handler. */
3107 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3108 if (!NILP (handler
))
3109 return call2 (handler
, Qfile_acl
, absname
);
3111 #ifdef HAVE_POSIX_ACL
3112 absname
= ENCODE_FILE (absname
);
3114 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3118 str
= acl_to_text (acl
, NULL
);
3125 acl_string
= build_string (str
);
3135 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3137 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3138 ACL-STRING should contain the textual representation of the ACL
3139 entries in a format suitable for the platform.
3141 Value is t if setting of ACL was successful, nil otherwise.
3143 Setting ACL for local files requires Emacs to be built with ACL
3145 (Lisp_Object filename
, Lisp_Object acl_string
)
3147 Lisp_Object absname
;
3148 Lisp_Object handler
;
3149 #ifdef HAVE_POSIX_ACL
3150 Lisp_Object encoded_absname
;
3155 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3157 /* If the file name has special constructs in it,
3158 call the corresponding file handler. */
3159 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3160 if (!NILP (handler
))
3161 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3163 #ifdef HAVE_POSIX_ACL
3164 if (STRINGP (acl_string
))
3166 acl
= acl_from_text (SSDATA (acl_string
));
3169 report_file_error ("Converting ACL", Fcons (absname
, Qnil
));
3173 encoded_absname
= ENCODE_FILE (absname
);
3175 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3178 if (fail
&& errno
!= ENOTSUP
)
3179 report_file_error ("Setting ACL", Fcons (absname
, Qnil
));
3182 return fail
? Qnil
: Qt
;
3189 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3190 doc
: /* Return mode bits of file named FILENAME, as an integer.
3191 Return nil, if file does not exist or is not accessible. */)
3192 (Lisp_Object filename
)
3194 Lisp_Object absname
;
3196 Lisp_Object handler
;
3198 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3200 /* If the file name has special constructs in it,
3201 call the corresponding file handler. */
3202 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3203 if (!NILP (handler
))
3204 return call2 (handler
, Qfile_modes
, absname
);
3206 absname
= ENCODE_FILE (absname
);
3208 if (stat (SSDATA (absname
), &st
) < 0)
3211 return make_number (st
.st_mode
& 07777);
3214 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3215 "(let ((file (read-file-name \"File: \"))) \
3216 (list file (read-file-modes nil file)))",
3217 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3218 Only the 12 low bits of MODE are used.
3220 Interactively, mode bits are read by `read-file-modes', which accepts
3221 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3222 (Lisp_Object filename
, Lisp_Object mode
)
3224 Lisp_Object absname
, encoded_absname
;
3225 Lisp_Object handler
;
3227 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3228 CHECK_NUMBER (mode
);
3230 /* If the file name has special constructs in it,
3231 call the corresponding file handler. */
3232 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3233 if (!NILP (handler
))
3234 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3236 encoded_absname
= ENCODE_FILE (absname
);
3238 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3239 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3244 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3245 doc
: /* Set the file permission bits for newly created files.
3246 The argument MODE should be an integer; only the low 9 bits are used.
3247 This setting is inherited by subprocesses. */)
3250 CHECK_NUMBER (mode
);
3252 umask ((~ XINT (mode
)) & 0777);
3257 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3258 doc
: /* Return the default file protection for created files.
3259 The value is an integer. */)
3266 realmask
= umask (0);
3270 XSETINT (value
, (~ realmask
) & 0777);
3275 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3276 doc
: /* Set times of file FILENAME to TIMESTAMP.
3277 Set both access and modification times.
3278 Return t on success, else nil.
3279 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3281 (Lisp_Object filename
, Lisp_Object timestamp
)
3283 Lisp_Object absname
, encoded_absname
;
3284 Lisp_Object handler
;
3285 EMACS_TIME t
= lisp_time_argument (timestamp
);
3287 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3289 /* If the file name has special constructs in it,
3290 call the corresponding file handler. */
3291 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3292 if (!NILP (handler
))
3293 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3295 encoded_absname
= ENCODE_FILE (absname
);
3298 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3301 /* Setting times on a directory always fails. */
3302 if (file_directory_p (SSDATA (encoded_absname
)))
3305 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3314 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3315 doc
: /* Tell Unix to finish all pending disk updates. */)
3322 #endif /* HAVE_SYNC */
3324 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3325 doc
: /* Return t if file FILE1 is newer than file FILE2.
3326 If FILE1 does not exist, the answer is nil;
3327 otherwise, if FILE2 does not exist, the answer is t. */)
3328 (Lisp_Object file1
, Lisp_Object file2
)
3330 Lisp_Object absname1
, absname2
;
3331 struct stat st1
, st2
;
3332 Lisp_Object handler
;
3333 struct gcpro gcpro1
, gcpro2
;
3335 CHECK_STRING (file1
);
3336 CHECK_STRING (file2
);
3339 GCPRO2 (absname1
, file2
);
3340 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3341 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3344 /* If the file name has special constructs in it,
3345 call the corresponding file handler. */
3346 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3348 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3349 if (!NILP (handler
))
3350 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3352 GCPRO2 (absname1
, absname2
);
3353 absname1
= ENCODE_FILE (absname1
);
3354 absname2
= ENCODE_FILE (absname2
);
3357 if (stat (SSDATA (absname1
), &st1
) < 0)
3360 if (stat (SSDATA (absname2
), &st2
) < 0)
3363 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3367 #ifndef READ_BUF_SIZE
3368 #define READ_BUF_SIZE (64 << 10)
3370 /* Some buffer offsets are stored in 'int' variables. */
3371 verify (READ_BUF_SIZE
<= INT_MAX
);
3373 /* This function is called after Lisp functions to decide a coding
3374 system are called, or when they cause an error. Before they are
3375 called, the current buffer is set unibyte and it contains only a
3376 newly inserted text (thus the buffer was empty before the
3379 The functions may set markers, overlays, text properties, or even
3380 alter the buffer contents, change the current buffer.
3382 Here, we reset all those changes by:
3383 o set back the current buffer.
3384 o move all markers and overlays to BEG.
3385 o remove all text properties.
3386 o set back the buffer multibyteness. */
3389 decide_coding_unwind (Lisp_Object unwind_data
)
3391 Lisp_Object multibyte
, undo_list
, buffer
;
3393 multibyte
= XCAR (unwind_data
);
3394 unwind_data
= XCDR (unwind_data
);
3395 undo_list
= XCAR (unwind_data
);
3396 buffer
= XCDR (unwind_data
);
3398 set_buffer_internal (XBUFFER (buffer
));
3399 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3400 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3401 set_buffer_intervals (current_buffer
, NULL
);
3402 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3404 /* Now we are safe to change the buffer's multibyteness directly. */
3405 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3406 bset_undo_list (current_buffer
, undo_list
);
3411 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3412 object where slot 0 is the file descriptor, slot 1 specifies
3413 an offset to put the read bytes, and slot 2 is the maximum
3414 amount of bytes to read. Value is the number of bytes read. */
3417 read_non_regular (Lisp_Object state
)
3423 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3424 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3425 + XSAVE_INTEGER (state
, 1)),
3426 XSAVE_INTEGER (state
, 2));
3428 /* Fast recycle this object for the likely next call. */
3430 return make_number (nbytes
);
3434 /* Condition-case handler used when reading from non-regular files
3435 in insert-file-contents. */
3438 read_non_regular_quit (Lisp_Object ignore
)
3443 /* Return the file offset that VAL represents, checking for type
3444 errors and overflow. */
3446 file_offset (Lisp_Object val
)
3448 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3453 double v
= XFLOAT_DATA (val
);
3455 && (sizeof (off_t
) < sizeof v
3456 ? v
<= TYPE_MAXIMUM (off_t
)
3457 : v
< TYPE_MAXIMUM (off_t
)))
3461 wrong_type_argument (intern ("file-offset"), val
);
3464 /* Return a special time value indicating the error number ERRNUM. */
3466 time_error_value (int errnum
)
3468 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3469 ? NONEXISTENT_MODTIME_NSECS
3470 : UNKNOWN_MODTIME_NSECS
);
3471 return make_emacs_time (0, ns
);
3474 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3476 doc
: /* Insert contents of file FILENAME after point.
3477 Returns list of absolute file name and number of characters inserted.
3478 If second argument VISIT is non-nil, the buffer's visited filename and
3479 last save file modtime are set, and it is marked unmodified. If
3480 visiting and the file does not exist, visiting is completed before the
3483 The optional third and fourth arguments BEG and END specify what portion
3484 of the file to insert. These arguments count bytes in the file, not
3485 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3487 If optional fifth argument REPLACE is non-nil, replace the current
3488 buffer contents (in the accessible portion) with the file contents.
3489 This is better than simply deleting and inserting the whole thing
3490 because (1) it preserves some marker positions and (2) it puts less data
3491 in the undo list. When REPLACE is non-nil, the second return value is
3492 the number of characters that replace previous buffer contents.
3494 This function does code conversion according to the value of
3495 `coding-system-for-read' or `file-coding-system-alist', and sets the
3496 variable `last-coding-system-used' to the coding system actually used.
3498 In addition, this function decodes the inserted text from known formats
3499 by calling `format-decode', which see. */)
3500 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3505 ptrdiff_t inserted
= 0;
3508 off_t beg_offset
, end_offset
;
3510 ptrdiff_t count
= SPECPDL_INDEX ();
3511 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3512 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3514 ptrdiff_t total
= 0;
3515 bool not_regular
= 0;
3517 char read_buf
[READ_BUF_SIZE
];
3518 struct coding_system coding
;
3519 bool replace_handled
= 0;
3520 bool set_coding_system
= 0;
3521 Lisp_Object coding_system
;
3523 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3524 bool we_locked_file
= 0;
3525 bool deferred_remove_unwind_protect
= 0;
3527 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3528 error ("Cannot do file visiting in an indirect buffer");
3530 if (!NILP (BVAR (current_buffer
, read_only
)))
3531 Fbarf_if_buffer_read_only ();
3535 orig_filename
= Qnil
;
3538 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3540 CHECK_STRING (filename
);
3541 filename
= Fexpand_file_name (filename
, Qnil
);
3543 /* The value Qnil means that the coding system is not yet
3545 coding_system
= Qnil
;
3547 /* If the file name has special constructs in it,
3548 call the corresponding file handler. */
3549 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3550 if (!NILP (handler
))
3552 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3553 visit
, beg
, end
, replace
);
3554 if (CONSP (val
) && CONSP (XCDR (val
))
3555 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3556 inserted
= XINT (XCAR (XCDR (val
)));
3560 orig_filename
= filename
;
3561 filename
= ENCODE_FILE (filename
);
3563 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3568 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3569 mtime
= time_error_value (save_errno
);
3571 if (!NILP (Vcoding_system_for_read
))
3572 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3576 /* Replacement should preserve point as it preserves markers. */
3577 if (!NILP (replace
))
3578 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3580 record_unwind_protect (close_file_unwind
, make_number (fd
));
3582 if (fstat (fd
, &st
) != 0)
3583 report_file_error ("Input file status", Fcons (orig_filename
, Qnil
));
3584 mtime
= get_stat_mtime (&st
);
3586 /* This code will need to be changed in order to work on named
3587 pipes, and it's probably just not worth it. So we should at
3588 least signal an error. */
3589 if (!S_ISREG (st
.st_mode
))
3596 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3597 xsignal2 (Qfile_error
,
3598 build_string ("not a regular file"), orig_filename
);
3603 if (!NILP (beg
) || !NILP (end
))
3604 error ("Attempt to visit less than an entire file");
3605 if (BEG
< Z
&& NILP (replace
))
3606 error ("Cannot do file visiting in a non-empty buffer");
3610 beg_offset
= file_offset (beg
);
3615 end_offset
= file_offset (end
);
3619 end_offset
= TYPE_MAXIMUM (off_t
);
3622 end_offset
= st
.st_size
;
3624 /* A negative size can happen on a platform that allows file
3625 sizes greater than the maximum off_t value. */
3629 /* The file size returned from stat may be zero, but data
3630 may be readable nonetheless, for example when this is a
3631 file in the /proc filesystem. */
3632 if (end_offset
== 0)
3633 end_offset
= READ_BUF_SIZE
;
3637 /* Check now whether the buffer will become too large,
3638 in the likely case where the file's length is not changing.
3639 This saves a lot of needless work before a buffer overflow. */
3642 /* The likely offset where we will stop reading. We could read
3643 more (or less), if the file grows (or shrinks) as we read it. */
3644 off_t likely_end
= min (end_offset
, st
.st_size
);
3646 if (beg_offset
< likely_end
)
3649 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3650 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3651 off_t likely_growth
= likely_end
- beg_offset
;
3652 if (buf_growth_max
< likely_growth
)
3657 /* Prevent redisplay optimizations. */
3658 current_buffer
->clip_changed
= 1;
3660 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3662 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3663 setup_coding_system (coding_system
, &coding
);
3664 /* Ensure we set Vlast_coding_system_used. */
3665 set_coding_system
= 1;
3669 /* Decide the coding system to use for reading the file now
3670 because we can't use an optimized method for handling
3671 `coding:' tag if the current buffer is not empty. */
3672 if (!NILP (Vcoding_system_for_read
))
3673 coding_system
= Vcoding_system_for_read
;
3676 /* Don't try looking inside a file for a coding system
3677 specification if it is not seekable. */
3678 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3680 /* Find a coding system specified in the heading two
3681 lines or in the tailing several lines of the file.
3682 We assume that the 1K-byte and 3K-byte for heading
3683 and tailing respectively are sufficient for this
3687 if (st
.st_size
<= (1024 * 4))
3688 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3691 nread
= emacs_read (fd
, read_buf
, 1024);
3695 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3696 report_file_error ("Setting file position",
3697 Fcons (orig_filename
, Qnil
));
3698 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3699 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3704 error ("IO error reading %s: %s",
3705 SDATA (orig_filename
), emacs_strerror (errno
));
3708 struct buffer
*prev
= current_buffer
;
3709 Lisp_Object workbuf
;
3712 record_unwind_current_buffer ();
3714 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3715 buf
= XBUFFER (workbuf
);
3717 delete_all_overlays (buf
);
3718 bset_directory (buf
, BVAR (current_buffer
, directory
));
3719 bset_read_only (buf
, Qnil
);
3720 bset_filename (buf
, Qnil
);
3721 bset_undo_list (buf
, Qt
);
3722 eassert (buf
->overlays_before
== NULL
);
3723 eassert (buf
->overlays_after
== NULL
);
3725 set_buffer_internal (buf
);
3727 bset_enable_multibyte_characters (buf
, Qnil
);
3729 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3730 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3731 coding_system
= call2 (Vset_auto_coding_function
,
3732 filename
, make_number (nread
));
3733 set_buffer_internal (prev
);
3735 /* Discard the unwind protect for recovering the
3739 /* Rewind the file for the actual read done later. */
3740 if (lseek (fd
, 0, SEEK_SET
) < 0)
3741 report_file_error ("Setting file position",
3742 Fcons (orig_filename
, Qnil
));
3746 if (NILP (coding_system
))
3748 /* If we have not yet decided a coding system, check
3749 file-coding-system-alist. */
3750 Lisp_Object args
[6];
3752 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3753 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3754 coding_system
= Ffind_operation_coding_system (6, args
);
3755 if (CONSP (coding_system
))
3756 coding_system
= XCAR (coding_system
);
3760 if (NILP (coding_system
))
3761 coding_system
= Qundecided
;
3763 CHECK_CODING_SYSTEM (coding_system
);
3765 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3766 /* We must suppress all character code conversion except for
3767 end-of-line conversion. */
3768 coding_system
= raw_text_coding_system (coding_system
);
3770 setup_coding_system (coding_system
, &coding
);
3771 /* Ensure we set Vlast_coding_system_used. */
3772 set_coding_system
= 1;
3775 /* If requested, replace the accessible part of the buffer
3776 with the file contents. Avoid replacing text at the
3777 beginning or end of the buffer that matches the file contents;
3778 that preserves markers pointing to the unchanged parts.
3780 Here we implement this feature in an optimized way
3781 for the case where code conversion is NOT needed.
3782 The following if-statement handles the case of conversion
3783 in a less optimal way.
3785 If the code conversion is "automatic" then we try using this
3786 method and hope for the best.
3787 But if we discover the need for conversion, we give up on this method
3788 and let the following if-statement handle the replace job. */
3791 && (NILP (coding_system
)
3792 || ! CODING_REQUIRE_DECODING (&coding
)))
3794 /* same_at_start and same_at_end count bytes,
3795 because file access counts bytes
3796 and BEG and END count bytes. */
3797 ptrdiff_t same_at_start
= BEGV_BYTE
;
3798 ptrdiff_t same_at_end
= ZV_BYTE
;
3800 /* There is still a possibility we will find the need to do code
3801 conversion. If that happens, set this variable to
3802 give up on handling REPLACE in the optimized way. */
3803 bool giveup_match_end
= 0;
3805 if (beg_offset
!= 0)
3807 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3808 report_file_error ("Setting file position",
3809 Fcons (orig_filename
, Qnil
));
3814 /* Count how many chars at the start of the file
3815 match the text at the beginning of the buffer. */
3820 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3822 error ("IO error reading %s: %s",
3823 SSDATA (orig_filename
), emacs_strerror (errno
));
3824 else if (nread
== 0)
3827 if (CODING_REQUIRE_DETECTION (&coding
))
3829 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3832 setup_coding_system (coding_system
, &coding
);
3835 if (CODING_REQUIRE_DECODING (&coding
))
3836 /* We found that the file should be decoded somehow.
3837 Let's give up here. */
3839 giveup_match_end
= 1;
3844 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3845 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3846 same_at_start
++, bufpos
++;
3847 /* If we found a discrepancy, stop the scan.
3848 Otherwise loop around and scan the next bufferful. */
3849 if (bufpos
!= nread
)
3853 /* If the file matches the buffer completely,
3854 there's no need to replace anything. */
3855 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3859 /* Truncate the buffer to the size of the file. */
3860 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3865 /* Count how many chars at the end of the file
3866 match the text at the end of the buffer. But, if we have
3867 already found that decoding is necessary, don't waste time. */
3868 while (!giveup_match_end
)
3870 int total_read
, nread
, bufpos
, trial
;
3873 /* At what file position are we now scanning? */
3874 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3875 /* If the entire file matches the buffer tail, stop the scan. */
3878 /* How much can we scan in the next step? */
3879 trial
= min (curpos
, sizeof read_buf
);
3880 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3881 report_file_error ("Setting file position",
3882 Fcons (orig_filename
, Qnil
));
3884 total_read
= nread
= 0;
3885 while (total_read
< trial
)
3887 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3889 error ("IO error reading %s: %s",
3890 SDATA (orig_filename
), emacs_strerror (errno
));
3891 else if (nread
== 0)
3893 total_read
+= nread
;
3896 /* Scan this bufferful from the end, comparing with
3897 the Emacs buffer. */
3898 bufpos
= total_read
;
3900 /* Compare with same_at_start to avoid counting some buffer text
3901 as matching both at the file's beginning and at the end. */
3902 while (bufpos
> 0 && same_at_end
> same_at_start
3903 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3904 same_at_end
--, bufpos
--;
3906 /* If we found a discrepancy, stop the scan.
3907 Otherwise loop around and scan the preceding bufferful. */
3910 /* If this discrepancy is because of code conversion,
3911 we cannot use this method; giveup and try the other. */
3912 if (same_at_end
> same_at_start
3913 && FETCH_BYTE (same_at_end
- 1) >= 0200
3914 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3915 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3916 giveup_match_end
= 1;
3925 if (! giveup_match_end
)
3929 /* We win! We can handle REPLACE the optimized way. */
3931 /* Extend the start of non-matching text area to multibyte
3932 character boundary. */
3933 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3934 while (same_at_start
> BEGV_BYTE
3935 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3938 /* Extend the end of non-matching text area to multibyte
3939 character boundary. */
3940 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3941 while (same_at_end
< ZV_BYTE
3942 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3945 /* Don't try to reuse the same piece of text twice. */
3946 overlap
= (same_at_start
- BEGV_BYTE
3948 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3950 same_at_end
+= overlap
;
3952 /* Arrange to read only the nonmatching middle part of the file. */
3953 beg_offset
+= same_at_start
- BEGV_BYTE
;
3954 end_offset
-= ZV_BYTE
- same_at_end
;
3956 del_range_byte (same_at_start
, same_at_end
, 0);
3957 /* Insert from the file at the proper position. */
3958 temp
= BYTE_TO_CHAR (same_at_start
);
3959 SET_PT_BOTH (temp
, same_at_start
);
3961 /* If display currently starts at beginning of line,
3962 keep it that way. */
3963 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3964 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3966 replace_handled
= 1;
3970 /* If requested, replace the accessible part of the buffer
3971 with the file contents. Avoid replacing text at the
3972 beginning or end of the buffer that matches the file contents;
3973 that preserves markers pointing to the unchanged parts.
3975 Here we implement this feature for the case where code conversion
3976 is needed, in a simple way that needs a lot of memory.
3977 The preceding if-statement handles the case of no conversion
3978 in a more optimized way. */
3979 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3981 ptrdiff_t same_at_start
= BEGV_BYTE
;
3982 ptrdiff_t same_at_end
= ZV_BYTE
;
3983 ptrdiff_t same_at_start_charpos
;
3984 ptrdiff_t inserted_chars
;
3987 unsigned char *decoded
;
3990 ptrdiff_t this_count
= SPECPDL_INDEX ();
3992 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3993 Lisp_Object conversion_buffer
;
3994 struct gcpro gcpro1
;
3996 conversion_buffer
= code_conversion_save (1, multibyte
);
3998 /* First read the whole file, performing code conversion into
3999 CONVERSION_BUFFER. */
4001 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4002 report_file_error ("Setting file position",
4003 Fcons (orig_filename
, Qnil
));
4005 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4006 unprocessed
= 0; /* Bytes not processed in previous loop. */
4008 GCPRO1 (conversion_buffer
);
4011 /* Read at most READ_BUF_SIZE bytes at a time, to allow
4012 quitting while reading a huge file. */
4014 /* Allow quitting out of the actual I/O. */
4017 this = emacs_read (fd
, read_buf
+ unprocessed
,
4018 READ_BUF_SIZE
- unprocessed
);
4024 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
4025 BUF_Z (XBUFFER (conversion_buffer
)));
4026 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4027 unprocessed
+ this, conversion_buffer
);
4028 unprocessed
= coding
.carryover_bytes
;
4029 if (coding
.carryover_bytes
> 0)
4030 memcpy (read_buf
, coding
.carryover
, unprocessed
);
4035 /* We should remove the unwind_protect calling
4036 close_file_unwind, but other stuff has been added the stack,
4037 so defer the removal till we reach the `handled' label. */
4038 deferred_remove_unwind_protect
= 1;
4041 error ("IO error reading %s: %s",
4042 SDATA (orig_filename
), emacs_strerror (errno
));
4044 if (unprocessed
> 0)
4046 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4047 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4048 unprocessed
, conversion_buffer
);
4049 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4052 coding_system
= CODING_ID_NAME (coding
.id
);
4053 set_coding_system
= 1;
4054 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4055 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4056 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4058 /* Compare the beginning of the converted string with the buffer
4062 while (bufpos
< inserted
&& same_at_start
< same_at_end
4063 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4064 same_at_start
++, bufpos
++;
4066 /* If the file matches the head of buffer completely,
4067 there's no need to replace anything. */
4069 if (bufpos
== inserted
)
4071 /* Truncate the buffer to the size of the file. */
4072 if (same_at_start
== same_at_end
)
4075 del_range_byte (same_at_start
, same_at_end
, 0);
4078 unbind_to (this_count
, Qnil
);
4082 /* Extend the start of non-matching text area to the previous
4083 multibyte character boundary. */
4084 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4085 while (same_at_start
> BEGV_BYTE
4086 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4089 /* Scan this bufferful from the end, comparing with
4090 the Emacs buffer. */
4093 /* Compare with same_at_start to avoid counting some buffer text
4094 as matching both at the file's beginning and at the end. */
4095 while (bufpos
> 0 && same_at_end
> same_at_start
4096 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4097 same_at_end
--, bufpos
--;
4099 /* Extend the end of non-matching text area to the next
4100 multibyte character boundary. */
4101 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4102 while (same_at_end
< ZV_BYTE
4103 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4106 /* Don't try to reuse the same piece of text twice. */
4107 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4109 same_at_end
+= overlap
;
4111 /* If display currently starts at beginning of line,
4112 keep it that way. */
4113 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4114 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4116 /* Replace the chars that we need to replace,
4117 and update INSERTED to equal the number of bytes
4118 we are taking from the decoded string. */
4119 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4121 if (same_at_end
!= same_at_start
)
4123 del_range_byte (same_at_start
, same_at_end
, 0);
4125 same_at_start
= GPT_BYTE
;
4129 temp
= BYTE_TO_CHAR (same_at_start
);
4131 /* Insert from the file at the proper position. */
4132 SET_PT_BOTH (temp
, same_at_start
);
4133 same_at_start_charpos
4134 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4135 same_at_start
- BEGV_BYTE
4136 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4138 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4139 same_at_start
+ inserted
- BEGV_BYTE
4140 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4141 - same_at_start_charpos
);
4142 /* This binding is to avoid ask-user-about-supersession-threat
4143 being called in insert_from_buffer (via in
4144 prepare_to_modify_buffer). */
4145 specbind (intern ("buffer-file-name"), Qnil
);
4146 insert_from_buffer (XBUFFER (conversion_buffer
),
4147 same_at_start_charpos
, inserted_chars
, 0);
4148 /* Set `inserted' to the number of inserted characters. */
4149 inserted
= PT
- temp
;
4150 /* Set point before the inserted characters. */
4151 SET_PT_BOTH (temp
, same_at_start
);
4153 unbind_to (this_count
, Qnil
);
4159 total
= end_offset
- beg_offset
;
4161 /* For a special file, all we can do is guess. */
4162 total
= READ_BUF_SIZE
;
4164 if (NILP (visit
) && total
> 0)
4166 #ifdef CLASH_DETECTION
4167 if (!NILP (BVAR (current_buffer
, file_truename
))
4168 /* Make binding buffer-file-name to nil effective. */
4169 && !NILP (BVAR (current_buffer
, filename
))
4170 && SAVE_MODIFF
>= MODIFF
)
4172 #endif /* CLASH_DETECTION */
4173 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4176 move_gap_both (PT
, PT_BYTE
);
4177 if (GAP_SIZE
< total
)
4178 make_gap (total
- GAP_SIZE
);
4180 if (beg_offset
!= 0 || !NILP (replace
))
4182 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4183 report_file_error ("Setting file position",
4184 Fcons (orig_filename
, Qnil
));
4187 /* In the following loop, HOW_MUCH contains the total bytes read so
4188 far for a regular file, and not changed for a special file. But,
4189 before exiting the loop, it is set to a negative value if I/O
4193 /* Total bytes inserted. */
4196 /* Here, we don't do code conversion in the loop. It is done by
4197 decode_coding_gap after all data are read into the buffer. */
4199 ptrdiff_t gap_size
= GAP_SIZE
;
4201 while (how_much
< total
)
4203 /* try is reserved in some compilers (Microsoft C) */
4204 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4211 /* Maybe make more room. */
4212 if (gap_size
< trytry
)
4214 make_gap (trytry
- gap_size
);
4215 gap_size
= GAP_SIZE
- inserted
;
4218 /* Read from the file, capturing `quit'. When an
4219 error occurs, end the loop, and arrange for a quit
4220 to be signaled after decoding the text we read. */
4221 nbytes
= internal_condition_case_1
4223 make_save_value ("iii", (ptrdiff_t) fd
, inserted
, trytry
),
4224 Qerror
, read_non_regular_quit
);
4232 this = XINT (nbytes
);
4236 /* Allow quitting out of the actual I/O. We don't make text
4237 part of the buffer until all the reading is done, so a C-g
4238 here doesn't do any harm. */
4241 this = emacs_read (fd
,
4242 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4256 /* For a regular file, where TOTAL is the real size,
4257 count HOW_MUCH to compare with it.
4258 For a special file, where TOTAL is just a buffer size,
4259 so don't bother counting in HOW_MUCH.
4260 (INSERTED is where we count the number of characters inserted.) */
4267 /* Now we have either read all the file data into the gap,
4268 or stop reading on I/O error or quit. If nothing was
4269 read, undo marking the buffer modified. */
4273 #ifdef CLASH_DETECTION
4275 unlock_file (BVAR (current_buffer
, file_truename
));
4277 Vdeactivate_mark
= old_Vdeactivate_mark
;
4280 Vdeactivate_mark
= Qt
;
4284 /* Discard the unwind protect for closing the file. */
4288 error ("IO error reading %s: %s",
4289 SDATA (orig_filename
), emacs_strerror (errno
));
4291 /* Make the text read part of the buffer. */
4292 GAP_SIZE
-= inserted
;
4294 GPT_BYTE
+= inserted
;
4296 ZV_BYTE
+= inserted
;
4301 /* Put an anchor to ensure multi-byte form ends at gap. */
4306 if (NILP (coding_system
))
4308 /* The coding system is not yet decided. Decide it by an
4309 optimized method for handling `coding:' tag.
4311 Note that we can get here only if the buffer was empty
4312 before the insertion. */
4314 if (!NILP (Vcoding_system_for_read
))
4315 coding_system
= Vcoding_system_for_read
;
4318 /* Since we are sure that the current buffer was empty
4319 before the insertion, we can toggle
4320 enable-multibyte-characters directly here without taking
4321 care of marker adjustment. By this way, we can run Lisp
4322 program safely before decoding the inserted text. */
4323 Lisp_Object unwind_data
;
4324 ptrdiff_t count1
= SPECPDL_INDEX ();
4326 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4327 Fcons (BVAR (current_buffer
, undo_list
),
4328 Fcurrent_buffer ()));
4329 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4330 bset_undo_list (current_buffer
, Qt
);
4331 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4333 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4335 coding_system
= call2 (Vset_auto_coding_function
,
4336 filename
, make_number (inserted
));
4339 if (NILP (coding_system
))
4341 /* If the coding system is not yet decided, check
4342 file-coding-system-alist. */
4343 Lisp_Object args
[6];
4345 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4346 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4347 coding_system
= Ffind_operation_coding_system (6, args
);
4348 if (CONSP (coding_system
))
4349 coding_system
= XCAR (coding_system
);
4351 unbind_to (count1
, Qnil
);
4352 inserted
= Z_BYTE
- BEG_BYTE
;
4355 if (NILP (coding_system
))
4356 coding_system
= Qundecided
;
4358 CHECK_CODING_SYSTEM (coding_system
);
4360 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4361 /* We must suppress all character code conversion except for
4362 end-of-line conversion. */
4363 coding_system
= raw_text_coding_system (coding_system
);
4364 setup_coding_system (coding_system
, &coding
);
4365 /* Ensure we set Vlast_coding_system_used. */
4366 set_coding_system
= 1;
4371 /* When we visit a file by raw-text, we change the buffer to
4373 if (CODING_FOR_UNIBYTE (&coding
)
4374 /* Can't do this if part of the buffer might be preserved. */
4376 /* Visiting a file with these coding system makes the buffer
4378 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4381 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4382 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4383 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4385 move_gap_both (PT
, PT_BYTE
);
4386 GAP_SIZE
+= inserted
;
4387 ZV_BYTE
-= inserted
;
4391 decode_coding_gap (&coding
, inserted
, inserted
);
4392 inserted
= coding
.produced_char
;
4393 coding_system
= CODING_ID_NAME (coding
.id
);
4395 else if (inserted
> 0)
4396 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4399 /* Call after-change hooks for the inserted text, aside from the case
4400 of normal visiting (not with REPLACE), which is done in a new buffer
4401 "before" the buffer is changed. */
4402 if (inserted
> 0 && total
> 0
4403 && (NILP (visit
) || !NILP (replace
)))
4405 signal_after_change (PT
, 0, inserted
);
4406 update_compositions (PT
, PT
, CHECK_BORDER
);
4409 /* Now INSERTED is measured in characters. */
4413 if (deferred_remove_unwind_protect
)
4414 /* If requested above, discard the unwind protect for closing the
4420 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4421 bset_undo_list (current_buffer
, Qnil
);
4425 current_buffer
->modtime
= mtime
;
4426 current_buffer
->modtime_size
= st
.st_size
;
4427 bset_filename (current_buffer
, orig_filename
);
4430 SAVE_MODIFF
= MODIFF
;
4431 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4432 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4433 #ifdef CLASH_DETECTION
4436 if (!NILP (BVAR (current_buffer
, file_truename
)))
4437 unlock_file (BVAR (current_buffer
, file_truename
));
4438 unlock_file (filename
);
4440 #endif /* CLASH_DETECTION */
4442 xsignal2 (Qfile_error
,
4443 build_string ("not a regular file"), orig_filename
);
4446 if (set_coding_system
)
4447 Vlast_coding_system_used
= coding_system
;
4449 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4451 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4453 if (! NILP (insval
))
4455 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4456 wrong_type_argument (intern ("inserted-chars"), insval
);
4457 inserted
= XFASTINT (insval
);
4461 /* Decode file format. */
4464 /* Don't run point motion or modification hooks when decoding. */
4465 ptrdiff_t count1
= SPECPDL_INDEX ();
4466 ptrdiff_t old_inserted
= inserted
;
4467 specbind (Qinhibit_point_motion_hooks
, Qt
);
4468 specbind (Qinhibit_modification_hooks
, Qt
);
4470 /* Save old undo list and don't record undo for decoding. */
4471 old_undo
= BVAR (current_buffer
, undo_list
);
4472 bset_undo_list (current_buffer
, Qt
);
4476 insval
= call3 (Qformat_decode
,
4477 Qnil
, make_number (inserted
), visit
);
4478 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4479 wrong_type_argument (intern ("inserted-chars"), insval
);
4480 inserted
= XFASTINT (insval
);
4484 /* If REPLACE is non-nil and we succeeded in not replacing the
4485 beginning or end of the buffer text with the file's contents,
4486 call format-decode with `point' positioned at the beginning
4487 of the buffer and `inserted' equaling the number of
4488 characters in the buffer. Otherwise, format-decode might
4489 fail to correctly analyze the beginning or end of the buffer.
4490 Hence we temporarily save `point' and `inserted' here and
4491 restore `point' iff format-decode did not insert or delete
4492 any text. Otherwise we leave `point' at point-min. */
4493 ptrdiff_t opoint
= PT
;
4494 ptrdiff_t opoint_byte
= PT_BYTE
;
4495 ptrdiff_t oinserted
= ZV
- BEGV
;
4496 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4498 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4499 insval
= call3 (Qformat_decode
,
4500 Qnil
, make_number (oinserted
), visit
);
4501 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4502 wrong_type_argument (intern ("inserted-chars"), insval
);
4503 if (ochars_modiff
== CHARS_MODIFF
)
4504 /* format_decode didn't modify buffer's characters => move
4505 point back to position before inserted text and leave
4506 value of inserted alone. */
4507 SET_PT_BOTH (opoint
, opoint_byte
);
4509 /* format_decode modified buffer's characters => consider
4510 entire buffer changed and leave point at point-min. */
4511 inserted
= XFASTINT (insval
);
4514 /* For consistency with format-decode call these now iff inserted > 0
4515 (martin 2007-06-28). */
4516 p
= Vafter_insert_file_functions
;
4521 insval
= call1 (XCAR (p
), make_number (inserted
));
4524 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4525 wrong_type_argument (intern ("inserted-chars"), insval
);
4526 inserted
= XFASTINT (insval
);
4531 /* For the rationale of this see the comment on
4532 format-decode above. */
4533 ptrdiff_t opoint
= PT
;
4534 ptrdiff_t opoint_byte
= PT_BYTE
;
4535 ptrdiff_t oinserted
= ZV
- BEGV
;
4536 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4538 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4539 insval
= call1 (XCAR (p
), make_number (oinserted
));
4542 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4543 wrong_type_argument (intern ("inserted-chars"), insval
);
4544 if (ochars_modiff
== CHARS_MODIFF
)
4545 /* after_insert_file_functions didn't modify
4546 buffer's characters => move point back to
4547 position before inserted text and leave value of
4549 SET_PT_BOTH (opoint
, opoint_byte
);
4551 /* after_insert_file_functions did modify buffer's
4552 characters => consider entire buffer changed and
4553 leave point at point-min. */
4554 inserted
= XFASTINT (insval
);
4564 bset_undo_list (current_buffer
, old_undo
);
4565 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4567 /* Adjust the last undo record for the size change during
4568 the format conversion. */
4569 Lisp_Object tem
= XCAR (old_undo
);
4570 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4571 && INTEGERP (XCDR (tem
))
4572 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4573 XSETCDR (tem
, make_number (PT
+ inserted
));
4577 /* If undo_list was Qt before, keep it that way.
4578 Otherwise start with an empty undo_list. */
4579 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4581 unbind_to (count1
, Qnil
);
4585 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4587 /* If visiting nonexistent file, return nil. */
4589 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4593 Fsignal (Qquit
, Qnil
);
4595 /* Retval needs to be dealt with in all cases consistently. */
4597 val
= list2 (orig_filename
, make_number (inserted
));
4599 RETURN_UNGCPRO (unbind_to (count
, val
));
4602 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4605 build_annotations_unwind (Lisp_Object arg
)
4607 Vwrite_region_annotation_buffers
= arg
;
4611 /* Decide the coding-system to encode the data with. */
4613 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4614 Schoose_write_coding_system
, 3, 6, 0,
4615 doc
: /* Choose the coding system for writing a file.
4616 Arguments are as for `write-region'.
4617 This function is for internal use only. It may prompt the user. */ )
4618 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4619 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4622 Lisp_Object eol_parent
= Qnil
;
4624 /* Mimic write-region behavior. */
4627 XSETFASTINT (start
, BEGV
);
4628 XSETFASTINT (end
, ZV
);
4632 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4633 BVAR (current_buffer
, auto_save_file_name
))))
4638 else if (!NILP (Vcoding_system_for_write
))
4640 val
= Vcoding_system_for_write
;
4641 if (coding_system_require_warning
4642 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4643 /* Confirm that VAL can surely encode the current region. */
4644 val
= call5 (Vselect_safe_coding_system_function
,
4645 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4650 /* If the variable `buffer-file-coding-system' is set locally,
4651 it means that the file was read with some kind of code
4652 conversion or the variable is explicitly set by users. We
4653 had better write it out with the same coding system even if
4654 `enable-multibyte-characters' is nil.
4656 If it is not set locally, we anyway have to convert EOL
4657 format if the default value of `buffer-file-coding-system'
4658 tells that it is not Unix-like (LF only) format. */
4659 bool using_default_coding
= 0;
4660 bool force_raw_text
= 0;
4662 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4664 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4667 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4673 /* Check file-coding-system-alist. */
4674 Lisp_Object args
[7], coding_systems
;
4676 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4677 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4679 coding_systems
= Ffind_operation_coding_system (7, args
);
4680 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4681 val
= XCDR (coding_systems
);
4686 /* If we still have not decided a coding system, use the
4687 default value of buffer-file-coding-system. */
4688 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4689 using_default_coding
= 1;
4692 if (! NILP (val
) && ! force_raw_text
)
4694 Lisp_Object spec
, attrs
;
4696 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4697 attrs
= AREF (spec
, 0);
4698 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4703 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4704 /* Confirm that VAL can surely encode the current region. */
4705 val
= call5 (Vselect_safe_coding_system_function
,
4706 start
, end
, val
, Qnil
, filename
);
4708 /* If the decided coding-system doesn't specify end-of-line
4709 format, we use that of
4710 `default-buffer-file-coding-system'. */
4711 if (! using_default_coding
4712 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4713 val
= (coding_inherit_eol_type
4714 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4716 /* If we decide not to encode text, use `raw-text' or one of its
4719 val
= raw_text_coding_system (val
);
4722 val
= coding_inherit_eol_type (val
, eol_parent
);
4726 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4727 "r\nFWrite region to file: \ni\ni\ni\np",
4728 doc
: /* Write current region into specified file.
4729 When called from a program, requires three arguments:
4730 START, END and FILENAME. START and END are normally buffer positions
4731 specifying the part of the buffer to write.
4732 If START is nil, that means to use the entire buffer contents.
4733 If START is a string, then output that string to the file
4734 instead of any buffer contents; END is ignored.
4736 Optional fourth argument APPEND if non-nil means
4737 append to existing file contents (if any). If it is a number,
4738 seek to that offset in the file before writing.
4739 Optional fifth argument VISIT, if t or a string, means
4740 set the last-save-file-modtime of buffer to this file's modtime
4741 and mark buffer not modified.
4742 If VISIT is a string, it is a second file name;
4743 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4744 VISIT is also the file name to lock and unlock for clash detection.
4745 If VISIT is neither t nor nil nor a string,
4746 that means do not display the \"Wrote file\" message.
4747 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4748 use for locking and unlocking, overriding FILENAME and VISIT.
4749 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4750 for an existing file with the same name. If MUSTBENEW is `excl',
4751 that means to get an error if the file already exists; never overwrite.
4752 If MUSTBENEW is neither nil nor `excl', that means ask for
4753 confirmation before overwriting, but do go ahead and overwrite the file
4754 if the user confirms.
4756 This does code conversion according to the value of
4757 `coding-system-for-write', `buffer-file-coding-system', or
4758 `file-coding-system-alist', and sets the variable
4759 `last-coding-system-used' to the coding system actually used.
4761 This calls `write-region-annotate-functions' at the start, and
4762 `write-region-post-annotation-function' at the end. */)
4763 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4768 off_t offset
IF_LINT (= 0);
4774 ptrdiff_t count
= SPECPDL_INDEX ();
4776 Lisp_Object handler
;
4777 Lisp_Object visit_file
;
4778 Lisp_Object annotations
;
4779 Lisp_Object encoded_filename
;
4780 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4781 bool quietly
= !NILP (visit
);
4782 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4783 struct buffer
*given_buffer
;
4784 struct coding_system coding
;
4786 if (current_buffer
->base_buffer
&& visiting
)
4787 error ("Cannot do file visiting in an indirect buffer");
4789 if (!NILP (start
) && !STRINGP (start
))
4790 validate_region (&start
, &end
);
4793 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4795 filename
= Fexpand_file_name (filename
, Qnil
);
4797 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4798 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4800 if (STRINGP (visit
))
4801 visit_file
= Fexpand_file_name (visit
, Qnil
);
4803 visit_file
= filename
;
4805 if (NILP (lockname
))
4806 lockname
= visit_file
;
4810 /* If the file name has special constructs in it,
4811 call the corresponding file handler. */
4812 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4813 /* If FILENAME has no handler, see if VISIT has one. */
4814 if (NILP (handler
) && STRINGP (visit
))
4815 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4817 if (!NILP (handler
))
4820 val
= call6 (handler
, Qwrite_region
, start
, end
,
4821 filename
, append
, visit
);
4825 SAVE_MODIFF
= MODIFF
;
4826 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4827 bset_filename (current_buffer
, visit_file
);
4833 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4835 /* Special kludge to simplify auto-saving. */
4838 /* Do it later, so write-region-annotate-function can work differently
4839 if we save "the buffer" vs "a region".
4840 This is useful in tar-mode. --Stef
4841 XSETFASTINT (start, BEG);
4842 XSETFASTINT (end, Z); */
4846 record_unwind_protect (build_annotations_unwind
,
4847 Vwrite_region_annotation_buffers
);
4848 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4849 count1
= SPECPDL_INDEX ();
4851 given_buffer
= current_buffer
;
4853 if (!STRINGP (start
))
4855 annotations
= build_annotations (start
, end
);
4857 if (current_buffer
!= given_buffer
)
4859 XSETFASTINT (start
, BEGV
);
4860 XSETFASTINT (end
, ZV
);
4866 XSETFASTINT (start
, BEGV
);
4867 XSETFASTINT (end
, ZV
);
4872 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4874 /* Decide the coding-system to encode the data with.
4875 We used to make this choice before calling build_annotations, but that
4876 leads to problems when a write-annotate-function takes care of
4877 unsavable chars (as was the case with X-Symbol). */
4878 Vlast_coding_system_used
=
4879 Fchoose_write_coding_system (start
, end
, filename
,
4880 append
, visit
, lockname
);
4882 setup_coding_system (Vlast_coding_system_used
, &coding
);
4884 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4885 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4887 #ifdef CLASH_DETECTION
4889 lock_file (lockname
);
4890 #endif /* CLASH_DETECTION */
4892 encoded_filename
= ENCODE_FILE (filename
);
4893 fn
= SSDATA (encoded_filename
);
4894 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4895 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4896 if (NUMBERP (append
))
4897 offset
= file_offset (append
);
4898 else if (!NILP (append
))
4899 open_flags
|= O_APPEND
;
4901 mode
= S_IREAD
| S_IWRITE
;
4903 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4906 desc
= emacs_open (fn
, open_flags
, mode
);
4910 #ifdef CLASH_DETECTION
4912 if (!auto_saving
) unlock_file (lockname
);
4914 #endif /* CLASH_DETECTION */
4916 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4919 record_unwind_protect (close_file_unwind
, make_number (desc
));
4921 if (NUMBERP (append
))
4923 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4926 #ifdef CLASH_DETECTION
4928 if (!auto_saving
) unlock_file (lockname
);
4930 #endif /* CLASH_DETECTION */
4932 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4940 if (STRINGP (start
))
4941 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4942 else if (XINT (start
) != XINT (end
))
4943 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4944 &annotations
, &coding
);
4947 /* If file was empty, still need to write the annotations. */
4948 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4949 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4953 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4954 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4956 /* We have to flush out a data. */
4957 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4958 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4965 /* fsync appears to change the modtime on BSD4.2.
4966 Disk full in NFS may be reported here. */
4967 /* mib says that closing the file will try to write as fast as NFS can do
4968 it, and that means the fsync here is not crucial for autosave files. */
4969 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4971 /* If fsync fails with EINTR, don't treat that as serious. Also
4972 ignore EINVAL which happens when fsync is not supported on this
4974 if (errno
!= EINTR
&& errno
!= EINVAL
)
4975 ok
= 0, save_errno
= errno
;
4979 modtime
= invalid_emacs_time ();
4982 if (fstat (desc
, &st
) == 0)
4983 modtime
= get_stat_mtime (&st
);
4985 ok
= 0, save_errno
= errno
;
4988 /* NFS can report a write failure now. */
4989 if (emacs_close (desc
) < 0)
4990 ok
= 0, save_errno
= errno
;
4992 /* Discard the unwind protect for close_file_unwind. */
4993 specpdl_ptr
= specpdl
+ count1
;
4995 /* Some file systems have a bug where st_mtime is not updated
4996 properly after a write. For example, CIFS might not see the
4997 st_mtime change until after the file is opened again.
4999 Attempt to detect this file system bug, and update MODTIME to the
5000 newer st_mtime if the bug appears to be present. This introduces
5001 a race condition, so to avoid most instances of the race condition
5002 on non-buggy file systems, skip this check if the most recently
5003 encountered non-buggy file system was the current file system.
5005 A race condition can occur if some other process modifies the
5006 file between the fstat above and the fstat below, but the race is
5007 unlikely and a similar race between the last write and the fstat
5008 above cannot possibly be closed anyway. */
5010 if (EMACS_TIME_VALID_P (modtime
)
5011 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
5013 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
5017 if (fstat (desc1
, &st1
) == 0
5018 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
5020 /* Use the heuristic if it appears to be valid. With neither
5021 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
5022 file, the time stamp won't change. Also, some non-POSIX
5023 systems don't update an empty file's time stamp when
5024 truncating it. Finally, file systems with 100 ns or worse
5025 resolution sometimes seem to have bugs: on a system with ns
5026 resolution, checking ns % 100 incorrectly avoids the heuristic
5027 1% of the time, but the problem should be temporary as we will
5028 try again on the next time stamp. */
5030 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
5032 && EMACS_NSECS (modtime
) % 100 != 0);
5034 EMACS_TIME modtime1
= get_stat_mtime (&st1
);
5036 && EMACS_TIME_EQ (modtime
, modtime1
)
5037 && st
.st_size
== st1
.st_size
)
5039 timestamp_file_system
= st
.st_dev
;
5040 valid_timestamp_file_system
= 1;
5044 st
.st_size
= st1
.st_size
;
5048 emacs_close (desc1
);
5052 /* Call write-region-post-annotation-function. */
5053 while (CONSP (Vwrite_region_annotation_buffers
))
5055 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5056 if (!NILP (Fbuffer_live_p (buf
)))
5059 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5060 call0 (Vwrite_region_post_annotation_function
);
5062 Vwrite_region_annotation_buffers
5063 = XCDR (Vwrite_region_annotation_buffers
);
5066 unbind_to (count
, Qnil
);
5068 #ifdef CLASH_DETECTION
5070 unlock_file (lockname
);
5071 #endif /* CLASH_DETECTION */
5073 /* Do this before reporting IO error
5074 to avoid a "file has changed on disk" warning on
5075 next attempt to save. */
5076 if (EMACS_TIME_VALID_P (modtime
))
5078 current_buffer
->modtime
= modtime
;
5079 current_buffer
->modtime_size
= st
.st_size
;
5083 error ("IO error writing %s: %s", SDATA (filename
),
5084 emacs_strerror (save_errno
));
5088 SAVE_MODIFF
= MODIFF
;
5089 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5090 bset_filename (current_buffer
, visit_file
);
5091 update_mode_lines
++;
5096 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5097 BVAR (current_buffer
, auto_save_file_name
))))
5098 SAVE_MODIFF
= MODIFF
;
5104 message_with_string ((NUMBERP (append
)
5114 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
5116 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5117 doc
: /* Return t if (car A) is numerically less than (car B). */)
5118 (Lisp_Object a
, Lisp_Object b
)
5120 return Flss (Fcar (a
), Fcar (b
));
5123 /* Build the complete list of annotations appropriate for writing out
5124 the text between START and END, by calling all the functions in
5125 write-region-annotate-functions and merging the lists they return.
5126 If one of these functions switches to a different buffer, we assume
5127 that buffer contains altered text. Therefore, the caller must
5128 make sure to restore the current buffer in all cases,
5129 as save-excursion would do. */
5132 build_annotations (Lisp_Object start
, Lisp_Object end
)
5134 Lisp_Object annotations
;
5136 struct gcpro gcpro1
, gcpro2
;
5137 Lisp_Object original_buffer
;
5139 bool used_global
= 0;
5141 XSETBUFFER (original_buffer
, current_buffer
);
5144 p
= Vwrite_region_annotate_functions
;
5145 GCPRO2 (annotations
, p
);
5148 struct buffer
*given_buffer
= current_buffer
;
5149 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5150 { /* Use the global value of the hook. */
5153 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5155 p
= Fappend (2, arg
);
5158 Vwrite_region_annotations_so_far
= annotations
;
5159 res
= call2 (XCAR (p
), start
, end
);
5160 /* If the function makes a different buffer current,
5161 assume that means this buffer contains altered text to be output.
5162 Reset START and END from the buffer bounds
5163 and discard all previous annotations because they should have
5164 been dealt with by this function. */
5165 if (current_buffer
!= given_buffer
)
5167 Vwrite_region_annotation_buffers
5168 = Fcons (Fcurrent_buffer (),
5169 Vwrite_region_annotation_buffers
);
5170 XSETFASTINT (start
, BEGV
);
5171 XSETFASTINT (end
, ZV
);
5174 Flength (res
); /* Check basic validity of return value */
5175 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5179 /* Now do the same for annotation functions implied by the file-format */
5180 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5181 p
= BVAR (current_buffer
, auto_save_file_format
);
5183 p
= BVAR (current_buffer
, file_format
);
5184 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5186 struct buffer
*given_buffer
= current_buffer
;
5188 Vwrite_region_annotations_so_far
= annotations
;
5190 /* Value is either a list of annotations or nil if the function
5191 has written annotations to a temporary buffer, which is now
5193 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5194 original_buffer
, make_number (i
));
5195 if (current_buffer
!= given_buffer
)
5197 XSETFASTINT (start
, BEGV
);
5198 XSETFASTINT (end
, ZV
);
5203 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5211 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5212 If STRING is nil, POS is the character position in the current buffer.
5213 Intersperse with them the annotations from *ANNOT
5214 which fall within the range of POS to POS + NCHARS,
5215 each at its appropriate position.
5217 We modify *ANNOT by discarding elements as we use them up.
5219 Return true if successful. */
5222 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5223 ptrdiff_t nchars
, Lisp_Object
*annot
,
5224 struct coding_system
*coding
)
5228 ptrdiff_t lastpos
= pos
+ nchars
;
5230 while (NILP (*annot
) || CONSP (*annot
))
5232 tem
= Fcar_safe (Fcar (*annot
));
5235 nextpos
= XFASTINT (tem
);
5237 /* If there are no more annotations in this range,
5238 output the rest of the range all at once. */
5239 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5240 return e_write (desc
, string
, pos
, lastpos
, coding
);
5242 /* Output buffer text up to the next annotation's position. */
5245 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5249 /* Output the annotation. */
5250 tem
= Fcdr (Fcar (*annot
));
5253 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5256 *annot
= Fcdr (*annot
);
5262 /* Write text in the range START and END into descriptor DESC,
5263 encoding them with coding system CODING. If STRING is nil, START
5264 and END are character positions of the current buffer, else they
5265 are indexes to the string STRING. Return true if successful. */
5268 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5269 struct coding_system
*coding
)
5271 if (STRINGP (string
))
5274 end
= SCHARS (string
);
5277 /* We used to have a code for handling selective display here. But,
5278 now it is handled within encode_coding. */
5282 if (STRINGP (string
))
5284 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5285 if (CODING_REQUIRE_ENCODING (coding
))
5287 encode_coding_object (coding
, string
,
5288 start
, string_char_to_byte (string
, start
),
5289 end
, string_char_to_byte (string
, end
), Qt
);
5293 coding
->dst_object
= string
;
5294 coding
->consumed_char
= SCHARS (string
);
5295 coding
->produced
= SBYTES (string
);
5300 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5301 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5303 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5304 if (CODING_REQUIRE_ENCODING (coding
))
5306 encode_coding_object (coding
, Fcurrent_buffer (),
5307 start
, start_byte
, end
, end_byte
, Qt
);
5311 coding
->dst_object
= Qnil
;
5312 coding
->dst_pos_byte
= start_byte
;
5313 if (start
>= GPT
|| end
<= GPT
)
5315 coding
->consumed_char
= end
- start
;
5316 coding
->produced
= end_byte
- start_byte
;
5320 coding
->consumed_char
= GPT
- start
;
5321 coding
->produced
= GPT_BYTE
- start_byte
;
5326 if (coding
->produced
> 0)
5329 -= emacs_write (desc
,
5330 STRINGP (coding
->dst_object
)
5331 ? SSDATA (coding
->dst_object
)
5332 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5335 if (coding
->produced
)
5338 start
+= coding
->consumed_char
;
5344 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5345 Sverify_visited_file_modtime
, 0, 1, 0,
5346 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5347 This means that the file has not been changed since it was visited or saved.
5348 If BUF is omitted or nil, it defaults to the current buffer.
5349 See Info node `(elisp)Modification Time' for more details. */)
5354 Lisp_Object handler
;
5355 Lisp_Object filename
;
5366 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5367 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5369 /* If the file name has special constructs in it,
5370 call the corresponding file handler. */
5371 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5372 Qverify_visited_file_modtime
);
5373 if (!NILP (handler
))
5374 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5376 filename
= ENCODE_FILE (BVAR (b
, filename
));
5378 mtime
= (stat (SSDATA (filename
), &st
) == 0
5379 ? get_stat_mtime (&st
)
5380 : time_error_value (errno
));
5381 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5382 && (b
->modtime_size
< 0
5383 || st
.st_size
== b
->modtime_size
))
5388 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5389 Sclear_visited_file_modtime
, 0, 0, 0,
5390 doc
: /* Clear out records of last mod time of visited file.
5391 Next attempt to save will certainly not complain of a discrepancy. */)
5394 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5395 current_buffer
->modtime_size
= -1;
5399 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5400 Svisited_file_modtime
, 0, 0, 0,
5401 doc
: /* Return the current buffer's recorded visited file modification time.
5402 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5403 `file-attributes' returns. If the current buffer has no recorded file
5404 modification time, this function returns 0. If the visited file
5405 doesn't exist, HIGH will be -1.
5406 See Info node `(elisp)Modification Time' for more details. */)
5409 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5411 if (EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
5413 /* make_lisp_time won't work here if time_t is unsigned. */
5414 return list4 (make_number (-1), make_number (65535),
5415 make_number (0), make_number (0));
5417 return make_number (0);
5419 return make_lisp_time (current_buffer
->modtime
);
5422 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5423 Sset_visited_file_modtime
, 0, 1, 0,
5424 doc
: /* Update buffer's recorded modification time from the visited file's time.
5425 Useful if the buffer was not read from the file normally
5426 or if the file itself has been changed for some known benign reason.
5427 An argument specifies the modification time value to use
5428 \(instead of that of the visited file), in the form of a list
5429 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5430 (Lisp_Object time_list
)
5432 if (!NILP (time_list
))
5434 current_buffer
->modtime
= lisp_time_argument (time_list
);
5435 current_buffer
->modtime_size
= -1;
5439 register Lisp_Object filename
;
5441 Lisp_Object handler
;
5443 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5445 /* If the file name has special constructs in it,
5446 call the corresponding file handler. */
5447 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5448 if (!NILP (handler
))
5449 /* The handler can find the file name the same way we did. */
5450 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5452 filename
= ENCODE_FILE (filename
);
5454 if (stat (SSDATA (filename
), &st
) >= 0)
5456 current_buffer
->modtime
= get_stat_mtime (&st
);
5457 current_buffer
->modtime_size
= st
.st_size
;
5465 auto_save_error (Lisp_Object error_val
)
5467 Lisp_Object args
[3], msg
;
5469 struct gcpro gcpro1
;
5471 auto_save_error_occurred
= 1;
5473 ring_bell (XFRAME (selected_frame
));
5475 args
[0] = build_string ("Auto-saving %s: %s");
5476 args
[1] = BVAR (current_buffer
, name
);
5477 args
[2] = Ferror_message_string (error_val
);
5478 msg
= Fformat (3, args
);
5481 for (i
= 0; i
< 3; ++i
)
5486 message3_nolog (msg
);
5487 Fsleep_for (make_number (1), Qnil
);
5500 auto_save_mode_bits
= 0666;
5502 /* Get visited file's mode to become the auto save file's mode. */
5503 if (! NILP (BVAR (current_buffer
, filename
)))
5505 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5506 /* But make sure we can overwrite it later! */
5507 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5508 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5510 /* Remote files don't cooperate with stat. */
5511 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5515 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5516 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5521 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5524 FILE *stream
= XSAVE_POINTER (arg
, 0);
5536 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5539 minibuffer_auto_raise
= XINT (value
);
5544 do_auto_save_make_dir (Lisp_Object dir
)
5548 auto_saving_dir_umask
= 077;
5549 result
= call2 (Qmake_directory
, dir
, Qt
);
5550 auto_saving_dir_umask
= 0;
5555 do_auto_save_eh (Lisp_Object ignore
)
5557 auto_saving_dir_umask
= 0;
5561 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5562 doc
: /* Auto-save all buffers that need it.
5563 This is all buffers that have auto-saving enabled
5564 and are changed since last auto-saved.
5565 Auto-saving writes the buffer into a file
5566 so that your editing is not lost if the system crashes.
5567 This file is not the file you visited; that changes only when you save.
5568 Normally we run the normal hook `auto-save-hook' before saving.
5570 A non-nil NO-MESSAGE argument means do not print any message if successful.
5571 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5572 (Lisp_Object no_message
, Lisp_Object current_only
)
5574 struct buffer
*old
= current_buffer
, *b
;
5575 Lisp_Object tail
, buf
, hook
;
5576 bool auto_saved
= 0;
5577 int do_handled_files
;
5579 FILE *stream
= NULL
;
5580 ptrdiff_t count
= SPECPDL_INDEX ();
5581 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5582 bool old_message_p
= 0;
5583 struct gcpro gcpro1
, gcpro2
;
5585 if (max_specpdl_size
< specpdl_size
+ 40)
5586 max_specpdl_size
= specpdl_size
+ 40;
5591 if (NILP (no_message
))
5593 old_message_p
= push_message ();
5594 record_unwind_protect (pop_message_unwind
, Qnil
);
5597 /* Ordinarily don't quit within this function,
5598 but don't make it impossible to quit (in case we get hung in I/O). */
5602 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5603 point to non-strings reached from Vbuffer_alist. */
5605 hook
= intern ("auto-save-hook");
5606 Frun_hooks (1, &hook
);
5608 if (STRINGP (Vauto_save_list_file_name
))
5610 Lisp_Object listfile
;
5612 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5614 /* Don't try to create the directory when shutting down Emacs,
5615 because creating the directory might signal an error, and
5616 that would leave Emacs in a strange state. */
5617 if (!NILP (Vrun_hooks
))
5621 GCPRO2 (dir
, listfile
);
5622 dir
= Ffile_name_directory (listfile
);
5623 if (NILP (Ffile_directory_p (dir
)))
5624 internal_condition_case_1 (do_auto_save_make_dir
,
5630 stream
= fopen (SSDATA (listfile
), "w");
5633 record_unwind_protect (do_auto_save_unwind
,
5634 make_save_pointer (stream
));
5635 record_unwind_protect (do_auto_save_unwind_1
,
5636 make_number (minibuffer_auto_raise
));
5637 minibuffer_auto_raise
= 0;
5639 auto_save_error_occurred
= 0;
5641 /* On first pass, save all files that don't have handlers.
5642 On second pass, save all files that do have handlers.
5644 If Emacs is crashing, the handlers may tweak what is causing
5645 Emacs to crash in the first place, and it would be a shame if
5646 Emacs failed to autosave perfectly ordinary files because it
5647 couldn't handle some ange-ftp'd file. */
5649 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5650 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5652 buf
= XCDR (XCAR (tail
));
5655 /* Record all the buffers that have auto save mode
5656 in the special file that lists them. For each of these buffers,
5657 Record visited name (if any) and auto save name. */
5658 if (STRINGP (BVAR (b
, auto_save_file_name
))
5659 && stream
!= NULL
&& do_handled_files
== 0)
5662 if (!NILP (BVAR (b
, filename
)))
5664 fwrite (SDATA (BVAR (b
, filename
)), 1,
5665 SBYTES (BVAR (b
, filename
)), stream
);
5667 putc ('\n', stream
);
5668 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5669 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5670 putc ('\n', stream
);
5674 if (!NILP (current_only
)
5675 && b
!= current_buffer
)
5678 /* Don't auto-save indirect buffers.
5679 The base buffer takes care of it. */
5683 /* Check for auto save enabled
5684 and file changed since last auto save
5685 and file changed since last real save. */
5686 if (STRINGP (BVAR (b
, auto_save_file_name
))
5687 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5688 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5689 /* -1 means we've turned off autosaving for a while--see below. */
5690 && XINT (BVAR (b
, save_length
)) >= 0
5691 && (do_handled_files
5692 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5695 EMACS_TIME before_time
= current_emacs_time ();
5696 EMACS_TIME after_time
;
5698 /* If we had a failure, don't try again for 20 minutes. */
5699 if (b
->auto_save_failure_time
> 0
5700 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5703 set_buffer_internal (b
);
5704 if (NILP (Vauto_save_include_big_deletions
)
5705 && (XFASTINT (BVAR (b
, save_length
)) * 10
5706 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5707 /* A short file is likely to change a large fraction;
5708 spare the user annoying messages. */
5709 && XFASTINT (BVAR (b
, save_length
)) > 5000
5710 /* These messages are frequent and annoying for `*mail*'. */
5711 && !EQ (BVAR (b
, filename
), Qnil
)
5712 && NILP (no_message
))
5714 /* It has shrunk too much; turn off auto-saving here. */
5715 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5716 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5718 minibuffer_auto_raise
= 0;
5719 /* Turn off auto-saving until there's a real save,
5720 and prevent any more warnings. */
5721 XSETINT (BVAR (b
, save_length
), -1);
5722 Fsleep_for (make_number (1), Qnil
);
5725 if (!auto_saved
&& NILP (no_message
))
5726 message1 ("Auto-saving...");
5727 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5729 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5730 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5731 set_buffer_internal (old
);
5733 after_time
= current_emacs_time ();
5735 /* If auto-save took more than 60 seconds,
5736 assume it was an NFS failure that got a timeout. */
5737 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5738 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5742 /* Prevent another auto save till enough input events come in. */
5743 record_auto_save ();
5745 if (auto_saved
&& NILP (no_message
))
5749 /* If we are going to restore an old message,
5750 give time to read ours. */
5751 sit_for (make_number (1), 0, 0);
5754 else if (!auto_save_error_occurred
)
5755 /* Don't overwrite the error message if an error occurred.
5756 If we displayed a message and then restored a state
5757 with no message, leave a "done" message on the screen. */
5758 message1 ("Auto-saving...done");
5763 /* This restores the message-stack status. */
5764 unbind_to (count
, Qnil
);
5768 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5769 Sset_buffer_auto_saved
, 0, 0, 0,
5770 doc
: /* Mark current buffer as auto-saved with its current text.
5771 No auto-save file will be written until the buffer changes again. */)
5774 /* FIXME: This should not be called in indirect buffers, since
5775 they're not autosaved. */
5776 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5777 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5778 current_buffer
->auto_save_failure_time
= 0;
5782 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5783 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5784 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5787 current_buffer
->auto_save_failure_time
= 0;
5791 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5793 doc
: /* Return t if current buffer has been auto-saved recently.
5794 More precisely, if it has been auto-saved since last read from or saved
5795 in the visited file. If the buffer has no visited file,
5796 then any auto-save counts as "recent". */)
5799 /* FIXME: maybe we should return nil for indirect buffers since
5800 they're never autosaved. */
5801 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5804 /* Reading and completing file names */
5806 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5807 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5808 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5809 The return value is only relevant for a call to `read-file-name' that happens
5810 before any other event (mouse or keypress) is handled. */)
5813 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5814 || defined (HAVE_NS)
5815 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5825 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5827 struct gcpro gcpro1
;
5828 Lisp_Object args
[7];
5830 GCPRO1 (default_filename
);
5831 args
[0] = intern ("read-file-name");
5834 args
[3] = default_filename
;
5835 args
[4] = mustmatch
;
5837 args
[6] = predicate
;
5838 RETURN_UNGCPRO (Ffuncall (7, args
));
5845 valid_timestamp_file_system
= 0;
5849 syms_of_fileio (void)
5851 DEFSYM (Qoperations
, "operations");
5852 DEFSYM (Qexpand_file_name
, "expand-file-name");
5853 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5854 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5855 DEFSYM (Qfile_name_directory
, "file-name-directory");
5856 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5857 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5858 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5859 DEFSYM (Qcopy_file
, "copy-file");
5860 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5861 DEFSYM (Qmake_directory
, "make-directory");
5862 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5863 DEFSYM (Qdelete_file
, "delete-file");
5864 DEFSYM (Qrename_file
, "rename-file");
5865 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5866 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5867 DEFSYM (Qfile_exists_p
, "file-exists-p");
5868 DEFSYM (Qfile_executable_p
, "file-executable-p");
5869 DEFSYM (Qfile_readable_p
, "file-readable-p");
5870 DEFSYM (Qfile_writable_p
, "file-writable-p");
5871 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5872 DEFSYM (Qaccess_file
, "access-file");
5873 DEFSYM (Qfile_directory_p
, "file-directory-p");
5874 DEFSYM (Qfile_regular_p
, "file-regular-p");
5875 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5876 DEFSYM (Qfile_modes
, "file-modes");
5877 DEFSYM (Qset_file_modes
, "set-file-modes");
5878 DEFSYM (Qset_file_times
, "set-file-times");
5879 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5880 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5881 DEFSYM (Qfile_acl
, "file-acl");
5882 DEFSYM (Qset_file_acl
, "set-file-acl");
5883 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5884 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5885 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5886 DEFSYM (Qwrite_region
, "write-region");
5887 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5888 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5889 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5891 DEFSYM (Qfile_name_history
, "file-name-history");
5892 Fset (Qfile_name_history
, Qnil
);
5894 DEFSYM (Qfile_error
, "file-error");
5895 DEFSYM (Qfile_already_exists
, "file-already-exists");
5896 DEFSYM (Qfile_date_error
, "file-date-error");
5897 DEFSYM (Qexcl
, "excl");
5899 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5900 doc
: /* Coding system for encoding file names.
5901 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5902 Vfile_name_coding_system
= Qnil
;
5904 DEFVAR_LISP ("default-file-name-coding-system",
5905 Vdefault_file_name_coding_system
,
5906 doc
: /* Default coding system for encoding file names.
5907 This variable is used only when `file-name-coding-system' is nil.
5909 This variable is set/changed by the command `set-language-environment'.
5910 User should not set this variable manually,
5911 instead use `file-name-coding-system' to get a constant encoding
5912 of file names regardless of the current language environment. */);
5913 Vdefault_file_name_coding_system
= Qnil
;
5915 DEFSYM (Qformat_decode
, "format-decode");
5916 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5917 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5918 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5920 Fput (Qfile_error
, Qerror_conditions
,
5921 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5922 Fput (Qfile_error
, Qerror_message
,
5923 build_pure_c_string ("File error"));
5925 Fput (Qfile_already_exists
, Qerror_conditions
,
5926 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5927 Fput (Qfile_already_exists
, Qerror_message
,
5928 build_pure_c_string ("File already exists"));
5930 Fput (Qfile_date_error
, Qerror_conditions
,
5931 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5932 Fput (Qfile_date_error
, Qerror_message
,
5933 build_pure_c_string ("Cannot set file date"));
5935 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5936 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5937 If a file name matches REGEXP, all I/O on that file is done by calling
5938 HANDLER. If a file name matches more than one handler, the handler
5939 whose match starts last in the file name gets precedence. The
5940 function `find-file-name-handler' checks this list for a handler for
5943 HANDLER should be a function. The first argument given to it is the
5944 name of the I/O primitive to be handled; the remaining arguments are
5945 the arguments that were passed to that primitive. For example, if you
5946 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5947 HANDLER is called like this:
5949 (funcall HANDLER 'file-exists-p FILENAME)
5951 Note that HANDLER must be able to handle all I/O primitives; if it has
5952 nothing special to do for a primitive, it should reinvoke the
5953 primitive to handle the operation \"the usual way\".
5954 See Info node `(elisp)Magic File Names' for more details. */);
5955 Vfile_name_handler_alist
= Qnil
;
5957 DEFVAR_LISP ("set-auto-coding-function",
5958 Vset_auto_coding_function
,
5959 doc
: /* If non-nil, a function to call to decide a coding system of file.
5960 Two arguments are passed to this function: the file name
5961 and the length of a file contents following the point.
5962 This function should return a coding system to decode the file contents.
5963 It should check the file name against `auto-coding-alist'.
5964 If no coding system is decided, it should check a coding system
5965 specified in the heading lines with the format:
5966 -*- ... coding: CODING-SYSTEM; ... -*-
5967 or local variable spec of the tailing lines with `coding:' tag. */);
5968 Vset_auto_coding_function
= Qnil
;
5970 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5971 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5972 Each is passed one argument, the number of characters inserted,
5973 with point at the start of the inserted text. Each function
5974 should leave point the same, and return the new character count.
5975 If `insert-file-contents' is intercepted by a handler from
5976 `file-name-handler-alist', that handler is responsible for calling the
5977 functions in `after-insert-file-functions' if appropriate. */);
5978 Vafter_insert_file_functions
= Qnil
;
5980 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5981 doc
: /* A list of functions to be called at the start of `write-region'.
5982 Each is passed two arguments, START and END as for `write-region'.
5983 These are usually two numbers but not always; see the documentation
5984 for `write-region'. The function should return a list of pairs
5985 of the form (POSITION . STRING), consisting of strings to be effectively
5986 inserted at the specified positions of the file being written (1 means to
5987 insert before the first byte written). The POSITIONs must be sorted into
5990 If there are several annotation functions, the lists returned by these
5991 functions are merged destructively. As each annotation function runs,
5992 the variable `write-region-annotations-so-far' contains a list of all
5993 annotations returned by previous annotation functions.
5995 An annotation function can return with a different buffer current.
5996 Doing so removes the annotations returned by previous functions, and
5997 resets START and END to `point-min' and `point-max' of the new buffer.
5999 After `write-region' completes, Emacs calls the function stored in
6000 `write-region-post-annotation-function', once for each buffer that was
6001 current when building the annotations (i.e., at least once), with that
6002 buffer current. */);
6003 Vwrite_region_annotate_functions
= Qnil
;
6004 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
6006 DEFVAR_LISP ("write-region-post-annotation-function",
6007 Vwrite_region_post_annotation_function
,
6008 doc
: /* Function to call after `write-region' completes.
6009 The function is called with no arguments. If one or more of the
6010 annotation functions in `write-region-annotate-functions' changed the
6011 current buffer, the function stored in this variable is called for
6012 each of those additional buffers as well, in addition to the original
6013 buffer. The relevant buffer is current during each function call. */);
6014 Vwrite_region_post_annotation_function
= Qnil
;
6015 staticpro (&Vwrite_region_annotation_buffers
);
6017 DEFVAR_LISP ("write-region-annotations-so-far",
6018 Vwrite_region_annotations_so_far
,
6019 doc
: /* When an annotation function is called, this holds the previous annotations.
6020 These are the annotations made by other annotation functions
6021 that were already called. See also `write-region-annotate-functions'. */);
6022 Vwrite_region_annotations_so_far
= Qnil
;
6024 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6025 doc
: /* A list of file name handlers that temporarily should not be used.
6026 This applies only to the operation `inhibit-file-name-operation'. */);
6027 Vinhibit_file_name_handlers
= Qnil
;
6029 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6030 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6031 Vinhibit_file_name_operation
= Qnil
;
6033 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6034 doc
: /* File name in which we write a list of all auto save file names.
6035 This variable is initialized automatically from `auto-save-list-file-prefix'
6036 shortly after Emacs reads your init file, if you have not yet given it
6037 a non-nil value. */);
6038 Vauto_save_list_file_name
= Qnil
;
6040 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6041 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6042 Normally auto-save files are written under other names. */);
6043 Vauto_save_visited_file_name
= Qnil
;
6045 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6046 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6047 If nil, deleting a substantial portion of the text disables auto-save
6048 in the buffer; this is the default behavior, because the auto-save
6049 file is usually more useful if it contains the deleted text. */);
6050 Vauto_save_include_big_deletions
= Qnil
;
6053 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6054 doc
: /* Non-nil means don't call fsync in `write-region'.
6055 This variable affects calls to `write-region' as well as save commands.
6056 A non-nil value may result in data loss! */);
6057 write_region_inhibit_fsync
= 0;
6060 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6061 doc
: /* Specifies whether to use the system's trash can.
6062 When non-nil, certain file deletion commands use the function
6063 `move-file-to-trash' instead of deleting files outright.
6064 This includes interactive calls to `delete-file' and
6065 `delete-directory' and the Dired deletion commands. */);
6066 delete_by_moving_to_trash
= 0;
6067 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6069 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6070 DEFSYM (Qcopy_directory
, "copy-directory");
6071 DEFSYM (Qdelete_directory
, "delete-directory");
6073 defsubr (&Sfind_file_name_handler
);
6074 defsubr (&Sfile_name_directory
);
6075 defsubr (&Sfile_name_nondirectory
);
6076 defsubr (&Sunhandled_file_name_directory
);
6077 defsubr (&Sfile_name_as_directory
);
6078 defsubr (&Sdirectory_file_name
);
6079 defsubr (&Smake_temp_name
);
6080 defsubr (&Sexpand_file_name
);
6081 defsubr (&Ssubstitute_in_file_name
);
6082 defsubr (&Scopy_file
);
6083 defsubr (&Smake_directory_internal
);
6084 defsubr (&Sdelete_directory_internal
);
6085 defsubr (&Sdelete_file
);
6086 defsubr (&Srename_file
);
6087 defsubr (&Sadd_name_to_file
);
6088 defsubr (&Smake_symbolic_link
);
6089 defsubr (&Sfile_name_absolute_p
);
6090 defsubr (&Sfile_exists_p
);
6091 defsubr (&Sfile_executable_p
);
6092 defsubr (&Sfile_readable_p
);
6093 defsubr (&Sfile_writable_p
);
6094 defsubr (&Saccess_file
);
6095 defsubr (&Sfile_symlink_p
);
6096 defsubr (&Sfile_directory_p
);
6097 defsubr (&Sfile_accessible_directory_p
);
6098 defsubr (&Sfile_regular_p
);
6099 defsubr (&Sfile_modes
);
6100 defsubr (&Sset_file_modes
);
6101 defsubr (&Sset_file_times
);
6102 defsubr (&Sfile_selinux_context
);
6103 defsubr (&Sfile_acl
);
6104 defsubr (&Sset_file_acl
);
6105 defsubr (&Sset_file_selinux_context
);
6106 defsubr (&Sset_default_file_modes
);
6107 defsubr (&Sdefault_file_modes
);
6108 defsubr (&Sfile_newer_than_file_p
);
6109 defsubr (&Sinsert_file_contents
);
6110 defsubr (&Schoose_write_coding_system
);
6111 defsubr (&Swrite_region
);
6112 defsubr (&Scar_less_than_car
);
6113 defsubr (&Sverify_visited_file_modtime
);
6114 defsubr (&Sclear_visited_file_modtime
);
6115 defsubr (&Svisited_file_modtime
);
6116 defsubr (&Sset_visited_file_modtime
);
6117 defsubr (&Sdo_auto_save
);
6118 defsubr (&Sset_buffer_auto_saved
);
6119 defsubr (&Sclear_buffer_auto_save_failure
);
6120 defsubr (&Srecent_auto_save_p
);
6122 defsubr (&Snext_read_file_uses_dialog_p
);
6125 defsubr (&Sunix_sync
);