1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
53 #include "dispextern.h"
61 #endif /* not WINDOWSNT */
65 #include <sys/param.h>
70 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
71 redirector allows the six letters between 'Z' and 'a' as well. */
73 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
76 #define IS_DRIVE(x) c_isalpha (x)
78 /* Need to lower-case the drive letter, or else expanded
79 filenames will sometimes compare unequal, because
80 `expand-file-name' doesn't always down-case the drive letter. */
81 #define DRIVE_LETTER(x) c_tolower (x)
85 #include <allocator.h>
86 #include <careadlinkat.h>
87 #include <stat-time.h>
95 /* True during writing of auto-save files. */
96 static bool auto_saving
;
98 /* Nonzero umask during creation of auto-save directories. */
99 static mode_t auto_saving_dir_umask
;
101 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
102 a new file with the same mode as the original. */
103 static mode_t auto_save_mode_bits
;
105 /* Set by auto_save_1 if an error occurred during the last auto-save. */
106 static bool auto_save_error_occurred
;
108 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
109 number of a file system where time stamps were observed to to work. */
110 static bool valid_timestamp_file_system
;
111 static dev_t timestamp_file_system
;
113 /* The symbol bound to coding-system-for-read when
114 insert-file-contents is called for recovering a file. This is not
115 an actual coding system name, but just an indicator to tell
116 insert-file-contents to use `emacs-mule' with a special flag for
117 auto saving and recovering a file. */
118 static Lisp_Object Qauto_save_coding
;
120 /* Property name of a file name handler,
121 which gives a list of operations it handles.. */
122 static Lisp_Object Qoperations
;
124 /* Lisp functions for translating file formats. */
125 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
127 /* Lisp function for setting buffer-file-coding-system and the
128 multibyteness of the current buffer after inserting a file. */
129 static Lisp_Object Qafter_insert_file_set_coding
;
131 static Lisp_Object Qwrite_region_annotate_functions
;
132 /* Each time an annotation function changes the buffer, the new buffer
134 static Lisp_Object Vwrite_region_annotation_buffers
;
136 static Lisp_Object Qdelete_by_moving_to_trash
;
138 /* Lisp function for moving files to trash. */
139 static Lisp_Object Qmove_file_to_trash
;
141 /* Lisp function for recursively copying directories. */
142 static Lisp_Object Qcopy_directory
;
144 /* Lisp function for recursively deleting directories. */
145 static Lisp_Object Qdelete_directory
;
150 Lisp_Object Qfile_error
;
151 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
152 static Lisp_Object Qexcl
;
153 Lisp_Object Qfile_name_history
;
155 static Lisp_Object Qcar_less_than_car
;
157 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
158 Lisp_Object
*, struct coding_system
*);
159 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
160 struct coding_system
*);
164 report_file_error (const char *string
, Lisp_Object data
)
166 Lisp_Object errstring
;
170 synchronize_system_messages_locale ();
171 str
= strerror (errorno
);
172 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
173 Vlocale_coding_system
, 0);
179 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
182 /* System error messages are capitalized. Downcase the initial
183 unless it is followed by a slash. (The slash case caters to
184 error messages that begin with "I/O" or, in German, "E/A".) */
185 if (STRING_MULTIBYTE (errstring
)
186 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
190 str
= SSDATA (errstring
);
191 c
= STRING_CHAR ((unsigned char *) str
);
192 Faset (errstring
, make_number (0), make_number (downcase (c
)));
195 xsignal (Qfile_error
,
196 Fcons (build_string (string
), Fcons (errstring
, data
)));
201 close_file_unwind (Lisp_Object fd
)
203 emacs_close (XFASTINT (fd
));
207 /* Restore point, having saved it as a marker. */
210 restore_point_unwind (Lisp_Object location
)
212 Fgoto_char (location
);
213 Fset_marker (location
, Qnil
, Qnil
);
218 static Lisp_Object Qexpand_file_name
;
219 static Lisp_Object Qsubstitute_in_file_name
;
220 static Lisp_Object Qdirectory_file_name
;
221 static Lisp_Object Qfile_name_directory
;
222 static Lisp_Object Qfile_name_nondirectory
;
223 static Lisp_Object Qunhandled_file_name_directory
;
224 static Lisp_Object Qfile_name_as_directory
;
225 static Lisp_Object Qcopy_file
;
226 static Lisp_Object Qmake_directory_internal
;
227 static Lisp_Object Qmake_directory
;
228 static Lisp_Object Qdelete_directory_internal
;
229 Lisp_Object Qdelete_file
;
230 static Lisp_Object Qrename_file
;
231 static Lisp_Object Qadd_name_to_file
;
232 static Lisp_Object Qmake_symbolic_link
;
233 Lisp_Object Qfile_exists_p
;
234 static Lisp_Object Qfile_executable_p
;
235 static Lisp_Object Qfile_readable_p
;
236 static Lisp_Object Qfile_writable_p
;
237 static Lisp_Object Qfile_symlink_p
;
238 static Lisp_Object Qaccess_file
;
239 Lisp_Object Qfile_directory_p
;
240 static Lisp_Object Qfile_regular_p
;
241 static Lisp_Object Qfile_accessible_directory_p
;
242 static Lisp_Object Qfile_modes
;
243 static Lisp_Object Qset_file_modes
;
244 static Lisp_Object Qset_file_times
;
245 static Lisp_Object Qfile_selinux_context
;
246 static Lisp_Object Qset_file_selinux_context
;
247 static Lisp_Object Qfile_acl
;
248 static Lisp_Object Qset_file_acl
;
249 static Lisp_Object Qfile_newer_than_file_p
;
250 Lisp_Object Qinsert_file_contents
;
251 static Lisp_Object Qchoose_write_coding_system
;
252 Lisp_Object Qwrite_region
;
253 static Lisp_Object Qverify_visited_file_modtime
;
254 static Lisp_Object Qset_visited_file_modtime
;
256 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
257 Sfind_file_name_handler
, 2, 2, 0,
258 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
259 Otherwise, return nil.
260 A file name is handled if one of the regular expressions in
261 `file-name-handler-alist' matches it.
263 If OPERATION equals `inhibit-file-name-operation', then we ignore
264 any handlers that are members of `inhibit-file-name-handlers',
265 but we still do run any other handlers. This lets handlers
266 use the standard functions without calling themselves recursively. */)
267 (Lisp_Object filename
, Lisp_Object operation
)
269 /* This function must not munge the match data. */
270 Lisp_Object chain
, inhibited_handlers
, result
;
274 CHECK_STRING (filename
);
276 if (EQ (operation
, Vinhibit_file_name_operation
))
277 inhibited_handlers
= Vinhibit_file_name_handlers
;
279 inhibited_handlers
= Qnil
;
281 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
282 chain
= XCDR (chain
))
288 Lisp_Object string
= XCAR (elt
);
290 Lisp_Object handler
= XCDR (elt
);
291 Lisp_Object operations
= Qnil
;
293 if (SYMBOLP (handler
))
294 operations
= Fget (handler
, Qoperations
);
297 && (match_pos
= fast_string_match (string
, filename
)) > pos
298 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
302 handler
= XCDR (elt
);
303 tem
= Fmemq (handler
, inhibited_handlers
);
317 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
319 doc
: /* Return the directory component in file name FILENAME.
320 Return nil if FILENAME does not include a directory.
321 Otherwise return a directory name.
322 Given a Unix syntax file name, returns a string ending in slash. */)
323 (Lisp_Object filename
)
326 register const char *beg
;
331 register const char *p
;
334 CHECK_STRING (filename
);
336 /* If the file name has special constructs in it,
337 call the corresponding file handler. */
338 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
341 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
343 return STRINGP (handled_name
) ? handled_name
: Qnil
;
347 beg
= alloca (SBYTES (filename
) + 1);
348 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
350 beg
= SSDATA (filename
);
352 p
= beg
+ SBYTES (filename
);
354 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
356 /* only recognize drive specifier at the beginning */
358 /* handle the "/:d:foo" and "/:foo" cases correctly */
359 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
360 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
367 /* Expansion of "c:" to drive and default directory. */
370 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
371 char *res
= alloca (MAXPATHLEN
+ 1);
374 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
376 memcpy (res
, beg
, 2);
381 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
383 size_t l
= strlen (res
);
385 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
388 p
= beg
+ strlen (beg
);
389 dostounix_filename (beg
, 0);
390 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
391 STRING_MULTIBYTE (filename
));
394 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
395 STRING_MULTIBYTE (filename
));
397 else if (STRING_MULTIBYTE (filename
))
399 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
400 dostounix_filename (SSDATA (tem_fn
), 1);
402 if (!NILP (Vw32_downcase_file_names
))
403 tem_fn
= Fdowncase (tem_fn
);
408 dostounix_filename (beg
, 0);
409 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
413 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
417 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
418 Sfile_name_nondirectory
, 1, 1, 0,
419 doc
: /* Return file name FILENAME sans its directory.
420 For example, in a Unix-syntax file name,
421 this is everything after the last slash,
422 or the entire name if it contains no slash. */)
423 (Lisp_Object filename
)
425 register const char *beg
, *p
, *end
;
428 CHECK_STRING (filename
);
430 /* If the file name has special constructs in it,
431 call the corresponding file handler. */
432 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
435 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
437 if (STRINGP (handled_name
))
439 error ("Invalid handler in `file-name-handler-alist'");
442 beg
= SSDATA (filename
);
443 end
= p
= beg
+ SBYTES (filename
);
445 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
447 /* only recognize drive specifier at beginning */
449 /* handle the "/:d:foo" case correctly */
450 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
455 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
458 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
459 Sunhandled_file_name_directory
, 1, 1, 0,
460 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
461 A `directly usable' directory name is one that may be used without the
462 intervention of any file handler.
463 If FILENAME is a directly usable file itself, return
464 \(file-name-directory FILENAME).
465 If FILENAME refers to a file which is not accessible from a local process,
466 then this should return nil.
467 The `call-process' and `start-process' functions use this function to
468 get a current directory to run processes in. */)
469 (Lisp_Object filename
)
473 /* If the file name has special constructs in it,
474 call the corresponding file handler. */
475 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
478 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
480 return STRINGP (handled_name
) ? handled_name
: Qnil
;
483 return Ffile_name_directory (filename
);
486 /* Convert from file name SRC of length SRCLEN to directory name in
487 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
488 string. On UNIX, just make sure there is a terminating /. Return
489 the length of DST in bytes. */
492 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
505 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
507 dst
[srclen
] = DIRECTORY_SEP
;
508 dst
[srclen
+ 1] = '\0';
512 dostounix_filename (dst
, multibyte
);
517 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
518 Sfile_name_as_directory
, 1, 1, 0,
519 doc
: /* Return a string representing the file name FILE interpreted as a directory.
520 This operation exists because a directory is also a file, but its name as
521 a directory is different from its name as a file.
522 The result can be used as the value of `default-directory'
523 or passed as second argument to `expand-file-name'.
524 For a Unix-syntax file name, just appends a slash. */)
535 /* If the file name has special constructs in it,
536 call the corresponding file handler. */
537 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
540 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
542 if (STRINGP (handled_name
))
544 error ("Invalid handler in `file-name-handler-alist'");
548 if (!NILP (Vw32_downcase_file_names
))
549 file
= Fdowncase (file
);
551 buf
= alloca (SBYTES (file
) + 10);
552 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
553 STRING_MULTIBYTE (file
));
554 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
557 /* Convert from directory name SRC of length SRCLEN to file name in
558 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
559 string. On UNIX, just make sure there isn't a terminating /.
560 Return the length of DST in bytes. */
563 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
565 /* Process as Unix format: just remove any final slash.
566 But leave "/" unchanged; do not change it to "". */
569 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
571 && !IS_ANY_SEP (dst
[srclen
- 2])
579 dostounix_filename (dst
, multibyte
);
584 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
586 doc
: /* Returns the file name of the directory named DIRECTORY.
587 This is the name of the file that holds the data for the directory DIRECTORY.
588 This operation exists because a directory is also a file, but its name as
589 a directory is different from its name as a file.
590 In Unix-syntax, this function just removes the final slash. */)
591 (Lisp_Object directory
)
597 CHECK_STRING (directory
);
599 if (NILP (directory
))
602 /* If the file name has special constructs in it,
603 call the corresponding file handler. */
604 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
607 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
609 if (STRINGP (handled_name
))
611 error ("Invalid handler in `file-name-handler-alist'");
615 if (!NILP (Vw32_downcase_file_names
))
616 directory
= Fdowncase (directory
);
618 buf
= alloca (SBYTES (directory
) + 20);
619 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
620 STRING_MULTIBYTE (directory
));
621 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
624 static const char make_temp_name_tbl
[64] =
626 'A','B','C','D','E','F','G','H',
627 'I','J','K','L','M','N','O','P',
628 'Q','R','S','T','U','V','W','X',
629 'Y','Z','a','b','c','d','e','f',
630 'g','h','i','j','k','l','m','n',
631 'o','p','q','r','s','t','u','v',
632 'w','x','y','z','0','1','2','3',
633 '4','5','6','7','8','9','-','_'
636 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
638 /* Value is a temporary file name starting with PREFIX, a string.
640 The Emacs process number forms part of the result, so there is
641 no danger of generating a name being used by another process.
642 In addition, this function makes an attempt to choose a name
643 which has no existing file. To make this work, PREFIX should be
644 an absolute file name.
646 BASE64_P means add the pid as 3 characters in base64
647 encoding. In this case, 6 characters will be added to PREFIX to
648 form the file name. Otherwise, if Emacs is running on a system
649 with long file names, add the pid as a decimal number.
651 This function signals an error if no unique file name could be
655 make_temp_name (Lisp_Object prefix
, bool base64_p
)
661 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
664 CHECK_STRING (prefix
);
666 /* VAL is created by adding 6 characters to PREFIX. The first
667 three are the PID of this process, in base 64, and the second
668 three are incremented if the file already exists. This ensures
669 262144 unique file names per PID per PREFIX. */
675 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
676 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
677 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
682 #ifdef HAVE_LONG_FILE_NAMES
683 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
685 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
686 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
687 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
692 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
693 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
694 if (!STRING_MULTIBYTE (prefix
))
695 STRING_SET_UNIBYTE (val
);
697 memcpy (data
, SSDATA (prefix
), len
);
700 memcpy (p
, pidbuf
, pidlen
);
703 /* Here we try to minimize useless stat'ing when this function is
704 invoked many times successively with the same PREFIX. We achieve
705 this by initializing count to a random value, and incrementing it
708 We don't want make-temp-name to be called while dumping,
709 because then make_temp_name_count_initialized_p would get set
710 and then make_temp_name_count would not be set when Emacs starts. */
712 if (!make_temp_name_count_initialized_p
)
714 make_temp_name_count
= time (NULL
);
715 make_temp_name_count_initialized_p
= 1;
720 unsigned num
= make_temp_name_count
;
722 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
723 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
724 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
726 /* Poor man's congruential RN generator. Replace with
727 ++make_temp_name_count for debugging. */
728 make_temp_name_count
+= 25229;
729 make_temp_name_count
%= 225307;
731 if (!check_existing (data
))
733 /* We want to return only if errno is ENOENT. */
737 /* The error here is dubious, but there is little else we
738 can do. The alternatives are to return nil, which is
739 as bad as (and in many cases worse than) throwing the
740 error, or to ignore the error, which will likely result
741 in looping through 225307 stat's, which is not only
742 dog-slow, but also useless since eventually nil would
743 have to be returned anyway. */
744 report_file_error ("Cannot create temporary name for prefix",
745 Fcons (prefix
, Qnil
));
752 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
753 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
754 The Emacs process number forms part of the result,
755 so there is no danger of generating a name being used by another process.
757 In addition, this function makes an attempt to choose a name
758 which has no existing file. To make this work,
759 PREFIX should be an absolute file name.
761 There is a race condition between calling `make-temp-name' and creating the
762 file which opens all kinds of security holes. For that reason, you should
763 probably use `make-temp-file' instead, except in three circumstances:
765 * If you are creating the file in the user's home directory.
766 * If you are creating a directory rather than an ordinary file.
767 * If you are taking special precautions as `make-temp-file' does. */)
770 return make_temp_name (prefix
, 0);
775 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
776 doc
: /* Convert filename NAME to absolute, and canonicalize it.
777 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
778 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
779 the current buffer's value of `default-directory' is used.
780 NAME should be a string that is a valid file name for the underlying
782 File name components that are `.' are removed, and
783 so are file name components followed by `..', along with the `..' itself;
784 note that these simplifications are done without checking the resulting
785 file names in the file system.
786 Multiple consecutive slashes are collapsed into a single slash,
787 except at the beginning of the file name when they are significant (e.g.,
788 UNC file names on MS-Windows.)
789 An initial `~/' expands to your home directory.
790 An initial `~USER/' expands to USER's home directory.
791 See also the function `substitute-in-file-name'.
793 For technical reasons, this function can return correct but
794 non-intuitive results for the root directory; for instance,
795 \(expand-file-name ".." "/") returns "/..". For this reason, use
796 \(directory-file-name (file-name-directory dirname)) to traverse a
797 filesystem tree, not (expand-file-name ".." dirname). */)
798 (Lisp_Object name
, Lisp_Object default_directory
)
800 /* These point to SDATA and need to be careful with string-relocation
801 during GC (via DECODE_FILE). */
804 /* This should only point to alloca'd data. */
811 bool collapse_newdir
= 1;
815 Lisp_Object handler
, result
, handled_name
;
821 /* If the file name has special constructs in it,
822 call the corresponding file handler. */
823 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
826 handled_name
= call3 (handler
, Qexpand_file_name
,
827 name
, default_directory
);
828 if (STRINGP (handled_name
))
830 error ("Invalid handler in `file-name-handler-alist'");
834 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
835 if (NILP (default_directory
))
836 default_directory
= BVAR (current_buffer
, directory
);
837 if (! STRINGP (default_directory
))
840 /* "/" is not considered a root directory on DOS_NT, so using "/"
841 here causes an infinite recursion in, e.g., the following:
843 (let (default-directory)
844 (expand-file-name "a"))
846 To avoid this, we set default_directory to the root of the
848 default_directory
= build_string (emacs_root_dir ());
850 default_directory
= build_string ("/");
854 if (!NILP (default_directory
))
856 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
859 handled_name
= call3 (handler
, Qexpand_file_name
,
860 name
, default_directory
);
861 if (STRINGP (handled_name
))
863 error ("Invalid handler in `file-name-handler-alist'");
868 char *o
= SSDATA (default_directory
);
870 /* Make sure DEFAULT_DIRECTORY is properly expanded.
871 It would be better to do this down below where we actually use
872 default_directory. Unfortunately, calling Fexpand_file_name recursively
873 could invoke GC, and the strings might be relocated. This would
874 be annoying because we have pointers into strings lying around
875 that would need adjusting, and people would add new pointers to
876 the code and forget to adjust them, resulting in intermittent bugs.
877 Putting this call here avoids all that crud.
879 The EQ test avoids infinite recursion. */
880 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
881 /* Save time in some common cases - as long as default_directory
882 is not relative, it can be canonicalized with name below (if it
883 is needed at all) without requiring it to be expanded now. */
885 /* Detect MSDOS file names with drive specifiers. */
886 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
887 && IS_DIRECTORY_SEP (o
[2]))
889 /* Detect Windows file names in UNC format. */
890 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
892 #else /* not DOS_NT */
893 /* Detect Unix absolute file names (/... alone is not absolute on
895 && ! (IS_DIRECTORY_SEP (o
[0]))
896 #endif /* not DOS_NT */
902 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
906 multibyte
= STRING_MULTIBYTE (name
);
907 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
910 default_directory
= string_to_multibyte (default_directory
);
913 name
= string_to_multibyte (name
);
919 if (!NILP (Vw32_downcase_file_names
))
920 default_directory
= Fdowncase (default_directory
);
923 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
924 nm
= alloca (SBYTES (name
) + 1);
925 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
928 /* Note if special escape prefix is present, but remove for now. */
929 if (nm
[0] == '/' && nm
[1] == ':')
935 /* Find and remove drive specifier if present; this makes nm absolute
936 even if the rest of the name appears to be relative. Only look for
937 drive specifier at the beginning. */
938 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
940 drive
= (unsigned char) nm
[0];
945 /* If we see "c://somedir", we want to strip the first slash after the
946 colon when stripping the drive letter. Otherwise, this expands to
948 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
951 /* Discard any previous drive specifier if nm is now in UNC format. */
952 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
956 #endif /* WINDOWSNT */
959 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
960 none are found, we can probably return right away. We will avoid
961 allocating a new string if name is already fully expanded. */
963 IS_DIRECTORY_SEP (nm
[0])
965 && drive
&& !is_escaped
968 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
972 /* If it turns out that the filename we want to return is just a
973 suffix of FILENAME, we don't need to go through and edit
974 things; we just need to construct a new string using data
975 starting at the middle of FILENAME. If we set LOSE, that
976 means we've discovered that we can't do that cool trick. */
982 /* Since we know the name is absolute, we can assume that each
983 element starts with a "/". */
985 /* "." and ".." are hairy. */
986 if (IS_DIRECTORY_SEP (p
[0])
988 && (IS_DIRECTORY_SEP (p
[2])
990 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
993 /* We want to replace multiple `/' in a row with a single
996 && IS_DIRECTORY_SEP (p
[0])
997 && IS_DIRECTORY_SEP (p
[1]))
1004 /* Make sure directories are all separated with /, but
1005 avoid allocation of a new string when not required. */
1006 dostounix_filename (nm
, multibyte
);
1008 if (IS_DIRECTORY_SEP (nm
[1]))
1010 if (strcmp (nm
, SSDATA (name
)) != 0)
1011 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1015 /* Drive must be set, so this is okay. */
1016 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1020 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1021 temp
[0] = DRIVE_LETTER (drive
);
1022 name
= concat2 (build_string (temp
), name
);
1025 if (!NILP (Vw32_downcase_file_names
))
1026 name
= Fdowncase (name
);
1029 #else /* not DOS_NT */
1030 if (strcmp (nm
, SSDATA (name
)) == 0)
1032 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1033 #endif /* not DOS_NT */
1037 /* At this point, nm might or might not be an absolute file name. We
1038 need to expand ~ or ~user if present, otherwise prefix nm with
1039 default_directory if nm is not absolute, and finally collapse /./
1040 and /foo/../ sequences.
1042 We set newdir to be the appropriate prefix if one is needed:
1043 - the relevant user directory if nm starts with ~ or ~user
1044 - the specified drive's working dir (DOS/NT only) if nm does not
1046 - the value of default_directory.
1048 Note that these prefixes are not guaranteed to be absolute (except
1049 for the working dir of a drive). Therefore, to ensure we always
1050 return an absolute name, if the final prefix is not absolute we
1051 append it to the current working directory. */
1055 if (nm
[0] == '~') /* prefix ~ */
1057 if (IS_DIRECTORY_SEP (nm
[1])
1058 || nm
[1] == 0) /* ~ by itself */
1062 if (!(newdir
= egetenv ("HOME")))
1065 /* `egetenv' may return a unibyte string, which will bite us since
1066 we expect the directory to be multibyte. */
1067 tem
= build_string (newdir
);
1068 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1070 hdir
= DECODE_FILE (tem
);
1071 newdir
= SSDATA (hdir
);
1074 collapse_newdir
= 0;
1077 else /* ~user/filename */
1080 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1081 o
= alloca (p
- nm
+ 1);
1082 memcpy (o
, nm
, p
- nm
);
1086 pw
= getpwnam (o
+ 1);
1092 newdir
= pw
->pw_dir
;
1093 /* `getpwnam' may return a unibyte string, which will
1094 bite us since we expect the directory to be
1096 tem
= build_string (newdir
);
1097 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1099 hdir
= DECODE_FILE (tem
);
1100 newdir
= SSDATA (hdir
);
1104 collapse_newdir
= 0;
1108 /* If we don't find a user of that name, leave the name
1109 unchanged; don't move nm forward to p. */
1114 /* On DOS and Windows, nm is absolute if a drive name was specified;
1115 use the drive's current directory as the prefix if needed. */
1116 if (!newdir
&& drive
)
1118 /* Get default directory if needed to make nm absolute. */
1120 if (!IS_DIRECTORY_SEP (nm
[0]))
1122 adir
= alloca (MAXPATHLEN
+ 1);
1123 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1127 Lisp_Object tem
= build_string (adir
);
1129 tem
= DECODE_FILE (tem
);
1130 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1135 /* Either nm starts with /, or drive isn't mounted. */
1137 adir
[0] = DRIVE_LETTER (drive
);
1146 /* Finally, if no prefix has been specified and nm is not absolute,
1147 then it must be expanded relative to default_directory. */
1151 /* /... alone is not absolute on DOS and Windows. */
1152 && !IS_DIRECTORY_SEP (nm
[0])
1155 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1159 newdir
= SSDATA (default_directory
);
1161 /* Note if special escape prefix is present, but remove for now. */
1162 if (newdir
[0] == '/' && newdir
[1] == ':')
1173 /* First ensure newdir is an absolute name. */
1175 /* Detect MSDOS file names with drive specifiers. */
1176 ! (IS_DRIVE (newdir
[0])
1177 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1179 /* Detect Windows file names in UNC format. */
1180 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1184 /* Effectively, let newdir be (expand-file-name newdir cwd).
1185 Because of the admonition against calling expand-file-name
1186 when we have pointers into lisp strings, we accomplish this
1187 indirectly by prepending newdir to nm if necessary, and using
1188 cwd (or the wd of newdir's drive) as the new newdir. */
1191 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1193 drive
= (unsigned char) newdir
[0];
1196 if (!IS_DIRECTORY_SEP (nm
[0]))
1198 ptrdiff_t newlen
= strlen (newdir
);
1199 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1200 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1204 adir
= alloca (MAXPATHLEN
+ 1);
1207 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1211 getcwd (adir
, MAXPATHLEN
+ 1);
1214 Lisp_Object tem
= build_string (adir
);
1216 tem
= DECODE_FILE (tem
);
1217 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1222 /* Strip off drive name from prefix, if present. */
1223 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1229 /* Keep only a prefix from newdir if nm starts with slash
1230 (//server/share for UNC, nothing otherwise). */
1231 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1234 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1236 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1238 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1240 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1253 /* Get rid of any slash at the end of newdir, unless newdir is
1254 just / or // (an incomplete UNC name). */
1255 length
= strlen (newdir
);
1257 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1259 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1263 char *temp
= alloca (length
);
1264 memcpy (temp
, newdir
, length
- 1);
1265 temp
[length
- 1] = 0;
1276 /* Now concatenate the directory and name to new space in the stack frame. */
1277 tlen
+= strlen (nm
) + 1;
1279 /* Reserve space for drive specifier and escape prefix, since either
1280 or both may need to be inserted. (The Microsoft x86 compiler
1281 produces incorrect code if the following two lines are combined.) */
1282 target
= alloca (tlen
+ 4);
1284 #else /* not DOS_NT */
1285 target
= alloca (tlen
);
1286 #endif /* not DOS_NT */
1291 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1294 /* If newdir is effectively "C:/", then the drive letter will have
1295 been stripped and newdir will be "/". Concatenating with an
1296 absolute directory in nm produces "//", which will then be
1297 incorrectly treated as a network share. Ignore newdir in
1298 this case (keeping the drive letter). */
1299 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1300 && newdir
[1] == '\0'))
1302 strcpy (target
, newdir
);
1305 file_name_as_directory (target
, newdir
, length
, multibyte
);
1308 strcat (target
, nm
);
1310 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1318 if (!IS_DIRECTORY_SEP (*p
))
1322 else if (p
[1] == '.'
1323 && (IS_DIRECTORY_SEP (p
[2])
1326 /* If "/." is the entire filename, keep the "/". Otherwise,
1327 just delete the whole "/.". */
1328 if (o
== target
&& p
[2] == '\0')
1332 else if (p
[1] == '.' && p
[2] == '.'
1333 /* `/../' is the "superroot" on certain file systems.
1334 Turned off on DOS_NT systems because they have no
1335 "superroot" and because this causes us to produce
1336 file names like "d:/../foo" which fail file-related
1337 functions of the underlying OS. (To reproduce, try a
1338 long series of "../../" in default_directory, longer
1339 than the number of levels from the root.) */
1343 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1348 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1351 /* Don't go below server level in UNC filenames. */
1352 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1353 && IS_DIRECTORY_SEP (*target
))
1357 /* Keep initial / only if this is the whole name. */
1358 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1362 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1363 /* Collapse multiple `/' in a row. */
1372 /* At last, set drive name. */
1374 /* Except for network file name. */
1375 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1376 #endif /* WINDOWSNT */
1378 if (!drive
) emacs_abort ();
1380 target
[0] = DRIVE_LETTER (drive
);
1383 /* Reinsert the escape prefix if required. */
1390 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1391 dostounix_filename (SSDATA (result
), multibyte
);
1393 if (!NILP (Vw32_downcase_file_names
))
1394 result
= Fdowncase (result
);
1397 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1398 #endif /* !DOS_NT */
1401 /* Again look to see if the file name has special constructs in it
1402 and perhaps call the corresponding file handler. This is needed
1403 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1404 the ".." component gives us "/user@host:/bar/../baz" which needs
1405 to be expanded again. */
1406 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1407 if (!NILP (handler
))
1409 handled_name
= call3 (handler
, Qexpand_file_name
,
1410 result
, default_directory
);
1411 if (STRINGP (handled_name
))
1412 return handled_name
;
1413 error ("Invalid handler in `file-name-handler-alist'");
1420 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1421 This is the old version of expand-file-name, before it was thoroughly
1422 rewritten for Emacs 10.31. We leave this version here commented-out,
1423 because the code is very complex and likely to have subtle bugs. If
1424 bugs _are_ found, it might be of interest to look at the old code and
1425 see what did it do in the relevant situation.
1427 Don't remove this code: it's true that it will be accessible
1428 from the repository, but a few years from deletion, people will
1429 forget it is there. */
1431 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1432 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1433 "Convert FILENAME to absolute, and canonicalize it.\n\
1434 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1435 \(does not start with slash); if DEFAULT is nil or missing,\n\
1436 the current buffer's value of default-directory is used.\n\
1437 Filenames containing `.' or `..' as components are simplified;\n\
1438 initial `~/' expands to your home directory.\n\
1439 See also the function `substitute-in-file-name'.")
1441 Lisp_Object name
, defalt
;
1445 register unsigned char *newdir
, *p
, *o
;
1447 unsigned char *target
;
1450 CHECK_STRING (name
);
1453 /* If nm is absolute, flush ...// and detect /./ and /../.
1454 If no /./ or /../ we can return right away. */
1461 if (p
[0] == '/' && p
[1] == '/')
1463 if (p
[0] == '/' && p
[1] == '~')
1464 nm
= p
+ 1, lose
= 1;
1465 if (p
[0] == '/' && p
[1] == '.'
1466 && (p
[2] == '/' || p
[2] == 0
1467 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1473 if (nm
== SDATA (name
))
1475 return build_string (nm
);
1479 /* Now determine directory to start with and put it in NEWDIR. */
1483 if (nm
[0] == '~') /* prefix ~ */
1484 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1486 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1487 newdir
= (unsigned char *) "";
1490 else /* ~user/filename */
1492 /* Get past ~ to user. */
1493 unsigned char *user
= nm
+ 1;
1494 /* Find end of name. */
1495 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1496 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1497 /* Copy the user name into temp storage. */
1498 o
= alloca (len
+ 1);
1499 memcpy (o
, user
, len
);
1502 /* Look up the user name. */
1504 pw
= (struct passwd
*) getpwnam (o
+ 1);
1507 error ("\"%s\" isn't a registered user", o
+ 1);
1509 newdir
= (unsigned char *) pw
->pw_dir
;
1511 /* Discard the user name from NM. */
1515 if (nm
[0] != '/' && !newdir
)
1518 defalt
= current_buffer
->directory
;
1519 CHECK_STRING (defalt
);
1520 newdir
= SDATA (defalt
);
1523 /* Now concatenate the directory and name to new space in the stack frame. */
1525 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1526 target
= alloca (tlen
);
1531 if (nm
[0] == 0 || nm
[0] == '/')
1532 strcpy (target
, newdir
);
1534 file_name_as_directory (target
, newdir
);
1537 strcat (target
, nm
);
1539 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1550 else if (!strncmp (p
, "//", 2)
1556 else if (p
[0] == '/' && p
[1] == '.'
1557 && (p
[2] == '/' || p
[2] == 0))
1559 else if (!strncmp (p
, "/..", 3)
1560 /* `/../' is the "superroot" on certain file systems. */
1562 && (p
[3] == '/' || p
[3] == 0))
1564 while (o
!= target
&& *--o
!= '/')
1566 if (o
== target
&& *o
== '/')
1576 return make_string (target
, o
- target
);
1580 /* If /~ or // appears, discard everything through first slash. */
1582 file_name_absolute_p (const char *filename
)
1585 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1587 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1588 && IS_DIRECTORY_SEP (filename
[2]))
1594 search_embedded_absfilename (char *nm
, char *endp
)
1598 for (p
= nm
+ 1; p
< endp
; p
++)
1600 if (IS_DIRECTORY_SEP (p
[-1])
1601 && file_name_absolute_p (p
)
1602 #if defined (WINDOWSNT) || defined (CYGWIN)
1603 /* // at start of file name is meaningful in Apollo,
1604 WindowsNT and Cygwin systems. */
1605 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1606 #endif /* not (WINDOWSNT || CYGWIN) */
1609 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1610 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1612 char *o
= alloca (s
- p
+ 1);
1614 memcpy (o
, p
, s
- p
);
1617 /* If we have ~user and `user' exists, discard
1618 everything up to ~. But if `user' does not exist, leave
1619 ~user alone, it might be a literal file name. */
1621 pw
= getpwnam (o
+ 1);
1633 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1634 Ssubstitute_in_file_name
, 1, 1, 0,
1635 doc
: /* Substitute environment variables referred to in FILENAME.
1636 `$FOO' where FOO is an environment variable name means to substitute
1637 the value of that variable. The variable name should be terminated
1638 with a character not a letter, digit or underscore; otherwise, enclose
1639 the entire variable name in braces.
1641 If `/~' appears, all of FILENAME through that `/' is discarded.
1642 If `//' appears, everything up to and including the first of
1643 those `/' is discarded. */)
1644 (Lisp_Object filename
)
1646 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1647 char *target
= NULL
;
1648 ptrdiff_t total
= 0;
1649 bool substituted
= 0;
1652 Lisp_Object handler
;
1654 CHECK_STRING (filename
);
1656 multibyte
= STRING_MULTIBYTE (filename
);
1658 /* If the file name has special constructs in it,
1659 call the corresponding file handler. */
1660 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1661 if (!NILP (handler
))
1663 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1665 if (STRINGP (handled_name
))
1666 return handled_name
;
1667 error ("Invalid handler in `file-name-handler-alist'");
1670 /* Always work on a copy of the string, in case GC happens during
1671 decode of environment variables, causing the original Lisp_String
1672 data to be relocated. */
1673 nm
= alloca (SBYTES (filename
) + 1);
1674 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1677 dostounix_filename (nm
, multibyte
);
1678 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1680 endp
= nm
+ SBYTES (filename
);
1682 /* If /~ or // appears, discard everything through first slash. */
1683 p
= search_embedded_absfilename (nm
, endp
);
1685 /* Start over with the new string, so we check the file-name-handler
1686 again. Important with filenames like "/home/foo//:/hello///there"
1687 which would substitute to "/:/hello///there" rather than "/there". */
1688 return Fsubstitute_in_file_name
1689 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1691 /* See if any variables are substituted into the string
1692 and find the total length of their values in `total'. */
1694 for (p
= nm
; p
!= endp
;)
1704 /* "$$" means a single "$". */
1713 p
= memchr (p
, '}', endp
- p
);
1721 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1725 /* Copy out the variable name. */
1726 target
= alloca (s
- o
+ 1);
1727 memcpy (target
, o
, s
- o
);
1730 strupr (target
); /* $home == $HOME etc. */
1733 /* Get variable value. */
1734 o
= egetenv (target
);
1737 /* Don't try to guess a maximum length - UTF8 can use up to
1738 four bytes per character. This code is unlikely to run
1739 in a situation that requires performance, so decoding the
1740 env variables twice should be acceptable. Note that
1741 decoding may cause a garbage collect. */
1742 Lisp_Object orig
, decoded
;
1743 orig
= build_unibyte_string (o
);
1744 decoded
= DECODE_FILE (orig
);
1745 total
+= SBYTES (decoded
);
1755 if (!NILP (Vw32_downcase_file_names
))
1756 filename
= Fdowncase (filename
);
1761 /* If substitution required, recopy the string and do it. */
1762 /* Make space in stack frame for the new copy. */
1763 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1766 /* Copy the rest of the name through, replacing $ constructs with values. */
1783 p
= memchr (p
, '}', endp
- p
);
1791 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1795 /* Copy out the variable name. */
1796 target
= alloca (s
- o
+ 1);
1797 memcpy (target
, o
, s
- o
);
1800 /* Get variable value. */
1801 o
= egetenv (target
);
1805 strcpy (x
, target
); x
+= strlen (target
);
1809 Lisp_Object orig
, decoded
;
1810 ptrdiff_t orig_length
, decoded_length
;
1811 orig_length
= strlen (o
);
1812 orig
= make_unibyte_string (o
, orig_length
);
1813 decoded
= DECODE_FILE (orig
);
1814 decoded_length
= SBYTES (decoded
);
1815 memcpy (x
, SDATA (decoded
), decoded_length
);
1816 x
+= decoded_length
;
1818 /* If environment variable needed decoding, return value
1819 needs to be multibyte. */
1820 if (decoded_length
!= orig_length
1821 || memcmp (SDATA (decoded
), o
, orig_length
))
1828 /* If /~ or // appears, discard everything through first slash. */
1829 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1830 /* This time we do not start over because we've already expanded envvars
1831 and replaced $$ with $. Maybe we should start over as well, but we'd
1832 need to quote some $ to $$ first. */
1836 if (!NILP (Vw32_downcase_file_names
))
1838 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1840 xname
= Fdowncase (xname
);
1845 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1848 error ("Bad format environment-variable substitution");
1850 error ("Missing \"}\" in environment-variable substitution");
1852 error ("Substituting nonexistent environment variable \"%s\"", target
);
1855 /* A slightly faster and more convenient way to get
1856 (directory-file-name (expand-file-name FOO)). */
1859 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1861 register Lisp_Object absname
;
1863 absname
= Fexpand_file_name (filename
, defdir
);
1865 /* Remove final slash, if any (unless this is the root dir).
1866 stat behaves differently depending! */
1867 if (SCHARS (absname
) > 1
1868 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1869 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1870 /* We cannot take shortcuts; they might be wrong for magic file names. */
1871 absname
= Fdirectory_file_name (absname
);
1875 /* Signal an error if the file ABSNAME already exists.
1876 If INTERACTIVE, ask the user whether to proceed,
1877 and bypass the error if the user says to go ahead.
1878 QUERYSTRING is a name for the action that is being considered
1881 *STATPTR is used to store the stat information if the file exists.
1882 If the file does not exist, STATPTR->st_mode is set to 0.
1883 If STATPTR is null, we don't store into it.
1885 If QUICK, ask for y or n, not yes or no. */
1888 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1889 bool interactive
, struct stat
*statptr
,
1892 Lisp_Object tem
, encoded_filename
;
1893 struct stat statbuf
;
1894 struct gcpro gcpro1
;
1896 encoded_filename
= ENCODE_FILE (absname
);
1898 /* `stat' is a good way to tell whether the file exists,
1899 regardless of what access permissions it has. */
1900 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1902 if (S_ISDIR (statbuf
.st_mode
))
1903 xsignal2 (Qfile_error
,
1904 build_string ("File is a directory"), absname
);
1907 xsignal2 (Qfile_already_exists
,
1908 build_string ("File already exists"), absname
);
1910 tem
= format2 ("File %s already exists; %s anyway? ",
1911 absname
, build_string (querystring
));
1913 tem
= call1 (intern ("y-or-n-p"), tem
);
1915 tem
= do_yes_or_no_p (tem
);
1918 xsignal2 (Qfile_already_exists
,
1919 build_string ("File already exists"), absname
);
1926 statptr
->st_mode
= 0;
1931 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1932 "fCopy file: \nGCopy %s to file: \np\nP",
1933 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1934 If NEWNAME names a directory, copy FILE there.
1936 This function always sets the file modes of the output file to match
1939 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1940 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1941 signal a `file-already-exists' error without overwriting. If
1942 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1943 about overwriting; this is what happens in interactive use with M-x.
1944 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1947 Fourth arg KEEP-TIME non-nil means give the output file the same
1948 last-modified time as the old one. (This works on only some systems.)
1950 A prefix arg makes KEEP-TIME non-nil.
1952 If PRESERVE-UID-GID is non-nil, we try to transfer the
1953 uid and gid of FILE to NEWNAME.
1955 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1956 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1957 entries (depending on how Emacs was built). */)
1958 (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
)
1962 char buf
[16 * 1024];
1963 struct stat st
, out_st
;
1964 Lisp_Object handler
;
1965 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1966 ptrdiff_t count
= SPECPDL_INDEX ();
1967 Lisp_Object encoded_file
, encoded_newname
;
1969 security_context_t con
;
1972 #ifdef HAVE_POSIX_ACL
1976 encoded_file
= encoded_newname
= Qnil
;
1977 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1978 CHECK_STRING (file
);
1979 CHECK_STRING (newname
);
1981 if (!NILP (Ffile_directory_p (newname
)))
1982 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1984 newname
= Fexpand_file_name (newname
, Qnil
);
1986 file
= Fexpand_file_name (file
, Qnil
);
1988 /* If the input file name has special constructs in it,
1989 call the corresponding file handler. */
1990 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1991 /* Likewise for output file name. */
1993 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1994 if (!NILP (handler
))
1995 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1996 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1997 preserve_extended_attributes
));
1999 encoded_file
= ENCODE_FILE (file
);
2000 encoded_newname
= ENCODE_FILE (newname
);
2002 if (NILP (ok_if_already_exists
)
2003 || INTEGERP (ok_if_already_exists
))
2004 barf_or_query_if_file_exists (newname
, "copy to it",
2005 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2006 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
2010 if (!NILP (preserve_extended_attributes
))
2012 #ifdef HAVE_POSIX_ACL
2013 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2014 if (acl
== NULL
&& errno
!= ENOTSUP
)
2015 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2018 if (!CopyFile (SDATA (encoded_file
),
2019 SDATA (encoded_newname
),
2022 /* CopyFile doesn't set errno when it fails. By far the most
2023 "popular" reason is that the target is read-only. */
2024 if (GetLastError () == 5)
2028 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2030 /* CopyFile retains the timestamp by default. */
2031 else if (NILP (keep_time
))
2037 filename
= SDATA (encoded_newname
);
2039 /* Ensure file is writable while its modified time is set. */
2040 attributes
= GetFileAttributes (filename
);
2041 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2042 now
= current_emacs_time ();
2043 if (set_file_times (-1, filename
, now
, now
))
2045 /* Restore original attributes. */
2046 SetFileAttributes (filename
, attributes
);
2047 xsignal2 (Qfile_date_error
,
2048 build_string ("Cannot set file date"), newname
);
2050 /* Restore original attributes. */
2051 SetFileAttributes (filename
, attributes
);
2053 #ifdef HAVE_POSIX_ACL
2057 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2058 if (fail
&& errno
!= ENOTSUP
)
2059 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2064 #else /* not WINDOWSNT */
2066 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2070 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2072 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2074 if (fstat (ifd
, &st
) != 0)
2075 report_file_error ("Input file status", Fcons (file
, Qnil
));
2077 if (!NILP (preserve_extended_attributes
))
2080 if (is_selinux_enabled ())
2082 conlength
= fgetfilecon (ifd
, &con
);
2083 if (conlength
== -1)
2084 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
2088 #ifdef HAVE_POSIX_ACL
2089 acl
= acl_get_fd (ifd
);
2090 if (acl
== NULL
&& errno
!= ENOTSUP
)
2091 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2095 if (out_st
.st_mode
!= 0
2096 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2099 report_file_error ("Input and output files are the same",
2100 Fcons (file
, Fcons (newname
, Qnil
)));
2103 /* We can copy only regular files. */
2104 if (!S_ISREG (st
.st_mode
))
2106 /* Get a better looking error message. */
2107 errno
= S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
;
2108 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2112 /* System's default file type was set to binary by _fmode in emacs.c. */
2113 ofd
= emacs_open (SDATA (encoded_newname
),
2114 O_WRONLY
| O_TRUNC
| O_CREAT
2115 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2116 S_IREAD
| S_IWRITE
);
2117 #else /* not MSDOS */
2119 mode_t new_mask
= !NILP (preserve_uid_gid
) ? 0600 : 0666;
2120 new_mask
&= st
.st_mode
;
2121 ofd
= emacs_open (SSDATA (encoded_newname
),
2122 (O_WRONLY
| O_TRUNC
| O_CREAT
2123 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2126 #endif /* not MSDOS */
2128 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2130 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2134 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2135 if (emacs_write (ofd
, buf
, n
) != n
)
2136 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2140 /* Preserve the original file modes, and if requested, also its
2143 mode_t mode_mask
= 07777;
2144 if (!NILP (preserve_uid_gid
))
2146 /* Attempt to change owner and group. If that doesn't work
2147 attempt to change just the group, as that is sometimes allowed.
2148 Adjust the mode mask to eliminate setuid or setgid bits
2149 that are inappropriate if the owner and group are wrong. */
2150 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2152 mode_mask
&= ~06000;
2153 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2157 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2158 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2160 #endif /* not MSDOS */
2165 /* Set the modified context back to the file. */
2166 bool fail
= fsetfilecon (ofd
, con
) != 0;
2167 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2168 if (fail
&& errno
!= ENOTSUP
)
2169 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2175 #ifdef HAVE_POSIX_ACL
2178 bool fail
= acl_set_fd (ofd
, acl
) != 0;
2179 if (fail
&& errno
!= ENOTSUP
)
2180 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2186 if (!NILP (keep_time
))
2188 EMACS_TIME atime
= get_stat_atime (&st
);
2189 EMACS_TIME mtime
= get_stat_mtime (&st
);
2190 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2191 xsignal2 (Qfile_date_error
,
2192 build_string ("Cannot set file date"), newname
);
2195 if (emacs_close (ofd
) < 0)
2196 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2201 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2202 and if it can't, it tells so. Otherwise, under MSDOS we usually
2203 get only the READ bit, which will make the copied file read-only,
2204 so it's better not to chmod at all. */
2205 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2206 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2208 #endif /* not WINDOWSNT */
2210 /* Discard the unwind protects. */
2211 specpdl_ptr
= specpdl
+ count
;
2217 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2218 Smake_directory_internal
, 1, 1, 0,
2219 doc
: /* Create a new directory named DIRECTORY. */)
2220 (Lisp_Object directory
)
2223 Lisp_Object handler
;
2224 Lisp_Object encoded_dir
;
2226 CHECK_STRING (directory
);
2227 directory
= Fexpand_file_name (directory
, Qnil
);
2229 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2230 if (!NILP (handler
))
2231 return call2 (handler
, Qmake_directory_internal
, directory
);
2233 encoded_dir
= ENCODE_FILE (directory
);
2235 dir
= SSDATA (encoded_dir
);
2238 if (mkdir (dir
) != 0)
2240 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2242 report_file_error ("Creating directory", list1 (directory
));
2247 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2248 Sdelete_directory_internal
, 1, 1, 0,
2249 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2250 (Lisp_Object directory
)
2253 Lisp_Object encoded_dir
;
2255 CHECK_STRING (directory
);
2256 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2257 encoded_dir
= ENCODE_FILE (directory
);
2258 dir
= SSDATA (encoded_dir
);
2260 if (rmdir (dir
) != 0)
2261 report_file_error ("Removing directory", list1 (directory
));
2266 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2267 "(list (read-file-name \
2268 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2269 \"Move file to trash: \" \"Delete file: \") \
2270 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2271 (null current-prefix-arg))",
2272 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2273 If file has multiple names, it continues to exist with the other names.
2274 TRASH non-nil means to trash the file instead of deleting, provided
2275 `delete-by-moving-to-trash' is non-nil.
2277 When called interactively, TRASH is t if no prefix argument is given.
2278 With a prefix argument, TRASH is nil. */)
2279 (Lisp_Object filename
, Lisp_Object trash
)
2281 Lisp_Object handler
;
2282 Lisp_Object encoded_file
;
2283 struct gcpro gcpro1
;
2286 if (!NILP (Ffile_directory_p (filename
))
2287 && NILP (Ffile_symlink_p (filename
)))
2288 xsignal2 (Qfile_error
,
2289 build_string ("Removing old name: is a directory"),
2292 filename
= Fexpand_file_name (filename
, Qnil
);
2294 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2295 if (!NILP (handler
))
2296 return call3 (handler
, Qdelete_file
, filename
, trash
);
2298 if (delete_by_moving_to_trash
&& !NILP (trash
))
2299 return call1 (Qmove_file_to_trash
, filename
);
2301 encoded_file
= ENCODE_FILE (filename
);
2303 if (unlink (SSDATA (encoded_file
)) < 0)
2304 report_file_error ("Removing old name", list1 (filename
));
2309 internal_delete_file_1 (Lisp_Object ignore
)
2314 /* Delete file FILENAME, returning true if successful.
2315 This ignores `delete-by-moving-to-trash'. */
2318 internal_delete_file (Lisp_Object filename
)
2322 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2323 Qt
, internal_delete_file_1
);
2327 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2328 "fRename file: \nGRename %s to file: \np",
2329 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2330 If file has names other than FILE, it continues to have those names.
2331 Signals a `file-already-exists' error if a file NEWNAME already exists
2332 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2333 A number as third arg means request confirmation if NEWNAME already exists.
2334 This is what happens in interactive use with M-x. */)
2335 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2337 Lisp_Object handler
;
2338 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2339 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2341 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2342 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2343 CHECK_STRING (file
);
2344 CHECK_STRING (newname
);
2345 file
= Fexpand_file_name (file
, Qnil
);
2347 if ((!NILP (Ffile_directory_p (newname
)))
2349 /* If the file names are identical but for the case,
2350 don't attempt to move directory to itself. */
2351 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2355 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2356 ? file
: Fdirectory_file_name (file
));
2357 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2360 newname
= Fexpand_file_name (newname
, Qnil
);
2362 /* If the file name has special constructs in it,
2363 call the corresponding file handler. */
2364 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2366 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2367 if (!NILP (handler
))
2368 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2369 file
, newname
, ok_if_already_exists
));
2371 encoded_file
= ENCODE_FILE (file
);
2372 encoded_newname
= ENCODE_FILE (newname
);
2375 /* If the file names are identical but for the case, don't ask for
2376 confirmation: they simply want to change the letter-case of the
2378 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2380 if (NILP (ok_if_already_exists
)
2381 || INTEGERP (ok_if_already_exists
))
2382 barf_or_query_if_file_exists (newname
, "rename to it",
2383 INTEGERP (ok_if_already_exists
), 0, 0);
2384 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2389 symlink_target
= Ffile_symlink_p (file
);
2390 if (! NILP (symlink_target
))
2391 Fmake_symbolic_link (symlink_target
, newname
,
2392 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2393 else if (!NILP (Ffile_directory_p (file
)))
2394 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2396 /* We have already prompted if it was an integer, so don't
2397 have copy-file prompt again. */
2398 Fcopy_file (file
, newname
,
2399 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2402 count
= SPECPDL_INDEX ();
2403 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2405 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2406 call2 (Qdelete_directory
, file
, Qt
);
2408 Fdelete_file (file
, Qnil
);
2409 unbind_to (count
, Qnil
);
2412 report_file_error ("Renaming", list2 (file
, newname
));
2418 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2419 "fAdd name to file: \nGName to add to %s: \np",
2420 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2421 Signals a `file-already-exists' error if a file NEWNAME already exists
2422 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2423 A number as third arg means request confirmation if NEWNAME already exists.
2424 This is what happens in interactive use with M-x. */)
2425 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2427 Lisp_Object handler
;
2428 Lisp_Object encoded_file
, encoded_newname
;
2429 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2431 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2432 encoded_file
= encoded_newname
= Qnil
;
2433 CHECK_STRING (file
);
2434 CHECK_STRING (newname
);
2435 file
= Fexpand_file_name (file
, Qnil
);
2437 if (!NILP (Ffile_directory_p (newname
)))
2438 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2440 newname
= Fexpand_file_name (newname
, Qnil
);
2442 /* If the file name has special constructs in it,
2443 call the corresponding file handler. */
2444 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2445 if (!NILP (handler
))
2446 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2447 newname
, ok_if_already_exists
));
2449 /* If the new name has special constructs in it,
2450 call the corresponding file handler. */
2451 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2452 if (!NILP (handler
))
2453 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2454 newname
, ok_if_already_exists
));
2456 encoded_file
= ENCODE_FILE (file
);
2457 encoded_newname
= ENCODE_FILE (newname
);
2459 if (NILP (ok_if_already_exists
)
2460 || INTEGERP (ok_if_already_exists
))
2461 barf_or_query_if_file_exists (newname
, "make it a new name",
2462 INTEGERP (ok_if_already_exists
), 0, 0);
2464 unlink (SSDATA (newname
));
2465 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2466 report_file_error ("Adding new name", list2 (file
, newname
));
2472 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2473 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2474 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2475 Both args must be strings.
2476 Signals a `file-already-exists' error if a file LINKNAME already exists
2477 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2478 A number as third arg means request confirmation if LINKNAME already exists.
2479 This happens for interactive use with M-x. */)
2480 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2482 Lisp_Object handler
;
2483 Lisp_Object encoded_filename
, encoded_linkname
;
2484 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2486 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2487 encoded_filename
= encoded_linkname
= Qnil
;
2488 CHECK_STRING (filename
);
2489 CHECK_STRING (linkname
);
2490 /* If the link target has a ~, we must expand it to get
2491 a truly valid file name. Otherwise, do not expand;
2492 we want to permit links to relative file names. */
2493 if (SREF (filename
, 0) == '~')
2494 filename
= Fexpand_file_name (filename
, Qnil
);
2496 if (!NILP (Ffile_directory_p (linkname
)))
2497 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2499 linkname
= Fexpand_file_name (linkname
, Qnil
);
2501 /* If the file name has special constructs in it,
2502 call the corresponding file handler. */
2503 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2504 if (!NILP (handler
))
2505 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2506 linkname
, ok_if_already_exists
));
2508 /* If the new link name has special constructs in it,
2509 call the corresponding file handler. */
2510 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2511 if (!NILP (handler
))
2512 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2513 linkname
, ok_if_already_exists
));
2515 encoded_filename
= ENCODE_FILE (filename
);
2516 encoded_linkname
= ENCODE_FILE (linkname
);
2518 if (NILP (ok_if_already_exists
)
2519 || INTEGERP (ok_if_already_exists
))
2520 barf_or_query_if_file_exists (linkname
, "make it a link",
2521 INTEGERP (ok_if_already_exists
), 0, 0);
2522 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2524 /* If we didn't complain already, silently delete existing file. */
2525 if (errno
== EEXIST
)
2527 unlink (SSDATA (encoded_linkname
));
2528 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2535 if (errno
== ENOSYS
)
2538 xsignal1 (Qfile_error
,
2539 build_string ("Symbolic links are not supported"));
2542 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2549 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2551 doc
: /* Return t if file FILENAME specifies an absolute file name.
2552 On Unix, this is a name starting with a `/' or a `~'. */)
2553 (Lisp_Object filename
)
2555 CHECK_STRING (filename
);
2556 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2559 /* Return true if FILENAME exists. */
2561 check_existing (const char *filename
)
2563 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2566 /* Return true if file FILENAME exists and can be executed. */
2569 check_executable (char *filename
)
2571 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2574 /* Return true if file FILENAME exists and can be accessed
2575 according to AMODE, which should include W_OK.
2576 On failure, return false and set errno. */
2579 check_writable (const char *filename
, int amode
)
2582 /* FIXME: an faccessat implementation should be added to the
2583 DOS/Windows ports and this #ifdef branch should be removed. */
2585 if (stat (filename
, &st
) < 0)
2588 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2589 #else /* not MSDOS */
2590 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2592 /* faccessat may have returned failure because Cygwin couldn't
2593 determine the file's UID or GID; if so, we return success. */
2596 int faccessat_errno
= errno
;
2598 if (stat (filename
, &st
) < 0)
2600 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2601 errno
= faccessat_errno
;
2605 #endif /* not MSDOS */
2608 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2609 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2610 See also `file-readable-p' and `file-attributes'.
2611 This returns nil for a symlink to a nonexistent file.
2612 Use `file-symlink-p' to test for such links. */)
2613 (Lisp_Object filename
)
2615 Lisp_Object absname
;
2616 Lisp_Object handler
;
2618 CHECK_STRING (filename
);
2619 absname
= Fexpand_file_name (filename
, Qnil
);
2621 /* If the file name has special constructs in it,
2622 call the corresponding file handler. */
2623 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2624 if (!NILP (handler
))
2625 return call2 (handler
, Qfile_exists_p
, absname
);
2627 absname
= ENCODE_FILE (absname
);
2629 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2632 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2633 doc
: /* Return t if FILENAME can be executed by you.
2634 For a directory, this means you can access files in that directory. */)
2635 (Lisp_Object filename
)
2637 Lisp_Object absname
;
2638 Lisp_Object handler
;
2640 CHECK_STRING (filename
);
2641 absname
= Fexpand_file_name (filename
, Qnil
);
2643 /* If the file name has special constructs in it,
2644 call the corresponding file handler. */
2645 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2646 if (!NILP (handler
))
2647 return call2 (handler
, Qfile_executable_p
, absname
);
2649 absname
= ENCODE_FILE (absname
);
2651 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2654 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2655 doc
: /* Return t if file FILENAME exists and you can read it.
2656 See also `file-exists-p' and `file-attributes'. */)
2657 (Lisp_Object filename
)
2659 Lisp_Object absname
;
2660 Lisp_Object handler
;
2662 CHECK_STRING (filename
);
2663 absname
= Fexpand_file_name (filename
, Qnil
);
2665 /* If the file name has special constructs in it,
2666 call the corresponding file handler. */
2667 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2668 if (!NILP (handler
))
2669 return call2 (handler
, Qfile_readable_p
, absname
);
2671 absname
= ENCODE_FILE (absname
);
2672 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2676 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2677 doc
: /* Return t if file FILENAME can be written or created by you. */)
2678 (Lisp_Object filename
)
2680 Lisp_Object absname
, dir
, encoded
;
2681 Lisp_Object handler
;
2683 CHECK_STRING (filename
);
2684 absname
= Fexpand_file_name (filename
, Qnil
);
2686 /* If the file name has special constructs in it,
2687 call the corresponding file handler. */
2688 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2689 if (!NILP (handler
))
2690 return call2 (handler
, Qfile_writable_p
, absname
);
2692 encoded
= ENCODE_FILE (absname
);
2693 if (check_writable (SSDATA (encoded
), W_OK
))
2695 if (errno
!= ENOENT
)
2698 dir
= Ffile_name_directory (absname
);
2699 eassert (!NILP (dir
));
2701 dir
= Fdirectory_file_name (dir
);
2704 dir
= ENCODE_FILE (dir
);
2706 /* The read-only attribute of the parent directory doesn't affect
2707 whether a file or directory can be created within it. Some day we
2708 should check ACLs though, which do affect this. */
2709 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2711 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2715 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2716 doc
: /* Access file FILENAME, and get an error if that does not work.
2717 The second argument STRING is used in the error message.
2718 If there is no error, returns nil. */)
2719 (Lisp_Object filename
, Lisp_Object string
)
2721 Lisp_Object handler
, encoded_filename
, absname
;
2724 CHECK_STRING (filename
);
2725 absname
= Fexpand_file_name (filename
, Qnil
);
2727 CHECK_STRING (string
);
2729 /* If the file name has special constructs in it,
2730 call the corresponding file handler. */
2731 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2732 if (!NILP (handler
))
2733 return call3 (handler
, Qaccess_file
, absname
, string
);
2735 encoded_filename
= ENCODE_FILE (absname
);
2737 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2739 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2745 /* Relative to directory FD, return the symbolic link value of FILENAME.
2746 On failure, return nil. */
2748 emacs_readlinkat (int fd
, char const *filename
)
2750 static struct allocator
const emacs_norealloc_allocator
=
2751 { xmalloc
, NULL
, xfree
, memory_full
};
2753 char readlink_buf
[1024];
2754 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2755 &emacs_norealloc_allocator
, readlinkat
);
2759 val
= build_string (buf
);
2760 if (buf
[0] == '/' && strchr (buf
, ':'))
2761 val
= concat2 (build_string ("/:"), val
);
2762 if (buf
!= readlink_buf
)
2764 val
= DECODE_FILE (val
);
2768 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2769 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2770 The value is the link target, as a string.
2771 Otherwise it returns nil.
2773 This function returns t when given the name of a symlink that
2774 points to a nonexistent file. */)
2775 (Lisp_Object filename
)
2777 Lisp_Object handler
;
2779 CHECK_STRING (filename
);
2780 filename
= Fexpand_file_name (filename
, Qnil
);
2782 /* If the file name has special constructs in it,
2783 call the corresponding file handler. */
2784 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2785 if (!NILP (handler
))
2786 return call2 (handler
, Qfile_symlink_p
, filename
);
2788 filename
= ENCODE_FILE (filename
);
2790 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2793 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2794 doc
: /* Return t if FILENAME names an existing directory.
2795 Symbolic links to directories count as directories.
2796 See `file-symlink-p' to distinguish symlinks. */)
2797 (Lisp_Object filename
)
2799 Lisp_Object absname
;
2800 Lisp_Object handler
;
2802 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2804 /* If the file name has special constructs in it,
2805 call the corresponding file handler. */
2806 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2807 if (!NILP (handler
))
2808 return call2 (handler
, Qfile_directory_p
, absname
);
2810 absname
= ENCODE_FILE (absname
);
2812 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2815 /* Return true if FILE is a directory or a symlink to a directory. */
2817 file_directory_p (char const *file
)
2820 /* This is cheaper than 'stat'. */
2821 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2824 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2828 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2829 Sfile_accessible_directory_p
, 1, 1, 0,
2830 doc
: /* Return t if file FILENAME names a directory you can open.
2831 For the value to be t, FILENAME must specify the name of a directory as a file,
2832 and the directory must allow you to open files in it. In order to use a
2833 directory as a buffer's current directory, this predicate must return true.
2834 A directory name spec may be given instead; then the value is t
2835 if the directory so specified exists and really is a readable and
2836 searchable directory. */)
2837 (Lisp_Object filename
)
2839 Lisp_Object absname
;
2840 Lisp_Object handler
;
2842 CHECK_STRING (filename
);
2843 absname
= Fexpand_file_name (filename
, Qnil
);
2845 /* If the file name has special constructs in it,
2846 call the corresponding file handler. */
2847 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2848 if (!NILP (handler
))
2849 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2851 absname
= ENCODE_FILE (absname
);
2852 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2855 /* If FILE is a searchable directory or a symlink to a
2856 searchable directory, return true. Otherwise return
2857 false and set errno to an error number. */
2859 file_accessible_directory_p (char const *file
)
2862 /* There's no need to test whether FILE is searchable, as the
2863 searchable/executable bit is invented on DOS_NT platforms. */
2864 return file_directory_p (file
);
2866 /* On POSIXish platforms, use just one system call; this avoids a
2867 race and is typically faster. */
2868 ptrdiff_t len
= strlen (file
);
2874 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2875 There are three exceptions: "", "/", and "//". Leave "" alone,
2876 as it's invalid. Append only "." to the other two exceptions as
2877 "/" and "//" are distinct on some platforms, whereas "/", "///",
2878 "////", etc. are all equivalent. */
2883 /* Just check for trailing '/' when deciding whether to append '/'.
2884 That's simpler than testing the two special cases "/" and "//",
2885 and it's a safe optimization here. */
2886 char *buf
= SAFE_ALLOCA (len
+ 3);
2887 memcpy (buf
, file
, len
);
2888 strcpy (buf
+ len
, "/." + (file
[len
- 1] == '/'));
2892 ok
= check_existing (dir
);
2893 saved_errno
= errno
;
2895 errno
= saved_errno
;
2900 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2901 doc
: /* Return t if FILENAME names a regular file.
2902 This is the sort of file that holds an ordinary stream of data bytes.
2903 Symbolic links to regular files count as regular files.
2904 See `file-symlink-p' to distinguish symlinks. */)
2905 (Lisp_Object filename
)
2907 register Lisp_Object absname
;
2909 Lisp_Object handler
;
2911 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2913 /* If the file name has special constructs in it,
2914 call the corresponding file handler. */
2915 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2916 if (!NILP (handler
))
2917 return call2 (handler
, Qfile_regular_p
, absname
);
2919 absname
= ENCODE_FILE (absname
);
2924 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2926 /* Tell stat to use expensive method to get accurate info. */
2927 Vw32_get_true_file_attributes
= Qt
;
2928 result
= stat (SDATA (absname
), &st
);
2929 Vw32_get_true_file_attributes
= tem
;
2933 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2936 if (stat (SSDATA (absname
), &st
) < 0)
2938 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2942 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2943 Sfile_selinux_context
, 1, 1, 0,
2944 doc
: /* Return SELinux context of file named FILENAME.
2945 The return value is a list (USER ROLE TYPE RANGE), where the list
2946 elements are strings naming the user, role, type, and range of the
2947 file's SELinux security context.
2949 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2950 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2951 (Lisp_Object filename
)
2953 Lisp_Object absname
;
2954 Lisp_Object values
[4];
2955 Lisp_Object handler
;
2957 security_context_t con
;
2962 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2964 /* If the file name has special constructs in it,
2965 call the corresponding file handler. */
2966 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2967 if (!NILP (handler
))
2968 return call2 (handler
, Qfile_selinux_context
, absname
);
2970 absname
= ENCODE_FILE (absname
);
2977 if (is_selinux_enabled ())
2979 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2982 context
= context_new (con
);
2983 if (context_user_get (context
))
2984 values
[0] = build_string (context_user_get (context
));
2985 if (context_role_get (context
))
2986 values
[1] = build_string (context_role_get (context
));
2987 if (context_type_get (context
))
2988 values
[2] = build_string (context_type_get (context
));
2989 if (context_range_get (context
))
2990 values
[3] = build_string (context_range_get (context
));
2991 context_free (context
);
2997 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
3000 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
3001 Sset_file_selinux_context
, 2, 2, 0,
3002 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
3003 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
3004 elements are strings naming the components of a SELinux context.
3006 Value is t if setting of SELinux context was successful, nil otherwise.
3008 This function does nothing and returns nil if SELinux is disabled,
3009 or if Emacs was not compiled with SELinux support. */)
3010 (Lisp_Object filename
, Lisp_Object context
)
3012 Lisp_Object absname
;
3013 Lisp_Object handler
;
3015 Lisp_Object encoded_absname
;
3016 Lisp_Object user
= CAR_SAFE (context
);
3017 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
3018 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
3019 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
3020 security_context_t con
;
3023 context_t parsed_con
;
3026 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3028 /* If the file name has special constructs in it,
3029 call the corresponding file handler. */
3030 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
3031 if (!NILP (handler
))
3032 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
3035 if (is_selinux_enabled ())
3037 /* Get current file context. */
3038 encoded_absname
= ENCODE_FILE (absname
);
3039 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
3042 parsed_con
= context_new (con
);
3043 /* Change the parts defined in the parameter.*/
3046 if (context_user_set (parsed_con
, SSDATA (user
)))
3047 error ("Doing context_user_set");
3051 if (context_role_set (parsed_con
, SSDATA (role
)))
3052 error ("Doing context_role_set");
3056 if (context_type_set (parsed_con
, SSDATA (type
)))
3057 error ("Doing context_type_set");
3059 if (STRINGP (range
))
3061 if (context_range_set (parsed_con
, SSDATA (range
)))
3062 error ("Doing context_range_set");
3065 /* Set the modified context back to the file. */
3066 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3067 context_str (parsed_con
))
3069 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3070 if (fail
&& errno
!= ENOTSUP
)
3071 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
3073 context_free (parsed_con
);
3075 return fail
? Qnil
: Qt
;
3078 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
3085 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3086 doc
: /* Return ACL entries of file named FILENAME.
3087 The entries are returned in a format suitable for use in `set-file-acl'
3088 but is otherwise undocumented and subject to change.
3089 Return nil if file does not exist or is not accessible, or if Emacs
3090 was unable to determine the ACL entries. */)
3091 (Lisp_Object filename
)
3093 Lisp_Object absname
;
3094 Lisp_Object handler
;
3095 #ifdef HAVE_POSIX_ACL
3097 Lisp_Object acl_string
;
3101 absname
= expand_and_dir_to_file (filename
,
3102 BVAR (current_buffer
, directory
));
3104 /* If the file name has special constructs in it,
3105 call the corresponding file handler. */
3106 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3107 if (!NILP (handler
))
3108 return call2 (handler
, Qfile_acl
, absname
);
3110 #ifdef HAVE_POSIX_ACL
3111 absname
= ENCODE_FILE (absname
);
3113 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3117 str
= acl_to_text (acl
, NULL
);
3124 acl_string
= build_string (str
);
3134 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3136 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3137 ACL-STRING should contain the textual representation of the ACL
3138 entries in a format suitable for the platform.
3140 Value is t if setting of ACL was successful, nil otherwise.
3142 Setting ACL for local files requires Emacs to be built with ACL
3144 (Lisp_Object filename
, Lisp_Object acl_string
)
3146 Lisp_Object absname
;
3147 Lisp_Object handler
;
3148 #ifdef HAVE_POSIX_ACL
3149 Lisp_Object encoded_absname
;
3154 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3156 /* If the file name has special constructs in it,
3157 call the corresponding file handler. */
3158 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3159 if (!NILP (handler
))
3160 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3162 #ifdef HAVE_POSIX_ACL
3163 if (STRINGP (acl_string
))
3165 acl
= acl_from_text (SSDATA (acl_string
));
3168 report_file_error ("Converting ACL", Fcons (absname
, Qnil
));
3172 encoded_absname
= ENCODE_FILE (absname
);
3174 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3177 if (fail
&& errno
!= ENOTSUP
)
3178 report_file_error ("Setting ACL", Fcons (absname
, Qnil
));
3181 return fail
? Qnil
: Qt
;
3188 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3189 doc
: /* Return mode bits of file named FILENAME, as an integer.
3190 Return nil, if file does not exist or is not accessible. */)
3191 (Lisp_Object filename
)
3193 Lisp_Object absname
;
3195 Lisp_Object handler
;
3197 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3199 /* If the file name has special constructs in it,
3200 call the corresponding file handler. */
3201 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3202 if (!NILP (handler
))
3203 return call2 (handler
, Qfile_modes
, absname
);
3205 absname
= ENCODE_FILE (absname
);
3207 if (stat (SSDATA (absname
), &st
) < 0)
3210 return make_number (st
.st_mode
& 07777);
3213 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3214 "(let ((file (read-file-name \"File: \"))) \
3215 (list file (read-file-modes nil file)))",
3216 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3217 Only the 12 low bits of MODE are used.
3219 Interactively, mode bits are read by `read-file-modes', which accepts
3220 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3221 (Lisp_Object filename
, Lisp_Object mode
)
3223 Lisp_Object absname
, encoded_absname
;
3224 Lisp_Object handler
;
3226 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3227 CHECK_NUMBER (mode
);
3229 /* If the file name has special constructs in it,
3230 call the corresponding file handler. */
3231 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3232 if (!NILP (handler
))
3233 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3235 encoded_absname
= ENCODE_FILE (absname
);
3237 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3238 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3243 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3244 doc
: /* Set the file permission bits for newly created files.
3245 The argument MODE should be an integer; only the low 9 bits are used.
3246 This setting is inherited by subprocesses. */)
3249 CHECK_NUMBER (mode
);
3251 umask ((~ XINT (mode
)) & 0777);
3256 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3257 doc
: /* Return the default file protection for created files.
3258 The value is an integer. */)
3265 realmask
= umask (0);
3269 XSETINT (value
, (~ realmask
) & 0777);
3274 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3275 doc
: /* Set times of file FILENAME to TIMESTAMP.
3276 Set both access and modification times.
3277 Return t on success, else nil.
3278 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3280 (Lisp_Object filename
, Lisp_Object timestamp
)
3282 Lisp_Object absname
, encoded_absname
;
3283 Lisp_Object handler
;
3284 EMACS_TIME t
= lisp_time_argument (timestamp
);
3286 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3288 /* If the file name has special constructs in it,
3289 call the corresponding file handler. */
3290 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3291 if (!NILP (handler
))
3292 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3294 encoded_absname
= ENCODE_FILE (absname
);
3297 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3300 /* Setting times on a directory always fails. */
3301 if (file_directory_p (SSDATA (encoded_absname
)))
3304 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3312 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3313 doc
: /* Tell Unix to finish all pending disk updates. */)
3320 #endif /* HAVE_SYNC */
3322 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3323 doc
: /* Return t if file FILE1 is newer than file FILE2.
3324 If FILE1 does not exist, the answer is nil;
3325 otherwise, if FILE2 does not exist, the answer is t. */)
3326 (Lisp_Object file1
, Lisp_Object file2
)
3328 Lisp_Object absname1
, absname2
;
3329 struct stat st1
, st2
;
3330 Lisp_Object handler
;
3331 struct gcpro gcpro1
, gcpro2
;
3333 CHECK_STRING (file1
);
3334 CHECK_STRING (file2
);
3337 GCPRO2 (absname1
, file2
);
3338 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3339 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3342 /* If the file name has special constructs in it,
3343 call the corresponding file handler. */
3344 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3346 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3347 if (!NILP (handler
))
3348 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3350 GCPRO2 (absname1
, absname2
);
3351 absname1
= ENCODE_FILE (absname1
);
3352 absname2
= ENCODE_FILE (absname2
);
3355 if (stat (SSDATA (absname1
), &st1
) < 0)
3358 if (stat (SSDATA (absname2
), &st2
) < 0)
3361 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3365 #ifndef READ_BUF_SIZE
3366 #define READ_BUF_SIZE (64 << 10)
3368 /* Some buffer offsets are stored in 'int' variables. */
3369 verify (READ_BUF_SIZE
<= INT_MAX
);
3371 /* This function is called after Lisp functions to decide a coding
3372 system are called, or when they cause an error. Before they are
3373 called, the current buffer is set unibyte and it contains only a
3374 newly inserted text (thus the buffer was empty before the
3377 The functions may set markers, overlays, text properties, or even
3378 alter the buffer contents, change the current buffer.
3380 Here, we reset all those changes by:
3381 o set back the current buffer.
3382 o move all markers and overlays to BEG.
3383 o remove all text properties.
3384 o set back the buffer multibyteness. */
3387 decide_coding_unwind (Lisp_Object unwind_data
)
3389 Lisp_Object multibyte
, undo_list
, buffer
;
3391 multibyte
= XCAR (unwind_data
);
3392 unwind_data
= XCDR (unwind_data
);
3393 undo_list
= XCAR (unwind_data
);
3394 buffer
= XCDR (unwind_data
);
3396 set_buffer_internal (XBUFFER (buffer
));
3397 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3398 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3399 set_buffer_intervals (current_buffer
, NULL
);
3400 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3402 /* Now we are safe to change the buffer's multibyteness directly. */
3403 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3404 bset_undo_list (current_buffer
, undo_list
);
3409 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3410 object where slot 0 is the file descriptor, slot 1 specifies
3411 an offset to put the read bytes, and slot 2 is the maximum
3412 amount of bytes to read. Value is the number of bytes read. */
3415 read_non_regular (Lisp_Object state
)
3421 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3422 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3423 + XSAVE_INTEGER (state
, 1)),
3424 XSAVE_INTEGER (state
, 2));
3426 /* Fast recycle this object for the likely next call. */
3428 return make_number (nbytes
);
3432 /* Condition-case handler used when reading from non-regular files
3433 in insert-file-contents. */
3436 read_non_regular_quit (Lisp_Object ignore
)
3441 /* Return the file offset that VAL represents, checking for type
3442 errors and overflow. */
3444 file_offset (Lisp_Object val
)
3446 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3451 double v
= XFLOAT_DATA (val
);
3453 && (sizeof (off_t
) < sizeof v
3454 ? v
<= TYPE_MAXIMUM (off_t
)
3455 : v
< TYPE_MAXIMUM (off_t
)))
3459 wrong_type_argument (intern ("file-offset"), val
);
3462 /* Return a special time value indicating the error number ERRNUM. */
3464 time_error_value (int errnum
)
3466 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3467 ? NONEXISTENT_MODTIME_NSECS
3468 : UNKNOWN_MODTIME_NSECS
);
3469 return make_emacs_time (0, ns
);
3472 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3474 doc
: /* Insert contents of file FILENAME after point.
3475 Returns list of absolute file name and number of characters inserted.
3476 If second argument VISIT is non-nil, the buffer's visited filename and
3477 last save file modtime are set, and it is marked unmodified. If
3478 visiting and the file does not exist, visiting is completed before the
3481 The optional third and fourth arguments BEG and END specify what portion
3482 of the file to insert. These arguments count bytes in the file, not
3483 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3485 If optional fifth argument REPLACE is non-nil, replace the current
3486 buffer contents (in the accessible portion) with the file contents.
3487 This is better than simply deleting and inserting the whole thing
3488 because (1) it preserves some marker positions and (2) it puts less data
3489 in the undo list. When REPLACE is non-nil, the second return value is
3490 the number of characters that replace previous buffer contents.
3492 This function does code conversion according to the value of
3493 `coding-system-for-read' or `file-coding-system-alist', and sets the
3494 variable `last-coding-system-used' to the coding system actually used.
3496 In addition, this function decodes the inserted text from known formats
3497 by calling `format-decode', which see. */)
3498 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3503 ptrdiff_t inserted
= 0;
3506 off_t beg_offset
, end_offset
;
3508 ptrdiff_t count
= SPECPDL_INDEX ();
3509 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3510 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3512 ptrdiff_t total
= 0;
3513 bool not_regular
= 0;
3515 char read_buf
[READ_BUF_SIZE
];
3516 struct coding_system coding
;
3517 bool replace_handled
= 0;
3518 bool set_coding_system
= 0;
3519 Lisp_Object coding_system
;
3521 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3522 bool we_locked_file
= 0;
3523 bool deferred_remove_unwind_protect
= 0;
3525 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3526 error ("Cannot do file visiting in an indirect buffer");
3528 if (!NILP (BVAR (current_buffer
, read_only
)))
3529 Fbarf_if_buffer_read_only ();
3533 orig_filename
= Qnil
;
3536 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3538 CHECK_STRING (filename
);
3539 filename
= Fexpand_file_name (filename
, Qnil
);
3541 /* The value Qnil means that the coding system is not yet
3543 coding_system
= Qnil
;
3545 /* If the file name has special constructs in it,
3546 call the corresponding file handler. */
3547 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3548 if (!NILP (handler
))
3550 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3551 visit
, beg
, end
, replace
);
3552 if (CONSP (val
) && CONSP (XCDR (val
))
3553 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3554 inserted
= XINT (XCAR (XCDR (val
)));
3558 orig_filename
= filename
;
3559 filename
= ENCODE_FILE (filename
);
3561 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3566 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3567 mtime
= time_error_value (save_errno
);
3569 if (!NILP (Vcoding_system_for_read
))
3570 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3574 /* Replacement should preserve point as it preserves markers. */
3575 if (!NILP (replace
))
3576 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3578 record_unwind_protect (close_file_unwind
, make_number (fd
));
3580 if (fstat (fd
, &st
) != 0)
3581 report_file_error ("Input file status", Fcons (orig_filename
, Qnil
));
3582 mtime
= get_stat_mtime (&st
);
3584 /* This code will need to be changed in order to work on named
3585 pipes, and it's probably just not worth it. So we should at
3586 least signal an error. */
3587 if (!S_ISREG (st
.st_mode
))
3594 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3595 xsignal2 (Qfile_error
,
3596 build_string ("not a regular file"), orig_filename
);
3601 if (!NILP (beg
) || !NILP (end
))
3602 error ("Attempt to visit less than an entire file");
3603 if (BEG
< Z
&& NILP (replace
))
3604 error ("Cannot do file visiting in a non-empty buffer");
3608 beg_offset
= file_offset (beg
);
3613 end_offset
= file_offset (end
);
3617 end_offset
= TYPE_MAXIMUM (off_t
);
3620 end_offset
= st
.st_size
;
3622 /* A negative size can happen on a platform that allows file
3623 sizes greater than the maximum off_t value. */
3627 /* The file size returned from stat may be zero, but data
3628 may be readable nonetheless, for example when this is a
3629 file in the /proc filesystem. */
3630 if (end_offset
== 0)
3631 end_offset
= READ_BUF_SIZE
;
3635 /* Check now whether the buffer will become too large,
3636 in the likely case where the file's length is not changing.
3637 This saves a lot of needless work before a buffer overflow. */
3640 /* The likely offset where we will stop reading. We could read
3641 more (or less), if the file grows (or shrinks) as we read it. */
3642 off_t likely_end
= min (end_offset
, st
.st_size
);
3644 if (beg_offset
< likely_end
)
3647 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3648 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3649 off_t likely_growth
= likely_end
- beg_offset
;
3650 if (buf_growth_max
< likely_growth
)
3655 /* Prevent redisplay optimizations. */
3656 current_buffer
->clip_changed
= 1;
3658 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3660 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3661 setup_coding_system (coding_system
, &coding
);
3662 /* Ensure we set Vlast_coding_system_used. */
3663 set_coding_system
= 1;
3667 /* Decide the coding system to use for reading the file now
3668 because we can't use an optimized method for handling
3669 `coding:' tag if the current buffer is not empty. */
3670 if (!NILP (Vcoding_system_for_read
))
3671 coding_system
= Vcoding_system_for_read
;
3674 /* Don't try looking inside a file for a coding system
3675 specification if it is not seekable. */
3676 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3678 /* Find a coding system specified in the heading two
3679 lines or in the tailing several lines of the file.
3680 We assume that the 1K-byte and 3K-byte for heading
3681 and tailing respectively are sufficient for this
3685 if (st
.st_size
<= (1024 * 4))
3686 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3689 nread
= emacs_read (fd
, read_buf
, 1024);
3693 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3694 report_file_error ("Setting file position",
3695 Fcons (orig_filename
, Qnil
));
3696 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3697 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3702 error ("IO error reading %s: %s",
3703 SDATA (orig_filename
), emacs_strerror (errno
));
3706 struct buffer
*prev
= current_buffer
;
3707 Lisp_Object workbuf
;
3710 record_unwind_current_buffer ();
3712 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3713 buf
= XBUFFER (workbuf
);
3715 delete_all_overlays (buf
);
3716 bset_directory (buf
, BVAR (current_buffer
, directory
));
3717 bset_read_only (buf
, Qnil
);
3718 bset_filename (buf
, Qnil
);
3719 bset_undo_list (buf
, Qt
);
3720 eassert (buf
->overlays_before
== NULL
);
3721 eassert (buf
->overlays_after
== NULL
);
3723 set_buffer_internal (buf
);
3725 bset_enable_multibyte_characters (buf
, Qnil
);
3727 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3728 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3729 coding_system
= call2 (Vset_auto_coding_function
,
3730 filename
, make_number (nread
));
3731 set_buffer_internal (prev
);
3733 /* Discard the unwind protect for recovering the
3737 /* Rewind the file for the actual read done later. */
3738 if (lseek (fd
, 0, SEEK_SET
) < 0)
3739 report_file_error ("Setting file position",
3740 Fcons (orig_filename
, Qnil
));
3744 if (NILP (coding_system
))
3746 /* If we have not yet decided a coding system, check
3747 file-coding-system-alist. */
3748 Lisp_Object args
[6];
3750 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3751 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3752 coding_system
= Ffind_operation_coding_system (6, args
);
3753 if (CONSP (coding_system
))
3754 coding_system
= XCAR (coding_system
);
3758 if (NILP (coding_system
))
3759 coding_system
= Qundecided
;
3761 CHECK_CODING_SYSTEM (coding_system
);
3763 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3764 /* We must suppress all character code conversion except for
3765 end-of-line conversion. */
3766 coding_system
= raw_text_coding_system (coding_system
);
3768 setup_coding_system (coding_system
, &coding
);
3769 /* Ensure we set Vlast_coding_system_used. */
3770 set_coding_system
= 1;
3773 /* If requested, replace the accessible part of the buffer
3774 with the file contents. Avoid replacing text at the
3775 beginning or end of the buffer that matches the file contents;
3776 that preserves markers pointing to the unchanged parts.
3778 Here we implement this feature in an optimized way
3779 for the case where code conversion is NOT needed.
3780 The following if-statement handles the case of conversion
3781 in a less optimal way.
3783 If the code conversion is "automatic" then we try using this
3784 method and hope for the best.
3785 But if we discover the need for conversion, we give up on this method
3786 and let the following if-statement handle the replace job. */
3789 && (NILP (coding_system
)
3790 || ! CODING_REQUIRE_DECODING (&coding
)))
3792 /* same_at_start and same_at_end count bytes,
3793 because file access counts bytes
3794 and BEG and END count bytes. */
3795 ptrdiff_t same_at_start
= BEGV_BYTE
;
3796 ptrdiff_t same_at_end
= ZV_BYTE
;
3798 /* There is still a possibility we will find the need to do code
3799 conversion. If that happens, set this variable to
3800 give up on handling REPLACE in the optimized way. */
3801 bool giveup_match_end
= 0;
3803 if (beg_offset
!= 0)
3805 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3806 report_file_error ("Setting file position",
3807 Fcons (orig_filename
, Qnil
));
3812 /* Count how many chars at the start of the file
3813 match the text at the beginning of the buffer. */
3818 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3820 error ("IO error reading %s: %s",
3821 SSDATA (orig_filename
), emacs_strerror (errno
));
3822 else if (nread
== 0)
3825 if (CODING_REQUIRE_DETECTION (&coding
))
3827 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3830 setup_coding_system (coding_system
, &coding
);
3833 if (CODING_REQUIRE_DECODING (&coding
))
3834 /* We found that the file should be decoded somehow.
3835 Let's give up here. */
3837 giveup_match_end
= 1;
3842 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3843 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3844 same_at_start
++, bufpos
++;
3845 /* If we found a discrepancy, stop the scan.
3846 Otherwise loop around and scan the next bufferful. */
3847 if (bufpos
!= nread
)
3851 /* If the file matches the buffer completely,
3852 there's no need to replace anything. */
3853 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3857 /* Truncate the buffer to the size of the file. */
3858 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3863 /* Count how many chars at the end of the file
3864 match the text at the end of the buffer. But, if we have
3865 already found that decoding is necessary, don't waste time. */
3866 while (!giveup_match_end
)
3868 int total_read
, nread
, bufpos
, trial
;
3871 /* At what file position are we now scanning? */
3872 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3873 /* If the entire file matches the buffer tail, stop the scan. */
3876 /* How much can we scan in the next step? */
3877 trial
= min (curpos
, sizeof read_buf
);
3878 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3879 report_file_error ("Setting file position",
3880 Fcons (orig_filename
, Qnil
));
3882 total_read
= nread
= 0;
3883 while (total_read
< trial
)
3885 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3887 error ("IO error reading %s: %s",
3888 SDATA (orig_filename
), emacs_strerror (errno
));
3889 else if (nread
== 0)
3891 total_read
+= nread
;
3894 /* Scan this bufferful from the end, comparing with
3895 the Emacs buffer. */
3896 bufpos
= total_read
;
3898 /* Compare with same_at_start to avoid counting some buffer text
3899 as matching both at the file's beginning and at the end. */
3900 while (bufpos
> 0 && same_at_end
> same_at_start
3901 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3902 same_at_end
--, bufpos
--;
3904 /* If we found a discrepancy, stop the scan.
3905 Otherwise loop around and scan the preceding bufferful. */
3908 /* If this discrepancy is because of code conversion,
3909 we cannot use this method; giveup and try the other. */
3910 if (same_at_end
> same_at_start
3911 && FETCH_BYTE (same_at_end
- 1) >= 0200
3912 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3913 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3914 giveup_match_end
= 1;
3923 if (! giveup_match_end
)
3927 /* We win! We can handle REPLACE the optimized way. */
3929 /* Extend the start of non-matching text area to multibyte
3930 character boundary. */
3931 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3932 while (same_at_start
> BEGV_BYTE
3933 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3936 /* Extend the end of non-matching text area to multibyte
3937 character boundary. */
3938 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3939 while (same_at_end
< ZV_BYTE
3940 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3943 /* Don't try to reuse the same piece of text twice. */
3944 overlap
= (same_at_start
- BEGV_BYTE
3946 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3948 same_at_end
+= overlap
;
3950 /* Arrange to read only the nonmatching middle part of the file. */
3951 beg_offset
+= same_at_start
- BEGV_BYTE
;
3952 end_offset
-= ZV_BYTE
- same_at_end
;
3954 del_range_byte (same_at_start
, same_at_end
, 0);
3955 /* Insert from the file at the proper position. */
3956 temp
= BYTE_TO_CHAR (same_at_start
);
3957 SET_PT_BOTH (temp
, same_at_start
);
3959 /* If display currently starts at beginning of line,
3960 keep it that way. */
3961 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3962 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3964 replace_handled
= 1;
3968 /* If requested, replace the accessible part of the buffer
3969 with the file contents. Avoid replacing text at the
3970 beginning or end of the buffer that matches the file contents;
3971 that preserves markers pointing to the unchanged parts.
3973 Here we implement this feature for the case where code conversion
3974 is needed, in a simple way that needs a lot of memory.
3975 The preceding if-statement handles the case of no conversion
3976 in a more optimized way. */
3977 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3979 ptrdiff_t same_at_start
= BEGV_BYTE
;
3980 ptrdiff_t same_at_end
= ZV_BYTE
;
3981 ptrdiff_t same_at_start_charpos
;
3982 ptrdiff_t inserted_chars
;
3985 unsigned char *decoded
;
3988 ptrdiff_t this_count
= SPECPDL_INDEX ();
3990 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3991 Lisp_Object conversion_buffer
;
3992 struct gcpro gcpro1
;
3994 conversion_buffer
= code_conversion_save (1, multibyte
);
3996 /* First read the whole file, performing code conversion into
3997 CONVERSION_BUFFER. */
3999 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4000 report_file_error ("Setting file position",
4001 Fcons (orig_filename
, Qnil
));
4003 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4004 unprocessed
= 0; /* Bytes not processed in previous loop. */
4006 GCPRO1 (conversion_buffer
);
4009 /* Read at most READ_BUF_SIZE bytes at a time, to allow
4010 quitting while reading a huge file. */
4012 /* Allow quitting out of the actual I/O. */
4015 this = emacs_read (fd
, read_buf
+ unprocessed
,
4016 READ_BUF_SIZE
- unprocessed
);
4022 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
4023 BUF_Z (XBUFFER (conversion_buffer
)));
4024 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4025 unprocessed
+ this, conversion_buffer
);
4026 unprocessed
= coding
.carryover_bytes
;
4027 if (coding
.carryover_bytes
> 0)
4028 memcpy (read_buf
, coding
.carryover
, unprocessed
);
4033 /* We should remove the unwind_protect calling
4034 close_file_unwind, but other stuff has been added the stack,
4035 so defer the removal till we reach the `handled' label. */
4036 deferred_remove_unwind_protect
= 1;
4039 error ("IO error reading %s: %s",
4040 SDATA (orig_filename
), emacs_strerror (errno
));
4042 if (unprocessed
> 0)
4044 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4045 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4046 unprocessed
, conversion_buffer
);
4047 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4050 coding_system
= CODING_ID_NAME (coding
.id
);
4051 set_coding_system
= 1;
4052 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4053 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4054 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4056 /* Compare the beginning of the converted string with the buffer
4060 while (bufpos
< inserted
&& same_at_start
< same_at_end
4061 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4062 same_at_start
++, bufpos
++;
4064 /* If the file matches the head of buffer completely,
4065 there's no need to replace anything. */
4067 if (bufpos
== inserted
)
4069 /* Truncate the buffer to the size of the file. */
4070 if (same_at_start
== same_at_end
)
4073 del_range_byte (same_at_start
, same_at_end
, 0);
4076 unbind_to (this_count
, Qnil
);
4080 /* Extend the start of non-matching text area to the previous
4081 multibyte character boundary. */
4082 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4083 while (same_at_start
> BEGV_BYTE
4084 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4087 /* Scan this bufferful from the end, comparing with
4088 the Emacs buffer. */
4091 /* Compare with same_at_start to avoid counting some buffer text
4092 as matching both at the file's beginning and at the end. */
4093 while (bufpos
> 0 && same_at_end
> same_at_start
4094 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4095 same_at_end
--, bufpos
--;
4097 /* Extend the end of non-matching text area to the next
4098 multibyte character boundary. */
4099 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4100 while (same_at_end
< ZV_BYTE
4101 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4104 /* Don't try to reuse the same piece of text twice. */
4105 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4107 same_at_end
+= overlap
;
4109 /* If display currently starts at beginning of line,
4110 keep it that way. */
4111 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4112 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4114 /* Replace the chars that we need to replace,
4115 and update INSERTED to equal the number of bytes
4116 we are taking from the decoded string. */
4117 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4119 if (same_at_end
!= same_at_start
)
4121 del_range_byte (same_at_start
, same_at_end
, 0);
4123 same_at_start
= GPT_BYTE
;
4127 temp
= BYTE_TO_CHAR (same_at_start
);
4129 /* Insert from the file at the proper position. */
4130 SET_PT_BOTH (temp
, same_at_start
);
4131 same_at_start_charpos
4132 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4133 same_at_start
- BEGV_BYTE
4134 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4136 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4137 same_at_start
+ inserted
- BEGV_BYTE
4138 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4139 - same_at_start_charpos
);
4140 /* This binding is to avoid ask-user-about-supersession-threat
4141 being called in insert_from_buffer (via in
4142 prepare_to_modify_buffer). */
4143 specbind (intern ("buffer-file-name"), Qnil
);
4144 insert_from_buffer (XBUFFER (conversion_buffer
),
4145 same_at_start_charpos
, inserted_chars
, 0);
4146 /* Set `inserted' to the number of inserted characters. */
4147 inserted
= PT
- temp
;
4148 /* Set point before the inserted characters. */
4149 SET_PT_BOTH (temp
, same_at_start
);
4151 unbind_to (this_count
, Qnil
);
4157 total
= end_offset
- beg_offset
;
4159 /* For a special file, all we can do is guess. */
4160 total
= READ_BUF_SIZE
;
4162 if (NILP (visit
) && total
> 0)
4164 #ifdef CLASH_DETECTION
4165 if (!NILP (BVAR (current_buffer
, file_truename
))
4166 /* Make binding buffer-file-name to nil effective. */
4167 && !NILP (BVAR (current_buffer
, filename
))
4168 && SAVE_MODIFF
>= MODIFF
)
4170 #endif /* CLASH_DETECTION */
4171 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4174 move_gap_both (PT
, PT_BYTE
);
4175 if (GAP_SIZE
< total
)
4176 make_gap (total
- GAP_SIZE
);
4178 if (beg_offset
!= 0 || !NILP (replace
))
4180 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4181 report_file_error ("Setting file position",
4182 Fcons (orig_filename
, Qnil
));
4185 /* In the following loop, HOW_MUCH contains the total bytes read so
4186 far for a regular file, and not changed for a special file. But,
4187 before exiting the loop, it is set to a negative value if I/O
4191 /* Total bytes inserted. */
4194 /* Here, we don't do code conversion in the loop. It is done by
4195 decode_coding_gap after all data are read into the buffer. */
4197 ptrdiff_t gap_size
= GAP_SIZE
;
4199 while (how_much
< total
)
4201 /* try is reserved in some compilers (Microsoft C) */
4202 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4209 /* Maybe make more room. */
4210 if (gap_size
< trytry
)
4212 make_gap (trytry
- gap_size
);
4213 gap_size
= GAP_SIZE
- inserted
;
4216 /* Read from the file, capturing `quit'. When an
4217 error occurs, end the loop, and arrange for a quit
4218 to be signaled after decoding the text we read. */
4219 nbytes
= internal_condition_case_1
4221 make_save_value ("iii", (ptrdiff_t) fd
, inserted
, trytry
),
4222 Qerror
, read_non_regular_quit
);
4230 this = XINT (nbytes
);
4234 /* Allow quitting out of the actual I/O. We don't make text
4235 part of the buffer until all the reading is done, so a C-g
4236 here doesn't do any harm. */
4239 this = emacs_read (fd
,
4240 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4254 /* For a regular file, where TOTAL is the real size,
4255 count HOW_MUCH to compare with it.
4256 For a special file, where TOTAL is just a buffer size,
4257 so don't bother counting in HOW_MUCH.
4258 (INSERTED is where we count the number of characters inserted.) */
4265 /* Now we have either read all the file data into the gap,
4266 or stop reading on I/O error or quit. If nothing was
4267 read, undo marking the buffer modified. */
4271 #ifdef CLASH_DETECTION
4273 unlock_file (BVAR (current_buffer
, file_truename
));
4275 Vdeactivate_mark
= old_Vdeactivate_mark
;
4278 Vdeactivate_mark
= Qt
;
4282 /* Discard the unwind protect for closing the file. */
4286 error ("IO error reading %s: %s",
4287 SDATA (orig_filename
), emacs_strerror (errno
));
4289 /* Make the text read part of the buffer. */
4290 GAP_SIZE
-= inserted
;
4292 GPT_BYTE
+= inserted
;
4294 ZV_BYTE
+= inserted
;
4299 /* Put an anchor to ensure multi-byte form ends at gap. */
4304 if (NILP (coding_system
))
4306 /* The coding system is not yet decided. Decide it by an
4307 optimized method for handling `coding:' tag.
4309 Note that we can get here only if the buffer was empty
4310 before the insertion. */
4312 if (!NILP (Vcoding_system_for_read
))
4313 coding_system
= Vcoding_system_for_read
;
4316 /* Since we are sure that the current buffer was empty
4317 before the insertion, we can toggle
4318 enable-multibyte-characters directly here without taking
4319 care of marker adjustment. By this way, we can run Lisp
4320 program safely before decoding the inserted text. */
4321 Lisp_Object unwind_data
;
4322 ptrdiff_t count1
= SPECPDL_INDEX ();
4324 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4325 Fcons (BVAR (current_buffer
, undo_list
),
4326 Fcurrent_buffer ()));
4327 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4328 bset_undo_list (current_buffer
, Qt
);
4329 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4331 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4333 coding_system
= call2 (Vset_auto_coding_function
,
4334 filename
, make_number (inserted
));
4337 if (NILP (coding_system
))
4339 /* If the coding system is not yet decided, check
4340 file-coding-system-alist. */
4341 Lisp_Object args
[6];
4343 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4344 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4345 coding_system
= Ffind_operation_coding_system (6, args
);
4346 if (CONSP (coding_system
))
4347 coding_system
= XCAR (coding_system
);
4349 unbind_to (count1
, Qnil
);
4350 inserted
= Z_BYTE
- BEG_BYTE
;
4353 if (NILP (coding_system
))
4354 coding_system
= Qundecided
;
4356 CHECK_CODING_SYSTEM (coding_system
);
4358 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4359 /* We must suppress all character code conversion except for
4360 end-of-line conversion. */
4361 coding_system
= raw_text_coding_system (coding_system
);
4362 setup_coding_system (coding_system
, &coding
);
4363 /* Ensure we set Vlast_coding_system_used. */
4364 set_coding_system
= 1;
4369 /* When we visit a file by raw-text, we change the buffer to
4371 if (CODING_FOR_UNIBYTE (&coding
)
4372 /* Can't do this if part of the buffer might be preserved. */
4374 /* Visiting a file with these coding system makes the buffer
4376 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4379 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4380 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4381 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4383 move_gap_both (PT
, PT_BYTE
);
4384 GAP_SIZE
+= inserted
;
4385 ZV_BYTE
-= inserted
;
4389 decode_coding_gap (&coding
, inserted
, inserted
);
4390 inserted
= coding
.produced_char
;
4391 coding_system
= CODING_ID_NAME (coding
.id
);
4393 else if (inserted
> 0)
4394 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4397 /* Call after-change hooks for the inserted text, aside from the case
4398 of normal visiting (not with REPLACE), which is done in a new buffer
4399 "before" the buffer is changed. */
4400 if (inserted
> 0 && total
> 0
4401 && (NILP (visit
) || !NILP (replace
)))
4403 signal_after_change (PT
, 0, inserted
);
4404 update_compositions (PT
, PT
, CHECK_BORDER
);
4407 /* Now INSERTED is measured in characters. */
4411 if (deferred_remove_unwind_protect
)
4412 /* If requested above, discard the unwind protect for closing the
4418 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4419 bset_undo_list (current_buffer
, Qnil
);
4423 current_buffer
->modtime
= mtime
;
4424 current_buffer
->modtime_size
= st
.st_size
;
4425 bset_filename (current_buffer
, orig_filename
);
4428 SAVE_MODIFF
= MODIFF
;
4429 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4430 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4431 #ifdef CLASH_DETECTION
4434 if (!NILP (BVAR (current_buffer
, file_truename
)))
4435 unlock_file (BVAR (current_buffer
, file_truename
));
4436 unlock_file (filename
);
4438 #endif /* CLASH_DETECTION */
4440 xsignal2 (Qfile_error
,
4441 build_string ("not a regular file"), orig_filename
);
4444 if (set_coding_system
)
4445 Vlast_coding_system_used
= coding_system
;
4447 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4449 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4451 if (! NILP (insval
))
4453 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4454 wrong_type_argument (intern ("inserted-chars"), insval
);
4455 inserted
= XFASTINT (insval
);
4459 /* Decode file format. */
4462 /* Don't run point motion or modification hooks when decoding. */
4463 ptrdiff_t count1
= SPECPDL_INDEX ();
4464 ptrdiff_t old_inserted
= inserted
;
4465 specbind (Qinhibit_point_motion_hooks
, Qt
);
4466 specbind (Qinhibit_modification_hooks
, Qt
);
4468 /* Save old undo list and don't record undo for decoding. */
4469 old_undo
= BVAR (current_buffer
, undo_list
);
4470 bset_undo_list (current_buffer
, Qt
);
4474 insval
= call3 (Qformat_decode
,
4475 Qnil
, make_number (inserted
), visit
);
4476 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4477 wrong_type_argument (intern ("inserted-chars"), insval
);
4478 inserted
= XFASTINT (insval
);
4482 /* If REPLACE is non-nil and we succeeded in not replacing the
4483 beginning or end of the buffer text with the file's contents,
4484 call format-decode with `point' positioned at the beginning
4485 of the buffer and `inserted' equaling the number of
4486 characters in the buffer. Otherwise, format-decode might
4487 fail to correctly analyze the beginning or end of the buffer.
4488 Hence we temporarily save `point' and `inserted' here and
4489 restore `point' iff format-decode did not insert or delete
4490 any text. Otherwise we leave `point' at point-min. */
4491 ptrdiff_t opoint
= PT
;
4492 ptrdiff_t opoint_byte
= PT_BYTE
;
4493 ptrdiff_t oinserted
= ZV
- BEGV
;
4494 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4496 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4497 insval
= call3 (Qformat_decode
,
4498 Qnil
, make_number (oinserted
), visit
);
4499 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4500 wrong_type_argument (intern ("inserted-chars"), insval
);
4501 if (ochars_modiff
== CHARS_MODIFF
)
4502 /* format_decode didn't modify buffer's characters => move
4503 point back to position before inserted text and leave
4504 value of inserted alone. */
4505 SET_PT_BOTH (opoint
, opoint_byte
);
4507 /* format_decode modified buffer's characters => consider
4508 entire buffer changed and leave point at point-min. */
4509 inserted
= XFASTINT (insval
);
4512 /* For consistency with format-decode call these now iff inserted > 0
4513 (martin 2007-06-28). */
4514 p
= Vafter_insert_file_functions
;
4519 insval
= call1 (XCAR (p
), make_number (inserted
));
4522 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4523 wrong_type_argument (intern ("inserted-chars"), insval
);
4524 inserted
= XFASTINT (insval
);
4529 /* For the rationale of this see the comment on
4530 format-decode above. */
4531 ptrdiff_t opoint
= PT
;
4532 ptrdiff_t opoint_byte
= PT_BYTE
;
4533 ptrdiff_t oinserted
= ZV
- BEGV
;
4534 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4536 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4537 insval
= call1 (XCAR (p
), make_number (oinserted
));
4540 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4541 wrong_type_argument (intern ("inserted-chars"), insval
);
4542 if (ochars_modiff
== CHARS_MODIFF
)
4543 /* after_insert_file_functions didn't modify
4544 buffer's characters => move point back to
4545 position before inserted text and leave value of
4547 SET_PT_BOTH (opoint
, opoint_byte
);
4549 /* after_insert_file_functions did modify buffer's
4550 characters => consider entire buffer changed and
4551 leave point at point-min. */
4552 inserted
= XFASTINT (insval
);
4562 bset_undo_list (current_buffer
, old_undo
);
4563 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4565 /* Adjust the last undo record for the size change during
4566 the format conversion. */
4567 Lisp_Object tem
= XCAR (old_undo
);
4568 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4569 && INTEGERP (XCDR (tem
))
4570 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4571 XSETCDR (tem
, make_number (PT
+ inserted
));
4575 /* If undo_list was Qt before, keep it that way.
4576 Otherwise start with an empty undo_list. */
4577 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4579 unbind_to (count1
, Qnil
);
4583 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4585 /* If visiting nonexistent file, return nil. */
4587 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4591 Fsignal (Qquit
, Qnil
);
4593 /* Retval needs to be dealt with in all cases consistently. */
4595 val
= list2 (orig_filename
, make_number (inserted
));
4597 RETURN_UNGCPRO (unbind_to (count
, val
));
4600 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4603 build_annotations_unwind (Lisp_Object arg
)
4605 Vwrite_region_annotation_buffers
= arg
;
4609 /* Decide the coding-system to encode the data with. */
4611 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4612 Schoose_write_coding_system
, 3, 6, 0,
4613 doc
: /* Choose the coding system for writing a file.
4614 Arguments are as for `write-region'.
4615 This function is for internal use only. It may prompt the user. */ )
4616 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4617 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4620 Lisp_Object eol_parent
= Qnil
;
4622 /* Mimic write-region behavior. */
4625 XSETFASTINT (start
, BEGV
);
4626 XSETFASTINT (end
, ZV
);
4630 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4631 BVAR (current_buffer
, auto_save_file_name
))))
4636 else if (!NILP (Vcoding_system_for_write
))
4638 val
= Vcoding_system_for_write
;
4639 if (coding_system_require_warning
4640 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4641 /* Confirm that VAL can surely encode the current region. */
4642 val
= call5 (Vselect_safe_coding_system_function
,
4643 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4648 /* If the variable `buffer-file-coding-system' is set locally,
4649 it means that the file was read with some kind of code
4650 conversion or the variable is explicitly set by users. We
4651 had better write it out with the same coding system even if
4652 `enable-multibyte-characters' is nil.
4654 If it is not set locally, we anyway have to convert EOL
4655 format if the default value of `buffer-file-coding-system'
4656 tells that it is not Unix-like (LF only) format. */
4657 bool using_default_coding
= 0;
4658 bool force_raw_text
= 0;
4660 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4662 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4665 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4671 /* Check file-coding-system-alist. */
4672 Lisp_Object args
[7], coding_systems
;
4674 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4675 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4677 coding_systems
= Ffind_operation_coding_system (7, args
);
4678 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4679 val
= XCDR (coding_systems
);
4684 /* If we still have not decided a coding system, use the
4685 default value of buffer-file-coding-system. */
4686 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4687 using_default_coding
= 1;
4690 if (! NILP (val
) && ! force_raw_text
)
4692 Lisp_Object spec
, attrs
;
4694 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4695 attrs
= AREF (spec
, 0);
4696 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4701 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4702 /* Confirm that VAL can surely encode the current region. */
4703 val
= call5 (Vselect_safe_coding_system_function
,
4704 start
, end
, val
, Qnil
, filename
);
4706 /* If the decided coding-system doesn't specify end-of-line
4707 format, we use that of
4708 `default-buffer-file-coding-system'. */
4709 if (! using_default_coding
4710 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4711 val
= (coding_inherit_eol_type
4712 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4714 /* If we decide not to encode text, use `raw-text' or one of its
4717 val
= raw_text_coding_system (val
);
4720 val
= coding_inherit_eol_type (val
, eol_parent
);
4724 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4725 "r\nFWrite region to file: \ni\ni\ni\np",
4726 doc
: /* Write current region into specified file.
4727 When called from a program, requires three arguments:
4728 START, END and FILENAME. START and END are normally buffer positions
4729 specifying the part of the buffer to write.
4730 If START is nil, that means to use the entire buffer contents.
4731 If START is a string, then output that string to the file
4732 instead of any buffer contents; END is ignored.
4734 Optional fourth argument APPEND if non-nil means
4735 append to existing file contents (if any). If it is a number,
4736 seek to that offset in the file before writing.
4737 Optional fifth argument VISIT, if t or a string, means
4738 set the last-save-file-modtime of buffer to this file's modtime
4739 and mark buffer not modified.
4740 If VISIT is a string, it is a second file name;
4741 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4742 VISIT is also the file name to lock and unlock for clash detection.
4743 If VISIT is neither t nor nil nor a string,
4744 that means do not display the \"Wrote file\" message.
4745 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4746 use for locking and unlocking, overriding FILENAME and VISIT.
4747 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4748 for an existing file with the same name. If MUSTBENEW is `excl',
4749 that means to get an error if the file already exists; never overwrite.
4750 If MUSTBENEW is neither nil nor `excl', that means ask for
4751 confirmation before overwriting, but do go ahead and overwrite the file
4752 if the user confirms.
4754 This does code conversion according to the value of
4755 `coding-system-for-write', `buffer-file-coding-system', or
4756 `file-coding-system-alist', and sets the variable
4757 `last-coding-system-used' to the coding system actually used.
4759 This calls `write-region-annotate-functions' at the start, and
4760 `write-region-post-annotation-function' at the end. */)
4761 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4766 off_t offset
IF_LINT (= 0);
4772 ptrdiff_t count
= SPECPDL_INDEX ();
4774 Lisp_Object handler
;
4775 Lisp_Object visit_file
;
4776 Lisp_Object annotations
;
4777 Lisp_Object encoded_filename
;
4778 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4779 bool quietly
= !NILP (visit
);
4780 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4781 struct buffer
*given_buffer
;
4782 struct coding_system coding
;
4784 if (current_buffer
->base_buffer
&& visiting
)
4785 error ("Cannot do file visiting in an indirect buffer");
4787 if (!NILP (start
) && !STRINGP (start
))
4788 validate_region (&start
, &end
);
4791 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4793 filename
= Fexpand_file_name (filename
, Qnil
);
4795 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4796 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4798 if (STRINGP (visit
))
4799 visit_file
= Fexpand_file_name (visit
, Qnil
);
4801 visit_file
= filename
;
4803 if (NILP (lockname
))
4804 lockname
= visit_file
;
4808 /* If the file name has special constructs in it,
4809 call the corresponding file handler. */
4810 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4811 /* If FILENAME has no handler, see if VISIT has one. */
4812 if (NILP (handler
) && STRINGP (visit
))
4813 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4815 if (!NILP (handler
))
4818 val
= call6 (handler
, Qwrite_region
, start
, end
,
4819 filename
, append
, visit
);
4823 SAVE_MODIFF
= MODIFF
;
4824 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4825 bset_filename (current_buffer
, visit_file
);
4831 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4833 /* Special kludge to simplify auto-saving. */
4836 /* Do it later, so write-region-annotate-function can work differently
4837 if we save "the buffer" vs "a region".
4838 This is useful in tar-mode. --Stef
4839 XSETFASTINT (start, BEG);
4840 XSETFASTINT (end, Z); */
4844 record_unwind_protect (build_annotations_unwind
,
4845 Vwrite_region_annotation_buffers
);
4846 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4847 count1
= SPECPDL_INDEX ();
4849 given_buffer
= current_buffer
;
4851 if (!STRINGP (start
))
4853 annotations
= build_annotations (start
, end
);
4855 if (current_buffer
!= given_buffer
)
4857 XSETFASTINT (start
, BEGV
);
4858 XSETFASTINT (end
, ZV
);
4864 XSETFASTINT (start
, BEGV
);
4865 XSETFASTINT (end
, ZV
);
4870 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4872 /* Decide the coding-system to encode the data with.
4873 We used to make this choice before calling build_annotations, but that
4874 leads to problems when a write-annotate-function takes care of
4875 unsavable chars (as was the case with X-Symbol). */
4876 Vlast_coding_system_used
=
4877 Fchoose_write_coding_system (start
, end
, filename
,
4878 append
, visit
, lockname
);
4880 setup_coding_system (Vlast_coding_system_used
, &coding
);
4882 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4883 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4885 #ifdef CLASH_DETECTION
4887 lock_file (lockname
);
4888 #endif /* CLASH_DETECTION */
4890 encoded_filename
= ENCODE_FILE (filename
);
4891 fn
= SSDATA (encoded_filename
);
4892 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4893 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4894 if (NUMBERP (append
))
4895 offset
= file_offset (append
);
4896 else if (!NILP (append
))
4897 open_flags
|= O_APPEND
;
4899 mode
= S_IREAD
| S_IWRITE
;
4901 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4904 desc
= emacs_open (fn
, open_flags
, mode
);
4908 #ifdef CLASH_DETECTION
4910 if (!auto_saving
) unlock_file (lockname
);
4912 #endif /* CLASH_DETECTION */
4914 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4917 record_unwind_protect (close_file_unwind
, make_number (desc
));
4919 if (NUMBERP (append
))
4921 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4924 #ifdef CLASH_DETECTION
4926 if (!auto_saving
) unlock_file (lockname
);
4928 #endif /* CLASH_DETECTION */
4930 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4938 if (STRINGP (start
))
4939 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4940 else if (XINT (start
) != XINT (end
))
4941 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4942 &annotations
, &coding
);
4945 /* If file was empty, still need to write the annotations. */
4946 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4947 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4951 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4952 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4954 /* We have to flush out a data. */
4955 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4956 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4962 /* fsync appears to change the modtime on BSD4.2.
4963 Disk full in NFS may be reported here. */
4964 /* mib says that closing the file will try to write as fast as NFS can do
4965 it, and that means the fsync here is not crucial for autosave files. */
4966 if (!auto_saving
&& !write_region_inhibit_fsync
)
4968 /* Transfer data and metadata to disk, retrying if interrupted. Also,
4969 ignore EINVAL which happens when fsync is not supported on this
4971 while (fsync (desc
) != 0)
4974 if (errno
!= EINVAL
)
4975 ok
= 0, save_errno
= errno
;
4980 modtime
= invalid_emacs_time ();
4983 if (fstat (desc
, &st
) == 0)
4984 modtime
= get_stat_mtime (&st
);
4986 ok
= 0, save_errno
= errno
;
4989 /* NFS can report a write failure now. */
4990 if (emacs_close (desc
) < 0)
4991 ok
= 0, save_errno
= errno
;
4993 /* Discard the unwind protect for close_file_unwind. */
4994 specpdl_ptr
= specpdl
+ count1
;
4996 /* Some file systems have a bug where st_mtime is not updated
4997 properly after a write. For example, CIFS might not see the
4998 st_mtime change until after the file is opened again.
5000 Attempt to detect this file system bug, and update MODTIME to the
5001 newer st_mtime if the bug appears to be present. This introduces
5002 a race condition, so to avoid most instances of the race condition
5003 on non-buggy file systems, skip this check if the most recently
5004 encountered non-buggy file system was the current file system.
5006 A race condition can occur if some other process modifies the
5007 file between the fstat above and the fstat below, but the race is
5008 unlikely and a similar race between the last write and the fstat
5009 above cannot possibly be closed anyway. */
5011 if (EMACS_TIME_VALID_P (modtime
)
5012 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
5014 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
5018 if (fstat (desc1
, &st1
) == 0
5019 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
5021 /* Use the heuristic if it appears to be valid. With neither
5022 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
5023 file, the time stamp won't change. Also, some non-POSIX
5024 systems don't update an empty file's time stamp when
5025 truncating it. Finally, file systems with 100 ns or worse
5026 resolution sometimes seem to have bugs: on a system with ns
5027 resolution, checking ns % 100 incorrectly avoids the heuristic
5028 1% of the time, but the problem should be temporary as we will
5029 try again on the next time stamp. */
5031 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
5033 && EMACS_NSECS (modtime
) % 100 != 0);
5035 EMACS_TIME modtime1
= get_stat_mtime (&st1
);
5037 && EMACS_TIME_EQ (modtime
, modtime1
)
5038 && st
.st_size
== st1
.st_size
)
5040 timestamp_file_system
= st
.st_dev
;
5041 valid_timestamp_file_system
= 1;
5045 st
.st_size
= st1
.st_size
;
5049 emacs_close (desc1
);
5053 /* Call write-region-post-annotation-function. */
5054 while (CONSP (Vwrite_region_annotation_buffers
))
5056 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5057 if (!NILP (Fbuffer_live_p (buf
)))
5060 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5061 call0 (Vwrite_region_post_annotation_function
);
5063 Vwrite_region_annotation_buffers
5064 = XCDR (Vwrite_region_annotation_buffers
);
5067 unbind_to (count
, Qnil
);
5069 #ifdef CLASH_DETECTION
5071 unlock_file (lockname
);
5072 #endif /* CLASH_DETECTION */
5074 /* Do this before reporting IO error
5075 to avoid a "file has changed on disk" warning on
5076 next attempt to save. */
5077 if (EMACS_TIME_VALID_P (modtime
))
5079 current_buffer
->modtime
= modtime
;
5080 current_buffer
->modtime_size
= st
.st_size
;
5084 error ("IO error writing %s: %s", SDATA (filename
),
5085 emacs_strerror (save_errno
));
5089 SAVE_MODIFF
= MODIFF
;
5090 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5091 bset_filename (current_buffer
, visit_file
);
5092 update_mode_lines
++;
5097 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5098 BVAR (current_buffer
, auto_save_file_name
))))
5099 SAVE_MODIFF
= MODIFF
;
5105 message_with_string ((NUMBERP (append
)
5115 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
5117 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5118 doc
: /* Return t if (car A) is numerically less than (car B). */)
5119 (Lisp_Object a
, Lisp_Object b
)
5121 return Flss (Fcar (a
), Fcar (b
));
5124 /* Build the complete list of annotations appropriate for writing out
5125 the text between START and END, by calling all the functions in
5126 write-region-annotate-functions and merging the lists they return.
5127 If one of these functions switches to a different buffer, we assume
5128 that buffer contains altered text. Therefore, the caller must
5129 make sure to restore the current buffer in all cases,
5130 as save-excursion would do. */
5133 build_annotations (Lisp_Object start
, Lisp_Object end
)
5135 Lisp_Object annotations
;
5137 struct gcpro gcpro1
, gcpro2
;
5138 Lisp_Object original_buffer
;
5140 bool used_global
= 0;
5142 XSETBUFFER (original_buffer
, current_buffer
);
5145 p
= Vwrite_region_annotate_functions
;
5146 GCPRO2 (annotations
, p
);
5149 struct buffer
*given_buffer
= current_buffer
;
5150 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5151 { /* Use the global value of the hook. */
5154 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5156 p
= Fappend (2, arg
);
5159 Vwrite_region_annotations_so_far
= annotations
;
5160 res
= call2 (XCAR (p
), start
, end
);
5161 /* If the function makes a different buffer current,
5162 assume that means this buffer contains altered text to be output.
5163 Reset START and END from the buffer bounds
5164 and discard all previous annotations because they should have
5165 been dealt with by this function. */
5166 if (current_buffer
!= given_buffer
)
5168 Vwrite_region_annotation_buffers
5169 = Fcons (Fcurrent_buffer (),
5170 Vwrite_region_annotation_buffers
);
5171 XSETFASTINT (start
, BEGV
);
5172 XSETFASTINT (end
, ZV
);
5175 Flength (res
); /* Check basic validity of return value */
5176 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5180 /* Now do the same for annotation functions implied by the file-format */
5181 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5182 p
= BVAR (current_buffer
, auto_save_file_format
);
5184 p
= BVAR (current_buffer
, file_format
);
5185 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5187 struct buffer
*given_buffer
= current_buffer
;
5189 Vwrite_region_annotations_so_far
= annotations
;
5191 /* Value is either a list of annotations or nil if the function
5192 has written annotations to a temporary buffer, which is now
5194 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5195 original_buffer
, make_number (i
));
5196 if (current_buffer
!= given_buffer
)
5198 XSETFASTINT (start
, BEGV
);
5199 XSETFASTINT (end
, ZV
);
5204 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5212 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5213 If STRING is nil, POS is the character position in the current buffer.
5214 Intersperse with them the annotations from *ANNOT
5215 which fall within the range of POS to POS + NCHARS,
5216 each at its appropriate position.
5218 We modify *ANNOT by discarding elements as we use them up.
5220 Return true if successful. */
5223 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5224 ptrdiff_t nchars
, Lisp_Object
*annot
,
5225 struct coding_system
*coding
)
5229 ptrdiff_t lastpos
= pos
+ nchars
;
5231 while (NILP (*annot
) || CONSP (*annot
))
5233 tem
= Fcar_safe (Fcar (*annot
));
5236 nextpos
= XFASTINT (tem
);
5238 /* If there are no more annotations in this range,
5239 output the rest of the range all at once. */
5240 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5241 return e_write (desc
, string
, pos
, lastpos
, coding
);
5243 /* Output buffer text up to the next annotation's position. */
5246 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5250 /* Output the annotation. */
5251 tem
= Fcdr (Fcar (*annot
));
5254 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5257 *annot
= Fcdr (*annot
);
5263 /* Write text in the range START and END into descriptor DESC,
5264 encoding them with coding system CODING. If STRING is nil, START
5265 and END are character positions of the current buffer, else they
5266 are indexes to the string STRING. Return true if successful. */
5269 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5270 struct coding_system
*coding
)
5272 if (STRINGP (string
))
5275 end
= SCHARS (string
);
5278 /* We used to have a code for handling selective display here. But,
5279 now it is handled within encode_coding. */
5283 if (STRINGP (string
))
5285 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5286 if (CODING_REQUIRE_ENCODING (coding
))
5288 encode_coding_object (coding
, string
,
5289 start
, string_char_to_byte (string
, start
),
5290 end
, string_char_to_byte (string
, end
), Qt
);
5294 coding
->dst_object
= string
;
5295 coding
->consumed_char
= SCHARS (string
);
5296 coding
->produced
= SBYTES (string
);
5301 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5302 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5304 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5305 if (CODING_REQUIRE_ENCODING (coding
))
5307 encode_coding_object (coding
, Fcurrent_buffer (),
5308 start
, start_byte
, end
, end_byte
, Qt
);
5312 coding
->dst_object
= Qnil
;
5313 coding
->dst_pos_byte
= start_byte
;
5314 if (start
>= GPT
|| end
<= GPT
)
5316 coding
->consumed_char
= end
- start
;
5317 coding
->produced
= end_byte
- start_byte
;
5321 coding
->consumed_char
= GPT
- start
;
5322 coding
->produced
= GPT_BYTE
- start_byte
;
5327 if (coding
->produced
> 0)
5330 -= emacs_write (desc
,
5331 STRINGP (coding
->dst_object
)
5332 ? SSDATA (coding
->dst_object
)
5333 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5336 if (coding
->produced
)
5339 start
+= coding
->consumed_char
;
5345 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5346 Sverify_visited_file_modtime
, 0, 1, 0,
5347 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5348 This means that the file has not been changed since it was visited or saved.
5349 If BUF is omitted or nil, it defaults to the current buffer.
5350 See Info node `(elisp)Modification Time' for more details. */)
5355 Lisp_Object handler
;
5356 Lisp_Object filename
;
5367 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5368 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5370 /* If the file name has special constructs in it,
5371 call the corresponding file handler. */
5372 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5373 Qverify_visited_file_modtime
);
5374 if (!NILP (handler
))
5375 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5377 filename
= ENCODE_FILE (BVAR (b
, filename
));
5379 mtime
= (stat (SSDATA (filename
), &st
) == 0
5380 ? get_stat_mtime (&st
)
5381 : time_error_value (errno
));
5382 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5383 && (b
->modtime_size
< 0
5384 || st
.st_size
== b
->modtime_size
))
5389 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5390 Sclear_visited_file_modtime
, 0, 0, 0,
5391 doc
: /* Clear out records of last mod time of visited file.
5392 Next attempt to save will certainly not complain of a discrepancy. */)
5395 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5396 current_buffer
->modtime_size
= -1;
5400 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5401 Svisited_file_modtime
, 0, 0, 0,
5402 doc
: /* Return the current buffer's recorded visited file modification time.
5403 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5404 `file-attributes' returns. If the current buffer has no recorded file
5405 modification time, this function returns 0. If the visited file
5406 doesn't exist, HIGH will be -1.
5407 See Info node `(elisp)Modification Time' for more details. */)
5410 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5412 if (EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
5414 /* make_lisp_time won't work here if time_t is unsigned. */
5415 return list4i (-1, 65535, 0, 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
;
6052 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6053 doc
: /* Non-nil means don't call fsync in `write-region'.
6054 This variable affects calls to `write-region' as well as save commands.
6055 A non-nil value may result in data loss! */);
6056 write_region_inhibit_fsync
= 0;
6058 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6059 doc
: /* Specifies whether to use the system's trash can.
6060 When non-nil, certain file deletion commands use the function
6061 `move-file-to-trash' instead of deleting files outright.
6062 This includes interactive calls to `delete-file' and
6063 `delete-directory' and the Dired deletion commands. */);
6064 delete_by_moving_to_trash
= 0;
6065 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6067 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6068 DEFSYM (Qcopy_directory
, "copy-directory");
6069 DEFSYM (Qdelete_directory
, "delete-directory");
6071 defsubr (&Sfind_file_name_handler
);
6072 defsubr (&Sfile_name_directory
);
6073 defsubr (&Sfile_name_nondirectory
);
6074 defsubr (&Sunhandled_file_name_directory
);
6075 defsubr (&Sfile_name_as_directory
);
6076 defsubr (&Sdirectory_file_name
);
6077 defsubr (&Smake_temp_name
);
6078 defsubr (&Sexpand_file_name
);
6079 defsubr (&Ssubstitute_in_file_name
);
6080 defsubr (&Scopy_file
);
6081 defsubr (&Smake_directory_internal
);
6082 defsubr (&Sdelete_directory_internal
);
6083 defsubr (&Sdelete_file
);
6084 defsubr (&Srename_file
);
6085 defsubr (&Sadd_name_to_file
);
6086 defsubr (&Smake_symbolic_link
);
6087 defsubr (&Sfile_name_absolute_p
);
6088 defsubr (&Sfile_exists_p
);
6089 defsubr (&Sfile_executable_p
);
6090 defsubr (&Sfile_readable_p
);
6091 defsubr (&Sfile_writable_p
);
6092 defsubr (&Saccess_file
);
6093 defsubr (&Sfile_symlink_p
);
6094 defsubr (&Sfile_directory_p
);
6095 defsubr (&Sfile_accessible_directory_p
);
6096 defsubr (&Sfile_regular_p
);
6097 defsubr (&Sfile_modes
);
6098 defsubr (&Sset_file_modes
);
6099 defsubr (&Sset_file_times
);
6100 defsubr (&Sfile_selinux_context
);
6101 defsubr (&Sfile_acl
);
6102 defsubr (&Sset_file_acl
);
6103 defsubr (&Sset_file_selinux_context
);
6104 defsubr (&Sset_default_file_modes
);
6105 defsubr (&Sdefault_file_modes
);
6106 defsubr (&Sfile_newer_than_file_p
);
6107 defsubr (&Sinsert_file_contents
);
6108 defsubr (&Schoose_write_coding_system
);
6109 defsubr (&Swrite_region
);
6110 defsubr (&Scar_less_than_car
);
6111 defsubr (&Sverify_visited_file_modtime
);
6112 defsubr (&Sclear_visited_file_modtime
);
6113 defsubr (&Svisited_file_modtime
);
6114 defsubr (&Sset_visited_file_modtime
);
6115 defsubr (&Sdo_auto_save
);
6116 defsubr (&Sset_buffer_auto_saved
);
6117 defsubr (&Sclear_buffer_auto_save_failure
);
6118 defsubr (&Srecent_auto_save_p
);
6120 defsubr (&Snext_read_file_uses_dialog_p
);
6123 defsubr (&Sunix_sync
);