1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2012 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 <stat-time.h>
93 /* True during writing of auto-save files. */
94 static bool auto_saving
;
96 /* Nonzero umask during creation of auto-save directories. */
97 static mode_t auto_saving_dir_umask
;
99 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
100 a new file with the same mode as the original. */
101 static mode_t auto_save_mode_bits
;
103 /* Set by auto_save_1 if an error occurred during the last auto-save. */
104 static bool auto_save_error_occurred
;
106 /* The symbol bound to coding-system-for-read when
107 insert-file-contents is called for recovering a file. This is not
108 an actual coding system name, but just an indicator to tell
109 insert-file-contents to use `emacs-mule' with a special flag for
110 auto saving and recovering a file. */
111 static Lisp_Object Qauto_save_coding
;
113 /* Property name of a file name handler,
114 which gives a list of operations it handles.. */
115 static Lisp_Object Qoperations
;
117 /* Lisp functions for translating file formats. */
118 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
120 /* Lisp function for setting buffer-file-coding-system and the
121 multibyteness of the current buffer after inserting a file. */
122 static Lisp_Object Qafter_insert_file_set_coding
;
124 static Lisp_Object Qwrite_region_annotate_functions
;
125 /* Each time an annotation function changes the buffer, the new buffer
127 static Lisp_Object Vwrite_region_annotation_buffers
;
132 static Lisp_Object Qdelete_by_moving_to_trash
;
134 /* Lisp function for moving files to trash. */
135 static Lisp_Object Qmove_file_to_trash
;
137 /* Lisp function for recursively copying directories. */
138 static Lisp_Object Qcopy_directory
;
140 /* Lisp function for recursively deleting directories. */
141 static Lisp_Object Qdelete_directory
;
146 Lisp_Object Qfile_error
;
147 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
148 static Lisp_Object Qexcl
;
149 Lisp_Object Qfile_name_history
;
151 static Lisp_Object Qcar_less_than_car
;
153 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
154 Lisp_Object
*, struct coding_system
*);
155 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
156 struct coding_system
*);
160 report_file_error (const char *string
, Lisp_Object data
)
162 Lisp_Object errstring
;
166 synchronize_system_messages_locale ();
167 str
= strerror (errorno
);
168 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
169 Vlocale_coding_system
, 0);
175 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
178 /* System error messages are capitalized. Downcase the initial
179 unless it is followed by a slash. (The slash case caters to
180 error messages that begin with "I/O" or, in German, "E/A".) */
181 if (STRING_MULTIBYTE (errstring
)
182 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
186 str
= SSDATA (errstring
);
187 c
= STRING_CHAR ((unsigned char *) str
);
188 Faset (errstring
, make_number (0), make_number (downcase (c
)));
191 xsignal (Qfile_error
,
192 Fcons (build_string (string
), Fcons (errstring
, data
)));
197 close_file_unwind (Lisp_Object fd
)
199 emacs_close (XFASTINT (fd
));
203 /* Restore point, having saved it as a marker. */
206 restore_point_unwind (Lisp_Object location
)
208 Fgoto_char (location
);
209 Fset_marker (location
, Qnil
, Qnil
);
214 static Lisp_Object Qexpand_file_name
;
215 static Lisp_Object Qsubstitute_in_file_name
;
216 static Lisp_Object Qdirectory_file_name
;
217 static Lisp_Object Qfile_name_directory
;
218 static Lisp_Object Qfile_name_nondirectory
;
219 static Lisp_Object Qunhandled_file_name_directory
;
220 static Lisp_Object Qfile_name_as_directory
;
221 static Lisp_Object Qcopy_file
;
222 static Lisp_Object Qmake_directory_internal
;
223 static Lisp_Object Qmake_directory
;
224 static Lisp_Object Qdelete_directory_internal
;
225 Lisp_Object Qdelete_file
;
226 static Lisp_Object Qrename_file
;
227 static Lisp_Object Qadd_name_to_file
;
228 static Lisp_Object Qmake_symbolic_link
;
229 Lisp_Object Qfile_exists_p
;
230 static Lisp_Object Qfile_executable_p
;
231 static Lisp_Object Qfile_readable_p
;
232 static Lisp_Object Qfile_writable_p
;
233 static Lisp_Object Qfile_symlink_p
;
234 static Lisp_Object Qaccess_file
;
235 Lisp_Object Qfile_directory_p
;
236 static Lisp_Object Qfile_regular_p
;
237 static Lisp_Object Qfile_accessible_directory_p
;
238 static Lisp_Object Qfile_modes
;
239 static Lisp_Object Qset_file_modes
;
240 static Lisp_Object Qset_file_times
;
241 static Lisp_Object Qfile_selinux_context
;
242 static Lisp_Object Qset_file_selinux_context
;
243 static Lisp_Object Qfile_acl
;
244 static Lisp_Object Qset_file_acl
;
245 static Lisp_Object Qfile_newer_than_file_p
;
246 Lisp_Object Qinsert_file_contents
;
247 Lisp_Object Qwrite_region
;
248 static Lisp_Object Qverify_visited_file_modtime
;
249 static Lisp_Object Qset_visited_file_modtime
;
251 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
252 Sfind_file_name_handler
, 2, 2, 0,
253 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
254 Otherwise, return nil.
255 A file name is handled if one of the regular expressions in
256 `file-name-handler-alist' matches it.
258 If OPERATION equals `inhibit-file-name-operation', then we ignore
259 any handlers that are members of `inhibit-file-name-handlers',
260 but we still do run any other handlers. This lets handlers
261 use the standard functions without calling themselves recursively. */)
262 (Lisp_Object filename
, Lisp_Object operation
)
264 /* This function must not munge the match data. */
265 Lisp_Object chain
, inhibited_handlers
, result
;
269 CHECK_STRING (filename
);
271 if (EQ (operation
, Vinhibit_file_name_operation
))
272 inhibited_handlers
= Vinhibit_file_name_handlers
;
274 inhibited_handlers
= Qnil
;
276 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
277 chain
= XCDR (chain
))
283 Lisp_Object string
= XCAR (elt
);
285 Lisp_Object handler
= XCDR (elt
);
286 Lisp_Object operations
= Qnil
;
288 if (SYMBOLP (handler
))
289 operations
= Fget (handler
, Qoperations
);
292 && (match_pos
= fast_string_match (string
, filename
)) > pos
293 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
297 handler
= XCDR (elt
);
298 tem
= Fmemq (handler
, inhibited_handlers
);
312 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
314 doc
: /* Return the directory component in file name FILENAME.
315 Return nil if FILENAME does not include a directory.
316 Otherwise return a directory name.
317 Given a Unix syntax file name, returns a string ending in slash. */)
318 (Lisp_Object filename
)
321 register const char *beg
;
326 register const char *p
;
329 CHECK_STRING (filename
);
331 /* If the file name has special constructs in it,
332 call the corresponding file handler. */
333 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
336 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
338 return STRINGP (handled_name
) ? handled_name
: Qnil
;
342 beg
= alloca (SBYTES (filename
) + 1);
343 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
345 beg
= SSDATA (filename
);
347 p
= beg
+ SBYTES (filename
);
349 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
351 /* only recognize drive specifier at the beginning */
353 /* handle the "/:d:foo" and "/:foo" cases correctly */
354 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
355 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
362 /* Expansion of "c:" to drive and default directory. */
365 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
366 char *res
= alloca (MAXPATHLEN
+ 1);
369 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
371 memcpy (res
, beg
, 2);
376 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
378 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
381 p
= beg
+ strlen (beg
);
382 dostounix_filename (beg
);
383 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
384 STRING_MULTIBYTE (filename
));
387 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
388 STRING_MULTIBYTE (filename
));
390 else if (STRING_MULTIBYTE (filename
))
392 tem_fn
= ENCODE_FILE (make_specified_string (beg
, -1, p
- beg
, 1));
393 dostounix_filename (SSDATA (tem_fn
));
394 tem_fn
= DECODE_FILE (tem_fn
);
398 dostounix_filename (beg
);
399 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
403 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
407 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
408 Sfile_name_nondirectory
, 1, 1, 0,
409 doc
: /* Return file name FILENAME sans its directory.
410 For example, in a Unix-syntax file name,
411 this is everything after the last slash,
412 or the entire name if it contains no slash. */)
413 (Lisp_Object filename
)
415 register const char *beg
, *p
, *end
;
418 CHECK_STRING (filename
);
420 /* If the file name has special constructs in it,
421 call the corresponding file handler. */
422 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
425 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
427 if (STRINGP (handled_name
))
429 error ("Invalid handler in `file-name-handler-alist'");
432 beg
= SSDATA (filename
);
433 end
= p
= beg
+ SBYTES (filename
);
435 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
437 /* only recognize drive specifier at beginning */
439 /* handle the "/:d:foo" case correctly */
440 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
445 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
448 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
449 Sunhandled_file_name_directory
, 1, 1, 0,
450 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
451 A `directly usable' directory name is one that may be used without the
452 intervention of any file handler.
453 If FILENAME is a directly usable file itself, return
454 \(file-name-directory FILENAME).
455 If FILENAME refers to a file which is not accessible from a local process,
456 then this should return nil.
457 The `call-process' and `start-process' functions use this function to
458 get a current directory to run processes in. */)
459 (Lisp_Object filename
)
463 /* If the file name has special constructs in it,
464 call the corresponding file handler. */
465 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
468 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
470 return STRINGP (handled_name
) ? handled_name
: Qnil
;
473 return Ffile_name_directory (filename
);
476 /* Convert from file name SRC of length SRCLEN to directory name in
477 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
478 string. On UNIX, just make sure there is a terminating /. Return
479 the length of DST in bytes. */
482 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
495 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
497 dst
[srclen
] = DIRECTORY_SEP
;
498 dst
[srclen
+ 1] = '\0';
504 Lisp_Object tem_fn
= make_specified_string (dst
, -1, srclen
, 1);
506 tem_fn
= ENCODE_FILE (tem_fn
);
507 dostounix_filename (SSDATA (tem_fn
));
508 tem_fn
= DECODE_FILE (tem_fn
);
509 memcpy (dst
, SSDATA (tem_fn
), (srclen
= SBYTES (tem_fn
)) + 1);
512 dostounix_filename (dst
);
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'");
547 buf
= alloca (SBYTES (file
) + 10);
548 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
549 STRING_MULTIBYTE (file
));
550 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
553 /* Convert from directory name SRC of length SRCLEN to file name in
554 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
555 string. On UNIX, just make sure there isn't a terminating /.
556 Return the length of DST in bytes. */
559 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
561 /* Process as Unix format: just remove any final slash.
562 But leave "/" unchanged; do not change it to "". */
565 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
567 && !IS_ANY_SEP (dst
[srclen
- 2])
577 Lisp_Object tem_fn
= make_specified_string (dst
, -1, srclen
, 1);
579 tem_fn
= ENCODE_FILE (tem_fn
);
580 dostounix_filename (SSDATA (tem_fn
));
581 tem_fn
= DECODE_FILE (tem_fn
);
582 memcpy (dst
, SSDATA (tem_fn
), (srclen
= SBYTES (tem_fn
)) + 1);
585 dostounix_filename (dst
);
590 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
592 doc
: /* Returns the file name of the directory named DIRECTORY.
593 This is the name of the file that holds the data for the directory DIRECTORY.
594 This operation exists because a directory is also a file, but its name as
595 a directory is different from its name as a file.
596 In Unix-syntax, this function just removes the final slash. */)
597 (Lisp_Object directory
)
603 CHECK_STRING (directory
);
605 if (NILP (directory
))
608 /* If the file name has special constructs in it,
609 call the corresponding file handler. */
610 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
613 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
615 if (STRINGP (handled_name
))
617 error ("Invalid handler in `file-name-handler-alist'");
620 buf
= alloca (SBYTES (directory
) + 20);
621 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
622 STRING_MULTIBYTE (directory
));
623 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
626 static const char make_temp_name_tbl
[64] =
628 'A','B','C','D','E','F','G','H',
629 'I','J','K','L','M','N','O','P',
630 'Q','R','S','T','U','V','W','X',
631 'Y','Z','a','b','c','d','e','f',
632 'g','h','i','j','k','l','m','n',
633 'o','p','q','r','s','t','u','v',
634 'w','x','y','z','0','1','2','3',
635 '4','5','6','7','8','9','-','_'
638 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
640 /* Value is a temporary file name starting with PREFIX, a string.
642 The Emacs process number forms part of the result, so there is
643 no danger of generating a name being used by another process.
644 In addition, this function makes an attempt to choose a name
645 which has no existing file. To make this work, PREFIX should be
646 an absolute file name.
648 BASE64_P means add the pid as 3 characters in base64
649 encoding. In this case, 6 characters will be added to PREFIX to
650 form the file name. Otherwise, if Emacs is running on a system
651 with long file names, add the pid as a decimal number.
653 This function signals an error if no unique file name could be
657 make_temp_name (Lisp_Object prefix
, bool base64_p
)
663 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
666 CHECK_STRING (prefix
);
668 /* VAL is created by adding 6 characters to PREFIX. The first
669 three are the PID of this process, in base 64, and the second
670 three are incremented if the file already exists. This ensures
671 262144 unique file names per PID per PREFIX. */
677 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
678 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
679 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
684 #ifdef HAVE_LONG_FILE_NAMES
685 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
687 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
688 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
689 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
694 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
695 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
696 if (!STRING_MULTIBYTE (prefix
))
697 STRING_SET_UNIBYTE (val
);
699 memcpy (data
, SSDATA (prefix
), len
);
702 memcpy (p
, pidbuf
, pidlen
);
705 /* Here we try to minimize useless stat'ing when this function is
706 invoked many times successively with the same PREFIX. We achieve
707 this by initializing count to a random value, and incrementing it
710 We don't want make-temp-name to be called while dumping,
711 because then make_temp_name_count_initialized_p would get set
712 and then make_temp_name_count would not be set when Emacs starts. */
714 if (!make_temp_name_count_initialized_p
)
716 make_temp_name_count
= time (NULL
);
717 make_temp_name_count_initialized_p
= 1;
722 unsigned num
= make_temp_name_count
;
724 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
725 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
726 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
728 /* Poor man's congruential RN generator. Replace with
729 ++make_temp_name_count for debugging. */
730 make_temp_name_count
+= 25229;
731 make_temp_name_count
%= 225307;
733 if (!check_existing (data
))
735 /* We want to return only if errno is ENOENT. */
739 /* The error here is dubious, but there is little else we
740 can do. The alternatives are to return nil, which is
741 as bad as (and in many cases worse than) throwing the
742 error, or to ignore the error, which will likely result
743 in looping through 225307 stat's, which is not only
744 dog-slow, but also useless since eventually nil would
745 have to be returned anyway. */
746 report_file_error ("Cannot create temporary name for prefix",
747 Fcons (prefix
, Qnil
));
754 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
755 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
756 The Emacs process number forms part of the result,
757 so there is no danger of generating a name being used by another process.
759 In addition, this function makes an attempt to choose a name
760 which has no existing file. To make this work,
761 PREFIX should be an absolute file name.
763 There is a race condition between calling `make-temp-name' and creating the
764 file which opens all kinds of security holes. For that reason, you should
765 probably use `make-temp-file' instead, except in three circumstances:
767 * If you are creating the file in the user's home directory.
768 * If you are creating a directory rather than an ordinary file.
769 * If you are taking special precautions as `make-temp-file' does. */)
772 return make_temp_name (prefix
, 0);
777 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
778 doc
: /* Convert filename NAME to absolute, and canonicalize it.
779 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
780 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
781 the current buffer's value of `default-directory' is used.
782 NAME should be a string that is a valid file name for the underlying
784 File name components that are `.' are removed, and
785 so are file name components followed by `..', along with the `..' itself;
786 note that these simplifications are done without checking the resulting
787 file names in the file system.
788 Multiple consecutive slashes are collapsed into a single slash,
789 except at the beginning of the file name when they are significant (e.g.,
790 UNC file names on MS-Windows.)
791 An initial `~/' expands to your home directory.
792 An initial `~USER/' expands to USER's home directory.
793 See also the function `substitute-in-file-name'.
795 For technical reasons, this function can return correct but
796 non-intuitive results for the root directory; for instance,
797 \(expand-file-name ".." "/") returns "/..". For this reason, use
798 \(directory-file-name (file-name-directory dirname)) to traverse a
799 filesystem tree, not (expand-file-name ".." dirname). */)
800 (Lisp_Object name
, Lisp_Object default_directory
)
802 /* These point to SDATA and need to be careful with string-relocation
803 during GC (via DECODE_FILE). */
806 /* This should only point to alloca'd data. */
813 bool collapse_newdir
= 1;
817 Lisp_Object handler
, result
, handled_name
;
823 /* If the file name has special constructs in it,
824 call the corresponding file handler. */
825 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
828 handled_name
= call3 (handler
, Qexpand_file_name
,
829 name
, default_directory
);
830 if (STRINGP (handled_name
))
832 error ("Invalid handler in `file-name-handler-alist'");
836 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
837 if (NILP (default_directory
))
838 default_directory
= BVAR (current_buffer
, directory
);
839 if (! STRINGP (default_directory
))
842 /* "/" is not considered a root directory on DOS_NT, so using "/"
843 here causes an infinite recursion in, e.g., the following:
845 (let (default-directory)
846 (expand-file-name "a"))
848 To avoid this, we set default_directory to the root of the
850 default_directory
= build_string (emacs_root_dir ());
852 default_directory
= build_string ("/");
856 if (!NILP (default_directory
))
858 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
861 handled_name
= call3 (handler
, Qexpand_file_name
,
862 name
, default_directory
);
863 if (STRINGP (handled_name
))
865 error ("Invalid handler in `file-name-handler-alist'");
870 char *o
= SSDATA (default_directory
);
872 /* Make sure DEFAULT_DIRECTORY is properly expanded.
873 It would be better to do this down below where we actually use
874 default_directory. Unfortunately, calling Fexpand_file_name recursively
875 could invoke GC, and the strings might be relocated. This would
876 be annoying because we have pointers into strings lying around
877 that would need adjusting, and people would add new pointers to
878 the code and forget to adjust them, resulting in intermittent bugs.
879 Putting this call here avoids all that crud.
881 The EQ test avoids infinite recursion. */
882 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
883 /* Save time in some common cases - as long as default_directory
884 is not relative, it can be canonicalized with name below (if it
885 is needed at all) without requiring it to be expanded now. */
887 /* Detect MSDOS file names with drive specifiers. */
888 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
889 && IS_DIRECTORY_SEP (o
[2]))
891 /* Detect Windows file names in UNC format. */
892 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
894 #else /* not DOS_NT */
895 /* Detect Unix absolute file names (/... alone is not absolute on
897 && ! (IS_DIRECTORY_SEP (o
[0]))
898 #endif /* not DOS_NT */
904 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
908 multibyte
= STRING_MULTIBYTE (name
);
909 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
912 default_directory
= string_to_multibyte (default_directory
);
915 name
= string_to_multibyte (name
);
920 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
921 nm
= alloca (SBYTES (name
) + 1);
922 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
925 /* Note if special escape prefix is present, but remove for now. */
926 if (nm
[0] == '/' && nm
[1] == ':')
932 /* Find and remove drive specifier if present; this makes nm absolute
933 even if the rest of the name appears to be relative. Only look for
934 drive specifier at the beginning. */
935 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
937 drive
= (unsigned char) nm
[0];
942 /* If we see "c://somedir", we want to strip the first slash after the
943 colon when stripping the drive letter. Otherwise, this expands to
945 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
948 /* Discard any previous drive specifier if nm is now in UNC format. */
949 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
953 #endif /* WINDOWSNT */
956 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
957 none are found, we can probably return right away. We will avoid
958 allocating a new string if name is already fully expanded. */
960 IS_DIRECTORY_SEP (nm
[0])
962 && drive
&& !is_escaped
965 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
969 /* If it turns out that the filename we want to return is just a
970 suffix of FILENAME, we don't need to go through and edit
971 things; we just need to construct a new string using data
972 starting at the middle of FILENAME. If we set LOSE, that
973 means we've discovered that we can't do that cool trick. */
979 /* Since we know the name is absolute, we can assume that each
980 element starts with a "/". */
982 /* "." and ".." are hairy. */
983 if (IS_DIRECTORY_SEP (p
[0])
985 && (IS_DIRECTORY_SEP (p
[2])
987 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
990 /* We want to replace multiple `/' in a row with a single
993 && IS_DIRECTORY_SEP (p
[0])
994 && IS_DIRECTORY_SEP (p
[1]))
1001 /* Make sure directories are all separated with /, but
1002 avoid allocation of a new string when not required. */
1005 Lisp_Object tem_name
= make_specified_string (nm
, -1, strlen (nm
),
1008 tem_name
= ENCODE_FILE (tem_name
);
1009 dostounix_filename (SSDATA (tem_name
));
1010 tem_name
= DECODE_FILE (tem_name
);
1011 memcpy (nm
, SSDATA (tem_name
), SBYTES (tem_name
) + 1);
1014 dostounix_filename (nm
);
1016 if (IS_DIRECTORY_SEP (nm
[1]))
1018 if (strcmp (nm
, SSDATA (name
)) != 0)
1019 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1023 /* Drive must be set, so this is okay. */
1024 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1028 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1029 temp
[0] = DRIVE_LETTER (drive
);
1030 name
= concat2 (build_string (temp
), name
);
1033 #else /* not DOS_NT */
1034 if (strcmp (nm
, SSDATA (name
)) == 0)
1036 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1037 #endif /* not DOS_NT */
1041 /* At this point, nm might or might not be an absolute file name. We
1042 need to expand ~ or ~user if present, otherwise prefix nm with
1043 default_directory if nm is not absolute, and finally collapse /./
1044 and /foo/../ sequences.
1046 We set newdir to be the appropriate prefix if one is needed:
1047 - the relevant user directory if nm starts with ~ or ~user
1048 - the specified drive's working dir (DOS/NT only) if nm does not
1050 - the value of default_directory.
1052 Note that these prefixes are not guaranteed to be absolute (except
1053 for the working dir of a drive). Therefore, to ensure we always
1054 return an absolute name, if the final prefix is not absolute we
1055 append it to the current working directory. */
1059 if (nm
[0] == '~') /* prefix ~ */
1061 if (IS_DIRECTORY_SEP (nm
[1])
1062 || nm
[1] == 0) /* ~ by itself */
1066 if (!(newdir
= egetenv ("HOME")))
1069 /* `egetenv' may return a unibyte string, which will bite us since
1070 we expect the directory to be multibyte. */
1071 tem
= build_string (newdir
);
1072 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1074 hdir
= DECODE_FILE (tem
);
1075 newdir
= SSDATA (hdir
);
1078 collapse_newdir
= 0;
1081 else /* ~user/filename */
1084 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1085 o
= alloca (p
- nm
+ 1);
1086 memcpy (o
, nm
, p
- nm
);
1090 pw
= getpwnam (o
+ 1);
1096 newdir
= pw
->pw_dir
;
1097 /* `getpwnam' may return a unibyte string, which will
1098 bite us since we expect the directory to be
1100 tem
= build_string (newdir
);
1101 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1103 hdir
= DECODE_FILE (tem
);
1104 newdir
= SSDATA (hdir
);
1108 collapse_newdir
= 0;
1112 /* If we don't find a user of that name, leave the name
1113 unchanged; don't move nm forward to p. */
1118 /* On DOS and Windows, nm is absolute if a drive name was specified;
1119 use the drive's current directory as the prefix if needed. */
1120 if (!newdir
&& drive
)
1122 /* Get default directory if needed to make nm absolute. */
1124 if (!IS_DIRECTORY_SEP (nm
[0]))
1126 adir
= alloca (MAXPATHLEN
+ 1);
1127 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1131 Lisp_Object tem
= build_string (adir
);
1133 tem
= DECODE_FILE (tem
);
1134 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1139 /* Either nm starts with /, or drive isn't mounted. */
1141 adir
[0] = DRIVE_LETTER (drive
);
1150 /* Finally, if no prefix has been specified and nm is not absolute,
1151 then it must be expanded relative to default_directory. */
1155 /* /... alone is not absolute on DOS and Windows. */
1156 && !IS_DIRECTORY_SEP (nm
[0])
1159 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1163 newdir
= SSDATA (default_directory
);
1165 /* Note if special escape prefix is present, but remove for now. */
1166 if (newdir
[0] == '/' && newdir
[1] == ':')
1177 /* First ensure newdir is an absolute name. */
1179 /* Detect MSDOS file names with drive specifiers. */
1180 ! (IS_DRIVE (newdir
[0])
1181 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1183 /* Detect Windows file names in UNC format. */
1184 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1188 /* Effectively, let newdir be (expand-file-name newdir cwd).
1189 Because of the admonition against calling expand-file-name
1190 when we have pointers into lisp strings, we accomplish this
1191 indirectly by prepending newdir to nm if necessary, and using
1192 cwd (or the wd of newdir's drive) as the new newdir. */
1195 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1197 drive
= (unsigned char) newdir
[0];
1200 if (!IS_DIRECTORY_SEP (nm
[0]))
1202 ptrdiff_t newlen
= strlen (newdir
);
1203 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1204 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1208 adir
= alloca (MAXPATHLEN
+ 1);
1211 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1215 getcwd (adir
, MAXPATHLEN
+ 1);
1218 Lisp_Object tem
= build_string (adir
);
1220 tem
= DECODE_FILE (tem
);
1221 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1226 /* Strip off drive name from prefix, if present. */
1227 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1233 /* Keep only a prefix from newdir if nm starts with slash
1234 (//server/share for UNC, nothing otherwise). */
1235 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1238 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1240 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1242 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1244 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1257 /* Get rid of any slash at the end of newdir, unless newdir is
1258 just / or // (an incomplete UNC name). */
1259 length
= strlen (newdir
);
1261 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1263 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1267 char *temp
= alloca (length
);
1268 memcpy (temp
, newdir
, length
- 1);
1269 temp
[length
- 1] = 0;
1280 /* Now concatenate the directory and name to new space in the stack frame. */
1281 tlen
+= strlen (nm
) + 1;
1283 /* Reserve space for drive specifier and escape prefix, since either
1284 or both may need to be inserted. (The Microsoft x86 compiler
1285 produces incorrect code if the following two lines are combined.) */
1286 target
= alloca (tlen
+ 4);
1288 #else /* not DOS_NT */
1289 target
= alloca (tlen
);
1290 #endif /* not DOS_NT */
1295 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1298 /* If newdir is effectively "C:/", then the drive letter will have
1299 been stripped and newdir will be "/". Concatenating with an
1300 absolute directory in nm produces "//", which will then be
1301 incorrectly treated as a network share. Ignore newdir in
1302 this case (keeping the drive letter). */
1303 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1304 && newdir
[1] == '\0'))
1306 strcpy (target
, newdir
);
1309 file_name_as_directory (target
, newdir
, length
, multibyte
);
1312 strcat (target
, nm
);
1314 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1322 if (!IS_DIRECTORY_SEP (*p
))
1326 else if (p
[1] == '.'
1327 && (IS_DIRECTORY_SEP (p
[2])
1330 /* If "/." is the entire filename, keep the "/". Otherwise,
1331 just delete the whole "/.". */
1332 if (o
== target
&& p
[2] == '\0')
1336 else if (p
[1] == '.' && p
[2] == '.'
1337 /* `/../' is the "superroot" on certain file systems.
1338 Turned off on DOS_NT systems because they have no
1339 "superroot" and because this causes us to produce
1340 file names like "d:/../foo" which fail file-related
1341 functions of the underlying OS. (To reproduce, try a
1342 long series of "../../" in default_directory, longer
1343 than the number of levels from the root.) */
1347 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1352 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1355 /* Don't go below server level in UNC filenames. */
1356 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1357 && IS_DIRECTORY_SEP (*target
))
1361 /* Keep initial / only if this is the whole name. */
1362 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1366 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1367 /* Collapse multiple `/' in a row. */
1376 /* At last, set drive name. */
1378 /* Except for network file name. */
1379 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1380 #endif /* WINDOWSNT */
1382 if (!drive
) emacs_abort ();
1384 target
[0] = DRIVE_LETTER (drive
);
1387 /* Reinsert the escape prefix if required. */
1394 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1397 result
= ENCODE_FILE (result
);
1398 dostounix_filename (SSDATA (result
));
1399 result
= DECODE_FILE (result
);
1402 dostounix_filename (SSDATA (result
));
1404 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1405 #endif /* !DOS_NT */
1408 /* Again look to see if the file name has special constructs in it
1409 and perhaps call the corresponding file handler. This is needed
1410 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1411 the ".." component gives us "/user@host:/bar/../baz" which needs
1412 to be expanded again. */
1413 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1414 if (!NILP (handler
))
1416 handled_name
= call3 (handler
, Qexpand_file_name
,
1417 result
, default_directory
);
1418 if (STRINGP (handled_name
))
1419 return handled_name
;
1420 error ("Invalid handler in `file-name-handler-alist'");
1427 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1428 This is the old version of expand-file-name, before it was thoroughly
1429 rewritten for Emacs 10.31. We leave this version here commented-out,
1430 because the code is very complex and likely to have subtle bugs. If
1431 bugs _are_ found, it might be of interest to look at the old code and
1432 see what did it do in the relevant situation.
1434 Don't remove this code: it's true that it will be accessible
1435 from the repository, but a few years from deletion, people will
1436 forget it is there. */
1438 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1439 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1440 "Convert FILENAME to absolute, and canonicalize it.\n\
1441 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1442 \(does not start with slash); if DEFAULT is nil or missing,\n\
1443 the current buffer's value of default-directory is used.\n\
1444 Filenames containing `.' or `..' as components are simplified;\n\
1445 initial `~/' expands to your home directory.\n\
1446 See also the function `substitute-in-file-name'.")
1448 Lisp_Object name
, defalt
;
1452 register unsigned char *newdir
, *p
, *o
;
1454 unsigned char *target
;
1457 CHECK_STRING (name
);
1460 /* If nm is absolute, flush ...// and detect /./ and /../.
1461 If no /./ or /../ we can return right away. */
1468 if (p
[0] == '/' && p
[1] == '/')
1470 if (p
[0] == '/' && p
[1] == '~')
1471 nm
= p
+ 1, lose
= 1;
1472 if (p
[0] == '/' && p
[1] == '.'
1473 && (p
[2] == '/' || p
[2] == 0
1474 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1480 if (nm
== SDATA (name
))
1482 return build_string (nm
);
1486 /* Now determine directory to start with and put it in NEWDIR. */
1490 if (nm
[0] == '~') /* prefix ~ */
1491 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1493 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1494 newdir
= (unsigned char *) "";
1497 else /* ~user/filename */
1499 /* Get past ~ to user. */
1500 unsigned char *user
= nm
+ 1;
1501 /* Find end of name. */
1502 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1503 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1504 /* Copy the user name into temp storage. */
1505 o
= alloca (len
+ 1);
1506 memcpy (o
, user
, len
);
1509 /* Look up the user name. */
1511 pw
= (struct passwd
*) getpwnam (o
+ 1);
1514 error ("\"%s\" isn't a registered user", o
+ 1);
1516 newdir
= (unsigned char *) pw
->pw_dir
;
1518 /* Discard the user name from NM. */
1522 if (nm
[0] != '/' && !newdir
)
1525 defalt
= current_buffer
->directory
;
1526 CHECK_STRING (defalt
);
1527 newdir
= SDATA (defalt
);
1530 /* Now concatenate the directory and name to new space in the stack frame. */
1532 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1533 target
= alloca (tlen
);
1538 if (nm
[0] == 0 || nm
[0] == '/')
1539 strcpy (target
, newdir
);
1541 file_name_as_directory (target
, newdir
);
1544 strcat (target
, nm
);
1546 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1557 else if (!strncmp (p
, "//", 2)
1563 else if (p
[0] == '/' && p
[1] == '.'
1564 && (p
[2] == '/' || p
[2] == 0))
1566 else if (!strncmp (p
, "/..", 3)
1567 /* `/../' is the "superroot" on certain file systems. */
1569 && (p
[3] == '/' || p
[3] == 0))
1571 while (o
!= target
&& *--o
!= '/')
1573 if (o
== target
&& *o
== '/')
1583 return make_string (target
, o
- target
);
1587 /* If /~ or // appears, discard everything through first slash. */
1589 file_name_absolute_p (const char *filename
)
1592 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1594 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1595 && IS_DIRECTORY_SEP (filename
[2]))
1601 search_embedded_absfilename (char *nm
, char *endp
)
1605 for (p
= nm
+ 1; p
< endp
; p
++)
1607 if (IS_DIRECTORY_SEP (p
[-1])
1608 && file_name_absolute_p (p
)
1609 #if defined (WINDOWSNT) || defined (CYGWIN)
1610 /* // at start of file name is meaningful in Apollo,
1611 WindowsNT and Cygwin systems. */
1612 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1613 #endif /* not (WINDOWSNT || CYGWIN) */
1616 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1617 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1619 char *o
= alloca (s
- p
+ 1);
1621 memcpy (o
, p
, s
- p
);
1624 /* If we have ~user and `user' exists, discard
1625 everything up to ~. But if `user' does not exist, leave
1626 ~user alone, it might be a literal file name. */
1628 pw
= getpwnam (o
+ 1);
1640 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1641 Ssubstitute_in_file_name
, 1, 1, 0,
1642 doc
: /* Substitute environment variables referred to in FILENAME.
1643 `$FOO' where FOO is an environment variable name means to substitute
1644 the value of that variable. The variable name should be terminated
1645 with a character not a letter, digit or underscore; otherwise, enclose
1646 the entire variable name in braces.
1648 If `/~' appears, all of FILENAME through that `/' is discarded.
1649 If `//' appears, everything up to and including the first of
1650 those `/' is discarded. */)
1651 (Lisp_Object filename
)
1653 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1654 char *target
= NULL
;
1655 ptrdiff_t total
= 0;
1656 bool substituted
= 0;
1659 Lisp_Object handler
;
1661 CHECK_STRING (filename
);
1663 multibyte
= STRING_MULTIBYTE (filename
);
1665 /* If the file name has special constructs in it,
1666 call the corresponding file handler. */
1667 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1668 if (!NILP (handler
))
1670 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1672 if (STRINGP (handled_name
))
1673 return handled_name
;
1674 error ("Invalid handler in `file-name-handler-alist'");
1677 /* Always work on a copy of the string, in case GC happens during
1678 decode of environment variables, causing the original Lisp_String
1679 data to be relocated. */
1680 nm
= alloca (SBYTES (filename
) + 1);
1681 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1686 Lisp_Object encoded_filename
= ENCODE_FILE (filename
);
1689 dostounix_filename (SDATA (encoded_filename
));
1690 tem_fn
= DECODE_FILE (encoded_filename
);
1691 nm
= alloca (SBYTES (tem_fn
) + 1);
1692 memcpy (nm
, SDATA (tem_fn
), SBYTES (tem_fn
) + 1);
1693 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1699 dostounix_filename (nm
);
1700 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1703 endp
= nm
+ SBYTES (filename
);
1705 /* If /~ or // appears, discard everything through first slash. */
1706 p
= search_embedded_absfilename (nm
, endp
);
1708 /* Start over with the new string, so we check the file-name-handler
1709 again. Important with filenames like "/home/foo//:/hello///there"
1710 which would substitute to "/:/hello///there" rather than "/there". */
1711 return Fsubstitute_in_file_name
1712 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1714 /* See if any variables are substituted into the string
1715 and find the total length of their values in `total'. */
1717 for (p
= nm
; p
!= endp
;)
1727 /* "$$" means a single "$". */
1736 while (p
!= endp
&& *p
!= '}') p
++;
1737 if (*p
!= '}') goto missingclose
;
1743 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1747 /* Copy out the variable name. */
1748 target
= alloca (s
- o
+ 1);
1749 memcpy (target
, o
, s
- o
);
1752 strupr (target
); /* $home == $HOME etc. */
1755 /* Get variable value. */
1756 o
= egetenv (target
);
1759 /* Don't try to guess a maximum length - UTF8 can use up to
1760 four bytes per character. This code is unlikely to run
1761 in a situation that requires performance, so decoding the
1762 env variables twice should be acceptable. Note that
1763 decoding may cause a garbage collect. */
1764 Lisp_Object orig
, decoded
;
1765 orig
= build_unibyte_string (o
);
1766 decoded
= DECODE_FILE (orig
);
1767 total
+= SBYTES (decoded
);
1777 /* If substitution required, recopy the string and do it. */
1778 /* Make space in stack frame for the new copy. */
1779 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1782 /* Copy the rest of the name through, replacing $ constructs with values. */
1799 while (p
!= endp
&& *p
!= '}') p
++;
1800 if (*p
!= '}') goto missingclose
;
1806 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1810 /* Copy out the variable name. */
1811 target
= alloca (s
- o
+ 1);
1812 memcpy (target
, o
, s
- o
);
1815 strupr (target
); /* $home == $HOME etc. */
1818 /* Get variable value. */
1819 o
= egetenv (target
);
1823 strcpy (x
, target
); x
+= strlen (target
);
1827 Lisp_Object orig
, decoded
;
1828 ptrdiff_t orig_length
, decoded_length
;
1829 orig_length
= strlen (o
);
1830 orig
= make_unibyte_string (o
, orig_length
);
1831 decoded
= DECODE_FILE (orig
);
1832 decoded_length
= SBYTES (decoded
);
1833 memcpy (x
, SDATA (decoded
), decoded_length
);
1834 x
+= decoded_length
;
1836 /* If environment variable needed decoding, return value
1837 needs to be multibyte. */
1838 if (decoded_length
!= orig_length
1839 || memcmp (SDATA (decoded
), o
, orig_length
))
1846 /* If /~ or // appears, discard everything through first slash. */
1847 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1848 /* This time we do not start over because we've already expanded envvars
1849 and replaced $$ with $. Maybe we should start over as well, but we'd
1850 need to quote some $ to $$ first. */
1853 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1856 error ("Bad format environment-variable substitution");
1858 error ("Missing \"}\" in environment-variable substitution");
1860 error ("Substituting nonexistent environment variable \"%s\"", target
);
1866 /* A slightly faster and more convenient way to get
1867 (directory-file-name (expand-file-name FOO)). */
1870 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1872 register Lisp_Object absname
;
1874 absname
= Fexpand_file_name (filename
, defdir
);
1876 /* Remove final slash, if any (unless this is the root dir).
1877 stat behaves differently depending! */
1878 if (SCHARS (absname
) > 1
1879 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1880 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1881 /* We cannot take shortcuts; they might be wrong for magic file names. */
1882 absname
= Fdirectory_file_name (absname
);
1886 /* Signal an error if the file ABSNAME already exists.
1887 If INTERACTIVE, ask the user whether to proceed,
1888 and bypass the error if the user says to go ahead.
1889 QUERYSTRING is a name for the action that is being considered
1892 *STATPTR is used to store the stat information if the file exists.
1893 If the file does not exist, STATPTR->st_mode is set to 0.
1894 If STATPTR is null, we don't store into it.
1896 If QUICK, ask for y or n, not yes or no. */
1899 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1900 bool interactive
, struct stat
*statptr
,
1903 Lisp_Object tem
, encoded_filename
;
1904 struct stat statbuf
;
1905 struct gcpro gcpro1
;
1907 encoded_filename
= ENCODE_FILE (absname
);
1909 /* `stat' is a good way to tell whether the file exists,
1910 regardless of what access permissions it has. */
1911 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1913 if (S_ISDIR (statbuf
.st_mode
))
1914 xsignal2 (Qfile_error
,
1915 build_string ("File is a directory"), absname
);
1918 xsignal2 (Qfile_already_exists
,
1919 build_string ("File already exists"), absname
);
1921 tem
= format2 ("File %s already exists; %s anyway? ",
1922 absname
, build_string (querystring
));
1924 tem
= call1 (intern ("y-or-n-p"), tem
);
1926 tem
= do_yes_or_no_p (tem
);
1929 xsignal2 (Qfile_already_exists
,
1930 build_string ("File already exists"), absname
);
1937 statptr
->st_mode
= 0;
1942 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1943 "fCopy file: \nGCopy %s to file: \np\nP",
1944 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1945 If NEWNAME names a directory, copy FILE there.
1947 This function always sets the file modes of the output file to match
1950 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1951 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1952 signal a `file-already-exists' error without overwriting. If
1953 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1954 about overwriting; this is what happens in interactive use with M-x.
1955 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1958 Fourth arg KEEP-TIME non-nil means give the output file the same
1959 last-modified time as the old one. (This works on only some systems.)
1961 A prefix arg makes KEEP-TIME non-nil.
1963 If PRESERVE-UID-GID is non-nil, we try to transfer the
1964 uid and gid of FILE to NEWNAME.
1966 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1967 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1968 entries (depending on how Emacs was built). */)
1969 (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
)
1973 char buf
[16 * 1024];
1974 struct stat st
, out_st
;
1975 Lisp_Object handler
;
1976 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1977 ptrdiff_t count
= SPECPDL_INDEX ();
1978 Lisp_Object encoded_file
, encoded_newname
;
1980 security_context_t con
;
1983 #ifdef HAVE_POSIX_ACL
1987 encoded_file
= encoded_newname
= Qnil
;
1988 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1989 CHECK_STRING (file
);
1990 CHECK_STRING (newname
);
1992 if (!NILP (Ffile_directory_p (newname
)))
1993 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1995 newname
= Fexpand_file_name (newname
, Qnil
);
1997 file
= Fexpand_file_name (file
, Qnil
);
1999 /* If the input file name has special constructs in it,
2000 call the corresponding file handler. */
2001 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2002 /* Likewise for output file name. */
2004 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2005 if (!NILP (handler
))
2006 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
2007 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
2008 preserve_extended_attributes
));
2010 encoded_file
= ENCODE_FILE (file
);
2011 encoded_newname
= ENCODE_FILE (newname
);
2013 if (NILP (ok_if_already_exists
)
2014 || INTEGERP (ok_if_already_exists
))
2015 barf_or_query_if_file_exists (newname
, "copy to it",
2016 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2017 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
2021 if (!NILP (preserve_extended_attributes
))
2023 #ifdef HAVE_POSIX_ACL
2024 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2025 if (acl
== NULL
&& errno
!= ENOTSUP
)
2026 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2029 if (!CopyFile (SDATA (encoded_file
),
2030 SDATA (encoded_newname
),
2032 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2033 /* CopyFile retains the timestamp by default. */
2034 else if (NILP (keep_time
))
2040 filename
= SDATA (encoded_newname
);
2042 /* Ensure file is writable while its modified time is set. */
2043 attributes
= GetFileAttributes (filename
);
2044 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2045 now
= current_emacs_time ();
2046 if (set_file_times (-1, filename
, now
, now
))
2048 /* Restore original attributes. */
2049 SetFileAttributes (filename
, attributes
);
2050 xsignal2 (Qfile_date_error
,
2051 build_string ("Cannot set file date"), newname
);
2053 /* Restore original attributes. */
2054 SetFileAttributes (filename
, attributes
);
2056 #ifdef HAVE_POSIX_ACL
2060 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2061 if (fail
&& errno
!= ENOTSUP
)
2062 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2067 #else /* not WINDOWSNT */
2069 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2073 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2075 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2077 if (fstat (ifd
, &st
) != 0)
2078 report_file_error ("Input file status", Fcons (file
, Qnil
));
2080 if (!NILP (preserve_extended_attributes
))
2083 if (is_selinux_enabled ())
2085 conlength
= fgetfilecon (ifd
, &con
);
2086 if (conlength
== -1)
2087 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
2091 #ifdef HAVE_POSIX_ACL
2092 acl
= acl_get_fd (ifd
);
2093 if (acl
== NULL
&& errno
!= ENOTSUP
)
2094 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2098 if (out_st
.st_mode
!= 0
2099 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2102 report_file_error ("Input and output files are the same",
2103 Fcons (file
, Fcons (newname
, Qnil
)));
2106 /* We can copy only regular files. */
2107 if (!S_ISREG (st
.st_mode
))
2109 /* Get a better looking error message. */
2110 errno
= S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
;
2111 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2115 /* System's default file type was set to binary by _fmode in emacs.c. */
2116 ofd
= emacs_open (SDATA (encoded_newname
),
2117 O_WRONLY
| O_TRUNC
| O_CREAT
2118 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2119 S_IREAD
| S_IWRITE
);
2120 #else /* not MSDOS */
2122 mode_t new_mask
= !NILP (preserve_uid_gid
) ? 0600 : 0666;
2123 new_mask
&= st
.st_mode
;
2124 ofd
= emacs_open (SSDATA (encoded_newname
),
2125 (O_WRONLY
| O_TRUNC
| O_CREAT
2126 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2129 #endif /* not MSDOS */
2131 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2133 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2137 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2138 if (emacs_write (ofd
, buf
, n
) != n
)
2139 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2143 /* Preserve the original file modes, and if requested, also its
2146 mode_t mode_mask
= 07777;
2147 if (!NILP (preserve_uid_gid
))
2149 /* Attempt to change owner and group. If that doesn't work
2150 attempt to change just the group, as that is sometimes allowed.
2151 Adjust the mode mask to eliminate setuid or setgid bits
2152 that are inappropriate if the owner and group are wrong. */
2153 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2155 mode_mask
&= ~06000;
2156 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2160 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2161 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2163 #endif /* not MSDOS */
2168 /* Set the modified context back to the file. */
2169 bool fail
= fsetfilecon (ofd
, con
) != 0;
2170 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2171 if (fail
&& errno
!= ENOTSUP
)
2172 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2178 #ifdef HAVE_POSIX_ACL
2181 bool fail
= acl_set_fd (ofd
, acl
) != 0;
2182 if (fail
&& errno
!= ENOTSUP
)
2183 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2189 if (!NILP (keep_time
))
2191 EMACS_TIME atime
= get_stat_atime (&st
);
2192 EMACS_TIME mtime
= get_stat_mtime (&st
);
2193 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2194 xsignal2 (Qfile_date_error
,
2195 build_string ("Cannot set file date"), newname
);
2198 if (emacs_close (ofd
) < 0)
2199 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2204 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2205 and if it can't, it tells so. Otherwise, under MSDOS we usually
2206 get only the READ bit, which will make the copied file read-only,
2207 so it's better not to chmod at all. */
2208 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2209 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2211 #endif /* not WINDOWSNT */
2213 /* Discard the unwind protects. */
2214 specpdl_ptr
= specpdl
+ count
;
2220 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2221 Smake_directory_internal
, 1, 1, 0,
2222 doc
: /* Create a new directory named DIRECTORY. */)
2223 (Lisp_Object directory
)
2226 Lisp_Object handler
;
2227 Lisp_Object encoded_dir
;
2229 CHECK_STRING (directory
);
2230 directory
= Fexpand_file_name (directory
, Qnil
);
2232 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2233 if (!NILP (handler
))
2234 return call2 (handler
, Qmake_directory_internal
, directory
);
2236 encoded_dir
= ENCODE_FILE (directory
);
2238 dir
= SSDATA (encoded_dir
);
2241 if (mkdir (dir
) != 0)
2243 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2245 report_file_error ("Creating directory", list1 (directory
));
2250 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2251 Sdelete_directory_internal
, 1, 1, 0,
2252 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2253 (Lisp_Object directory
)
2256 Lisp_Object encoded_dir
;
2258 CHECK_STRING (directory
);
2259 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2260 encoded_dir
= ENCODE_FILE (directory
);
2261 dir
= SSDATA (encoded_dir
);
2263 if (rmdir (dir
) != 0)
2264 report_file_error ("Removing directory", list1 (directory
));
2269 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2270 "(list (read-file-name \
2271 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2272 \"Move file to trash: \" \"Delete file: \") \
2273 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2274 (null current-prefix-arg))",
2275 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2276 If file has multiple names, it continues to exist with the other names.
2277 TRASH non-nil means to trash the file instead of deleting, provided
2278 `delete-by-moving-to-trash' is non-nil.
2280 When called interactively, TRASH is t if no prefix argument is given.
2281 With a prefix argument, TRASH is nil. */)
2282 (Lisp_Object filename
, Lisp_Object trash
)
2284 Lisp_Object handler
;
2285 Lisp_Object encoded_file
;
2286 struct gcpro gcpro1
;
2289 if (!NILP (Ffile_directory_p (filename
))
2290 && NILP (Ffile_symlink_p (filename
)))
2291 xsignal2 (Qfile_error
,
2292 build_string ("Removing old name: is a directory"),
2295 filename
= Fexpand_file_name (filename
, Qnil
);
2297 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2298 if (!NILP (handler
))
2299 return call3 (handler
, Qdelete_file
, filename
, trash
);
2301 if (delete_by_moving_to_trash
&& !NILP (trash
))
2302 return call1 (Qmove_file_to_trash
, filename
);
2304 encoded_file
= ENCODE_FILE (filename
);
2306 if (unlink (SSDATA (encoded_file
)) < 0)
2307 report_file_error ("Removing old name", list1 (filename
));
2312 internal_delete_file_1 (Lisp_Object ignore
)
2317 /* Delete file FILENAME, returning true if successful.
2318 This ignores `delete-by-moving-to-trash'. */
2321 internal_delete_file (Lisp_Object filename
)
2325 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2326 Qt
, internal_delete_file_1
);
2330 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2331 "fRename file: \nGRename %s to file: \np",
2332 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2333 If file has names other than FILE, it continues to have those names.
2334 Signals a `file-already-exists' error if a file NEWNAME already exists
2335 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2336 A number as third arg means request confirmation if NEWNAME already exists.
2337 This is what happens in interactive use with M-x. */)
2338 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2340 Lisp_Object handler
;
2341 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2342 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2344 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2345 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2346 CHECK_STRING (file
);
2347 CHECK_STRING (newname
);
2348 file
= Fexpand_file_name (file
, Qnil
);
2350 if ((!NILP (Ffile_directory_p (newname
)))
2352 /* If the file names are identical but for the case,
2353 don't attempt to move directory to itself. */
2354 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2358 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2359 ? file
: Fdirectory_file_name (file
));
2360 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2363 newname
= Fexpand_file_name (newname
, Qnil
);
2365 /* If the file name has special constructs in it,
2366 call the corresponding file handler. */
2367 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2369 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2370 if (!NILP (handler
))
2371 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2372 file
, newname
, ok_if_already_exists
));
2374 encoded_file
= ENCODE_FILE (file
);
2375 encoded_newname
= ENCODE_FILE (newname
);
2378 /* If the file names are identical but for the case, don't ask for
2379 confirmation: they simply want to change the letter-case of the
2381 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2383 if (NILP (ok_if_already_exists
)
2384 || INTEGERP (ok_if_already_exists
))
2385 barf_or_query_if_file_exists (newname
, "rename to it",
2386 INTEGERP (ok_if_already_exists
), 0, 0);
2387 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2392 symlink_target
= Ffile_symlink_p (file
);
2393 if (! NILP (symlink_target
))
2394 Fmake_symbolic_link (symlink_target
, newname
,
2395 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2396 else if (!NILP (Ffile_directory_p (file
)))
2397 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2399 /* We have already prompted if it was an integer, so don't
2400 have copy-file prompt again. */
2401 Fcopy_file (file
, newname
,
2402 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2405 count
= SPECPDL_INDEX ();
2406 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2408 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2409 call2 (Qdelete_directory
, file
, Qt
);
2411 Fdelete_file (file
, Qnil
);
2412 unbind_to (count
, Qnil
);
2415 report_file_error ("Renaming", list2 (file
, newname
));
2421 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2422 "fAdd name to file: \nGName to add to %s: \np",
2423 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2424 Signals a `file-already-exists' error if a file NEWNAME already exists
2425 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2426 A number as third arg means request confirmation if NEWNAME already exists.
2427 This is what happens in interactive use with M-x. */)
2428 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2430 Lisp_Object handler
;
2431 Lisp_Object encoded_file
, encoded_newname
;
2432 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2434 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2435 encoded_file
= encoded_newname
= Qnil
;
2436 CHECK_STRING (file
);
2437 CHECK_STRING (newname
);
2438 file
= Fexpand_file_name (file
, Qnil
);
2440 if (!NILP (Ffile_directory_p (newname
)))
2441 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2443 newname
= Fexpand_file_name (newname
, Qnil
);
2445 /* If the file name has special constructs in it,
2446 call the corresponding file handler. */
2447 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2448 if (!NILP (handler
))
2449 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2450 newname
, ok_if_already_exists
));
2452 /* If the new name has special constructs in it,
2453 call the corresponding file handler. */
2454 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2455 if (!NILP (handler
))
2456 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2457 newname
, ok_if_already_exists
));
2459 encoded_file
= ENCODE_FILE (file
);
2460 encoded_newname
= ENCODE_FILE (newname
);
2462 if (NILP (ok_if_already_exists
)
2463 || INTEGERP (ok_if_already_exists
))
2464 barf_or_query_if_file_exists (newname
, "make it a new name",
2465 INTEGERP (ok_if_already_exists
), 0, 0);
2467 unlink (SSDATA (newname
));
2468 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2469 report_file_error ("Adding new name", list2 (file
, newname
));
2475 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2476 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2477 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2478 Both args must be strings.
2479 Signals a `file-already-exists' error if a file LINKNAME already exists
2480 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2481 A number as third arg means request confirmation if LINKNAME already exists.
2482 This happens for interactive use with M-x. */)
2483 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2485 Lisp_Object handler
;
2486 Lisp_Object encoded_filename
, encoded_linkname
;
2487 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2489 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2490 encoded_filename
= encoded_linkname
= Qnil
;
2491 CHECK_STRING (filename
);
2492 CHECK_STRING (linkname
);
2493 /* If the link target has a ~, we must expand it to get
2494 a truly valid file name. Otherwise, do not expand;
2495 we want to permit links to relative file names. */
2496 if (SREF (filename
, 0) == '~')
2497 filename
= Fexpand_file_name (filename
, Qnil
);
2499 if (!NILP (Ffile_directory_p (linkname
)))
2500 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2502 linkname
= Fexpand_file_name (linkname
, Qnil
);
2504 /* If the file name has special constructs in it,
2505 call the corresponding file handler. */
2506 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2507 if (!NILP (handler
))
2508 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2509 linkname
, ok_if_already_exists
));
2511 /* If the new link name has special constructs in it,
2512 call the corresponding file handler. */
2513 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2514 if (!NILP (handler
))
2515 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2516 linkname
, ok_if_already_exists
));
2518 encoded_filename
= ENCODE_FILE (filename
);
2519 encoded_linkname
= ENCODE_FILE (linkname
);
2521 if (NILP (ok_if_already_exists
)
2522 || INTEGERP (ok_if_already_exists
))
2523 barf_or_query_if_file_exists (linkname
, "make it a link",
2524 INTEGERP (ok_if_already_exists
), 0, 0);
2525 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2527 /* If we didn't complain already, silently delete existing file. */
2528 if (errno
== EEXIST
)
2530 unlink (SSDATA (encoded_linkname
));
2531 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2538 if (errno
== ENOSYS
)
2541 xsignal1 (Qfile_error
,
2542 build_string ("Symbolic links are not supported"));
2545 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2552 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2554 doc
: /* Return t if file FILENAME specifies an absolute file name.
2555 On Unix, this is a name starting with a `/' or a `~'. */)
2556 (Lisp_Object filename
)
2558 CHECK_STRING (filename
);
2559 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2562 /* Return true if FILENAME exists. */
2564 check_existing (const char *filename
)
2566 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2569 /* Return true if file FILENAME exists and can be executed. */
2572 check_executable (char *filename
)
2574 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2577 /* Return true if file FILENAME exists and can be accessed
2578 according to AMODE, which should include W_OK.
2579 On failure, return false and set errno. */
2582 check_writable (const char *filename
, int amode
)
2585 /* FIXME: an faccessat implementation should be added to the
2586 DOS/Windows ports and this #ifdef branch should be removed. */
2588 if (stat (filename
, &st
) < 0)
2591 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2592 #else /* not MSDOS */
2593 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2595 /* faccessat may have returned failure because Cygwin couldn't
2596 determine the file's UID or GID; if so, we return success. */
2599 int faccessat_errno
= errno
;
2601 if (stat (filename
, &st
) < 0)
2603 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2604 errno
= faccessat_errno
;
2608 #endif /* not MSDOS */
2611 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2612 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2613 See also `file-readable-p' and `file-attributes'.
2614 This returns nil for a symlink to a nonexistent file.
2615 Use `file-symlink-p' to test for such links. */)
2616 (Lisp_Object filename
)
2618 Lisp_Object absname
;
2619 Lisp_Object handler
;
2621 CHECK_STRING (filename
);
2622 absname
= Fexpand_file_name (filename
, Qnil
);
2624 /* If the file name has special constructs in it,
2625 call the corresponding file handler. */
2626 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2627 if (!NILP (handler
))
2628 return call2 (handler
, Qfile_exists_p
, absname
);
2630 absname
= ENCODE_FILE (absname
);
2632 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2635 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2636 doc
: /* Return t if FILENAME can be executed by you.
2637 For a directory, this means you can access files in that directory. */)
2638 (Lisp_Object filename
)
2640 Lisp_Object absname
;
2641 Lisp_Object handler
;
2643 CHECK_STRING (filename
);
2644 absname
= Fexpand_file_name (filename
, Qnil
);
2646 /* If the file name has special constructs in it,
2647 call the corresponding file handler. */
2648 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2649 if (!NILP (handler
))
2650 return call2 (handler
, Qfile_executable_p
, absname
);
2652 absname
= ENCODE_FILE (absname
);
2654 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2657 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2658 doc
: /* Return t if file FILENAME exists and you can read it.
2659 See also `file-exists-p' and `file-attributes'. */)
2660 (Lisp_Object filename
)
2662 Lisp_Object absname
;
2663 Lisp_Object handler
;
2665 CHECK_STRING (filename
);
2666 absname
= Fexpand_file_name (filename
, Qnil
);
2668 /* If the file name has special constructs in it,
2669 call the corresponding file handler. */
2670 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2671 if (!NILP (handler
))
2672 return call2 (handler
, Qfile_readable_p
, absname
);
2674 absname
= ENCODE_FILE (absname
);
2675 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2679 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2680 doc
: /* Return t if file FILENAME can be written or created by you. */)
2681 (Lisp_Object filename
)
2683 Lisp_Object absname
, dir
, encoded
;
2684 Lisp_Object handler
;
2686 CHECK_STRING (filename
);
2687 absname
= Fexpand_file_name (filename
, Qnil
);
2689 /* If the file name has special constructs in it,
2690 call the corresponding file handler. */
2691 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2692 if (!NILP (handler
))
2693 return call2 (handler
, Qfile_writable_p
, absname
);
2695 encoded
= ENCODE_FILE (absname
);
2696 if (check_writable (SSDATA (encoded
), W_OK
))
2698 if (errno
!= ENOENT
)
2701 dir
= Ffile_name_directory (absname
);
2702 eassert (!NILP (dir
));
2704 dir
= Fdirectory_file_name (dir
);
2707 dir
= ENCODE_FILE (dir
);
2709 /* The read-only attribute of the parent directory doesn't affect
2710 whether a file or directory can be created within it. Some day we
2711 should check ACLs though, which do affect this. */
2712 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2714 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2718 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2719 doc
: /* Access file FILENAME, and get an error if that does not work.
2720 The second argument STRING is used in the error message.
2721 If there is no error, returns nil. */)
2722 (Lisp_Object filename
, Lisp_Object string
)
2724 Lisp_Object handler
, encoded_filename
, absname
;
2727 CHECK_STRING (filename
);
2728 absname
= Fexpand_file_name (filename
, Qnil
);
2730 CHECK_STRING (string
);
2732 /* If the file name has special constructs in it,
2733 call the corresponding file handler. */
2734 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2735 if (!NILP (handler
))
2736 return call3 (handler
, Qaccess_file
, absname
, string
);
2738 encoded_filename
= ENCODE_FILE (absname
);
2740 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2742 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2748 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2749 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2750 The value is the link target, as a string.
2751 Otherwise it returns nil.
2753 This function returns t when given the name of a symlink that
2754 points to a nonexistent file. */)
2755 (Lisp_Object filename
)
2757 Lisp_Object handler
;
2760 char readlink_buf
[READLINK_BUFSIZE
];
2762 CHECK_STRING (filename
);
2763 filename
= Fexpand_file_name (filename
, Qnil
);
2765 /* If the file name has special constructs in it,
2766 call the corresponding file handler. */
2767 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2768 if (!NILP (handler
))
2769 return call2 (handler
, Qfile_symlink_p
, filename
);
2771 filename
= ENCODE_FILE (filename
);
2773 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2777 val
= build_string (buf
);
2778 if (buf
[0] == '/' && strchr (buf
, ':'))
2779 val
= concat2 (build_string ("/:"), val
);
2780 if (buf
!= readlink_buf
)
2782 val
= DECODE_FILE (val
);
2786 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2787 doc
: /* Return t if FILENAME names an existing directory.
2788 Symbolic links to directories count as directories.
2789 See `file-symlink-p' to distinguish symlinks. */)
2790 (Lisp_Object filename
)
2792 Lisp_Object absname
;
2793 Lisp_Object handler
;
2795 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2797 /* If the file name has special constructs in it,
2798 call the corresponding file handler. */
2799 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2800 if (!NILP (handler
))
2801 return call2 (handler
, Qfile_directory_p
, absname
);
2803 absname
= ENCODE_FILE (absname
);
2805 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2808 /* Return true if FILE is a directory or a symlink to a directory. */
2810 file_directory_p (char const *file
)
2813 /* This is cheaper than 'stat'. */
2814 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2817 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2821 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2822 Sfile_accessible_directory_p
, 1, 1, 0,
2823 doc
: /* Return t if file FILENAME names a directory you can open.
2824 For the value to be t, FILENAME must specify the name of a directory as a file,
2825 and the directory must allow you to open files in it. In order to use a
2826 directory as a buffer's current directory, this predicate must return true.
2827 A directory name spec may be given instead; then the value is t
2828 if the directory so specified exists and really is a readable and
2829 searchable directory. */)
2830 (Lisp_Object filename
)
2832 Lisp_Object absname
;
2833 Lisp_Object handler
;
2835 CHECK_STRING (filename
);
2836 absname
= Fexpand_file_name (filename
, Qnil
);
2838 /* If the file name has special constructs in it,
2839 call the corresponding file handler. */
2840 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2841 if (!NILP (handler
))
2842 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2844 absname
= ENCODE_FILE (absname
);
2845 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2848 /* If FILE is a searchable directory or a symlink to a
2849 searchable directory, return true. Otherwise return
2850 false and set errno to an error number. */
2852 file_accessible_directory_p (char const *file
)
2855 /* There's no need to test whether FILE is searchable, as the
2856 searchable/executable bit is invented on DOS_NT platforms. */
2857 return file_directory_p (file
);
2859 /* On POSIXish platforms, use just one system call; this avoids a
2860 race and is typically faster. */
2861 ptrdiff_t len
= strlen (file
);
2867 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2868 There are three exceptions: "", "/", and "//". Leave "" alone,
2869 as it's invalid. Append only "." to the other two exceptions as
2870 "/" and "//" are distinct on some platforms, whereas "/", "///",
2871 "////", etc. are all equivalent. */
2876 /* Just check for trailing '/' when deciding whether to append '/'.
2877 That's simpler than testing the two special cases "/" and "//",
2878 and it's a safe optimization here. */
2879 char *buf
= SAFE_ALLOCA (len
+ 3);
2880 memcpy (buf
, file
, len
);
2881 strcpy (buf
+ len
, "/." + (file
[len
- 1] == '/'));
2885 ok
= check_existing (dir
);
2886 saved_errno
= errno
;
2888 errno
= saved_errno
;
2893 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2894 doc
: /* Return t if FILENAME names a regular file.
2895 This is the sort of file that holds an ordinary stream of data bytes.
2896 Symbolic links to regular files count as regular files.
2897 See `file-symlink-p' to distinguish symlinks. */)
2898 (Lisp_Object filename
)
2900 register Lisp_Object absname
;
2902 Lisp_Object handler
;
2904 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2906 /* If the file name has special constructs in it,
2907 call the corresponding file handler. */
2908 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2909 if (!NILP (handler
))
2910 return call2 (handler
, Qfile_regular_p
, absname
);
2912 absname
= ENCODE_FILE (absname
);
2917 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2919 /* Tell stat to use expensive method to get accurate info. */
2920 Vw32_get_true_file_attributes
= Qt
;
2921 result
= stat (SDATA (absname
), &st
);
2922 Vw32_get_true_file_attributes
= tem
;
2926 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2929 if (stat (SSDATA (absname
), &st
) < 0)
2931 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2935 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2936 Sfile_selinux_context
, 1, 1, 0,
2937 doc
: /* Return SELinux context of file named FILENAME.
2938 The return value is a list (USER ROLE TYPE RANGE), where the list
2939 elements are strings naming the user, role, type, and range of the
2940 file's SELinux security context.
2942 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2943 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2944 (Lisp_Object filename
)
2946 Lisp_Object absname
;
2947 Lisp_Object values
[4];
2948 Lisp_Object handler
;
2950 security_context_t con
;
2955 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2957 /* If the file name has special constructs in it,
2958 call the corresponding file handler. */
2959 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2960 if (!NILP (handler
))
2961 return call2 (handler
, Qfile_selinux_context
, absname
);
2963 absname
= ENCODE_FILE (absname
);
2970 if (is_selinux_enabled ())
2972 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2975 context
= context_new (con
);
2976 if (context_user_get (context
))
2977 values
[0] = build_string (context_user_get (context
));
2978 if (context_role_get (context
))
2979 values
[1] = build_string (context_role_get (context
));
2980 if (context_type_get (context
))
2981 values
[2] = build_string (context_type_get (context
));
2982 if (context_range_get (context
))
2983 values
[3] = build_string (context_range_get (context
));
2984 context_free (context
);
2990 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2993 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2994 Sset_file_selinux_context
, 2, 2, 0,
2995 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2996 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2997 elements are strings naming the components of a SELinux context.
2999 Value is t if setting of SELinux context was successful, nil otherwise.
3001 This function does nothing and returns nil if SELinux is disabled,
3002 or if Emacs was not compiled with SELinux support. */)
3003 (Lisp_Object filename
, Lisp_Object context
)
3005 Lisp_Object absname
;
3006 Lisp_Object handler
;
3008 Lisp_Object encoded_absname
;
3009 Lisp_Object user
= CAR_SAFE (context
);
3010 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
3011 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
3012 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
3013 security_context_t con
;
3016 context_t parsed_con
;
3019 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3021 /* If the file name has special constructs in it,
3022 call the corresponding file handler. */
3023 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
3024 if (!NILP (handler
))
3025 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
3028 if (is_selinux_enabled ())
3030 /* Get current file context. */
3031 encoded_absname
= ENCODE_FILE (absname
);
3032 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
3035 parsed_con
= context_new (con
);
3036 /* Change the parts defined in the parameter.*/
3039 if (context_user_set (parsed_con
, SSDATA (user
)))
3040 error ("Doing context_user_set");
3044 if (context_role_set (parsed_con
, SSDATA (role
)))
3045 error ("Doing context_role_set");
3049 if (context_type_set (parsed_con
, SSDATA (type
)))
3050 error ("Doing context_type_set");
3052 if (STRINGP (range
))
3054 if (context_range_set (parsed_con
, SSDATA (range
)))
3055 error ("Doing context_range_set");
3058 /* Set the modified context back to the file. */
3059 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3060 context_str (parsed_con
))
3062 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3063 if (fail
&& errno
!= ENOTSUP
)
3064 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
3066 context_free (parsed_con
);
3068 return fail
? Qnil
: Qt
;
3071 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
3078 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3079 doc
: /* Return ACL entries of file named FILENAME, as a string.
3080 Return nil if file does not exist or is not accessible, or if Emacs
3081 was unable to determine the ACL entries. The latter can happen for
3082 local files if Emacs was not compiled with ACL support, or for remote
3083 files if the file handler returns nil for the file's ACL entries. */)
3084 (Lisp_Object filename
)
3086 Lisp_Object absname
;
3087 Lisp_Object handler
;
3088 #ifdef HAVE_POSIX_ACL
3090 Lisp_Object acl_string
;
3094 absname
= expand_and_dir_to_file (filename
,
3095 BVAR (current_buffer
, directory
));
3097 /* If the file name has special constructs in it,
3098 call the corresponding file handler. */
3099 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3100 if (!NILP (handler
))
3101 return call2 (handler
, Qfile_acl
, absname
);
3103 #ifdef HAVE_POSIX_ACL
3104 absname
= ENCODE_FILE (absname
);
3106 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3110 str
= acl_to_text (acl
, NULL
);
3117 acl_string
= build_string (str
);
3127 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3129 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3130 ACL-STRING should contain the textual representation of the ACL
3131 entries in a format suitable for the platform.
3133 Value is t if setting of ACL was successful, nil otherwise.
3135 Setting ACL for local files requires Emacs to be built with ACL
3137 (Lisp_Object filename
, Lisp_Object acl_string
)
3139 Lisp_Object absname
;
3140 Lisp_Object handler
;
3141 #ifdef HAVE_POSIX_ACL
3142 Lisp_Object encoded_absname
;
3147 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3149 /* If the file name has special constructs in it,
3150 call the corresponding file handler. */
3151 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3152 if (!NILP (handler
))
3153 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3155 #ifdef HAVE_POSIX_ACL
3156 if (STRINGP (acl_string
))
3158 acl
= acl_from_text (SSDATA (acl_string
));
3161 report_file_error ("Converting ACL", Fcons (absname
, Qnil
));
3165 encoded_absname
= ENCODE_FILE (absname
);
3167 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3170 if (fail
&& errno
!= ENOTSUP
)
3171 report_file_error ("Setting ACL", Fcons (absname
, Qnil
));
3174 return fail
? Qnil
: Qt
;
3181 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3182 doc
: /* Return mode bits of file named FILENAME, as an integer.
3183 Return nil, if file does not exist or is not accessible. */)
3184 (Lisp_Object filename
)
3186 Lisp_Object absname
;
3188 Lisp_Object handler
;
3190 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3192 /* If the file name has special constructs in it,
3193 call the corresponding file handler. */
3194 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3195 if (!NILP (handler
))
3196 return call2 (handler
, Qfile_modes
, absname
);
3198 absname
= ENCODE_FILE (absname
);
3200 if (stat (SSDATA (absname
), &st
) < 0)
3203 return make_number (st
.st_mode
& 07777);
3206 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3207 "(let ((file (read-file-name \"File: \"))) \
3208 (list file (read-file-modes nil file)))",
3209 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3210 Only the 12 low bits of MODE are used.
3212 Interactively, mode bits are read by `read-file-modes', which accepts
3213 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3214 (Lisp_Object filename
, Lisp_Object mode
)
3216 Lisp_Object absname
, encoded_absname
;
3217 Lisp_Object handler
;
3219 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3220 CHECK_NUMBER (mode
);
3222 /* If the file name has special constructs in it,
3223 call the corresponding file handler. */
3224 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3225 if (!NILP (handler
))
3226 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3228 encoded_absname
= ENCODE_FILE (absname
);
3230 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3231 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3236 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3237 doc
: /* Set the file permission bits for newly created files.
3238 The argument MODE should be an integer; only the low 9 bits are used.
3239 This setting is inherited by subprocesses. */)
3242 CHECK_NUMBER (mode
);
3244 umask ((~ XINT (mode
)) & 0777);
3249 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3250 doc
: /* Return the default file protection for created files.
3251 The value is an integer. */)
3258 realmask
= umask (0);
3262 XSETINT (value
, (~ realmask
) & 0777);
3267 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3268 doc
: /* Set times of file FILENAME to TIMESTAMP.
3269 Set both access and modification times.
3270 Return t on success, else nil.
3271 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3273 (Lisp_Object filename
, Lisp_Object timestamp
)
3275 Lisp_Object absname
, encoded_absname
;
3276 Lisp_Object handler
;
3277 EMACS_TIME t
= lisp_time_argument (timestamp
);
3279 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3281 /* If the file name has special constructs in it,
3282 call the corresponding file handler. */
3283 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3284 if (!NILP (handler
))
3285 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3287 encoded_absname
= ENCODE_FILE (absname
);
3290 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3293 /* Setting times on a directory always fails. */
3294 if (file_directory_p (SSDATA (encoded_absname
)))
3297 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3306 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3307 doc
: /* Tell Unix to finish all pending disk updates. */)
3314 #endif /* HAVE_SYNC */
3316 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3317 doc
: /* Return t if file FILE1 is newer than file FILE2.
3318 If FILE1 does not exist, the answer is nil;
3319 otherwise, if FILE2 does not exist, the answer is t. */)
3320 (Lisp_Object file1
, Lisp_Object file2
)
3322 Lisp_Object absname1
, absname2
;
3323 struct stat st1
, st2
;
3324 Lisp_Object handler
;
3325 struct gcpro gcpro1
, gcpro2
;
3327 CHECK_STRING (file1
);
3328 CHECK_STRING (file2
);
3331 GCPRO2 (absname1
, file2
);
3332 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3333 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3336 /* If the file name has special constructs in it,
3337 call the corresponding file handler. */
3338 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3340 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3341 if (!NILP (handler
))
3342 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3344 GCPRO2 (absname1
, absname2
);
3345 absname1
= ENCODE_FILE (absname1
);
3346 absname2
= ENCODE_FILE (absname2
);
3349 if (stat (SSDATA (absname1
), &st1
) < 0)
3352 if (stat (SSDATA (absname2
), &st2
) < 0)
3355 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3359 #ifndef READ_BUF_SIZE
3360 #define READ_BUF_SIZE (64 << 10)
3362 /* Some buffer offsets are stored in 'int' variables. */
3363 verify (READ_BUF_SIZE
<= INT_MAX
);
3365 /* This function is called after Lisp functions to decide a coding
3366 system are called, or when they cause an error. Before they are
3367 called, the current buffer is set unibyte and it contains only a
3368 newly inserted text (thus the buffer was empty before the
3371 The functions may set markers, overlays, text properties, or even
3372 alter the buffer contents, change the current buffer.
3374 Here, we reset all those changes by:
3375 o set back the current buffer.
3376 o move all markers and overlays to BEG.
3377 o remove all text properties.
3378 o set back the buffer multibyteness. */
3381 decide_coding_unwind (Lisp_Object unwind_data
)
3383 Lisp_Object multibyte
, undo_list
, buffer
;
3385 multibyte
= XCAR (unwind_data
);
3386 unwind_data
= XCDR (unwind_data
);
3387 undo_list
= XCAR (unwind_data
);
3388 buffer
= XCDR (unwind_data
);
3390 set_buffer_internal (XBUFFER (buffer
));
3391 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3392 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3393 set_buffer_intervals (current_buffer
, NULL
);
3394 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3396 /* Now we are safe to change the buffer's multibyteness directly. */
3397 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3398 bset_undo_list (current_buffer
, undo_list
);
3404 /* Used to pass values from insert-file-contents to read_non_regular. */
3406 static int non_regular_fd
;
3407 static ptrdiff_t non_regular_inserted
;
3408 static int non_regular_nbytes
;
3411 /* Read from a non-regular file.
3412 Read non_regular_nbytes bytes max from non_regular_fd.
3413 Non_regular_inserted specifies where to put the read bytes.
3414 Value is the number of bytes read. */
3417 read_non_regular (Lisp_Object ignore
)
3423 nbytes
= emacs_read (non_regular_fd
,
3424 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3425 + non_regular_inserted
),
3426 non_regular_nbytes
);
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 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3442 except that it also tests for OFFSET being out of lseek's range. */
3444 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3446 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3447 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3448 if (! ((offset
>= TYPE_MINIMUM (off_t
)) & (offset
<= TYPE_MAXIMUM (off_t
))))
3453 return lseek (fd
, offset
, whence
);
3456 /* Return a special time value indicating the error number ERRNUM. */
3458 time_error_value (int errnum
)
3460 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3461 ? NONEXISTENT_MODTIME_NSECS
3462 : UNKNOWN_MODTIME_NSECS
);
3463 return make_emacs_time (0, ns
);
3466 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3468 doc
: /* Insert contents of file FILENAME after point.
3469 Returns list of absolute file name and number of characters inserted.
3470 If second argument VISIT is non-nil, the buffer's visited filename and
3471 last save file modtime are set, and it is marked unmodified. If
3472 visiting and the file does not exist, visiting is completed before the
3475 The optional third and fourth arguments BEG and END specify what portion
3476 of the file to insert. These arguments count bytes in the file, not
3477 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3479 If optional fifth argument REPLACE is non-nil, replace the current
3480 buffer contents (in the accessible portion) with the file contents.
3481 This is better than simply deleting and inserting the whole thing
3482 because (1) it preserves some marker positions and (2) it puts less data
3483 in the undo list. When REPLACE is non-nil, the second return value is
3484 the number of characters that replace previous buffer contents.
3486 This function does code conversion according to the value of
3487 `coding-system-for-read' or `file-coding-system-alist', and sets the
3488 variable `last-coding-system-used' to the coding system actually used.
3490 In addition, this function decodes the inserted text from known formats
3491 by calling `format-decode', which see. */)
3492 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3498 ptrdiff_t inserted
= 0;
3501 off_t beg_offset
, end_offset
;
3503 ptrdiff_t count
= SPECPDL_INDEX ();
3504 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3505 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3507 ptrdiff_t total
= 0;
3508 bool not_regular
= 0;
3510 char read_buf
[READ_BUF_SIZE
];
3511 struct coding_system coding
;
3512 char buffer
[1 << 14];
3513 bool replace_handled
= 0;
3514 bool set_coding_system
= 0;
3515 Lisp_Object coding_system
;
3517 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3518 bool we_locked_file
= 0;
3519 bool deferred_remove_unwind_protect
= 0;
3521 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3522 error ("Cannot do file visiting in an indirect buffer");
3524 if (!NILP (BVAR (current_buffer
, read_only
)))
3525 Fbarf_if_buffer_read_only ();
3529 orig_filename
= Qnil
;
3532 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3534 CHECK_STRING (filename
);
3535 filename
= Fexpand_file_name (filename
, Qnil
);
3537 /* The value Qnil means that the coding system is not yet
3539 coding_system
= Qnil
;
3541 /* If the file name has special constructs in it,
3542 call the corresponding file handler. */
3543 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3544 if (!NILP (handler
))
3546 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3547 visit
, beg
, end
, replace
);
3548 if (CONSP (val
) && CONSP (XCDR (val
))
3549 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3550 inserted
= XINT (XCAR (XCDR (val
)));
3554 orig_filename
= filename
;
3555 filename
= ENCODE_FILE (filename
);
3561 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3563 /* Tell stat to use expensive method to get accurate info. */
3564 Vw32_get_true_file_attributes
= Qt
;
3565 file_status
= stat (SSDATA (filename
), &st
);
3566 Vw32_get_true_file_attributes
= tem
;
3569 file_status
= stat (SSDATA (filename
), &st
);
3570 #endif /* WINDOWSNT */
3572 if (file_status
== 0)
3573 mtime
= get_stat_mtime (&st
);
3579 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3580 mtime
= time_error_value (save_errno
);
3583 if (!NILP (Vcoding_system_for_read
))
3584 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3588 /* This code will need to be changed in order to work on named
3589 pipes, and it's probably just not worth it. So we should at
3590 least signal an error. */
3591 if (!S_ISREG (st
.st_mode
))
3598 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3599 xsignal2 (Qfile_error
,
3600 build_string ("not a regular file"), orig_filename
);
3604 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3607 /* Replacement should preserve point as it preserves markers. */
3608 if (!NILP (replace
))
3609 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3611 record_unwind_protect (close_file_unwind
, make_number (fd
));
3616 if (!NILP (beg
) || !NILP (end
))
3617 error ("Attempt to visit less than an entire file");
3618 if (BEG
< Z
&& NILP (replace
))
3619 error ("Cannot do file visiting in a non-empty buffer");
3624 if (! RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
)))
3625 wrong_type_argument (intern ("file-offset"), beg
);
3626 beg_offset
= XFASTINT (beg
);
3633 if (! RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
)))
3634 wrong_type_argument (intern ("file-offset"), end
);
3635 end_offset
= XFASTINT (end
);
3640 end_offset
= TYPE_MAXIMUM (off_t
);
3643 end_offset
= st
.st_size
;
3645 /* A negative size can happen on a platform that allows file
3646 sizes greater than the maximum off_t value. */
3650 /* The file size returned from stat may be zero, but data
3651 may be readable nonetheless, for example when this is a
3652 file in the /proc filesystem. */
3653 if (end_offset
== 0)
3654 end_offset
= READ_BUF_SIZE
;
3658 /* Check now whether the buffer will become too large,
3659 in the likely case where the file's length is not changing.
3660 This saves a lot of needless work before a buffer overflow. */
3663 /* The likely offset where we will stop reading. We could read
3664 more (or less), if the file grows (or shrinks) as we read it. */
3665 off_t likely_end
= min (end_offset
, st
.st_size
);
3667 if (beg_offset
< likely_end
)
3670 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3671 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3672 off_t likely_growth
= likely_end
- beg_offset
;
3673 if (buf_growth_max
< likely_growth
)
3678 /* Prevent redisplay optimizations. */
3679 current_buffer
->clip_changed
= 1;
3681 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3683 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3684 setup_coding_system (coding_system
, &coding
);
3685 /* Ensure we set Vlast_coding_system_used. */
3686 set_coding_system
= 1;
3690 /* Decide the coding system to use for reading the file now
3691 because we can't use an optimized method for handling
3692 `coding:' tag if the current buffer is not empty. */
3693 if (!NILP (Vcoding_system_for_read
))
3694 coding_system
= Vcoding_system_for_read
;
3697 /* Don't try looking inside a file for a coding system
3698 specification if it is not seekable. */
3699 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3701 /* Find a coding system specified in the heading two
3702 lines or in the tailing several lines of the file.
3703 We assume that the 1K-byte and 3K-byte for heading
3704 and tailing respectively are sufficient for this
3708 if (st
.st_size
<= (1024 * 4))
3709 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3712 nread
= emacs_read (fd
, read_buf
, 1024);
3716 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3717 report_file_error ("Setting file position",
3718 Fcons (orig_filename
, Qnil
));
3719 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3720 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3725 error ("IO error reading %s: %s",
3726 SDATA (orig_filename
), emacs_strerror (errno
));
3729 struct buffer
*prev
= current_buffer
;
3730 Lisp_Object workbuf
;
3733 record_unwind_current_buffer ();
3735 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3736 buf
= XBUFFER (workbuf
);
3738 delete_all_overlays (buf
);
3739 bset_directory (buf
, BVAR (current_buffer
, directory
));
3740 bset_read_only (buf
, Qnil
);
3741 bset_filename (buf
, Qnil
);
3742 bset_undo_list (buf
, Qt
);
3743 eassert (buf
->overlays_before
== NULL
);
3744 eassert (buf
->overlays_after
== NULL
);
3746 set_buffer_internal (buf
);
3748 bset_enable_multibyte_characters (buf
, Qnil
);
3750 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3751 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3752 coding_system
= call2 (Vset_auto_coding_function
,
3753 filename
, make_number (nread
));
3754 set_buffer_internal (prev
);
3756 /* Discard the unwind protect for recovering the
3760 /* Rewind the file for the actual read done later. */
3761 if (lseek (fd
, 0, SEEK_SET
) < 0)
3762 report_file_error ("Setting file position",
3763 Fcons (orig_filename
, Qnil
));
3767 if (NILP (coding_system
))
3769 /* If we have not yet decided a coding system, check
3770 file-coding-system-alist. */
3771 Lisp_Object args
[6];
3773 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3774 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3775 coding_system
= Ffind_operation_coding_system (6, args
);
3776 if (CONSP (coding_system
))
3777 coding_system
= XCAR (coding_system
);
3781 if (NILP (coding_system
))
3782 coding_system
= Qundecided
;
3784 CHECK_CODING_SYSTEM (coding_system
);
3786 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3787 /* We must suppress all character code conversion except for
3788 end-of-line conversion. */
3789 coding_system
= raw_text_coding_system (coding_system
);
3791 setup_coding_system (coding_system
, &coding
);
3792 /* Ensure we set Vlast_coding_system_used. */
3793 set_coding_system
= 1;
3796 /* If requested, replace the accessible part of the buffer
3797 with the file contents. Avoid replacing text at the
3798 beginning or end of the buffer that matches the file contents;
3799 that preserves markers pointing to the unchanged parts.
3801 Here we implement this feature in an optimized way
3802 for the case where code conversion is NOT needed.
3803 The following if-statement handles the case of conversion
3804 in a less optimal way.
3806 If the code conversion is "automatic" then we try using this
3807 method and hope for the best.
3808 But if we discover the need for conversion, we give up on this method
3809 and let the following if-statement handle the replace job. */
3812 && (NILP (coding_system
)
3813 || ! CODING_REQUIRE_DECODING (&coding
)))
3815 /* same_at_start and same_at_end count bytes,
3816 because file access counts bytes
3817 and BEG and END count bytes. */
3818 ptrdiff_t same_at_start
= BEGV_BYTE
;
3819 ptrdiff_t same_at_end
= ZV_BYTE
;
3821 /* There is still a possibility we will find the need to do code
3822 conversion. If that happens, set this variable to
3823 give up on handling REPLACE in the optimized way. */
3824 bool giveup_match_end
= 0;
3826 if (beg_offset
!= 0)
3828 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3829 report_file_error ("Setting file position",
3830 Fcons (orig_filename
, Qnil
));
3835 /* Count how many chars at the start of the file
3836 match the text at the beginning of the buffer. */
3841 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3843 error ("IO error reading %s: %s",
3844 SSDATA (orig_filename
), emacs_strerror (errno
));
3845 else if (nread
== 0)
3848 if (CODING_REQUIRE_DETECTION (&coding
))
3850 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3853 setup_coding_system (coding_system
, &coding
);
3856 if (CODING_REQUIRE_DECODING (&coding
))
3857 /* We found that the file should be decoded somehow.
3858 Let's give up here. */
3860 giveup_match_end
= 1;
3865 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3866 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3867 same_at_start
++, bufpos
++;
3868 /* If we found a discrepancy, stop the scan.
3869 Otherwise loop around and scan the next bufferful. */
3870 if (bufpos
!= nread
)
3874 /* If the file matches the buffer completely,
3875 there's no need to replace anything. */
3876 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3880 /* Truncate the buffer to the size of the file. */
3881 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3886 /* Count how many chars at the end of the file
3887 match the text at the end of the buffer. But, if we have
3888 already found that decoding is necessary, don't waste time. */
3889 while (!giveup_match_end
)
3891 int total_read
, nread
, bufpos
, trial
;
3894 /* At what file position are we now scanning? */
3895 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3896 /* If the entire file matches the buffer tail, stop the scan. */
3899 /* How much can we scan in the next step? */
3900 trial
= min (curpos
, sizeof buffer
);
3901 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3902 report_file_error ("Setting file position",
3903 Fcons (orig_filename
, Qnil
));
3905 total_read
= nread
= 0;
3906 while (total_read
< trial
)
3908 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3910 error ("IO error reading %s: %s",
3911 SDATA (orig_filename
), emacs_strerror (errno
));
3912 else if (nread
== 0)
3914 total_read
+= nread
;
3917 /* Scan this bufferful from the end, comparing with
3918 the Emacs buffer. */
3919 bufpos
= total_read
;
3921 /* Compare with same_at_start to avoid counting some buffer text
3922 as matching both at the file's beginning and at the end. */
3923 while (bufpos
> 0 && same_at_end
> same_at_start
3924 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3925 same_at_end
--, bufpos
--;
3927 /* If we found a discrepancy, stop the scan.
3928 Otherwise loop around and scan the preceding bufferful. */
3931 /* If this discrepancy is because of code conversion,
3932 we cannot use this method; giveup and try the other. */
3933 if (same_at_end
> same_at_start
3934 && FETCH_BYTE (same_at_end
- 1) >= 0200
3935 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3936 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3937 giveup_match_end
= 1;
3946 if (! giveup_match_end
)
3950 /* We win! We can handle REPLACE the optimized way. */
3952 /* Extend the start of non-matching text area to multibyte
3953 character boundary. */
3954 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3955 while (same_at_start
> BEGV_BYTE
3956 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3959 /* Extend the end of non-matching text area to multibyte
3960 character boundary. */
3961 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3962 while (same_at_end
< ZV_BYTE
3963 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3966 /* Don't try to reuse the same piece of text twice. */
3967 overlap
= (same_at_start
- BEGV_BYTE
3969 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3971 same_at_end
+= overlap
;
3973 /* Arrange to read only the nonmatching middle part of the file. */
3974 beg_offset
+= same_at_start
- BEGV_BYTE
;
3975 end_offset
-= ZV_BYTE
- same_at_end
;
3977 del_range_byte (same_at_start
, same_at_end
, 0);
3978 /* Insert from the file at the proper position. */
3979 temp
= BYTE_TO_CHAR (same_at_start
);
3980 SET_PT_BOTH (temp
, same_at_start
);
3982 /* If display currently starts at beginning of line,
3983 keep it that way. */
3984 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3985 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3987 replace_handled
= 1;
3991 /* If requested, replace the accessible part of the buffer
3992 with the file contents. Avoid replacing text at the
3993 beginning or end of the buffer that matches the file contents;
3994 that preserves markers pointing to the unchanged parts.
3996 Here we implement this feature for the case where code conversion
3997 is needed, in a simple way that needs a lot of memory.
3998 The preceding if-statement handles the case of no conversion
3999 in a more optimized way. */
4000 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
4002 ptrdiff_t same_at_start
= BEGV_BYTE
;
4003 ptrdiff_t same_at_end
= ZV_BYTE
;
4004 ptrdiff_t same_at_start_charpos
;
4005 ptrdiff_t inserted_chars
;
4008 unsigned char *decoded
;
4011 ptrdiff_t this_count
= SPECPDL_INDEX ();
4013 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4014 Lisp_Object conversion_buffer
;
4015 struct gcpro gcpro1
;
4017 conversion_buffer
= code_conversion_save (1, multibyte
);
4019 /* First read the whole file, performing code conversion into
4020 CONVERSION_BUFFER. */
4022 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4023 report_file_error ("Setting file position",
4024 Fcons (orig_filename
, Qnil
));
4026 total
= st
.st_size
; /* Total bytes in the file. */
4027 how_much
= 0; /* Bytes read from file so far. */
4028 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4029 unprocessed
= 0; /* Bytes not processed in previous loop. */
4031 GCPRO1 (conversion_buffer
);
4032 while (how_much
< total
)
4034 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
4035 quitting while reading a huge while. */
4036 /* `try'' is reserved in some compilers (Microsoft C). */
4037 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
4039 /* Allow quitting out of the actual I/O. */
4042 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
4050 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
4051 BUF_Z (XBUFFER (conversion_buffer
)));
4052 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4053 unprocessed
+ this, conversion_buffer
);
4054 unprocessed
= coding
.carryover_bytes
;
4055 if (coding
.carryover_bytes
> 0)
4056 memcpy (read_buf
, coding
.carryover
, unprocessed
);
4061 /* We should remove the unwind_protect calling
4062 close_file_unwind, but other stuff has been added the stack,
4063 so defer the removal till we reach the `handled' label. */
4064 deferred_remove_unwind_protect
= 1;
4066 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
4067 if we couldn't read the file. */
4070 error ("IO error reading %s: %s",
4071 SDATA (orig_filename
), emacs_strerror (errno
));
4073 if (unprocessed
> 0)
4075 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4076 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4077 unprocessed
, conversion_buffer
);
4078 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4081 coding_system
= CODING_ID_NAME (coding
.id
);
4082 set_coding_system
= 1;
4083 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4084 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4085 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4087 /* Compare the beginning of the converted string with the buffer
4091 while (bufpos
< inserted
&& same_at_start
< same_at_end
4092 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4093 same_at_start
++, bufpos
++;
4095 /* If the file matches the head of buffer completely,
4096 there's no need to replace anything. */
4098 if (bufpos
== inserted
)
4100 /* Truncate the buffer to the size of the file. */
4101 if (same_at_start
== same_at_end
)
4104 del_range_byte (same_at_start
, same_at_end
, 0);
4107 unbind_to (this_count
, Qnil
);
4111 /* Extend the start of non-matching text area to the previous
4112 multibyte character boundary. */
4113 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4114 while (same_at_start
> BEGV_BYTE
4115 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4118 /* Scan this bufferful from the end, comparing with
4119 the Emacs buffer. */
4122 /* Compare with same_at_start to avoid counting some buffer text
4123 as matching both at the file's beginning and at the end. */
4124 while (bufpos
> 0 && same_at_end
> same_at_start
4125 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4126 same_at_end
--, bufpos
--;
4128 /* Extend the end of non-matching text area to the next
4129 multibyte character boundary. */
4130 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4131 while (same_at_end
< ZV_BYTE
4132 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4135 /* Don't try to reuse the same piece of text twice. */
4136 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4138 same_at_end
+= overlap
;
4140 /* If display currently starts at beginning of line,
4141 keep it that way. */
4142 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4143 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4145 /* Replace the chars that we need to replace,
4146 and update INSERTED to equal the number of bytes
4147 we are taking from the decoded string. */
4148 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4150 if (same_at_end
!= same_at_start
)
4152 del_range_byte (same_at_start
, same_at_end
, 0);
4154 same_at_start
= GPT_BYTE
;
4158 temp
= BYTE_TO_CHAR (same_at_start
);
4160 /* Insert from the file at the proper position. */
4161 SET_PT_BOTH (temp
, same_at_start
);
4162 same_at_start_charpos
4163 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4164 same_at_start
- BEGV_BYTE
4165 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4167 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4168 same_at_start
+ inserted
- BEGV_BYTE
4169 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4170 - same_at_start_charpos
);
4171 /* This binding is to avoid ask-user-about-supersession-threat
4172 being called in insert_from_buffer (via in
4173 prepare_to_modify_buffer). */
4174 specbind (intern ("buffer-file-name"), Qnil
);
4175 insert_from_buffer (XBUFFER (conversion_buffer
),
4176 same_at_start_charpos
, inserted_chars
, 0);
4177 /* Set `inserted' to the number of inserted characters. */
4178 inserted
= PT
- temp
;
4179 /* Set point before the inserted characters. */
4180 SET_PT_BOTH (temp
, same_at_start
);
4182 unbind_to (this_count
, Qnil
);
4188 total
= end_offset
- beg_offset
;
4190 /* For a special file, all we can do is guess. */
4191 total
= READ_BUF_SIZE
;
4193 if (NILP (visit
) && total
> 0)
4195 #ifdef CLASH_DETECTION
4196 if (!NILP (BVAR (current_buffer
, file_truename
))
4197 /* Make binding buffer-file-name to nil effective. */
4198 && !NILP (BVAR (current_buffer
, filename
))
4199 && SAVE_MODIFF
>= MODIFF
)
4201 #endif /* CLASH_DETECTION */
4202 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4205 move_gap_both (PT
, PT_BYTE
);
4206 if (GAP_SIZE
< total
)
4207 make_gap (total
- GAP_SIZE
);
4209 if (beg_offset
!= 0 || !NILP (replace
))
4211 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4212 report_file_error ("Setting file position",
4213 Fcons (orig_filename
, Qnil
));
4216 /* In the following loop, HOW_MUCH contains the total bytes read so
4217 far for a regular file, and not changed for a special file. But,
4218 before exiting the loop, it is set to a negative value if I/O
4222 /* Total bytes inserted. */
4225 /* Here, we don't do code conversion in the loop. It is done by
4226 decode_coding_gap after all data are read into the buffer. */
4228 ptrdiff_t gap_size
= GAP_SIZE
;
4230 while (how_much
< total
)
4232 /* try is reserved in some compilers (Microsoft C) */
4233 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4240 /* Maybe make more room. */
4241 if (gap_size
< trytry
)
4243 make_gap (total
- gap_size
);
4244 gap_size
= GAP_SIZE
;
4247 /* Read from the file, capturing `quit'. When an
4248 error occurs, end the loop, and arrange for a quit
4249 to be signaled after decoding the text we read. */
4250 non_regular_fd
= fd
;
4251 non_regular_inserted
= inserted
;
4252 non_regular_nbytes
= trytry
;
4253 nbytes
= internal_condition_case_1 (read_non_regular
,
4255 read_non_regular_quit
);
4262 this = XINT (nbytes
);
4266 /* Allow quitting out of the actual I/O. We don't make text
4267 part of the buffer until all the reading is done, so a C-g
4268 here doesn't do any harm. */
4271 this = emacs_read (fd
,
4272 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4286 /* For a regular file, where TOTAL is the real size,
4287 count HOW_MUCH to compare with it.
4288 For a special file, where TOTAL is just a buffer size,
4289 so don't bother counting in HOW_MUCH.
4290 (INSERTED is where we count the number of characters inserted.) */
4297 /* Now we have read all the file data into the gap.
4298 If it was empty, undo marking the buffer modified. */
4302 #ifdef CLASH_DETECTION
4304 unlock_file (BVAR (current_buffer
, file_truename
));
4306 Vdeactivate_mark
= old_Vdeactivate_mark
;
4309 Vdeactivate_mark
= Qt
;
4311 /* Make the text read part of the buffer. */
4312 GAP_SIZE
-= inserted
;
4314 GPT_BYTE
+= inserted
;
4316 ZV_BYTE
+= inserted
;
4321 /* Put an anchor to ensure multi-byte form ends at gap. */
4326 /* Discard the unwind protect for closing the file. */
4330 error ("IO error reading %s: %s",
4331 SDATA (orig_filename
), emacs_strerror (errno
));
4335 if (NILP (coding_system
))
4337 /* The coding system is not yet decided. Decide it by an
4338 optimized method for handling `coding:' tag.
4340 Note that we can get here only if the buffer was empty
4341 before the insertion. */
4343 if (!NILP (Vcoding_system_for_read
))
4344 coding_system
= Vcoding_system_for_read
;
4347 /* Since we are sure that the current buffer was empty
4348 before the insertion, we can toggle
4349 enable-multibyte-characters directly here without taking
4350 care of marker adjustment. By this way, we can run Lisp
4351 program safely before decoding the inserted text. */
4352 Lisp_Object unwind_data
;
4353 ptrdiff_t count1
= SPECPDL_INDEX ();
4355 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4356 Fcons (BVAR (current_buffer
, undo_list
),
4357 Fcurrent_buffer ()));
4358 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4359 bset_undo_list (current_buffer
, Qt
);
4360 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4362 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4364 coding_system
= call2 (Vset_auto_coding_function
,
4365 filename
, make_number (inserted
));
4368 if (NILP (coding_system
))
4370 /* If the coding system is not yet decided, check
4371 file-coding-system-alist. */
4372 Lisp_Object args
[6];
4374 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4375 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4376 coding_system
= Ffind_operation_coding_system (6, args
);
4377 if (CONSP (coding_system
))
4378 coding_system
= XCAR (coding_system
);
4380 unbind_to (count1
, Qnil
);
4381 inserted
= Z_BYTE
- BEG_BYTE
;
4384 if (NILP (coding_system
))
4385 coding_system
= Qundecided
;
4387 CHECK_CODING_SYSTEM (coding_system
);
4389 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4390 /* We must suppress all character code conversion except for
4391 end-of-line conversion. */
4392 coding_system
= raw_text_coding_system (coding_system
);
4393 setup_coding_system (coding_system
, &coding
);
4394 /* Ensure we set Vlast_coding_system_used. */
4395 set_coding_system
= 1;
4400 /* When we visit a file by raw-text, we change the buffer to
4402 if (CODING_FOR_UNIBYTE (&coding
)
4403 /* Can't do this if part of the buffer might be preserved. */
4405 /* Visiting a file with these coding system makes the buffer
4407 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4410 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4411 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4412 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4414 move_gap_both (PT
, PT_BYTE
);
4415 GAP_SIZE
+= inserted
;
4416 ZV_BYTE
-= inserted
;
4420 decode_coding_gap (&coding
, inserted
, inserted
);
4421 inserted
= coding
.produced_char
;
4422 coding_system
= CODING_ID_NAME (coding
.id
);
4424 else if (inserted
> 0)
4425 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4428 /* Call after-change hooks for the inserted text, aside from the case
4429 of normal visiting (not with REPLACE), which is done in a new buffer
4430 "before" the buffer is changed. */
4431 if (inserted
> 0 && total
> 0
4432 && (NILP (visit
) || !NILP (replace
)))
4434 signal_after_change (PT
, 0, inserted
);
4435 update_compositions (PT
, PT
, CHECK_BORDER
);
4438 /* Now INSERTED is measured in characters. */
4442 if (deferred_remove_unwind_protect
)
4443 /* If requested above, discard the unwind protect for closing the
4449 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4450 bset_undo_list (current_buffer
, Qnil
);
4454 current_buffer
->modtime
= mtime
;
4455 current_buffer
->modtime_size
= st
.st_size
;
4456 bset_filename (current_buffer
, orig_filename
);
4459 SAVE_MODIFF
= MODIFF
;
4460 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4461 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4462 #ifdef CLASH_DETECTION
4465 if (!NILP (BVAR (current_buffer
, file_truename
)))
4466 unlock_file (BVAR (current_buffer
, file_truename
));
4467 unlock_file (filename
);
4469 #endif /* CLASH_DETECTION */
4471 xsignal2 (Qfile_error
,
4472 build_string ("not a regular file"), orig_filename
);
4475 if (set_coding_system
)
4476 Vlast_coding_system_used
= coding_system
;
4478 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4480 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4482 if (! NILP (insval
))
4484 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4485 wrong_type_argument (intern ("inserted-chars"), insval
);
4486 inserted
= XFASTINT (insval
);
4490 /* Decode file format. */
4493 /* Don't run point motion or modification hooks when decoding. */
4494 ptrdiff_t count1
= SPECPDL_INDEX ();
4495 ptrdiff_t old_inserted
= inserted
;
4496 specbind (Qinhibit_point_motion_hooks
, Qt
);
4497 specbind (Qinhibit_modification_hooks
, Qt
);
4499 /* Save old undo list and don't record undo for decoding. */
4500 old_undo
= BVAR (current_buffer
, undo_list
);
4501 bset_undo_list (current_buffer
, Qt
);
4505 insval
= call3 (Qformat_decode
,
4506 Qnil
, make_number (inserted
), visit
);
4507 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4508 wrong_type_argument (intern ("inserted-chars"), insval
);
4509 inserted
= XFASTINT (insval
);
4513 /* If REPLACE is non-nil and we succeeded in not replacing the
4514 beginning or end of the buffer text with the file's contents,
4515 call format-decode with `point' positioned at the beginning
4516 of the buffer and `inserted' equaling the number of
4517 characters in the buffer. Otherwise, format-decode might
4518 fail to correctly analyze the beginning or end of the buffer.
4519 Hence we temporarily save `point' and `inserted' here and
4520 restore `point' iff format-decode did not insert or delete
4521 any text. Otherwise we leave `point' at point-min. */
4522 ptrdiff_t opoint
= PT
;
4523 ptrdiff_t opoint_byte
= PT_BYTE
;
4524 ptrdiff_t oinserted
= ZV
- BEGV
;
4525 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4527 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4528 insval
= call3 (Qformat_decode
,
4529 Qnil
, make_number (oinserted
), visit
);
4530 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4531 wrong_type_argument (intern ("inserted-chars"), insval
);
4532 if (ochars_modiff
== CHARS_MODIFF
)
4533 /* format_decode didn't modify buffer's characters => move
4534 point back to position before inserted text and leave
4535 value of inserted alone. */
4536 SET_PT_BOTH (opoint
, opoint_byte
);
4538 /* format_decode modified buffer's characters => consider
4539 entire buffer changed and leave point at point-min. */
4540 inserted
= XFASTINT (insval
);
4543 /* For consistency with format-decode call these now iff inserted > 0
4544 (martin 2007-06-28). */
4545 p
= Vafter_insert_file_functions
;
4550 insval
= call1 (XCAR (p
), make_number (inserted
));
4553 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4554 wrong_type_argument (intern ("inserted-chars"), insval
);
4555 inserted
= XFASTINT (insval
);
4560 /* For the rationale of this see the comment on
4561 format-decode above. */
4562 ptrdiff_t opoint
= PT
;
4563 ptrdiff_t opoint_byte
= PT_BYTE
;
4564 ptrdiff_t oinserted
= ZV
- BEGV
;
4565 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4567 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4568 insval
= call1 (XCAR (p
), make_number (oinserted
));
4571 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4572 wrong_type_argument (intern ("inserted-chars"), insval
);
4573 if (ochars_modiff
== CHARS_MODIFF
)
4574 /* after_insert_file_functions didn't modify
4575 buffer's characters => move point back to
4576 position before inserted text and leave value of
4578 SET_PT_BOTH (opoint
, opoint_byte
);
4580 /* after_insert_file_functions did modify buffer's
4581 characters => consider entire buffer changed and
4582 leave point at point-min. */
4583 inserted
= XFASTINT (insval
);
4593 bset_undo_list (current_buffer
, old_undo
);
4594 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4596 /* Adjust the last undo record for the size change during
4597 the format conversion. */
4598 Lisp_Object tem
= XCAR (old_undo
);
4599 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4600 && INTEGERP (XCDR (tem
))
4601 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4602 XSETCDR (tem
, make_number (PT
+ inserted
));
4606 /* If undo_list was Qt before, keep it that way.
4607 Otherwise start with an empty undo_list. */
4608 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4610 unbind_to (count1
, Qnil
);
4614 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4616 /* If visiting nonexistent file, return nil. */
4618 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4622 Fsignal (Qquit
, Qnil
);
4624 /* ??? Retval needs to be dealt with in all cases consistently. */
4626 val
= Fcons (orig_filename
,
4627 Fcons (make_number (inserted
),
4630 RETURN_UNGCPRO (unbind_to (count
, val
));
4633 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4636 build_annotations_unwind (Lisp_Object arg
)
4638 Vwrite_region_annotation_buffers
= arg
;
4642 /* Decide the coding-system to encode the data with. */
4645 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4646 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4647 struct coding_system
*coding
)
4650 Lisp_Object eol_parent
= Qnil
;
4653 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4654 BVAR (current_buffer
, auto_save_file_name
))))
4659 else if (!NILP (Vcoding_system_for_write
))
4661 val
= Vcoding_system_for_write
;
4662 if (coding_system_require_warning
4663 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4664 /* Confirm that VAL can surely encode the current region. */
4665 val
= call5 (Vselect_safe_coding_system_function
,
4666 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4671 /* If the variable `buffer-file-coding-system' is set locally,
4672 it means that the file was read with some kind of code
4673 conversion or the variable is explicitly set by users. We
4674 had better write it out with the same coding system even if
4675 `enable-multibyte-characters' is nil.
4677 If it is not set locally, we anyway have to convert EOL
4678 format if the default value of `buffer-file-coding-system'
4679 tells that it is not Unix-like (LF only) format. */
4680 bool using_default_coding
= 0;
4681 bool force_raw_text
= 0;
4683 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4685 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4688 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4694 /* Check file-coding-system-alist. */
4695 Lisp_Object args
[7], coding_systems
;
4697 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4698 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4700 coding_systems
= Ffind_operation_coding_system (7, args
);
4701 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4702 val
= XCDR (coding_systems
);
4707 /* If we still have not decided a coding system, use the
4708 default value of buffer-file-coding-system. */
4709 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4710 using_default_coding
= 1;
4713 if (! NILP (val
) && ! force_raw_text
)
4715 Lisp_Object spec
, attrs
;
4717 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4718 attrs
= AREF (spec
, 0);
4719 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4724 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4725 /* Confirm that VAL can surely encode the current region. */
4726 val
= call5 (Vselect_safe_coding_system_function
,
4727 start
, end
, val
, Qnil
, filename
);
4729 /* If the decided coding-system doesn't specify end-of-line
4730 format, we use that of
4731 `default-buffer-file-coding-system'. */
4732 if (! using_default_coding
4733 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4734 val
= (coding_inherit_eol_type
4735 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4737 /* If we decide not to encode text, use `raw-text' or one of its
4740 val
= raw_text_coding_system (val
);
4743 val
= coding_inherit_eol_type (val
, eol_parent
);
4744 setup_coding_system (val
, coding
);
4746 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4747 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4751 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4752 "r\nFWrite region to file: \ni\ni\ni\np",
4753 doc
: /* Write current region into specified file.
4754 When called from a program, requires three arguments:
4755 START, END and FILENAME. START and END are normally buffer positions
4756 specifying the part of the buffer to write.
4757 If START is nil, that means to use the entire buffer contents.
4758 If START is a string, then output that string to the file
4759 instead of any buffer contents; END is ignored.
4761 Optional fourth argument APPEND if non-nil means
4762 append to existing file contents (if any). If it is an integer,
4763 seek to that offset in the file before writing.
4764 Optional fifth argument VISIT, if t or a string, means
4765 set the last-save-file-modtime of buffer to this file's modtime
4766 and mark buffer not modified.
4767 If VISIT is a string, it is a second file name;
4768 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4769 VISIT is also the file name to lock and unlock for clash detection.
4770 If VISIT is neither t nor nil nor a string,
4771 that means do not display the \"Wrote file\" message.
4772 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4773 use for locking and unlocking, overriding FILENAME and VISIT.
4774 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4775 for an existing file with the same name. If MUSTBENEW is `excl',
4776 that means to get an error if the file already exists; never overwrite.
4777 If MUSTBENEW is neither nil nor `excl', that means ask for
4778 confirmation before overwriting, but do go ahead and overwrite the file
4779 if the user confirms.
4781 This does code conversion according to the value of
4782 `coding-system-for-write', `buffer-file-coding-system', or
4783 `file-coding-system-alist', and sets the variable
4784 `last-coding-system-used' to the coding system actually used.
4786 This calls `write-region-annotate-functions' at the start, and
4787 `write-region-post-annotation-function' at the end. */)
4788 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4796 ptrdiff_t count
= SPECPDL_INDEX ();
4798 Lisp_Object handler
;
4799 Lisp_Object visit_file
;
4800 Lisp_Object annotations
;
4801 Lisp_Object encoded_filename
;
4802 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4803 bool quietly
= !NILP (visit
);
4804 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4805 struct buffer
*given_buffer
;
4806 struct coding_system coding
;
4808 if (current_buffer
->base_buffer
&& visiting
)
4809 error ("Cannot do file visiting in an indirect buffer");
4811 if (!NILP (start
) && !STRINGP (start
))
4812 validate_region (&start
, &end
);
4815 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4817 filename
= Fexpand_file_name (filename
, Qnil
);
4819 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4820 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4822 if (STRINGP (visit
))
4823 visit_file
= Fexpand_file_name (visit
, Qnil
);
4825 visit_file
= filename
;
4827 if (NILP (lockname
))
4828 lockname
= visit_file
;
4832 /* If the file name has special constructs in it,
4833 call the corresponding file handler. */
4834 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4835 /* If FILENAME has no handler, see if VISIT has one. */
4836 if (NILP (handler
) && STRINGP (visit
))
4837 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4839 if (!NILP (handler
))
4842 val
= call6 (handler
, Qwrite_region
, start
, end
,
4843 filename
, append
, visit
);
4847 SAVE_MODIFF
= MODIFF
;
4848 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4849 bset_filename (current_buffer
, visit_file
);
4855 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4857 /* Special kludge to simplify auto-saving. */
4860 /* Do it later, so write-region-annotate-function can work differently
4861 if we save "the buffer" vs "a region".
4862 This is useful in tar-mode. --Stef
4863 XSETFASTINT (start, BEG);
4864 XSETFASTINT (end, Z); */
4868 record_unwind_protect (build_annotations_unwind
,
4869 Vwrite_region_annotation_buffers
);
4870 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4871 count1
= SPECPDL_INDEX ();
4873 given_buffer
= current_buffer
;
4875 if (!STRINGP (start
))
4877 annotations
= build_annotations (start
, end
);
4879 if (current_buffer
!= given_buffer
)
4881 XSETFASTINT (start
, BEGV
);
4882 XSETFASTINT (end
, ZV
);
4888 XSETFASTINT (start
, BEGV
);
4889 XSETFASTINT (end
, ZV
);
4894 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4896 /* Decide the coding-system to encode the data with.
4897 We used to make this choice before calling build_annotations, but that
4898 leads to problems when a write-annotate-function takes care of
4899 unsavable chars (as was the case with X-Symbol). */
4900 Vlast_coding_system_used
4901 = choose_write_coding_system (start
, end
, filename
,
4902 append
, visit
, lockname
, &coding
);
4904 #ifdef CLASH_DETECTION
4906 lock_file (lockname
);
4907 #endif /* CLASH_DETECTION */
4909 encoded_filename
= ENCODE_FILE (filename
);
4911 fn
= SSDATA (encoded_filename
);
4915 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4916 #else /* not DOS_NT */
4917 desc
= emacs_open (fn
, O_WRONLY
, 0);
4918 #endif /* not DOS_NT */
4920 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4922 desc
= emacs_open (fn
,
4923 O_WRONLY
| O_CREAT
| O_BINARY
4924 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4925 S_IREAD
| S_IWRITE
);
4926 #else /* not DOS_NT */
4927 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4928 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4929 auto_saving
? auto_save_mode_bits
: 0666);
4930 #endif /* not DOS_NT */
4934 #ifdef CLASH_DETECTION
4936 if (!auto_saving
) unlock_file (lockname
);
4938 #endif /* CLASH_DETECTION */
4940 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4943 record_unwind_protect (close_file_unwind
, make_number (desc
));
4945 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4949 if (NUMBERP (append
))
4950 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4952 ret
= lseek (desc
, 0, SEEK_END
);
4955 #ifdef CLASH_DETECTION
4957 if (!auto_saving
) unlock_file (lockname
);
4959 #endif /* CLASH_DETECTION */
4961 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4969 if (STRINGP (start
))
4970 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4971 else if (XINT (start
) != XINT (end
))
4972 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4973 &annotations
, &coding
);
4976 /* If file was empty, still need to write the annotations. */
4977 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4978 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4982 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4983 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4985 /* We have to flush out a data. */
4986 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4987 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4994 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4995 Disk full in NFS may be reported here. */
4996 /* mib says that closing the file will try to write as fast as NFS can do
4997 it, and that means the fsync here is not crucial for autosave files. */
4998 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
5000 /* If fsync fails with EINTR, don't treat that as serious. Also
5001 ignore EINVAL which happens when fsync is not supported on this
5003 if (errno
!= EINTR
&& errno
!= EINVAL
)
5004 ok
= 0, save_errno
= errno
;
5008 modtime
= invalid_emacs_time ();
5011 if (fstat (desc
, &st
) == 0)
5012 modtime
= get_stat_mtime (&st
);
5014 ok
= 0, save_errno
= errno
;
5017 /* NFS can report a write failure now. */
5018 if (emacs_close (desc
) < 0)
5019 ok
= 0, save_errno
= errno
;
5021 /* Discard the unwind protect for close_file_unwind. */
5022 specpdl_ptr
= specpdl
+ count1
;
5024 /* Call write-region-post-annotation-function. */
5025 while (CONSP (Vwrite_region_annotation_buffers
))
5027 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5028 if (!NILP (Fbuffer_live_p (buf
)))
5031 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5032 call0 (Vwrite_region_post_annotation_function
);
5034 Vwrite_region_annotation_buffers
5035 = XCDR (Vwrite_region_annotation_buffers
);
5038 unbind_to (count
, Qnil
);
5040 #ifdef CLASH_DETECTION
5042 unlock_file (lockname
);
5043 #endif /* CLASH_DETECTION */
5045 /* Do this before reporting IO error
5046 to avoid a "file has changed on disk" warning on
5047 next attempt to save. */
5048 if (EMACS_TIME_VALID_P (modtime
))
5050 current_buffer
->modtime
= modtime
;
5051 current_buffer
->modtime_size
= st
.st_size
;
5055 error ("IO error writing %s: %s", SDATA (filename
),
5056 emacs_strerror (save_errno
));
5060 SAVE_MODIFF
= MODIFF
;
5061 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5062 bset_filename (current_buffer
, visit_file
);
5063 update_mode_lines
++;
5068 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5069 BVAR (current_buffer
, auto_save_file_name
))))
5070 SAVE_MODIFF
= MODIFF
;
5076 message_with_string ((INTEGERP (append
)
5086 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
5088 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5089 doc
: /* Return t if (car A) is numerically less than (car B). */)
5090 (Lisp_Object a
, Lisp_Object b
)
5092 return Flss (Fcar (a
), Fcar (b
));
5095 /* Build the complete list of annotations appropriate for writing out
5096 the text between START and END, by calling all the functions in
5097 write-region-annotate-functions and merging the lists they return.
5098 If one of these functions switches to a different buffer, we assume
5099 that buffer contains altered text. Therefore, the caller must
5100 make sure to restore the current buffer in all cases,
5101 as save-excursion would do. */
5104 build_annotations (Lisp_Object start
, Lisp_Object end
)
5106 Lisp_Object annotations
;
5108 struct gcpro gcpro1
, gcpro2
;
5109 Lisp_Object original_buffer
;
5111 bool used_global
= 0;
5113 XSETBUFFER (original_buffer
, current_buffer
);
5116 p
= Vwrite_region_annotate_functions
;
5117 GCPRO2 (annotations
, p
);
5120 struct buffer
*given_buffer
= current_buffer
;
5121 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5122 { /* Use the global value of the hook. */
5125 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5127 p
= Fappend (2, arg
);
5130 Vwrite_region_annotations_so_far
= annotations
;
5131 res
= call2 (XCAR (p
), start
, end
);
5132 /* If the function makes a different buffer current,
5133 assume that means this buffer contains altered text to be output.
5134 Reset START and END from the buffer bounds
5135 and discard all previous annotations because they should have
5136 been dealt with by this function. */
5137 if (current_buffer
!= given_buffer
)
5139 Vwrite_region_annotation_buffers
5140 = Fcons (Fcurrent_buffer (),
5141 Vwrite_region_annotation_buffers
);
5142 XSETFASTINT (start
, BEGV
);
5143 XSETFASTINT (end
, ZV
);
5146 Flength (res
); /* Check basic validity of return value */
5147 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5151 /* Now do the same for annotation functions implied by the file-format */
5152 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5153 p
= BVAR (current_buffer
, auto_save_file_format
);
5155 p
= BVAR (current_buffer
, file_format
);
5156 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5158 struct buffer
*given_buffer
= current_buffer
;
5160 Vwrite_region_annotations_so_far
= annotations
;
5162 /* Value is either a list of annotations or nil if the function
5163 has written annotations to a temporary buffer, which is now
5165 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5166 original_buffer
, make_number (i
));
5167 if (current_buffer
!= given_buffer
)
5169 XSETFASTINT (start
, BEGV
);
5170 XSETFASTINT (end
, ZV
);
5175 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5183 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5184 If STRING is nil, POS is the character position in the current buffer.
5185 Intersperse with them the annotations from *ANNOT
5186 which fall within the range of POS to POS + NCHARS,
5187 each at its appropriate position.
5189 We modify *ANNOT by discarding elements as we use them up.
5191 Return true if successful. */
5194 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5195 ptrdiff_t nchars
, Lisp_Object
*annot
,
5196 struct coding_system
*coding
)
5200 ptrdiff_t lastpos
= pos
+ nchars
;
5202 while (NILP (*annot
) || CONSP (*annot
))
5204 tem
= Fcar_safe (Fcar (*annot
));
5207 nextpos
= XFASTINT (tem
);
5209 /* If there are no more annotations in this range,
5210 output the rest of the range all at once. */
5211 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5212 return e_write (desc
, string
, pos
, lastpos
, coding
);
5214 /* Output buffer text up to the next annotation's position. */
5217 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5221 /* Output the annotation. */
5222 tem
= Fcdr (Fcar (*annot
));
5225 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5228 *annot
= Fcdr (*annot
);
5234 /* Write text in the range START and END into descriptor DESC,
5235 encoding them with coding system CODING. If STRING is nil, START
5236 and END are character positions of the current buffer, else they
5237 are indexes to the string STRING. Return true if successful. */
5240 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5241 struct coding_system
*coding
)
5243 if (STRINGP (string
))
5246 end
= SCHARS (string
);
5249 /* We used to have a code for handling selective display here. But,
5250 now it is handled within encode_coding. */
5254 if (STRINGP (string
))
5256 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5257 if (CODING_REQUIRE_ENCODING (coding
))
5259 encode_coding_object (coding
, string
,
5260 start
, string_char_to_byte (string
, start
),
5261 end
, string_char_to_byte (string
, end
), Qt
);
5265 coding
->dst_object
= string
;
5266 coding
->consumed_char
= SCHARS (string
);
5267 coding
->produced
= SBYTES (string
);
5272 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5273 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5275 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5276 if (CODING_REQUIRE_ENCODING (coding
))
5278 encode_coding_object (coding
, Fcurrent_buffer (),
5279 start
, start_byte
, end
, end_byte
, Qt
);
5283 coding
->dst_object
= Qnil
;
5284 coding
->dst_pos_byte
= start_byte
;
5285 if (start
>= GPT
|| end
<= GPT
)
5287 coding
->consumed_char
= end
- start
;
5288 coding
->produced
= end_byte
- start_byte
;
5292 coding
->consumed_char
= GPT
- start
;
5293 coding
->produced
= GPT_BYTE
- start_byte
;
5298 if (coding
->produced
> 0)
5301 -= emacs_write (desc
,
5302 STRINGP (coding
->dst_object
)
5303 ? SSDATA (coding
->dst_object
)
5304 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5307 if (coding
->produced
)
5310 start
+= coding
->consumed_char
;
5316 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5317 Sverify_visited_file_modtime
, 0, 1, 0,
5318 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5319 This means that the file has not been changed since it was visited or saved.
5320 If BUF is omitted or nil, it defaults to the current buffer.
5321 See Info node `(elisp)Modification Time' for more details. */)
5326 Lisp_Object handler
;
5327 Lisp_Object filename
;
5338 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5339 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5341 /* If the file name has special constructs in it,
5342 call the corresponding file handler. */
5343 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5344 Qverify_visited_file_modtime
);
5345 if (!NILP (handler
))
5346 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5348 filename
= ENCODE_FILE (BVAR (b
, filename
));
5350 mtime
= (stat (SSDATA (filename
), &st
) == 0
5351 ? get_stat_mtime (&st
)
5352 : time_error_value (errno
));
5353 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5354 && (b
->modtime_size
< 0
5355 || st
.st_size
== b
->modtime_size
))
5360 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5361 Sclear_visited_file_modtime
, 0, 0, 0,
5362 doc
: /* Clear out records of last mod time of visited file.
5363 Next attempt to save will certainly not complain of a discrepancy. */)
5366 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5367 current_buffer
->modtime_size
= -1;
5371 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5372 Svisited_file_modtime
, 0, 0, 0,
5373 doc
: /* Return the current buffer's recorded visited file modification time.
5374 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5375 `file-attributes' returns. If the current buffer has no recorded file
5376 modification time, this function returns 0. If the visited file
5377 doesn't exist, HIGH will be -1.
5378 See Info node `(elisp)Modification Time' for more details. */)
5381 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5383 if (EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
5385 /* make_lisp_time won't work here if time_t is unsigned. */
5386 return list4 (make_number (-1), make_number (65535),
5387 make_number (0), make_number (0));
5389 return make_number (0);
5391 return make_lisp_time (current_buffer
->modtime
);
5394 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5395 Sset_visited_file_modtime
, 0, 1, 0,
5396 doc
: /* Update buffer's recorded modification time from the visited file's time.
5397 Useful if the buffer was not read from the file normally
5398 or if the file itself has been changed for some known benign reason.
5399 An argument specifies the modification time value to use
5400 \(instead of that of the visited file), in the form of a list
5401 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5402 (Lisp_Object time_list
)
5404 if (!NILP (time_list
))
5406 current_buffer
->modtime
= lisp_time_argument (time_list
);
5407 current_buffer
->modtime_size
= -1;
5411 register Lisp_Object filename
;
5413 Lisp_Object handler
;
5415 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5417 /* If the file name has special constructs in it,
5418 call the corresponding file handler. */
5419 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5420 if (!NILP (handler
))
5421 /* The handler can find the file name the same way we did. */
5422 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5424 filename
= ENCODE_FILE (filename
);
5426 if (stat (SSDATA (filename
), &st
) >= 0)
5428 current_buffer
->modtime
= get_stat_mtime (&st
);
5429 current_buffer
->modtime_size
= st
.st_size
;
5437 auto_save_error (Lisp_Object error_val
)
5439 Lisp_Object args
[3], msg
;
5441 struct gcpro gcpro1
;
5445 auto_save_error_occurred
= 1;
5447 ring_bell (XFRAME (selected_frame
));
5449 args
[0] = build_string ("Auto-saving %s: %s");
5450 args
[1] = BVAR (current_buffer
, name
);
5451 args
[2] = Ferror_message_string (error_val
);
5452 msg
= Fformat (3, args
);
5454 nbytes
= SBYTES (msg
);
5455 msgbuf
= SAFE_ALLOCA (nbytes
);
5456 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5458 for (i
= 0; i
< 3; ++i
)
5461 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5463 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5464 Fsleep_for (make_number (1), Qnil
);
5478 auto_save_mode_bits
= 0666;
5480 /* Get visited file's mode to become the auto save file's mode. */
5481 if (! NILP (BVAR (current_buffer
, filename
)))
5483 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5484 /* But make sure we can overwrite it later! */
5485 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5486 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5488 /* Remote files don't cooperate with stat. */
5489 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5493 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5494 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5499 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5502 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5514 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5517 minibuffer_auto_raise
= XINT (value
);
5522 do_auto_save_make_dir (Lisp_Object dir
)
5526 auto_saving_dir_umask
= 077;
5527 result
= call2 (Qmake_directory
, dir
, Qt
);
5528 auto_saving_dir_umask
= 0;
5533 do_auto_save_eh (Lisp_Object ignore
)
5535 auto_saving_dir_umask
= 0;
5539 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5540 doc
: /* Auto-save all buffers that need it.
5541 This is all buffers that have auto-saving enabled
5542 and are changed since last auto-saved.
5543 Auto-saving writes the buffer into a file
5544 so that your editing is not lost if the system crashes.
5545 This file is not the file you visited; that changes only when you save.
5546 Normally we run the normal hook `auto-save-hook' before saving.
5548 A non-nil NO-MESSAGE argument means do not print any message if successful.
5549 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5550 (Lisp_Object no_message
, Lisp_Object current_only
)
5552 struct buffer
*old
= current_buffer
, *b
;
5553 Lisp_Object tail
, buf
, hook
;
5554 bool auto_saved
= 0;
5555 int do_handled_files
;
5557 FILE *stream
= NULL
;
5558 ptrdiff_t count
= SPECPDL_INDEX ();
5559 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5560 bool old_message_p
= 0;
5561 struct gcpro gcpro1
, gcpro2
;
5563 if (max_specpdl_size
< specpdl_size
+ 40)
5564 max_specpdl_size
= specpdl_size
+ 40;
5569 if (NILP (no_message
))
5571 old_message_p
= push_message ();
5572 record_unwind_protect (pop_message_unwind
, Qnil
);
5575 /* Ordinarily don't quit within this function,
5576 but don't make it impossible to quit (in case we get hung in I/O). */
5580 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5581 point to non-strings reached from Vbuffer_alist. */
5583 hook
= intern ("auto-save-hook");
5584 Frun_hooks (1, &hook
);
5586 if (STRINGP (Vauto_save_list_file_name
))
5588 Lisp_Object listfile
;
5590 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5592 /* Don't try to create the directory when shutting down Emacs,
5593 because creating the directory might signal an error, and
5594 that would leave Emacs in a strange state. */
5595 if (!NILP (Vrun_hooks
))
5599 GCPRO2 (dir
, listfile
);
5600 dir
= Ffile_name_directory (listfile
);
5601 if (NILP (Ffile_directory_p (dir
)))
5602 internal_condition_case_1 (do_auto_save_make_dir
,
5608 stream
= fopen (SSDATA (listfile
), "w");
5611 record_unwind_protect (do_auto_save_unwind
,
5612 make_save_value (stream
, 0));
5613 record_unwind_protect (do_auto_save_unwind_1
,
5614 make_number (minibuffer_auto_raise
));
5615 minibuffer_auto_raise
= 0;
5617 auto_save_error_occurred
= 0;
5619 /* On first pass, save all files that don't have handlers.
5620 On second pass, save all files that do have handlers.
5622 If Emacs is crashing, the handlers may tweak what is causing
5623 Emacs to crash in the first place, and it would be a shame if
5624 Emacs failed to autosave perfectly ordinary files because it
5625 couldn't handle some ange-ftp'd file. */
5627 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5628 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5630 buf
= XCDR (XCAR (tail
));
5633 /* Record all the buffers that have auto save mode
5634 in the special file that lists them. For each of these buffers,
5635 Record visited name (if any) and auto save name. */
5636 if (STRINGP (BVAR (b
, auto_save_file_name
))
5637 && stream
!= NULL
&& do_handled_files
== 0)
5640 if (!NILP (BVAR (b
, filename
)))
5642 fwrite (SDATA (BVAR (b
, filename
)), 1,
5643 SBYTES (BVAR (b
, filename
)), stream
);
5645 putc ('\n', stream
);
5646 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5647 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5648 putc ('\n', stream
);
5652 if (!NILP (current_only
)
5653 && b
!= current_buffer
)
5656 /* Don't auto-save indirect buffers.
5657 The base buffer takes care of it. */
5661 /* Check for auto save enabled
5662 and file changed since last auto save
5663 and file changed since last real save. */
5664 if (STRINGP (BVAR (b
, auto_save_file_name
))
5665 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5666 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5667 /* -1 means we've turned off autosaving for a while--see below. */
5668 && XINT (BVAR (b
, save_length
)) >= 0
5669 && (do_handled_files
5670 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5673 EMACS_TIME before_time
= current_emacs_time ();
5674 EMACS_TIME after_time
;
5676 /* If we had a failure, don't try again for 20 minutes. */
5677 if (b
->auto_save_failure_time
> 0
5678 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5681 set_buffer_internal (b
);
5682 if (NILP (Vauto_save_include_big_deletions
)
5683 && (XFASTINT (BVAR (b
, save_length
)) * 10
5684 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5685 /* A short file is likely to change a large fraction;
5686 spare the user annoying messages. */
5687 && XFASTINT (BVAR (b
, save_length
)) > 5000
5688 /* These messages are frequent and annoying for `*mail*'. */
5689 && !EQ (BVAR (b
, filename
), Qnil
)
5690 && NILP (no_message
))
5692 /* It has shrunk too much; turn off auto-saving here. */
5693 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5694 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5696 minibuffer_auto_raise
= 0;
5697 /* Turn off auto-saving until there's a real save,
5698 and prevent any more warnings. */
5699 XSETINT (BVAR (b
, save_length
), -1);
5700 Fsleep_for (make_number (1), Qnil
);
5703 if (!auto_saved
&& NILP (no_message
))
5704 message1 ("Auto-saving...");
5705 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5707 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5708 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5709 set_buffer_internal (old
);
5711 after_time
= current_emacs_time ();
5713 /* If auto-save took more than 60 seconds,
5714 assume it was an NFS failure that got a timeout. */
5715 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5716 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5720 /* Prevent another auto save till enough input events come in. */
5721 record_auto_save ();
5723 if (auto_saved
&& NILP (no_message
))
5727 /* If we are going to restore an old message,
5728 give time to read ours. */
5729 sit_for (make_number (1), 0, 0);
5732 else if (!auto_save_error_occurred
)
5733 /* Don't overwrite the error message if an error occurred.
5734 If we displayed a message and then restored a state
5735 with no message, leave a "done" message on the screen. */
5736 message1 ("Auto-saving...done");
5741 /* This restores the message-stack status. */
5742 unbind_to (count
, Qnil
);
5746 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5747 Sset_buffer_auto_saved
, 0, 0, 0,
5748 doc
: /* Mark current buffer as auto-saved with its current text.
5749 No auto-save file will be written until the buffer changes again. */)
5752 /* FIXME: This should not be called in indirect buffers, since
5753 they're not autosaved. */
5754 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5755 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5756 current_buffer
->auto_save_failure_time
= 0;
5760 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5761 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5762 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5765 current_buffer
->auto_save_failure_time
= 0;
5769 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5771 doc
: /* Return t if current buffer has been auto-saved recently.
5772 More precisely, if it has been auto-saved since last read from or saved
5773 in the visited file. If the buffer has no visited file,
5774 then any auto-save counts as "recent". */)
5777 /* FIXME: maybe we should return nil for indirect buffers since
5778 they're never autosaved. */
5779 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5782 /* Reading and completing file names */
5784 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5785 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5786 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5787 The return value is only relevant for a call to `read-file-name' that happens
5788 before any other event (mouse or keypress) is handled. */)
5791 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5792 || defined (HAVE_NS)
5793 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5803 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5805 struct gcpro gcpro1
;
5806 Lisp_Object args
[7];
5808 GCPRO1 (default_filename
);
5809 args
[0] = intern ("read-file-name");
5812 args
[3] = default_filename
;
5813 args
[4] = mustmatch
;
5815 args
[6] = predicate
;
5816 RETURN_UNGCPRO (Ffuncall (7, args
));
5821 syms_of_fileio (void)
5823 DEFSYM (Qoperations
, "operations");
5824 DEFSYM (Qexpand_file_name
, "expand-file-name");
5825 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5826 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5827 DEFSYM (Qfile_name_directory
, "file-name-directory");
5828 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5829 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5830 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5831 DEFSYM (Qcopy_file
, "copy-file");
5832 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5833 DEFSYM (Qmake_directory
, "make-directory");
5834 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5835 DEFSYM (Qdelete_file
, "delete-file");
5836 DEFSYM (Qrename_file
, "rename-file");
5837 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5838 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5839 DEFSYM (Qfile_exists_p
, "file-exists-p");
5840 DEFSYM (Qfile_executable_p
, "file-executable-p");
5841 DEFSYM (Qfile_readable_p
, "file-readable-p");
5842 DEFSYM (Qfile_writable_p
, "file-writable-p");
5843 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5844 DEFSYM (Qaccess_file
, "access-file");
5845 DEFSYM (Qfile_directory_p
, "file-directory-p");
5846 DEFSYM (Qfile_regular_p
, "file-regular-p");
5847 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5848 DEFSYM (Qfile_modes
, "file-modes");
5849 DEFSYM (Qset_file_modes
, "set-file-modes");
5850 DEFSYM (Qset_file_times
, "set-file-times");
5851 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5852 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5853 DEFSYM (Qfile_acl
, "file-acl");
5854 DEFSYM (Qset_file_acl
, "set-file-acl");
5855 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5856 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5857 DEFSYM (Qwrite_region
, "write-region");
5858 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5859 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5860 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5862 DEFSYM (Qfile_name_history
, "file-name-history");
5863 Fset (Qfile_name_history
, Qnil
);
5865 DEFSYM (Qfile_error
, "file-error");
5866 DEFSYM (Qfile_already_exists
, "file-already-exists");
5867 DEFSYM (Qfile_date_error
, "file-date-error");
5868 DEFSYM (Qexcl
, "excl");
5870 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5871 doc
: /* Coding system for encoding file names.
5872 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5873 Vfile_name_coding_system
= Qnil
;
5875 DEFVAR_LISP ("default-file-name-coding-system",
5876 Vdefault_file_name_coding_system
,
5877 doc
: /* Default coding system for encoding file names.
5878 This variable is used only when `file-name-coding-system' is nil.
5880 This variable is set/changed by the command `set-language-environment'.
5881 User should not set this variable manually,
5882 instead use `file-name-coding-system' to get a constant encoding
5883 of file names regardless of the current language environment. */);
5884 Vdefault_file_name_coding_system
= Qnil
;
5886 DEFSYM (Qformat_decode
, "format-decode");
5887 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5888 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5889 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5891 Fput (Qfile_error
, Qerror_conditions
,
5892 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5893 Fput (Qfile_error
, Qerror_message
,
5894 build_pure_c_string ("File error"));
5896 Fput (Qfile_already_exists
, Qerror_conditions
,
5897 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5898 Fput (Qfile_already_exists
, Qerror_message
,
5899 build_pure_c_string ("File already exists"));
5901 Fput (Qfile_date_error
, Qerror_conditions
,
5902 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5903 Fput (Qfile_date_error
, Qerror_message
,
5904 build_pure_c_string ("Cannot set file date"));
5906 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5907 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5908 If a file name matches REGEXP, all I/O on that file is done by calling
5909 HANDLER. If a file name matches more than one handler, the handler
5910 whose match starts last in the file name gets precedence. The
5911 function `find-file-name-handler' checks this list for a handler for
5914 HANDLER should be a function. The first argument given to it is the
5915 name of the I/O primitive to be handled; the remaining arguments are
5916 the arguments that were passed to that primitive. For example, if you
5917 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5918 HANDLER is called like this:
5920 (funcall HANDLER 'file-exists-p FILENAME)
5922 Note that HANDLER must be able to handle all I/O primitives; if it has
5923 nothing special to do for a primitive, it should reinvoke the
5924 primitive to handle the operation \"the usual way\".
5925 See Info node `(elisp)Magic File Names' for more details. */);
5926 Vfile_name_handler_alist
= Qnil
;
5928 DEFVAR_LISP ("set-auto-coding-function",
5929 Vset_auto_coding_function
,
5930 doc
: /* If non-nil, a function to call to decide a coding system of file.
5931 Two arguments are passed to this function: the file name
5932 and the length of a file contents following the point.
5933 This function should return a coding system to decode the file contents.
5934 It should check the file name against `auto-coding-alist'.
5935 If no coding system is decided, it should check a coding system
5936 specified in the heading lines with the format:
5937 -*- ... coding: CODING-SYSTEM; ... -*-
5938 or local variable spec of the tailing lines with `coding:' tag. */);
5939 Vset_auto_coding_function
= Qnil
;
5941 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5942 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5943 Each is passed one argument, the number of characters inserted,
5944 with point at the start of the inserted text. Each function
5945 should leave point the same, and return the new character count.
5946 If `insert-file-contents' is intercepted by a handler from
5947 `file-name-handler-alist', that handler is responsible for calling the
5948 functions in `after-insert-file-functions' if appropriate. */);
5949 Vafter_insert_file_functions
= Qnil
;
5951 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5952 doc
: /* A list of functions to be called at the start of `write-region'.
5953 Each is passed two arguments, START and END as for `write-region'.
5954 These are usually two numbers but not always; see the documentation
5955 for `write-region'. The function should return a list of pairs
5956 of the form (POSITION . STRING), consisting of strings to be effectively
5957 inserted at the specified positions of the file being written (1 means to
5958 insert before the first byte written). The POSITIONs must be sorted into
5961 If there are several annotation functions, the lists returned by these
5962 functions are merged destructively. As each annotation function runs,
5963 the variable `write-region-annotations-so-far' contains a list of all
5964 annotations returned by previous annotation functions.
5966 An annotation function can return with a different buffer current.
5967 Doing so removes the annotations returned by previous functions, and
5968 resets START and END to `point-min' and `point-max' of the new buffer.
5970 After `write-region' completes, Emacs calls the function stored in
5971 `write-region-post-annotation-function', once for each buffer that was
5972 current when building the annotations (i.e., at least once), with that
5973 buffer current. */);
5974 Vwrite_region_annotate_functions
= Qnil
;
5975 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5977 DEFVAR_LISP ("write-region-post-annotation-function",
5978 Vwrite_region_post_annotation_function
,
5979 doc
: /* Function to call after `write-region' completes.
5980 The function is called with no arguments. If one or more of the
5981 annotation functions in `write-region-annotate-functions' changed the
5982 current buffer, the function stored in this variable is called for
5983 each of those additional buffers as well, in addition to the original
5984 buffer. The relevant buffer is current during each function call. */);
5985 Vwrite_region_post_annotation_function
= Qnil
;
5986 staticpro (&Vwrite_region_annotation_buffers
);
5988 DEFVAR_LISP ("write-region-annotations-so-far",
5989 Vwrite_region_annotations_so_far
,
5990 doc
: /* When an annotation function is called, this holds the previous annotations.
5991 These are the annotations made by other annotation functions
5992 that were already called. See also `write-region-annotate-functions'. */);
5993 Vwrite_region_annotations_so_far
= Qnil
;
5995 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5996 doc
: /* A list of file name handlers that temporarily should not be used.
5997 This applies only to the operation `inhibit-file-name-operation'. */);
5998 Vinhibit_file_name_handlers
= Qnil
;
6000 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6001 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6002 Vinhibit_file_name_operation
= Qnil
;
6004 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6005 doc
: /* File name in which we write a list of all auto save file names.
6006 This variable is initialized automatically from `auto-save-list-file-prefix'
6007 shortly after Emacs reads your init file, if you have not yet given it
6008 a non-nil value. */);
6009 Vauto_save_list_file_name
= Qnil
;
6011 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6012 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6013 Normally auto-save files are written under other names. */);
6014 Vauto_save_visited_file_name
= Qnil
;
6016 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6017 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6018 If nil, deleting a substantial portion of the text disables auto-save
6019 in the buffer; this is the default behavior, because the auto-save
6020 file is usually more useful if it contains the deleted text. */);
6021 Vauto_save_include_big_deletions
= Qnil
;
6024 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6025 doc
: /* Non-nil means don't call fsync in `write-region'.
6026 This variable affects calls to `write-region' as well as save commands.
6027 A non-nil value may result in data loss! */);
6028 write_region_inhibit_fsync
= 0;
6031 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6032 doc
: /* Specifies whether to use the system's trash can.
6033 When non-nil, certain file deletion commands use the function
6034 `move-file-to-trash' instead of deleting files outright.
6035 This includes interactive calls to `delete-file' and
6036 `delete-directory' and the Dired deletion commands. */);
6037 delete_by_moving_to_trash
= 0;
6038 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6040 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6041 DEFSYM (Qcopy_directory
, "copy-directory");
6042 DEFSYM (Qdelete_directory
, "delete-directory");
6044 defsubr (&Sfind_file_name_handler
);
6045 defsubr (&Sfile_name_directory
);
6046 defsubr (&Sfile_name_nondirectory
);
6047 defsubr (&Sunhandled_file_name_directory
);
6048 defsubr (&Sfile_name_as_directory
);
6049 defsubr (&Sdirectory_file_name
);
6050 defsubr (&Smake_temp_name
);
6051 defsubr (&Sexpand_file_name
);
6052 defsubr (&Ssubstitute_in_file_name
);
6053 defsubr (&Scopy_file
);
6054 defsubr (&Smake_directory_internal
);
6055 defsubr (&Sdelete_directory_internal
);
6056 defsubr (&Sdelete_file
);
6057 defsubr (&Srename_file
);
6058 defsubr (&Sadd_name_to_file
);
6059 defsubr (&Smake_symbolic_link
);
6060 defsubr (&Sfile_name_absolute_p
);
6061 defsubr (&Sfile_exists_p
);
6062 defsubr (&Sfile_executable_p
);
6063 defsubr (&Sfile_readable_p
);
6064 defsubr (&Sfile_writable_p
);
6065 defsubr (&Saccess_file
);
6066 defsubr (&Sfile_symlink_p
);
6067 defsubr (&Sfile_directory_p
);
6068 defsubr (&Sfile_accessible_directory_p
);
6069 defsubr (&Sfile_regular_p
);
6070 defsubr (&Sfile_modes
);
6071 defsubr (&Sset_file_modes
);
6072 defsubr (&Sset_file_times
);
6073 defsubr (&Sfile_selinux_context
);
6074 defsubr (&Sfile_acl
);
6075 defsubr (&Sset_file_acl
);
6076 defsubr (&Sset_file_selinux_context
);
6077 defsubr (&Sset_default_file_modes
);
6078 defsubr (&Sdefault_file_modes
);
6079 defsubr (&Sfile_newer_than_file_p
);
6080 defsubr (&Sinsert_file_contents
);
6081 defsubr (&Swrite_region
);
6082 defsubr (&Scar_less_than_car
);
6083 defsubr (&Sverify_visited_file_modtime
);
6084 defsubr (&Sclear_visited_file_modtime
);
6085 defsubr (&Svisited_file_modtime
);
6086 defsubr (&Sset_visited_file_modtime
);
6087 defsubr (&Sdo_auto_save
);
6088 defsubr (&Sset_buffer_auto_saved
);
6089 defsubr (&Sclear_buffer_auto_save_failure
);
6090 defsubr (&Srecent_auto_save_p
);
6092 defsubr (&Snext_read_file_uses_dialog_p
);
6095 defsubr (&Sunix_sync
);