1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
53 #include "dispextern.h"
61 #endif /* not WINDOWSNT */
65 #include <sys/param.h>
70 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
71 redirector allows the six letters between 'Z' and 'a' as well. */
73 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
76 #define IS_DRIVE(x) c_isalpha (x)
78 /* Need to lower-case the drive letter, or else expanded
79 filenames will sometimes compare unequal, because
80 `expand-file-name' doesn't always down-case the drive letter. */
81 #define DRIVE_LETTER(x) c_tolower (x)
85 #include <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
),
2033 /* CopyFile doesn't set errno when it fails. By far the most
2034 "popular" reason is that the target is read-only. */
2035 if (GetLastError () == 5)
2039 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2041 /* CopyFile retains the timestamp by default. */
2042 else if (NILP (keep_time
))
2048 filename
= SDATA (encoded_newname
);
2050 /* Ensure file is writable while its modified time is set. */
2051 attributes
= GetFileAttributes (filename
);
2052 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2053 now
= current_emacs_time ();
2054 if (set_file_times (-1, filename
, now
, now
))
2056 /* Restore original attributes. */
2057 SetFileAttributes (filename
, attributes
);
2058 xsignal2 (Qfile_date_error
,
2059 build_string ("Cannot set file date"), newname
);
2061 /* Restore original attributes. */
2062 SetFileAttributes (filename
, attributes
);
2064 #ifdef HAVE_POSIX_ACL
2068 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2069 if (fail
&& errno
!= ENOTSUP
)
2070 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2075 #else /* not WINDOWSNT */
2077 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2081 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2083 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2085 if (fstat (ifd
, &st
) != 0)
2086 report_file_error ("Input file status", Fcons (file
, Qnil
));
2088 if (!NILP (preserve_extended_attributes
))
2091 if (is_selinux_enabled ())
2093 conlength
= fgetfilecon (ifd
, &con
);
2094 if (conlength
== -1)
2095 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
2099 #ifdef HAVE_POSIX_ACL
2100 acl
= acl_get_fd (ifd
);
2101 if (acl
== NULL
&& errno
!= ENOTSUP
)
2102 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2106 if (out_st
.st_mode
!= 0
2107 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2110 report_file_error ("Input and output files are the same",
2111 Fcons (file
, Fcons (newname
, Qnil
)));
2114 /* We can copy only regular files. */
2115 if (!S_ISREG (st
.st_mode
))
2117 /* Get a better looking error message. */
2118 errno
= S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
;
2119 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2123 /* System's default file type was set to binary by _fmode in emacs.c. */
2124 ofd
= emacs_open (SDATA (encoded_newname
),
2125 O_WRONLY
| O_TRUNC
| O_CREAT
2126 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2127 S_IREAD
| S_IWRITE
);
2128 #else /* not MSDOS */
2130 mode_t new_mask
= !NILP (preserve_uid_gid
) ? 0600 : 0666;
2131 new_mask
&= st
.st_mode
;
2132 ofd
= emacs_open (SSDATA (encoded_newname
),
2133 (O_WRONLY
| O_TRUNC
| O_CREAT
2134 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2137 #endif /* not MSDOS */
2139 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2141 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2145 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2146 if (emacs_write (ofd
, buf
, n
) != n
)
2147 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2151 /* Preserve the original file modes, and if requested, also its
2154 mode_t mode_mask
= 07777;
2155 if (!NILP (preserve_uid_gid
))
2157 /* Attempt to change owner and group. If that doesn't work
2158 attempt to change just the group, as that is sometimes allowed.
2159 Adjust the mode mask to eliminate setuid or setgid bits
2160 that are inappropriate if the owner and group are wrong. */
2161 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2163 mode_mask
&= ~06000;
2164 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2168 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2169 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2171 #endif /* not MSDOS */
2176 /* Set the modified context back to the file. */
2177 bool fail
= fsetfilecon (ofd
, con
) != 0;
2178 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2179 if (fail
&& errno
!= ENOTSUP
)
2180 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2186 #ifdef HAVE_POSIX_ACL
2189 bool fail
= acl_set_fd (ofd
, acl
) != 0;
2190 if (fail
&& errno
!= ENOTSUP
)
2191 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2197 if (!NILP (keep_time
))
2199 EMACS_TIME atime
= get_stat_atime (&st
);
2200 EMACS_TIME mtime
= get_stat_mtime (&st
);
2201 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2202 xsignal2 (Qfile_date_error
,
2203 build_string ("Cannot set file date"), newname
);
2206 if (emacs_close (ofd
) < 0)
2207 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2212 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2213 and if it can't, it tells so. Otherwise, under MSDOS we usually
2214 get only the READ bit, which will make the copied file read-only,
2215 so it's better not to chmod at all. */
2216 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2217 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2219 #endif /* not WINDOWSNT */
2221 /* Discard the unwind protects. */
2222 specpdl_ptr
= specpdl
+ count
;
2228 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2229 Smake_directory_internal
, 1, 1, 0,
2230 doc
: /* Create a new directory named DIRECTORY. */)
2231 (Lisp_Object directory
)
2234 Lisp_Object handler
;
2235 Lisp_Object encoded_dir
;
2237 CHECK_STRING (directory
);
2238 directory
= Fexpand_file_name (directory
, Qnil
);
2240 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2241 if (!NILP (handler
))
2242 return call2 (handler
, Qmake_directory_internal
, directory
);
2244 encoded_dir
= ENCODE_FILE (directory
);
2246 dir
= SSDATA (encoded_dir
);
2249 if (mkdir (dir
) != 0)
2251 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2253 report_file_error ("Creating directory", list1 (directory
));
2258 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2259 Sdelete_directory_internal
, 1, 1, 0,
2260 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2261 (Lisp_Object directory
)
2264 Lisp_Object encoded_dir
;
2266 CHECK_STRING (directory
);
2267 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2268 encoded_dir
= ENCODE_FILE (directory
);
2269 dir
= SSDATA (encoded_dir
);
2271 if (rmdir (dir
) != 0)
2272 report_file_error ("Removing directory", list1 (directory
));
2277 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2278 "(list (read-file-name \
2279 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2280 \"Move file to trash: \" \"Delete file: \") \
2281 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2282 (null current-prefix-arg))",
2283 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2284 If file has multiple names, it continues to exist with the other names.
2285 TRASH non-nil means to trash the file instead of deleting, provided
2286 `delete-by-moving-to-trash' is non-nil.
2288 When called interactively, TRASH is t if no prefix argument is given.
2289 With a prefix argument, TRASH is nil. */)
2290 (Lisp_Object filename
, Lisp_Object trash
)
2292 Lisp_Object handler
;
2293 Lisp_Object encoded_file
;
2294 struct gcpro gcpro1
;
2297 if (!NILP (Ffile_directory_p (filename
))
2298 && NILP (Ffile_symlink_p (filename
)))
2299 xsignal2 (Qfile_error
,
2300 build_string ("Removing old name: is a directory"),
2303 filename
= Fexpand_file_name (filename
, Qnil
);
2305 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2306 if (!NILP (handler
))
2307 return call3 (handler
, Qdelete_file
, filename
, trash
);
2309 if (delete_by_moving_to_trash
&& !NILP (trash
))
2310 return call1 (Qmove_file_to_trash
, filename
);
2312 encoded_file
= ENCODE_FILE (filename
);
2314 if (unlink (SSDATA (encoded_file
)) < 0)
2315 report_file_error ("Removing old name", list1 (filename
));
2320 internal_delete_file_1 (Lisp_Object ignore
)
2325 /* Delete file FILENAME, returning true if successful.
2326 This ignores `delete-by-moving-to-trash'. */
2329 internal_delete_file (Lisp_Object filename
)
2333 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2334 Qt
, internal_delete_file_1
);
2338 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2339 "fRename file: \nGRename %s to file: \np",
2340 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2341 If file has names other than FILE, it continues to have those names.
2342 Signals a `file-already-exists' error if a file NEWNAME already exists
2343 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2344 A number as third arg means request confirmation if NEWNAME already exists.
2345 This is what happens in interactive use with M-x. */)
2346 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2348 Lisp_Object handler
;
2349 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2350 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2352 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2353 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2354 CHECK_STRING (file
);
2355 CHECK_STRING (newname
);
2356 file
= Fexpand_file_name (file
, Qnil
);
2358 if ((!NILP (Ffile_directory_p (newname
)))
2360 /* If the file names are identical but for the case,
2361 don't attempt to move directory to itself. */
2362 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2366 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2367 ? file
: Fdirectory_file_name (file
));
2368 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2371 newname
= Fexpand_file_name (newname
, Qnil
);
2373 /* If the file name has special constructs in it,
2374 call the corresponding file handler. */
2375 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2377 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2378 if (!NILP (handler
))
2379 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2380 file
, newname
, ok_if_already_exists
));
2382 encoded_file
= ENCODE_FILE (file
);
2383 encoded_newname
= ENCODE_FILE (newname
);
2386 /* If the file names are identical but for the case, don't ask for
2387 confirmation: they simply want to change the letter-case of the
2389 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2391 if (NILP (ok_if_already_exists
)
2392 || INTEGERP (ok_if_already_exists
))
2393 barf_or_query_if_file_exists (newname
, "rename to it",
2394 INTEGERP (ok_if_already_exists
), 0, 0);
2395 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2400 symlink_target
= Ffile_symlink_p (file
);
2401 if (! NILP (symlink_target
))
2402 Fmake_symbolic_link (symlink_target
, newname
,
2403 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2404 else if (!NILP (Ffile_directory_p (file
)))
2405 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2407 /* We have already prompted if it was an integer, so don't
2408 have copy-file prompt again. */
2409 Fcopy_file (file
, newname
,
2410 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2413 count
= SPECPDL_INDEX ();
2414 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2416 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2417 call2 (Qdelete_directory
, file
, Qt
);
2419 Fdelete_file (file
, Qnil
);
2420 unbind_to (count
, Qnil
);
2423 report_file_error ("Renaming", list2 (file
, newname
));
2429 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2430 "fAdd name to file: \nGName to add to %s: \np",
2431 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2432 Signals a `file-already-exists' error if a file NEWNAME already exists
2433 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2434 A number as third arg means request confirmation if NEWNAME already exists.
2435 This is what happens in interactive use with M-x. */)
2436 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2438 Lisp_Object handler
;
2439 Lisp_Object encoded_file
, encoded_newname
;
2440 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2442 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2443 encoded_file
= encoded_newname
= Qnil
;
2444 CHECK_STRING (file
);
2445 CHECK_STRING (newname
);
2446 file
= Fexpand_file_name (file
, Qnil
);
2448 if (!NILP (Ffile_directory_p (newname
)))
2449 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2451 newname
= Fexpand_file_name (newname
, Qnil
);
2453 /* If the file name has special constructs in it,
2454 call the corresponding file handler. */
2455 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2456 if (!NILP (handler
))
2457 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2458 newname
, ok_if_already_exists
));
2460 /* If the new name has special constructs in it,
2461 call the corresponding file handler. */
2462 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2463 if (!NILP (handler
))
2464 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2465 newname
, ok_if_already_exists
));
2467 encoded_file
= ENCODE_FILE (file
);
2468 encoded_newname
= ENCODE_FILE (newname
);
2470 if (NILP (ok_if_already_exists
)
2471 || INTEGERP (ok_if_already_exists
))
2472 barf_or_query_if_file_exists (newname
, "make it a new name",
2473 INTEGERP (ok_if_already_exists
), 0, 0);
2475 unlink (SSDATA (newname
));
2476 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2477 report_file_error ("Adding new name", list2 (file
, newname
));
2483 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2484 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2485 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2486 Both args must be strings.
2487 Signals a `file-already-exists' error if a file LINKNAME already exists
2488 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2489 A number as third arg means request confirmation if LINKNAME already exists.
2490 This happens for interactive use with M-x. */)
2491 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2493 Lisp_Object handler
;
2494 Lisp_Object encoded_filename
, encoded_linkname
;
2495 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2497 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2498 encoded_filename
= encoded_linkname
= Qnil
;
2499 CHECK_STRING (filename
);
2500 CHECK_STRING (linkname
);
2501 /* If the link target has a ~, we must expand it to get
2502 a truly valid file name. Otherwise, do not expand;
2503 we want to permit links to relative file names. */
2504 if (SREF (filename
, 0) == '~')
2505 filename
= Fexpand_file_name (filename
, Qnil
);
2507 if (!NILP (Ffile_directory_p (linkname
)))
2508 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2510 linkname
= Fexpand_file_name (linkname
, Qnil
);
2512 /* If the file name has special constructs in it,
2513 call the corresponding file handler. */
2514 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2515 if (!NILP (handler
))
2516 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2517 linkname
, ok_if_already_exists
));
2519 /* If the new link name has special constructs in it,
2520 call the corresponding file handler. */
2521 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2522 if (!NILP (handler
))
2523 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2524 linkname
, ok_if_already_exists
));
2526 encoded_filename
= ENCODE_FILE (filename
);
2527 encoded_linkname
= ENCODE_FILE (linkname
);
2529 if (NILP (ok_if_already_exists
)
2530 || INTEGERP (ok_if_already_exists
))
2531 barf_or_query_if_file_exists (linkname
, "make it a link",
2532 INTEGERP (ok_if_already_exists
), 0, 0);
2533 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2535 /* If we didn't complain already, silently delete existing file. */
2536 if (errno
== EEXIST
)
2538 unlink (SSDATA (encoded_linkname
));
2539 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2546 if (errno
== ENOSYS
)
2549 xsignal1 (Qfile_error
,
2550 build_string ("Symbolic links are not supported"));
2553 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2560 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2562 doc
: /* Return t if file FILENAME specifies an absolute file name.
2563 On Unix, this is a name starting with a `/' or a `~'. */)
2564 (Lisp_Object filename
)
2566 CHECK_STRING (filename
);
2567 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2570 /* Return true if FILENAME exists. */
2572 check_existing (const char *filename
)
2574 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2577 /* Return true if file FILENAME exists and can be executed. */
2580 check_executable (char *filename
)
2582 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2585 /* Return true if file FILENAME exists and can be accessed
2586 according to AMODE, which should include W_OK.
2587 On failure, return false and set errno. */
2590 check_writable (const char *filename
, int amode
)
2593 /* FIXME: an faccessat implementation should be added to the
2594 DOS/Windows ports and this #ifdef branch should be removed. */
2596 if (stat (filename
, &st
) < 0)
2599 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2600 #else /* not MSDOS */
2601 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2603 /* faccessat may have returned failure because Cygwin couldn't
2604 determine the file's UID or GID; if so, we return success. */
2607 int faccessat_errno
= errno
;
2609 if (stat (filename
, &st
) < 0)
2611 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2612 errno
= faccessat_errno
;
2616 #endif /* not MSDOS */
2619 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2620 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2621 See also `file-readable-p' and `file-attributes'.
2622 This returns nil for a symlink to a nonexistent file.
2623 Use `file-symlink-p' to test for such links. */)
2624 (Lisp_Object filename
)
2626 Lisp_Object absname
;
2627 Lisp_Object handler
;
2629 CHECK_STRING (filename
);
2630 absname
= Fexpand_file_name (filename
, Qnil
);
2632 /* If the file name has special constructs in it,
2633 call the corresponding file handler. */
2634 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2635 if (!NILP (handler
))
2636 return call2 (handler
, Qfile_exists_p
, absname
);
2638 absname
= ENCODE_FILE (absname
);
2640 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2643 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2644 doc
: /* Return t if FILENAME can be executed by you.
2645 For a directory, this means you can access files in that directory. */)
2646 (Lisp_Object filename
)
2648 Lisp_Object absname
;
2649 Lisp_Object handler
;
2651 CHECK_STRING (filename
);
2652 absname
= Fexpand_file_name (filename
, Qnil
);
2654 /* If the file name has special constructs in it,
2655 call the corresponding file handler. */
2656 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2657 if (!NILP (handler
))
2658 return call2 (handler
, Qfile_executable_p
, absname
);
2660 absname
= ENCODE_FILE (absname
);
2662 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2665 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2666 doc
: /* Return t if file FILENAME exists and you can read it.
2667 See also `file-exists-p' and `file-attributes'. */)
2668 (Lisp_Object filename
)
2670 Lisp_Object absname
;
2671 Lisp_Object handler
;
2673 CHECK_STRING (filename
);
2674 absname
= Fexpand_file_name (filename
, Qnil
);
2676 /* If the file name has special constructs in it,
2677 call the corresponding file handler. */
2678 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2679 if (!NILP (handler
))
2680 return call2 (handler
, Qfile_readable_p
, absname
);
2682 absname
= ENCODE_FILE (absname
);
2683 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2687 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2688 doc
: /* Return t if file FILENAME can be written or created by you. */)
2689 (Lisp_Object filename
)
2691 Lisp_Object absname
, dir
, encoded
;
2692 Lisp_Object handler
;
2694 CHECK_STRING (filename
);
2695 absname
= Fexpand_file_name (filename
, Qnil
);
2697 /* If the file name has special constructs in it,
2698 call the corresponding file handler. */
2699 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2700 if (!NILP (handler
))
2701 return call2 (handler
, Qfile_writable_p
, absname
);
2703 encoded
= ENCODE_FILE (absname
);
2704 if (check_writable (SSDATA (encoded
), W_OK
))
2706 if (errno
!= ENOENT
)
2709 dir
= Ffile_name_directory (absname
);
2710 eassert (!NILP (dir
));
2712 dir
= Fdirectory_file_name (dir
);
2715 dir
= ENCODE_FILE (dir
);
2717 /* The read-only attribute of the parent directory doesn't affect
2718 whether a file or directory can be created within it. Some day we
2719 should check ACLs though, which do affect this. */
2720 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2722 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2726 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2727 doc
: /* Access file FILENAME, and get an error if that does not work.
2728 The second argument STRING is used in the error message.
2729 If there is no error, returns nil. */)
2730 (Lisp_Object filename
, Lisp_Object string
)
2732 Lisp_Object handler
, encoded_filename
, absname
;
2735 CHECK_STRING (filename
);
2736 absname
= Fexpand_file_name (filename
, Qnil
);
2738 CHECK_STRING (string
);
2740 /* If the file name has special constructs in it,
2741 call the corresponding file handler. */
2742 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2743 if (!NILP (handler
))
2744 return call3 (handler
, Qaccess_file
, absname
, string
);
2746 encoded_filename
= ENCODE_FILE (absname
);
2748 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2750 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2756 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2757 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2758 The value is the link target, as a string.
2759 Otherwise it returns nil.
2761 This function returns t when given the name of a symlink that
2762 points to a nonexistent file. */)
2763 (Lisp_Object filename
)
2765 Lisp_Object handler
;
2768 char readlink_buf
[READLINK_BUFSIZE
];
2770 CHECK_STRING (filename
);
2771 filename
= Fexpand_file_name (filename
, Qnil
);
2773 /* If the file name has special constructs in it,
2774 call the corresponding file handler. */
2775 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2776 if (!NILP (handler
))
2777 return call2 (handler
, Qfile_symlink_p
, filename
);
2779 filename
= ENCODE_FILE (filename
);
2781 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2785 val
= build_string (buf
);
2786 if (buf
[0] == '/' && strchr (buf
, ':'))
2787 val
= concat2 (build_string ("/:"), val
);
2788 if (buf
!= readlink_buf
)
2790 val
= DECODE_FILE (val
);
2794 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2795 doc
: /* Return t if FILENAME names an existing directory.
2796 Symbolic links to directories count as directories.
2797 See `file-symlink-p' to distinguish symlinks. */)
2798 (Lisp_Object filename
)
2800 Lisp_Object absname
;
2801 Lisp_Object handler
;
2803 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2805 /* If the file name has special constructs in it,
2806 call the corresponding file handler. */
2807 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2808 if (!NILP (handler
))
2809 return call2 (handler
, Qfile_directory_p
, absname
);
2811 absname
= ENCODE_FILE (absname
);
2813 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2816 /* Return true if FILE is a directory or a symlink to a directory. */
2818 file_directory_p (char const *file
)
2821 /* This is cheaper than 'stat'. */
2822 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2825 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2829 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2830 Sfile_accessible_directory_p
, 1, 1, 0,
2831 doc
: /* Return t if file FILENAME names a directory you can open.
2832 For the value to be t, FILENAME must specify the name of a directory as a file,
2833 and the directory must allow you to open files in it. In order to use a
2834 directory as a buffer's current directory, this predicate must return true.
2835 A directory name spec may be given instead; then the value is t
2836 if the directory so specified exists and really is a readable and
2837 searchable directory. */)
2838 (Lisp_Object filename
)
2840 Lisp_Object absname
;
2841 Lisp_Object handler
;
2843 CHECK_STRING (filename
);
2844 absname
= Fexpand_file_name (filename
, Qnil
);
2846 /* If the file name has special constructs in it,
2847 call the corresponding file handler. */
2848 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2849 if (!NILP (handler
))
2850 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2852 absname
= ENCODE_FILE (absname
);
2853 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2856 /* If FILE is a searchable directory or a symlink to a
2857 searchable directory, return true. Otherwise return
2858 false and set errno to an error number. */
2860 file_accessible_directory_p (char const *file
)
2863 /* There's no need to test whether FILE is searchable, as the
2864 searchable/executable bit is invented on DOS_NT platforms. */
2865 return file_directory_p (file
);
2867 /* On POSIXish platforms, use just one system call; this avoids a
2868 race and is typically faster. */
2869 ptrdiff_t len
= strlen (file
);
2875 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2876 There are three exceptions: "", "/", and "//". Leave "" alone,
2877 as it's invalid. Append only "." to the other two exceptions as
2878 "/" and "//" are distinct on some platforms, whereas "/", "///",
2879 "////", etc. are all equivalent. */
2884 /* Just check for trailing '/' when deciding whether to append '/'.
2885 That's simpler than testing the two special cases "/" and "//",
2886 and it's a safe optimization here. */
2887 char *buf
= SAFE_ALLOCA (len
+ 3);
2888 memcpy (buf
, file
, len
);
2889 strcpy (buf
+ len
, "/." + (file
[len
- 1] == '/'));
2893 ok
= check_existing (dir
);
2894 saved_errno
= errno
;
2896 errno
= saved_errno
;
2901 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2902 doc
: /* Return t if FILENAME names a regular file.
2903 This is the sort of file that holds an ordinary stream of data bytes.
2904 Symbolic links to regular files count as regular files.
2905 See `file-symlink-p' to distinguish symlinks. */)
2906 (Lisp_Object filename
)
2908 register Lisp_Object absname
;
2910 Lisp_Object handler
;
2912 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2914 /* If the file name has special constructs in it,
2915 call the corresponding file handler. */
2916 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2917 if (!NILP (handler
))
2918 return call2 (handler
, Qfile_regular_p
, absname
);
2920 absname
= ENCODE_FILE (absname
);
2925 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2927 /* Tell stat to use expensive method to get accurate info. */
2928 Vw32_get_true_file_attributes
= Qt
;
2929 result
= stat (SDATA (absname
), &st
);
2930 Vw32_get_true_file_attributes
= tem
;
2934 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2937 if (stat (SSDATA (absname
), &st
) < 0)
2939 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2943 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2944 Sfile_selinux_context
, 1, 1, 0,
2945 doc
: /* Return SELinux context of file named FILENAME.
2946 The return value is a list (USER ROLE TYPE RANGE), where the list
2947 elements are strings naming the user, role, type, and range of the
2948 file's SELinux security context.
2950 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2951 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2952 (Lisp_Object filename
)
2954 Lisp_Object absname
;
2955 Lisp_Object values
[4];
2956 Lisp_Object handler
;
2958 security_context_t con
;
2963 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2965 /* If the file name has special constructs in it,
2966 call the corresponding file handler. */
2967 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2968 if (!NILP (handler
))
2969 return call2 (handler
, Qfile_selinux_context
, absname
);
2971 absname
= ENCODE_FILE (absname
);
2978 if (is_selinux_enabled ())
2980 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2983 context
= context_new (con
);
2984 if (context_user_get (context
))
2985 values
[0] = build_string (context_user_get (context
));
2986 if (context_role_get (context
))
2987 values
[1] = build_string (context_role_get (context
));
2988 if (context_type_get (context
))
2989 values
[2] = build_string (context_type_get (context
));
2990 if (context_range_get (context
))
2991 values
[3] = build_string (context_range_get (context
));
2992 context_free (context
);
2998 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
3001 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
3002 Sset_file_selinux_context
, 2, 2, 0,
3003 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
3004 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
3005 elements are strings naming the components of a SELinux context.
3007 Value is t if setting of SELinux context was successful, nil otherwise.
3009 This function does nothing and returns nil if SELinux is disabled,
3010 or if Emacs was not compiled with SELinux support. */)
3011 (Lisp_Object filename
, Lisp_Object context
)
3013 Lisp_Object absname
;
3014 Lisp_Object handler
;
3016 Lisp_Object encoded_absname
;
3017 Lisp_Object user
= CAR_SAFE (context
);
3018 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
3019 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
3020 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
3021 security_context_t con
;
3024 context_t parsed_con
;
3027 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3029 /* If the file name has special constructs in it,
3030 call the corresponding file handler. */
3031 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
3032 if (!NILP (handler
))
3033 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
3036 if (is_selinux_enabled ())
3038 /* Get current file context. */
3039 encoded_absname
= ENCODE_FILE (absname
);
3040 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
3043 parsed_con
= context_new (con
);
3044 /* Change the parts defined in the parameter.*/
3047 if (context_user_set (parsed_con
, SSDATA (user
)))
3048 error ("Doing context_user_set");
3052 if (context_role_set (parsed_con
, SSDATA (role
)))
3053 error ("Doing context_role_set");
3057 if (context_type_set (parsed_con
, SSDATA (type
)))
3058 error ("Doing context_type_set");
3060 if (STRINGP (range
))
3062 if (context_range_set (parsed_con
, SSDATA (range
)))
3063 error ("Doing context_range_set");
3066 /* Set the modified context back to the file. */
3067 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3068 context_str (parsed_con
))
3070 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3071 if (fail
&& errno
!= ENOTSUP
)
3072 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
3074 context_free (parsed_con
);
3076 return fail
? Qnil
: Qt
;
3079 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
3086 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3087 doc
: /* Return ACL entries of file named FILENAME.
3088 The entries are returned in a format suitable for use in `set-file-acl'
3089 but is otherwise undocumented and subject to change.
3090 Return nil if file does not exist or is not accessible, or if Emacs
3091 was unable to determine the ACL entries. */)
3092 (Lisp_Object filename
)
3094 Lisp_Object absname
;
3095 Lisp_Object handler
;
3096 #ifdef HAVE_POSIX_ACL
3098 Lisp_Object acl_string
;
3102 absname
= expand_and_dir_to_file (filename
,
3103 BVAR (current_buffer
, directory
));
3105 /* If the file name has special constructs in it,
3106 call the corresponding file handler. */
3107 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3108 if (!NILP (handler
))
3109 return call2 (handler
, Qfile_acl
, absname
);
3111 #ifdef HAVE_POSIX_ACL
3112 absname
= ENCODE_FILE (absname
);
3114 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3118 str
= acl_to_text (acl
, NULL
);
3125 acl_string
= build_string (str
);
3135 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3137 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3138 ACL-STRING should contain the textual representation of the ACL
3139 entries in a format suitable for the platform.
3141 Value is t if setting of ACL was successful, nil otherwise.
3143 Setting ACL for local files requires Emacs to be built with ACL
3145 (Lisp_Object filename
, Lisp_Object acl_string
)
3147 Lisp_Object absname
;
3148 Lisp_Object handler
;
3149 #ifdef HAVE_POSIX_ACL
3150 Lisp_Object encoded_absname
;
3155 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3157 /* If the file name has special constructs in it,
3158 call the corresponding file handler. */
3159 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3160 if (!NILP (handler
))
3161 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3163 #ifdef HAVE_POSIX_ACL
3164 if (STRINGP (acl_string
))
3166 acl
= acl_from_text (SSDATA (acl_string
));
3169 report_file_error ("Converting ACL", Fcons (absname
, Qnil
));
3173 encoded_absname
= ENCODE_FILE (absname
);
3175 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3178 if (fail
&& errno
!= ENOTSUP
)
3179 report_file_error ("Setting ACL", Fcons (absname
, Qnil
));
3182 return fail
? Qnil
: Qt
;
3189 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3190 doc
: /* Return mode bits of file named FILENAME, as an integer.
3191 Return nil, if file does not exist or is not accessible. */)
3192 (Lisp_Object filename
)
3194 Lisp_Object absname
;
3196 Lisp_Object handler
;
3198 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3200 /* If the file name has special constructs in it,
3201 call the corresponding file handler. */
3202 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3203 if (!NILP (handler
))
3204 return call2 (handler
, Qfile_modes
, absname
);
3206 absname
= ENCODE_FILE (absname
);
3208 if (stat (SSDATA (absname
), &st
) < 0)
3211 return make_number (st
.st_mode
& 07777);
3214 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3215 "(let ((file (read-file-name \"File: \"))) \
3216 (list file (read-file-modes nil file)))",
3217 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3218 Only the 12 low bits of MODE are used.
3220 Interactively, mode bits are read by `read-file-modes', which accepts
3221 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3222 (Lisp_Object filename
, Lisp_Object mode
)
3224 Lisp_Object absname
, encoded_absname
;
3225 Lisp_Object handler
;
3227 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3228 CHECK_NUMBER (mode
);
3230 /* If the file name has special constructs in it,
3231 call the corresponding file handler. */
3232 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3233 if (!NILP (handler
))
3234 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3236 encoded_absname
= ENCODE_FILE (absname
);
3238 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3239 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3244 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3245 doc
: /* Set the file permission bits for newly created files.
3246 The argument MODE should be an integer; only the low 9 bits are used.
3247 This setting is inherited by subprocesses. */)
3250 CHECK_NUMBER (mode
);
3252 umask ((~ XINT (mode
)) & 0777);
3257 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3258 doc
: /* Return the default file protection for created files.
3259 The value is an integer. */)
3266 realmask
= umask (0);
3270 XSETINT (value
, (~ realmask
) & 0777);
3275 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3276 doc
: /* Set times of file FILENAME to TIMESTAMP.
3277 Set both access and modification times.
3278 Return t on success, else nil.
3279 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3281 (Lisp_Object filename
, Lisp_Object timestamp
)
3283 Lisp_Object absname
, encoded_absname
;
3284 Lisp_Object handler
;
3285 EMACS_TIME t
= lisp_time_argument (timestamp
);
3287 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3289 /* If the file name has special constructs in it,
3290 call the corresponding file handler. */
3291 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3292 if (!NILP (handler
))
3293 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3295 encoded_absname
= ENCODE_FILE (absname
);
3298 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3301 /* Setting times on a directory always fails. */
3302 if (file_directory_p (SSDATA (encoded_absname
)))
3305 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3314 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3315 doc
: /* Tell Unix to finish all pending disk updates. */)
3322 #endif /* HAVE_SYNC */
3324 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3325 doc
: /* Return t if file FILE1 is newer than file FILE2.
3326 If FILE1 does not exist, the answer is nil;
3327 otherwise, if FILE2 does not exist, the answer is t. */)
3328 (Lisp_Object file1
, Lisp_Object file2
)
3330 Lisp_Object absname1
, absname2
;
3331 struct stat st1
, st2
;
3332 Lisp_Object handler
;
3333 struct gcpro gcpro1
, gcpro2
;
3335 CHECK_STRING (file1
);
3336 CHECK_STRING (file2
);
3339 GCPRO2 (absname1
, file2
);
3340 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3341 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3344 /* If the file name has special constructs in it,
3345 call the corresponding file handler. */
3346 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3348 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3349 if (!NILP (handler
))
3350 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3352 GCPRO2 (absname1
, absname2
);
3353 absname1
= ENCODE_FILE (absname1
);
3354 absname2
= ENCODE_FILE (absname2
);
3357 if (stat (SSDATA (absname1
), &st1
) < 0)
3360 if (stat (SSDATA (absname2
), &st2
) < 0)
3363 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3367 #ifndef READ_BUF_SIZE
3368 #define READ_BUF_SIZE (64 << 10)
3370 /* Some buffer offsets are stored in 'int' variables. */
3371 verify (READ_BUF_SIZE
<= INT_MAX
);
3373 /* This function is called after Lisp functions to decide a coding
3374 system are called, or when they cause an error. Before they are
3375 called, the current buffer is set unibyte and it contains only a
3376 newly inserted text (thus the buffer was empty before the
3379 The functions may set markers, overlays, text properties, or even
3380 alter the buffer contents, change the current buffer.
3382 Here, we reset all those changes by:
3383 o set back the current buffer.
3384 o move all markers and overlays to BEG.
3385 o remove all text properties.
3386 o set back the buffer multibyteness. */
3389 decide_coding_unwind (Lisp_Object unwind_data
)
3391 Lisp_Object multibyte
, undo_list
, buffer
;
3393 multibyte
= XCAR (unwind_data
);
3394 unwind_data
= XCDR (unwind_data
);
3395 undo_list
= XCAR (unwind_data
);
3396 buffer
= XCDR (unwind_data
);
3398 set_buffer_internal (XBUFFER (buffer
));
3399 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3400 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3401 set_buffer_intervals (current_buffer
, NULL
);
3402 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3404 /* Now we are safe to change the buffer's multibyteness directly. */
3405 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3406 bset_undo_list (current_buffer
, undo_list
);
3411 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3412 object where slot 0 is the file descriptor, slot 1 specifies
3413 an offset to put the read bytes, and slot 2 is the maximum
3414 amount of bytes to read. Value is the number of bytes read. */
3417 read_non_regular (Lisp_Object state
)
3423 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3424 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3425 + XSAVE_INTEGER (state
, 1)),
3426 XSAVE_INTEGER (state
, 2));
3428 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 ptrdiff_t 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 nbytes
= internal_condition_case_1
4252 format_save_value ("iii", (ptrdiff_t) fd
, inserted
, trytry
),
4253 Qerror
, read_non_regular_quit
);
4261 this = XINT (nbytes
);
4265 /* Allow quitting out of the actual I/O. We don't make text
4266 part of the buffer until all the reading is done, so a C-g
4267 here doesn't do any harm. */
4270 this = emacs_read (fd
,
4271 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4285 /* For a regular file, where TOTAL is the real size,
4286 count HOW_MUCH to compare with it.
4287 For a special file, where TOTAL is just a buffer size,
4288 so don't bother counting in HOW_MUCH.
4289 (INSERTED is where we count the number of characters inserted.) */
4296 /* Now we have read all the file data into the gap.
4297 If it was empty, undo marking the buffer modified. */
4301 #ifdef CLASH_DETECTION
4303 unlock_file (BVAR (current_buffer
, file_truename
));
4305 Vdeactivate_mark
= old_Vdeactivate_mark
;
4308 Vdeactivate_mark
= Qt
;
4310 /* Make the text read part of the buffer. */
4311 GAP_SIZE
-= inserted
;
4313 GPT_BYTE
+= inserted
;
4315 ZV_BYTE
+= inserted
;
4320 /* Put an anchor to ensure multi-byte form ends at gap. */
4325 /* Discard the unwind protect for closing the file. */
4329 error ("IO error reading %s: %s",
4330 SDATA (orig_filename
), emacs_strerror (errno
));
4334 if (NILP (coding_system
))
4336 /* The coding system is not yet decided. Decide it by an
4337 optimized method for handling `coding:' tag.
4339 Note that we can get here only if the buffer was empty
4340 before the insertion. */
4342 if (!NILP (Vcoding_system_for_read
))
4343 coding_system
= Vcoding_system_for_read
;
4346 /* Since we are sure that the current buffer was empty
4347 before the insertion, we can toggle
4348 enable-multibyte-characters directly here without taking
4349 care of marker adjustment. By this way, we can run Lisp
4350 program safely before decoding the inserted text. */
4351 Lisp_Object unwind_data
;
4352 ptrdiff_t count1
= SPECPDL_INDEX ();
4354 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4355 Fcons (BVAR (current_buffer
, undo_list
),
4356 Fcurrent_buffer ()));
4357 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4358 bset_undo_list (current_buffer
, Qt
);
4359 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4361 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4363 coding_system
= call2 (Vset_auto_coding_function
,
4364 filename
, make_number (inserted
));
4367 if (NILP (coding_system
))
4369 /* If the coding system is not yet decided, check
4370 file-coding-system-alist. */
4371 Lisp_Object args
[6];
4373 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4374 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4375 coding_system
= Ffind_operation_coding_system (6, args
);
4376 if (CONSP (coding_system
))
4377 coding_system
= XCAR (coding_system
);
4379 unbind_to (count1
, Qnil
);
4380 inserted
= Z_BYTE
- BEG_BYTE
;
4383 if (NILP (coding_system
))
4384 coding_system
= Qundecided
;
4386 CHECK_CODING_SYSTEM (coding_system
);
4388 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4389 /* We must suppress all character code conversion except for
4390 end-of-line conversion. */
4391 coding_system
= raw_text_coding_system (coding_system
);
4392 setup_coding_system (coding_system
, &coding
);
4393 /* Ensure we set Vlast_coding_system_used. */
4394 set_coding_system
= 1;
4399 /* When we visit a file by raw-text, we change the buffer to
4401 if (CODING_FOR_UNIBYTE (&coding
)
4402 /* Can't do this if part of the buffer might be preserved. */
4404 /* Visiting a file with these coding system makes the buffer
4406 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4409 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4410 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4411 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4413 move_gap_both (PT
, PT_BYTE
);
4414 GAP_SIZE
+= inserted
;
4415 ZV_BYTE
-= inserted
;
4419 decode_coding_gap (&coding
, inserted
, inserted
);
4420 inserted
= coding
.produced_char
;
4421 coding_system
= CODING_ID_NAME (coding
.id
);
4423 else if (inserted
> 0)
4424 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4427 /* Call after-change hooks for the inserted text, aside from the case
4428 of normal visiting (not with REPLACE), which is done in a new buffer
4429 "before" the buffer is changed. */
4430 if (inserted
> 0 && total
> 0
4431 && (NILP (visit
) || !NILP (replace
)))
4433 signal_after_change (PT
, 0, inserted
);
4434 update_compositions (PT
, PT
, CHECK_BORDER
);
4437 /* Now INSERTED is measured in characters. */
4441 if (deferred_remove_unwind_protect
)
4442 /* If requested above, discard the unwind protect for closing the
4448 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4449 bset_undo_list (current_buffer
, Qnil
);
4453 current_buffer
->modtime
= mtime
;
4454 current_buffer
->modtime_size
= st
.st_size
;
4455 bset_filename (current_buffer
, orig_filename
);
4458 SAVE_MODIFF
= MODIFF
;
4459 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4460 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4461 #ifdef CLASH_DETECTION
4464 if (!NILP (BVAR (current_buffer
, file_truename
)))
4465 unlock_file (BVAR (current_buffer
, file_truename
));
4466 unlock_file (filename
);
4468 #endif /* CLASH_DETECTION */
4470 xsignal2 (Qfile_error
,
4471 build_string ("not a regular file"), orig_filename
);
4474 if (set_coding_system
)
4475 Vlast_coding_system_used
= coding_system
;
4477 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4479 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4481 if (! NILP (insval
))
4483 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4484 wrong_type_argument (intern ("inserted-chars"), insval
);
4485 inserted
= XFASTINT (insval
);
4489 /* Decode file format. */
4492 /* Don't run point motion or modification hooks when decoding. */
4493 ptrdiff_t count1
= SPECPDL_INDEX ();
4494 ptrdiff_t old_inserted
= inserted
;
4495 specbind (Qinhibit_point_motion_hooks
, Qt
);
4496 specbind (Qinhibit_modification_hooks
, Qt
);
4498 /* Save old undo list and don't record undo for decoding. */
4499 old_undo
= BVAR (current_buffer
, undo_list
);
4500 bset_undo_list (current_buffer
, Qt
);
4504 insval
= call3 (Qformat_decode
,
4505 Qnil
, make_number (inserted
), visit
);
4506 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4507 wrong_type_argument (intern ("inserted-chars"), insval
);
4508 inserted
= XFASTINT (insval
);
4512 /* If REPLACE is non-nil and we succeeded in not replacing the
4513 beginning or end of the buffer text with the file's contents,
4514 call format-decode with `point' positioned at the beginning
4515 of the buffer and `inserted' equaling the number of
4516 characters in the buffer. Otherwise, format-decode might
4517 fail to correctly analyze the beginning or end of the buffer.
4518 Hence we temporarily save `point' and `inserted' here and
4519 restore `point' iff format-decode did not insert or delete
4520 any text. Otherwise we leave `point' at point-min. */
4521 ptrdiff_t opoint
= PT
;
4522 ptrdiff_t opoint_byte
= PT_BYTE
;
4523 ptrdiff_t oinserted
= ZV
- BEGV
;
4524 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4526 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4527 insval
= call3 (Qformat_decode
,
4528 Qnil
, make_number (oinserted
), visit
);
4529 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4530 wrong_type_argument (intern ("inserted-chars"), insval
);
4531 if (ochars_modiff
== CHARS_MODIFF
)
4532 /* format_decode didn't modify buffer's characters => move
4533 point back to position before inserted text and leave
4534 value of inserted alone. */
4535 SET_PT_BOTH (opoint
, opoint_byte
);
4537 /* format_decode modified buffer's characters => consider
4538 entire buffer changed and leave point at point-min. */
4539 inserted
= XFASTINT (insval
);
4542 /* For consistency with format-decode call these now iff inserted > 0
4543 (martin 2007-06-28). */
4544 p
= Vafter_insert_file_functions
;
4549 insval
= call1 (XCAR (p
), make_number (inserted
));
4552 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4553 wrong_type_argument (intern ("inserted-chars"), insval
);
4554 inserted
= XFASTINT (insval
);
4559 /* For the rationale of this see the comment on
4560 format-decode above. */
4561 ptrdiff_t opoint
= PT
;
4562 ptrdiff_t opoint_byte
= PT_BYTE
;
4563 ptrdiff_t oinserted
= ZV
- BEGV
;
4564 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4566 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4567 insval
= call1 (XCAR (p
), make_number (oinserted
));
4570 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4571 wrong_type_argument (intern ("inserted-chars"), insval
);
4572 if (ochars_modiff
== CHARS_MODIFF
)
4573 /* after_insert_file_functions didn't modify
4574 buffer's characters => move point back to
4575 position before inserted text and leave value of
4577 SET_PT_BOTH (opoint
, opoint_byte
);
4579 /* after_insert_file_functions did modify buffer's
4580 characters => consider entire buffer changed and
4581 leave point at point-min. */
4582 inserted
= XFASTINT (insval
);
4592 bset_undo_list (current_buffer
, old_undo
);
4593 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4595 /* Adjust the last undo record for the size change during
4596 the format conversion. */
4597 Lisp_Object tem
= XCAR (old_undo
);
4598 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4599 && INTEGERP (XCDR (tem
))
4600 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4601 XSETCDR (tem
, make_number (PT
+ inserted
));
4605 /* If undo_list was Qt before, keep it that way.
4606 Otherwise start with an empty undo_list. */
4607 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4609 unbind_to (count1
, Qnil
);
4613 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4615 /* If visiting nonexistent file, return nil. */
4617 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4621 Fsignal (Qquit
, Qnil
);
4623 /* ??? Retval needs to be dealt with in all cases consistently. */
4625 val
= Fcons (orig_filename
,
4626 Fcons (make_number (inserted
),
4629 RETURN_UNGCPRO (unbind_to (count
, val
));
4632 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4635 build_annotations_unwind (Lisp_Object arg
)
4637 Vwrite_region_annotation_buffers
= arg
;
4641 /* Decide the coding-system to encode the data with. */
4644 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4645 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4646 struct coding_system
*coding
)
4649 Lisp_Object eol_parent
= Qnil
;
4652 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4653 BVAR (current_buffer
, auto_save_file_name
))))
4658 else if (!NILP (Vcoding_system_for_write
))
4660 val
= Vcoding_system_for_write
;
4661 if (coding_system_require_warning
4662 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4663 /* Confirm that VAL can surely encode the current region. */
4664 val
= call5 (Vselect_safe_coding_system_function
,
4665 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4670 /* If the variable `buffer-file-coding-system' is set locally,
4671 it means that the file was read with some kind of code
4672 conversion or the variable is explicitly set by users. We
4673 had better write it out with the same coding system even if
4674 `enable-multibyte-characters' is nil.
4676 If it is not set locally, we anyway have to convert EOL
4677 format if the default value of `buffer-file-coding-system'
4678 tells that it is not Unix-like (LF only) format. */
4679 bool using_default_coding
= 0;
4680 bool force_raw_text
= 0;
4682 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4684 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4687 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4693 /* Check file-coding-system-alist. */
4694 Lisp_Object args
[7], coding_systems
;
4696 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4697 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4699 coding_systems
= Ffind_operation_coding_system (7, args
);
4700 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4701 val
= XCDR (coding_systems
);
4706 /* If we still have not decided a coding system, use the
4707 default value of buffer-file-coding-system. */
4708 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4709 using_default_coding
= 1;
4712 if (! NILP (val
) && ! force_raw_text
)
4714 Lisp_Object spec
, attrs
;
4716 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4717 attrs
= AREF (spec
, 0);
4718 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4723 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4724 /* Confirm that VAL can surely encode the current region. */
4725 val
= call5 (Vselect_safe_coding_system_function
,
4726 start
, end
, val
, Qnil
, filename
);
4728 /* If the decided coding-system doesn't specify end-of-line
4729 format, we use that of
4730 `default-buffer-file-coding-system'. */
4731 if (! using_default_coding
4732 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4733 val
= (coding_inherit_eol_type
4734 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4736 /* If we decide not to encode text, use `raw-text' or one of its
4739 val
= raw_text_coding_system (val
);
4742 val
= coding_inherit_eol_type (val
, eol_parent
);
4743 setup_coding_system (val
, coding
);
4745 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4746 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4750 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4751 "r\nFWrite region to file: \ni\ni\ni\np",
4752 doc
: /* Write current region into specified file.
4753 When called from a program, requires three arguments:
4754 START, END and FILENAME. START and END are normally buffer positions
4755 specifying the part of the buffer to write.
4756 If START is nil, that means to use the entire buffer contents.
4757 If START is a string, then output that string to the file
4758 instead of any buffer contents; END is ignored.
4760 Optional fourth argument APPEND if non-nil means
4761 append to existing file contents (if any). If it is an integer,
4762 seek to that offset in the file before writing.
4763 Optional fifth argument VISIT, if t or a string, means
4764 set the last-save-file-modtime of buffer to this file's modtime
4765 and mark buffer not modified.
4766 If VISIT is a string, it is a second file name;
4767 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4768 VISIT is also the file name to lock and unlock for clash detection.
4769 If VISIT is neither t nor nil nor a string,
4770 that means do not display the \"Wrote file\" message.
4771 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4772 use for locking and unlocking, overriding FILENAME and VISIT.
4773 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4774 for an existing file with the same name. If MUSTBENEW is `excl',
4775 that means to get an error if the file already exists; never overwrite.
4776 If MUSTBENEW is neither nil nor `excl', that means ask for
4777 confirmation before overwriting, but do go ahead and overwrite the file
4778 if the user confirms.
4780 This does code conversion according to the value of
4781 `coding-system-for-write', `buffer-file-coding-system', or
4782 `file-coding-system-alist', and sets the variable
4783 `last-coding-system-used' to the coding system actually used.
4785 This calls `write-region-annotate-functions' at the start, and
4786 `write-region-post-annotation-function' at the end. */)
4787 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4795 ptrdiff_t count
= SPECPDL_INDEX ();
4797 Lisp_Object handler
;
4798 Lisp_Object visit_file
;
4799 Lisp_Object annotations
;
4800 Lisp_Object encoded_filename
;
4801 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4802 bool quietly
= !NILP (visit
);
4803 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4804 struct buffer
*given_buffer
;
4805 struct coding_system coding
;
4807 if (current_buffer
->base_buffer
&& visiting
)
4808 error ("Cannot do file visiting in an indirect buffer");
4810 if (!NILP (start
) && !STRINGP (start
))
4811 validate_region (&start
, &end
);
4814 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4816 filename
= Fexpand_file_name (filename
, Qnil
);
4818 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4819 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4821 if (STRINGP (visit
))
4822 visit_file
= Fexpand_file_name (visit
, Qnil
);
4824 visit_file
= filename
;
4826 if (NILP (lockname
))
4827 lockname
= visit_file
;
4831 /* If the file name has special constructs in it,
4832 call the corresponding file handler. */
4833 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4834 /* If FILENAME has no handler, see if VISIT has one. */
4835 if (NILP (handler
) && STRINGP (visit
))
4836 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4838 if (!NILP (handler
))
4841 val
= call6 (handler
, Qwrite_region
, start
, end
,
4842 filename
, append
, visit
);
4846 SAVE_MODIFF
= MODIFF
;
4847 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4848 bset_filename (current_buffer
, visit_file
);
4854 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4856 /* Special kludge to simplify auto-saving. */
4859 /* Do it later, so write-region-annotate-function can work differently
4860 if we save "the buffer" vs "a region".
4861 This is useful in tar-mode. --Stef
4862 XSETFASTINT (start, BEG);
4863 XSETFASTINT (end, Z); */
4867 record_unwind_protect (build_annotations_unwind
,
4868 Vwrite_region_annotation_buffers
);
4869 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4870 count1
= SPECPDL_INDEX ();
4872 given_buffer
= current_buffer
;
4874 if (!STRINGP (start
))
4876 annotations
= build_annotations (start
, end
);
4878 if (current_buffer
!= given_buffer
)
4880 XSETFASTINT (start
, BEGV
);
4881 XSETFASTINT (end
, ZV
);
4887 XSETFASTINT (start
, BEGV
);
4888 XSETFASTINT (end
, ZV
);
4893 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4895 /* Decide the coding-system to encode the data with.
4896 We used to make this choice before calling build_annotations, but that
4897 leads to problems when a write-annotate-function takes care of
4898 unsavable chars (as was the case with X-Symbol). */
4899 Vlast_coding_system_used
4900 = choose_write_coding_system (start
, end
, filename
,
4901 append
, visit
, lockname
, &coding
);
4903 #ifdef CLASH_DETECTION
4905 lock_file (lockname
);
4906 #endif /* CLASH_DETECTION */
4908 encoded_filename
= ENCODE_FILE (filename
);
4910 fn
= SSDATA (encoded_filename
);
4914 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4915 #else /* not DOS_NT */
4916 desc
= emacs_open (fn
, O_WRONLY
, 0);
4917 #endif /* not DOS_NT */
4919 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4921 desc
= emacs_open (fn
,
4922 O_WRONLY
| O_CREAT
| O_BINARY
4923 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4924 S_IREAD
| S_IWRITE
);
4925 #else /* not DOS_NT */
4926 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4927 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4928 auto_saving
? auto_save_mode_bits
: 0666);
4929 #endif /* not DOS_NT */
4933 #ifdef CLASH_DETECTION
4935 if (!auto_saving
) unlock_file (lockname
);
4937 #endif /* CLASH_DETECTION */
4939 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4942 record_unwind_protect (close_file_unwind
, make_number (desc
));
4944 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4948 if (NUMBERP (append
))
4949 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4951 ret
= lseek (desc
, 0, SEEK_END
);
4954 #ifdef CLASH_DETECTION
4956 if (!auto_saving
) unlock_file (lockname
);
4958 #endif /* CLASH_DETECTION */
4960 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4968 if (STRINGP (start
))
4969 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4970 else if (XINT (start
) != XINT (end
))
4971 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4972 &annotations
, &coding
);
4975 /* If file was empty, still need to write the annotations. */
4976 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4977 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4981 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4982 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4984 /* We have to flush out a data. */
4985 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4986 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4993 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4994 Disk full in NFS may be reported here. */
4995 /* mib says that closing the file will try to write as fast as NFS can do
4996 it, and that means the fsync here is not crucial for autosave files. */
4997 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4999 /* If fsync fails with EINTR, don't treat that as serious. Also
5000 ignore EINVAL which happens when fsync is not supported on this
5002 if (errno
!= EINTR
&& errno
!= EINVAL
)
5003 ok
= 0, save_errno
= errno
;
5007 modtime
= invalid_emacs_time ();
5010 if (fstat (desc
, &st
) == 0)
5011 modtime
= get_stat_mtime (&st
);
5013 ok
= 0, save_errno
= errno
;
5016 /* NFS can report a write failure now. */
5017 if (emacs_close (desc
) < 0)
5018 ok
= 0, save_errno
= errno
;
5020 /* Discard the unwind protect for close_file_unwind. */
5021 specpdl_ptr
= specpdl
+ count1
;
5023 /* Call write-region-post-annotation-function. */
5024 while (CONSP (Vwrite_region_annotation_buffers
))
5026 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5027 if (!NILP (Fbuffer_live_p (buf
)))
5030 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5031 call0 (Vwrite_region_post_annotation_function
);
5033 Vwrite_region_annotation_buffers
5034 = XCDR (Vwrite_region_annotation_buffers
);
5037 unbind_to (count
, Qnil
);
5039 #ifdef CLASH_DETECTION
5041 unlock_file (lockname
);
5042 #endif /* CLASH_DETECTION */
5044 /* Do this before reporting IO error
5045 to avoid a "file has changed on disk" warning on
5046 next attempt to save. */
5047 if (EMACS_TIME_VALID_P (modtime
))
5049 current_buffer
->modtime
= modtime
;
5050 current_buffer
->modtime_size
= st
.st_size
;
5054 error ("IO error writing %s: %s", SDATA (filename
),
5055 emacs_strerror (save_errno
));
5059 SAVE_MODIFF
= MODIFF
;
5060 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5061 bset_filename (current_buffer
, visit_file
);
5062 update_mode_lines
++;
5067 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5068 BVAR (current_buffer
, auto_save_file_name
))))
5069 SAVE_MODIFF
= MODIFF
;
5075 message_with_string ((INTEGERP (append
)
5085 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
5087 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5088 doc
: /* Return t if (car A) is numerically less than (car B). */)
5089 (Lisp_Object a
, Lisp_Object b
)
5091 return Flss (Fcar (a
), Fcar (b
));
5094 /* Build the complete list of annotations appropriate for writing out
5095 the text between START and END, by calling all the functions in
5096 write-region-annotate-functions and merging the lists they return.
5097 If one of these functions switches to a different buffer, we assume
5098 that buffer contains altered text. Therefore, the caller must
5099 make sure to restore the current buffer in all cases,
5100 as save-excursion would do. */
5103 build_annotations (Lisp_Object start
, Lisp_Object end
)
5105 Lisp_Object annotations
;
5107 struct gcpro gcpro1
, gcpro2
;
5108 Lisp_Object original_buffer
;
5110 bool used_global
= 0;
5112 XSETBUFFER (original_buffer
, current_buffer
);
5115 p
= Vwrite_region_annotate_functions
;
5116 GCPRO2 (annotations
, p
);
5119 struct buffer
*given_buffer
= current_buffer
;
5120 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5121 { /* Use the global value of the hook. */
5124 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5126 p
= Fappend (2, arg
);
5129 Vwrite_region_annotations_so_far
= annotations
;
5130 res
= call2 (XCAR (p
), start
, end
);
5131 /* If the function makes a different buffer current,
5132 assume that means this buffer contains altered text to be output.
5133 Reset START and END from the buffer bounds
5134 and discard all previous annotations because they should have
5135 been dealt with by this function. */
5136 if (current_buffer
!= given_buffer
)
5138 Vwrite_region_annotation_buffers
5139 = Fcons (Fcurrent_buffer (),
5140 Vwrite_region_annotation_buffers
);
5141 XSETFASTINT (start
, BEGV
);
5142 XSETFASTINT (end
, ZV
);
5145 Flength (res
); /* Check basic validity of return value */
5146 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5150 /* Now do the same for annotation functions implied by the file-format */
5151 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5152 p
= BVAR (current_buffer
, auto_save_file_format
);
5154 p
= BVAR (current_buffer
, file_format
);
5155 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5157 struct buffer
*given_buffer
= current_buffer
;
5159 Vwrite_region_annotations_so_far
= annotations
;
5161 /* Value is either a list of annotations or nil if the function
5162 has written annotations to a temporary buffer, which is now
5164 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5165 original_buffer
, make_number (i
));
5166 if (current_buffer
!= given_buffer
)
5168 XSETFASTINT (start
, BEGV
);
5169 XSETFASTINT (end
, ZV
);
5174 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5182 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5183 If STRING is nil, POS is the character position in the current buffer.
5184 Intersperse with them the annotations from *ANNOT
5185 which fall within the range of POS to POS + NCHARS,
5186 each at its appropriate position.
5188 We modify *ANNOT by discarding elements as we use them up.
5190 Return true if successful. */
5193 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5194 ptrdiff_t nchars
, Lisp_Object
*annot
,
5195 struct coding_system
*coding
)
5199 ptrdiff_t lastpos
= pos
+ nchars
;
5201 while (NILP (*annot
) || CONSP (*annot
))
5203 tem
= Fcar_safe (Fcar (*annot
));
5206 nextpos
= XFASTINT (tem
);
5208 /* If there are no more annotations in this range,
5209 output the rest of the range all at once. */
5210 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5211 return e_write (desc
, string
, pos
, lastpos
, coding
);
5213 /* Output buffer text up to the next annotation's position. */
5216 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5220 /* Output the annotation. */
5221 tem
= Fcdr (Fcar (*annot
));
5224 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5227 *annot
= Fcdr (*annot
);
5233 /* Write text in the range START and END into descriptor DESC,
5234 encoding them with coding system CODING. If STRING is nil, START
5235 and END are character positions of the current buffer, else they
5236 are indexes to the string STRING. Return true if successful. */
5239 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5240 struct coding_system
*coding
)
5242 if (STRINGP (string
))
5245 end
= SCHARS (string
);
5248 /* We used to have a code for handling selective display here. But,
5249 now it is handled within encode_coding. */
5253 if (STRINGP (string
))
5255 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5256 if (CODING_REQUIRE_ENCODING (coding
))
5258 encode_coding_object (coding
, string
,
5259 start
, string_char_to_byte (string
, start
),
5260 end
, string_char_to_byte (string
, end
), Qt
);
5264 coding
->dst_object
= string
;
5265 coding
->consumed_char
= SCHARS (string
);
5266 coding
->produced
= SBYTES (string
);
5271 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5272 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5274 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5275 if (CODING_REQUIRE_ENCODING (coding
))
5277 encode_coding_object (coding
, Fcurrent_buffer (),
5278 start
, start_byte
, end
, end_byte
, Qt
);
5282 coding
->dst_object
= Qnil
;
5283 coding
->dst_pos_byte
= start_byte
;
5284 if (start
>= GPT
|| end
<= GPT
)
5286 coding
->consumed_char
= end
- start
;
5287 coding
->produced
= end_byte
- start_byte
;
5291 coding
->consumed_char
= GPT
- start
;
5292 coding
->produced
= GPT_BYTE
- start_byte
;
5297 if (coding
->produced
> 0)
5300 -= emacs_write (desc
,
5301 STRINGP (coding
->dst_object
)
5302 ? SSDATA (coding
->dst_object
)
5303 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5306 if (coding
->produced
)
5309 start
+= coding
->consumed_char
;
5315 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5316 Sverify_visited_file_modtime
, 0, 1, 0,
5317 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5318 This means that the file has not been changed since it was visited or saved.
5319 If BUF is omitted or nil, it defaults to the current buffer.
5320 See Info node `(elisp)Modification Time' for more details. */)
5325 Lisp_Object handler
;
5326 Lisp_Object filename
;
5337 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5338 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5340 /* If the file name has special constructs in it,
5341 call the corresponding file handler. */
5342 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5343 Qverify_visited_file_modtime
);
5344 if (!NILP (handler
))
5345 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5347 filename
= ENCODE_FILE (BVAR (b
, filename
));
5349 mtime
= (stat (SSDATA (filename
), &st
) == 0
5350 ? get_stat_mtime (&st
)
5351 : time_error_value (errno
));
5352 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5353 && (b
->modtime_size
< 0
5354 || st
.st_size
== b
->modtime_size
))
5359 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5360 Sclear_visited_file_modtime
, 0, 0, 0,
5361 doc
: /* Clear out records of last mod time of visited file.
5362 Next attempt to save will certainly not complain of a discrepancy. */)
5365 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5366 current_buffer
->modtime_size
= -1;
5370 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5371 Svisited_file_modtime
, 0, 0, 0,
5372 doc
: /* Return the current buffer's recorded visited file modification time.
5373 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5374 `file-attributes' returns. If the current buffer has no recorded file
5375 modification time, this function returns 0. If the visited file
5376 doesn't exist, HIGH will be -1.
5377 See Info node `(elisp)Modification Time' for more details. */)
5380 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5382 if (EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
5384 /* make_lisp_time won't work here if time_t is unsigned. */
5385 return list4 (make_number (-1), make_number (65535),
5386 make_number (0), make_number (0));
5388 return make_number (0);
5390 return make_lisp_time (current_buffer
->modtime
);
5393 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5394 Sset_visited_file_modtime
, 0, 1, 0,
5395 doc
: /* Update buffer's recorded modification time from the visited file's time.
5396 Useful if the buffer was not read from the file normally
5397 or if the file itself has been changed for some known benign reason.
5398 An argument specifies the modification time value to use
5399 \(instead of that of the visited file), in the form of a list
5400 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5401 (Lisp_Object time_list
)
5403 if (!NILP (time_list
))
5405 current_buffer
->modtime
= lisp_time_argument (time_list
);
5406 current_buffer
->modtime_size
= -1;
5410 register Lisp_Object filename
;
5412 Lisp_Object handler
;
5414 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5416 /* If the file name has special constructs in it,
5417 call the corresponding file handler. */
5418 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5419 if (!NILP (handler
))
5420 /* The handler can find the file name the same way we did. */
5421 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5423 filename
= ENCODE_FILE (filename
);
5425 if (stat (SSDATA (filename
), &st
) >= 0)
5427 current_buffer
->modtime
= get_stat_mtime (&st
);
5428 current_buffer
->modtime_size
= st
.st_size
;
5436 auto_save_error (Lisp_Object error_val
)
5438 Lisp_Object args
[3], msg
;
5440 struct gcpro gcpro1
;
5444 auto_save_error_occurred
= 1;
5446 ring_bell (XFRAME (selected_frame
));
5448 args
[0] = build_string ("Auto-saving %s: %s");
5449 args
[1] = BVAR (current_buffer
, name
);
5450 args
[2] = Ferror_message_string (error_val
);
5451 msg
= Fformat (3, args
);
5453 nbytes
= SBYTES (msg
);
5454 msgbuf
= SAFE_ALLOCA (nbytes
);
5455 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5457 for (i
= 0; i
< 3; ++i
)
5460 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5462 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5463 Fsleep_for (make_number (1), Qnil
);
5477 auto_save_mode_bits
= 0666;
5479 /* Get visited file's mode to become the auto save file's mode. */
5480 if (! NILP (BVAR (current_buffer
, filename
)))
5482 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5483 /* But make sure we can overwrite it later! */
5484 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5485 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5487 /* Remote files don't cooperate with stat. */
5488 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5492 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5493 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5498 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5501 FILE *stream
= XSAVE_POINTER (arg
, 0);
5513 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5516 minibuffer_auto_raise
= XINT (value
);
5521 do_auto_save_make_dir (Lisp_Object dir
)
5525 auto_saving_dir_umask
= 077;
5526 result
= call2 (Qmake_directory
, dir
, Qt
);
5527 auto_saving_dir_umask
= 0;
5532 do_auto_save_eh (Lisp_Object ignore
)
5534 auto_saving_dir_umask
= 0;
5538 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5539 doc
: /* Auto-save all buffers that need it.
5540 This is all buffers that have auto-saving enabled
5541 and are changed since last auto-saved.
5542 Auto-saving writes the buffer into a file
5543 so that your editing is not lost if the system crashes.
5544 This file is not the file you visited; that changes only when you save.
5545 Normally we run the normal hook `auto-save-hook' before saving.
5547 A non-nil NO-MESSAGE argument means do not print any message if successful.
5548 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5549 (Lisp_Object no_message
, Lisp_Object current_only
)
5551 struct buffer
*old
= current_buffer
, *b
;
5552 Lisp_Object tail
, buf
, hook
;
5553 bool auto_saved
= 0;
5554 int do_handled_files
;
5556 FILE *stream
= NULL
;
5557 ptrdiff_t count
= SPECPDL_INDEX ();
5558 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5559 bool old_message_p
= 0;
5560 struct gcpro gcpro1
, gcpro2
;
5562 if (max_specpdl_size
< specpdl_size
+ 40)
5563 max_specpdl_size
= specpdl_size
+ 40;
5568 if (NILP (no_message
))
5570 old_message_p
= push_message ();
5571 record_unwind_protect (pop_message_unwind
, Qnil
);
5574 /* Ordinarily don't quit within this function,
5575 but don't make it impossible to quit (in case we get hung in I/O). */
5579 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5580 point to non-strings reached from Vbuffer_alist. */
5582 hook
= intern ("auto-save-hook");
5583 Frun_hooks (1, &hook
);
5585 if (STRINGP (Vauto_save_list_file_name
))
5587 Lisp_Object listfile
;
5589 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5591 /* Don't try to create the directory when shutting down Emacs,
5592 because creating the directory might signal an error, and
5593 that would leave Emacs in a strange state. */
5594 if (!NILP (Vrun_hooks
))
5598 GCPRO2 (dir
, listfile
);
5599 dir
= Ffile_name_directory (listfile
);
5600 if (NILP (Ffile_directory_p (dir
)))
5601 internal_condition_case_1 (do_auto_save_make_dir
,
5607 stream
= fopen (SSDATA (listfile
), "w");
5610 record_unwind_protect (do_auto_save_unwind
,
5611 make_save_value (stream
, 0));
5612 record_unwind_protect (do_auto_save_unwind_1
,
5613 make_number (minibuffer_auto_raise
));
5614 minibuffer_auto_raise
= 0;
5616 auto_save_error_occurred
= 0;
5618 /* On first pass, save all files that don't have handlers.
5619 On second pass, save all files that do have handlers.
5621 If Emacs is crashing, the handlers may tweak what is causing
5622 Emacs to crash in the first place, and it would be a shame if
5623 Emacs failed to autosave perfectly ordinary files because it
5624 couldn't handle some ange-ftp'd file. */
5626 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5627 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5629 buf
= XCDR (XCAR (tail
));
5632 /* Record all the buffers that have auto save mode
5633 in the special file that lists them. For each of these buffers,
5634 Record visited name (if any) and auto save name. */
5635 if (STRINGP (BVAR (b
, auto_save_file_name
))
5636 && stream
!= NULL
&& do_handled_files
== 0)
5639 if (!NILP (BVAR (b
, filename
)))
5641 fwrite (SDATA (BVAR (b
, filename
)), 1,
5642 SBYTES (BVAR (b
, filename
)), stream
);
5644 putc ('\n', stream
);
5645 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5646 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5647 putc ('\n', stream
);
5651 if (!NILP (current_only
)
5652 && b
!= current_buffer
)
5655 /* Don't auto-save indirect buffers.
5656 The base buffer takes care of it. */
5660 /* Check for auto save enabled
5661 and file changed since last auto save
5662 and file changed since last real save. */
5663 if (STRINGP (BVAR (b
, auto_save_file_name
))
5664 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5665 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5666 /* -1 means we've turned off autosaving for a while--see below. */
5667 && XINT (BVAR (b
, save_length
)) >= 0
5668 && (do_handled_files
5669 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5672 EMACS_TIME before_time
= current_emacs_time ();
5673 EMACS_TIME after_time
;
5675 /* If we had a failure, don't try again for 20 minutes. */
5676 if (b
->auto_save_failure_time
> 0
5677 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5680 set_buffer_internal (b
);
5681 if (NILP (Vauto_save_include_big_deletions
)
5682 && (XFASTINT (BVAR (b
, save_length
)) * 10
5683 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5684 /* A short file is likely to change a large fraction;
5685 spare the user annoying messages. */
5686 && XFASTINT (BVAR (b
, save_length
)) > 5000
5687 /* These messages are frequent and annoying for `*mail*'. */
5688 && !EQ (BVAR (b
, filename
), Qnil
)
5689 && NILP (no_message
))
5691 /* It has shrunk too much; turn off auto-saving here. */
5692 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5693 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5695 minibuffer_auto_raise
= 0;
5696 /* Turn off auto-saving until there's a real save,
5697 and prevent any more warnings. */
5698 XSETINT (BVAR (b
, save_length
), -1);
5699 Fsleep_for (make_number (1), Qnil
);
5702 if (!auto_saved
&& NILP (no_message
))
5703 message1 ("Auto-saving...");
5704 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5706 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5707 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5708 set_buffer_internal (old
);
5710 after_time
= current_emacs_time ();
5712 /* If auto-save took more than 60 seconds,
5713 assume it was an NFS failure that got a timeout. */
5714 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5715 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5719 /* Prevent another auto save till enough input events come in. */
5720 record_auto_save ();
5722 if (auto_saved
&& NILP (no_message
))
5726 /* If we are going to restore an old message,
5727 give time to read ours. */
5728 sit_for (make_number (1), 0, 0);
5731 else if (!auto_save_error_occurred
)
5732 /* Don't overwrite the error message if an error occurred.
5733 If we displayed a message and then restored a state
5734 with no message, leave a "done" message on the screen. */
5735 message1 ("Auto-saving...done");
5740 /* This restores the message-stack status. */
5741 unbind_to (count
, Qnil
);
5745 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5746 Sset_buffer_auto_saved
, 0, 0, 0,
5747 doc
: /* Mark current buffer as auto-saved with its current text.
5748 No auto-save file will be written until the buffer changes again. */)
5751 /* FIXME: This should not be called in indirect buffers, since
5752 they're not autosaved. */
5753 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5754 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5755 current_buffer
->auto_save_failure_time
= 0;
5759 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5760 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5761 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5764 current_buffer
->auto_save_failure_time
= 0;
5768 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5770 doc
: /* Return t if current buffer has been auto-saved recently.
5771 More precisely, if it has been auto-saved since last read from or saved
5772 in the visited file. If the buffer has no visited file,
5773 then any auto-save counts as "recent". */)
5776 /* FIXME: maybe we should return nil for indirect buffers since
5777 they're never autosaved. */
5778 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5781 /* Reading and completing file names */
5783 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5784 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5785 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5786 The return value is only relevant for a call to `read-file-name' that happens
5787 before any other event (mouse or keypress) is handled. */)
5790 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5791 || defined (HAVE_NS)
5792 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5802 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5804 struct gcpro gcpro1
;
5805 Lisp_Object args
[7];
5807 GCPRO1 (default_filename
);
5808 args
[0] = intern ("read-file-name");
5811 args
[3] = default_filename
;
5812 args
[4] = mustmatch
;
5814 args
[6] = predicate
;
5815 RETURN_UNGCPRO (Ffuncall (7, args
));
5820 syms_of_fileio (void)
5822 DEFSYM (Qoperations
, "operations");
5823 DEFSYM (Qexpand_file_name
, "expand-file-name");
5824 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5825 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5826 DEFSYM (Qfile_name_directory
, "file-name-directory");
5827 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5828 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5829 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5830 DEFSYM (Qcopy_file
, "copy-file");
5831 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5832 DEFSYM (Qmake_directory
, "make-directory");
5833 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5834 DEFSYM (Qdelete_file
, "delete-file");
5835 DEFSYM (Qrename_file
, "rename-file");
5836 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5837 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5838 DEFSYM (Qfile_exists_p
, "file-exists-p");
5839 DEFSYM (Qfile_executable_p
, "file-executable-p");
5840 DEFSYM (Qfile_readable_p
, "file-readable-p");
5841 DEFSYM (Qfile_writable_p
, "file-writable-p");
5842 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5843 DEFSYM (Qaccess_file
, "access-file");
5844 DEFSYM (Qfile_directory_p
, "file-directory-p");
5845 DEFSYM (Qfile_regular_p
, "file-regular-p");
5846 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5847 DEFSYM (Qfile_modes
, "file-modes");
5848 DEFSYM (Qset_file_modes
, "set-file-modes");
5849 DEFSYM (Qset_file_times
, "set-file-times");
5850 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5851 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5852 DEFSYM (Qfile_acl
, "file-acl");
5853 DEFSYM (Qset_file_acl
, "set-file-acl");
5854 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5855 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5856 DEFSYM (Qwrite_region
, "write-region");
5857 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5858 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5859 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5861 DEFSYM (Qfile_name_history
, "file-name-history");
5862 Fset (Qfile_name_history
, Qnil
);
5864 DEFSYM (Qfile_error
, "file-error");
5865 DEFSYM (Qfile_already_exists
, "file-already-exists");
5866 DEFSYM (Qfile_date_error
, "file-date-error");
5867 DEFSYM (Qexcl
, "excl");
5869 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5870 doc
: /* Coding system for encoding file names.
5871 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5872 Vfile_name_coding_system
= Qnil
;
5874 DEFVAR_LISP ("default-file-name-coding-system",
5875 Vdefault_file_name_coding_system
,
5876 doc
: /* Default coding system for encoding file names.
5877 This variable is used only when `file-name-coding-system' is nil.
5879 This variable is set/changed by the command `set-language-environment'.
5880 User should not set this variable manually,
5881 instead use `file-name-coding-system' to get a constant encoding
5882 of file names regardless of the current language environment. */);
5883 Vdefault_file_name_coding_system
= Qnil
;
5885 DEFSYM (Qformat_decode
, "format-decode");
5886 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5887 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5888 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5890 Fput (Qfile_error
, Qerror_conditions
,
5891 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5892 Fput (Qfile_error
, Qerror_message
,
5893 build_pure_c_string ("File error"));
5895 Fput (Qfile_already_exists
, Qerror_conditions
,
5896 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5897 Fput (Qfile_already_exists
, Qerror_message
,
5898 build_pure_c_string ("File already exists"));
5900 Fput (Qfile_date_error
, Qerror_conditions
,
5901 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5902 Fput (Qfile_date_error
, Qerror_message
,
5903 build_pure_c_string ("Cannot set file date"));
5905 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5906 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5907 If a file name matches REGEXP, all I/O on that file is done by calling
5908 HANDLER. If a file name matches more than one handler, the handler
5909 whose match starts last in the file name gets precedence. The
5910 function `find-file-name-handler' checks this list for a handler for
5913 HANDLER should be a function. The first argument given to it is the
5914 name of the I/O primitive to be handled; the remaining arguments are
5915 the arguments that were passed to that primitive. For example, if you
5916 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5917 HANDLER is called like this:
5919 (funcall HANDLER 'file-exists-p FILENAME)
5921 Note that HANDLER must be able to handle all I/O primitives; if it has
5922 nothing special to do for a primitive, it should reinvoke the
5923 primitive to handle the operation \"the usual way\".
5924 See Info node `(elisp)Magic File Names' for more details. */);
5925 Vfile_name_handler_alist
= Qnil
;
5927 DEFVAR_LISP ("set-auto-coding-function",
5928 Vset_auto_coding_function
,
5929 doc
: /* If non-nil, a function to call to decide a coding system of file.
5930 Two arguments are passed to this function: the file name
5931 and the length of a file contents following the point.
5932 This function should return a coding system to decode the file contents.
5933 It should check the file name against `auto-coding-alist'.
5934 If no coding system is decided, it should check a coding system
5935 specified in the heading lines with the format:
5936 -*- ... coding: CODING-SYSTEM; ... -*-
5937 or local variable spec of the tailing lines with `coding:' tag. */);
5938 Vset_auto_coding_function
= Qnil
;
5940 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5941 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5942 Each is passed one argument, the number of characters inserted,
5943 with point at the start of the inserted text. Each function
5944 should leave point the same, and return the new character count.
5945 If `insert-file-contents' is intercepted by a handler from
5946 `file-name-handler-alist', that handler is responsible for calling the
5947 functions in `after-insert-file-functions' if appropriate. */);
5948 Vafter_insert_file_functions
= Qnil
;
5950 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5951 doc
: /* A list of functions to be called at the start of `write-region'.
5952 Each is passed two arguments, START and END as for `write-region'.
5953 These are usually two numbers but not always; see the documentation
5954 for `write-region'. The function should return a list of pairs
5955 of the form (POSITION . STRING), consisting of strings to be effectively
5956 inserted at the specified positions of the file being written (1 means to
5957 insert before the first byte written). The POSITIONs must be sorted into
5960 If there are several annotation functions, the lists returned by these
5961 functions are merged destructively. As each annotation function runs,
5962 the variable `write-region-annotations-so-far' contains a list of all
5963 annotations returned by previous annotation functions.
5965 An annotation function can return with a different buffer current.
5966 Doing so removes the annotations returned by previous functions, and
5967 resets START and END to `point-min' and `point-max' of the new buffer.
5969 After `write-region' completes, Emacs calls the function stored in
5970 `write-region-post-annotation-function', once for each buffer that was
5971 current when building the annotations (i.e., at least once), with that
5972 buffer current. */);
5973 Vwrite_region_annotate_functions
= Qnil
;
5974 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5976 DEFVAR_LISP ("write-region-post-annotation-function",
5977 Vwrite_region_post_annotation_function
,
5978 doc
: /* Function to call after `write-region' completes.
5979 The function is called with no arguments. If one or more of the
5980 annotation functions in `write-region-annotate-functions' changed the
5981 current buffer, the function stored in this variable is called for
5982 each of those additional buffers as well, in addition to the original
5983 buffer. The relevant buffer is current during each function call. */);
5984 Vwrite_region_post_annotation_function
= Qnil
;
5985 staticpro (&Vwrite_region_annotation_buffers
);
5987 DEFVAR_LISP ("write-region-annotations-so-far",
5988 Vwrite_region_annotations_so_far
,
5989 doc
: /* When an annotation function is called, this holds the previous annotations.
5990 These are the annotations made by other annotation functions
5991 that were already called. See also `write-region-annotate-functions'. */);
5992 Vwrite_region_annotations_so_far
= Qnil
;
5994 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5995 doc
: /* A list of file name handlers that temporarily should not be used.
5996 This applies only to the operation `inhibit-file-name-operation'. */);
5997 Vinhibit_file_name_handlers
= Qnil
;
5999 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6000 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6001 Vinhibit_file_name_operation
= Qnil
;
6003 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6004 doc
: /* File name in which we write a list of all auto save file names.
6005 This variable is initialized automatically from `auto-save-list-file-prefix'
6006 shortly after Emacs reads your init file, if you have not yet given it
6007 a non-nil value. */);
6008 Vauto_save_list_file_name
= Qnil
;
6010 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6011 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6012 Normally auto-save files are written under other names. */);
6013 Vauto_save_visited_file_name
= Qnil
;
6015 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6016 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6017 If nil, deleting a substantial portion of the text disables auto-save
6018 in the buffer; this is the default behavior, because the auto-save
6019 file is usually more useful if it contains the deleted text. */);
6020 Vauto_save_include_big_deletions
= Qnil
;
6023 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6024 doc
: /* Non-nil means don't call fsync in `write-region'.
6025 This variable affects calls to `write-region' as well as save commands.
6026 A non-nil value may result in data loss! */);
6027 write_region_inhibit_fsync
= 0;
6030 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6031 doc
: /* Specifies whether to use the system's trash can.
6032 When non-nil, certain file deletion commands use the function
6033 `move-file-to-trash' instead of deleting files outright.
6034 This includes interactive calls to `delete-file' and
6035 `delete-directory' and the Dired deletion commands. */);
6036 delete_by_moving_to_trash
= 0;
6037 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6039 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6040 DEFSYM (Qcopy_directory
, "copy-directory");
6041 DEFSYM (Qdelete_directory
, "delete-directory");
6043 defsubr (&Sfind_file_name_handler
);
6044 defsubr (&Sfile_name_directory
);
6045 defsubr (&Sfile_name_nondirectory
);
6046 defsubr (&Sunhandled_file_name_directory
);
6047 defsubr (&Sfile_name_as_directory
);
6048 defsubr (&Sdirectory_file_name
);
6049 defsubr (&Smake_temp_name
);
6050 defsubr (&Sexpand_file_name
);
6051 defsubr (&Ssubstitute_in_file_name
);
6052 defsubr (&Scopy_file
);
6053 defsubr (&Smake_directory_internal
);
6054 defsubr (&Sdelete_directory_internal
);
6055 defsubr (&Sdelete_file
);
6056 defsubr (&Srename_file
);
6057 defsubr (&Sadd_name_to_file
);
6058 defsubr (&Smake_symbolic_link
);
6059 defsubr (&Sfile_name_absolute_p
);
6060 defsubr (&Sfile_exists_p
);
6061 defsubr (&Sfile_executable_p
);
6062 defsubr (&Sfile_readable_p
);
6063 defsubr (&Sfile_writable_p
);
6064 defsubr (&Saccess_file
);
6065 defsubr (&Sfile_symlink_p
);
6066 defsubr (&Sfile_directory_p
);
6067 defsubr (&Sfile_accessible_directory_p
);
6068 defsubr (&Sfile_regular_p
);
6069 defsubr (&Sfile_modes
);
6070 defsubr (&Sset_file_modes
);
6071 defsubr (&Sset_file_times
);
6072 defsubr (&Sfile_selinux_context
);
6073 defsubr (&Sfile_acl
);
6074 defsubr (&Sset_file_acl
);
6075 defsubr (&Sset_file_selinux_context
);
6076 defsubr (&Sset_default_file_modes
);
6077 defsubr (&Sdefault_file_modes
);
6078 defsubr (&Sfile_newer_than_file_p
);
6079 defsubr (&Sinsert_file_contents
);
6080 defsubr (&Swrite_region
);
6081 defsubr (&Scar_less_than_car
);
6082 defsubr (&Sverify_visited_file_modtime
);
6083 defsubr (&Sclear_visited_file_modtime
);
6084 defsubr (&Svisited_file_modtime
);
6085 defsubr (&Sset_visited_file_modtime
);
6086 defsubr (&Sdo_auto_save
);
6087 defsubr (&Sset_buffer_auto_saved
);
6088 defsubr (&Sclear_buffer_auto_save_failure
);
6089 defsubr (&Srecent_auto_save_p
);
6091 defsubr (&Snext_read_file_uses_dialog_p
);
6094 defsubr (&Sunix_sync
);