1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
53 #include "dispextern.h"
61 #endif /* not WINDOWSNT */
65 #include <sys/param.h>
70 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
71 redirector allows the six letters between 'Z' and 'a' as well. */
73 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
76 #define IS_DRIVE(x) c_isalpha (x)
78 /* Need to lower-case the drive letter, or else expanded
79 filenames will sometimes compare unequal, because
80 `expand-file-name' doesn't always down-case the drive letter. */
81 #define DRIVE_LETTER(x) c_tolower (x)
85 #include <stat-time.h>
93 /* True during writing of auto-save files. */
94 static bool auto_saving
;
96 /* Nonzero umask during creation of auto-save directories. */
97 static mode_t auto_saving_dir_umask
;
99 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
100 a new file with the same mode as the original. */
101 static mode_t auto_save_mode_bits
;
103 /* Set by auto_save_1 if an error occurred during the last auto-save. */
104 static bool auto_save_error_occurred
;
106 /* The symbol bound to coding-system-for-read when
107 insert-file-contents is called for recovering a file. This is not
108 an actual coding system name, but just an indicator to tell
109 insert-file-contents to use `emacs-mule' with a special flag for
110 auto saving and recovering a file. */
111 static Lisp_Object Qauto_save_coding
;
113 /* Property name of a file name handler,
114 which gives a list of operations it handles.. */
115 static Lisp_Object Qoperations
;
117 /* Lisp functions for translating file formats. */
118 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
120 /* Lisp function for setting buffer-file-coding-system and the
121 multibyteness of the current buffer after inserting a file. */
122 static Lisp_Object Qafter_insert_file_set_coding
;
124 static Lisp_Object Qwrite_region_annotate_functions
;
125 /* Each time an annotation function changes the buffer, the new buffer
127 static Lisp_Object Vwrite_region_annotation_buffers
;
132 static Lisp_Object Qdelete_by_moving_to_trash
;
134 /* Lisp function for moving files to trash. */
135 static Lisp_Object Qmove_file_to_trash
;
137 /* Lisp function for recursively copying directories. */
138 static Lisp_Object Qcopy_directory
;
140 /* Lisp function for recursively deleting directories. */
141 static Lisp_Object Qdelete_directory
;
146 Lisp_Object Qfile_error
;
147 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
148 static Lisp_Object Qexcl
;
149 Lisp_Object Qfile_name_history
;
151 static Lisp_Object Qcar_less_than_car
;
153 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
154 Lisp_Object
*, struct coding_system
*);
155 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
156 struct coding_system
*);
160 report_file_error (const char *string
, Lisp_Object data
)
162 Lisp_Object errstring
;
166 synchronize_system_messages_locale ();
167 str
= strerror (errorno
);
168 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
169 Vlocale_coding_system
, 0);
175 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
178 /* System error messages are capitalized. Downcase the initial
179 unless it is followed by a slash. (The slash case caters to
180 error messages that begin with "I/O" or, in German, "E/A".) */
181 if (STRING_MULTIBYTE (errstring
)
182 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
186 str
= SSDATA (errstring
);
187 c
= STRING_CHAR ((unsigned char *) str
);
188 Faset (errstring
, make_number (0), make_number (downcase (c
)));
191 xsignal (Qfile_error
,
192 Fcons (build_string (string
), Fcons (errstring
, data
)));
197 close_file_unwind (Lisp_Object fd
)
199 emacs_close (XFASTINT (fd
));
203 /* Restore point, having saved it as a marker. */
206 restore_point_unwind (Lisp_Object location
)
208 Fgoto_char (location
);
209 Fset_marker (location
, Qnil
, Qnil
);
214 static Lisp_Object Qexpand_file_name
;
215 static Lisp_Object Qsubstitute_in_file_name
;
216 static Lisp_Object Qdirectory_file_name
;
217 static Lisp_Object Qfile_name_directory
;
218 static Lisp_Object Qfile_name_nondirectory
;
219 static Lisp_Object Qunhandled_file_name_directory
;
220 static Lisp_Object Qfile_name_as_directory
;
221 static Lisp_Object Qcopy_file
;
222 static Lisp_Object Qmake_directory_internal
;
223 static Lisp_Object Qmake_directory
;
224 static Lisp_Object Qdelete_directory_internal
;
225 Lisp_Object Qdelete_file
;
226 static Lisp_Object Qrename_file
;
227 static Lisp_Object Qadd_name_to_file
;
228 static Lisp_Object Qmake_symbolic_link
;
229 Lisp_Object Qfile_exists_p
;
230 static Lisp_Object Qfile_executable_p
;
231 static Lisp_Object Qfile_readable_p
;
232 static Lisp_Object Qfile_writable_p
;
233 static Lisp_Object Qfile_symlink_p
;
234 static Lisp_Object Qaccess_file
;
235 Lisp_Object Qfile_directory_p
;
236 static Lisp_Object Qfile_regular_p
;
237 static Lisp_Object Qfile_accessible_directory_p
;
238 static Lisp_Object Qfile_modes
;
239 static Lisp_Object Qset_file_modes
;
240 static Lisp_Object Qset_file_times
;
241 static Lisp_Object Qfile_selinux_context
;
242 static Lisp_Object Qset_file_selinux_context
;
243 static Lisp_Object Qfile_acl
;
244 static Lisp_Object Qset_file_acl
;
245 static Lisp_Object Qfile_newer_than_file_p
;
246 Lisp_Object Qinsert_file_contents
;
247 Lisp_Object Qwrite_region
;
248 static Lisp_Object Qverify_visited_file_modtime
;
249 static Lisp_Object Qset_visited_file_modtime
;
251 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
252 Sfind_file_name_handler
, 2, 2, 0,
253 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
254 Otherwise, return nil.
255 A file name is handled if one of the regular expressions in
256 `file-name-handler-alist' matches it.
258 If OPERATION equals `inhibit-file-name-operation', then we ignore
259 any handlers that are members of `inhibit-file-name-handlers',
260 but we still do run any other handlers. This lets handlers
261 use the standard functions without calling themselves recursively. */)
262 (Lisp_Object filename
, Lisp_Object operation
)
264 /* This function must not munge the match data. */
265 Lisp_Object chain
, inhibited_handlers
, result
;
269 CHECK_STRING (filename
);
271 if (EQ (operation
, Vinhibit_file_name_operation
))
272 inhibited_handlers
= Vinhibit_file_name_handlers
;
274 inhibited_handlers
= Qnil
;
276 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
277 chain
= XCDR (chain
))
283 Lisp_Object string
= XCAR (elt
);
285 Lisp_Object handler
= XCDR (elt
);
286 Lisp_Object operations
= Qnil
;
288 if (SYMBOLP (handler
))
289 operations
= Fget (handler
, Qoperations
);
292 && (match_pos
= fast_string_match (string
, filename
)) > pos
293 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
297 handler
= XCDR (elt
);
298 tem
= Fmemq (handler
, inhibited_handlers
);
312 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
314 doc
: /* Return the directory component in file name FILENAME.
315 Return nil if FILENAME does not include a directory.
316 Otherwise return a directory name.
317 Given a Unix syntax file name, returns a string ending in slash. */)
318 (Lisp_Object filename
)
321 register const char *beg
;
326 register const char *p
;
329 CHECK_STRING (filename
);
331 /* If the file name has special constructs in it,
332 call the corresponding file handler. */
333 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
336 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
338 return STRINGP (handled_name
) ? handled_name
: Qnil
;
342 beg
= alloca (SBYTES (filename
) + 1);
343 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
345 beg
= SSDATA (filename
);
347 p
= beg
+ SBYTES (filename
);
349 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
351 /* only recognize drive specifier at the beginning */
353 /* handle the "/:d:foo" and "/:foo" cases correctly */
354 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
355 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
362 /* Expansion of "c:" to drive and default directory. */
365 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
366 char *res
= alloca (MAXPATHLEN
+ 1);
369 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
371 memcpy (res
, beg
, 2);
376 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
378 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
381 p
= beg
+ strlen (beg
);
384 tem_fn
= ENCODE_FILE (make_specified_string (beg
, -1, p
- beg
,
385 STRING_MULTIBYTE (filename
)));
386 dostounix_filename (SSDATA (tem_fn
));
387 return DECODE_FILE (tem_fn
);
389 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
393 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
394 Sfile_name_nondirectory
, 1, 1, 0,
395 doc
: /* Return file name FILENAME sans its directory.
396 For example, in a Unix-syntax file name,
397 this is everything after the last slash,
398 or the entire name if it contains no slash. */)
399 (Lisp_Object filename
)
401 register const char *beg
, *p
, *end
;
404 CHECK_STRING (filename
);
406 /* If the file name has special constructs in it,
407 call the corresponding file handler. */
408 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
411 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
413 if (STRINGP (handled_name
))
415 error ("Invalid handler in `file-name-handler-alist'");
418 beg
= SSDATA (filename
);
419 end
= p
= beg
+ SBYTES (filename
);
421 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
423 /* only recognize drive specifier at beginning */
425 /* handle the "/:d:foo" case correctly */
426 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
431 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
434 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
435 Sunhandled_file_name_directory
, 1, 1, 0,
436 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
437 A `directly usable' directory name is one that may be used without the
438 intervention of any file handler.
439 If FILENAME is a directly usable file itself, return
440 \(file-name-directory FILENAME).
441 If FILENAME refers to a file which is not accessible from a local process,
442 then this should return nil.
443 The `call-process' and `start-process' functions use this function to
444 get a current directory to run processes in. */)
445 (Lisp_Object filename
)
449 /* If the file name has special constructs in it,
450 call the corresponding file handler. */
451 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
454 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
456 return STRINGP (handled_name
) ? handled_name
: Qnil
;
459 return Ffile_name_directory (filename
);
462 /* Convert from file name SRC of length SRCLEN to directory name
463 in DST. On UNIX, just make sure there is a terminating /.
464 Return the length of DST in bytes. */
467 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
)
479 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
481 dst
[srclen
] = DIRECTORY_SEP
;
482 dst
[srclen
+ 1] = '\0';
487 Lisp_Object tem_fn
= make_specified_string (dst
, -1, srclen
, 1);
489 tem_fn
= ENCODE_FILE (tem_fn
);
490 dostounix_filename (SSDATA (tem_fn
));
491 tem_fn
= DECODE_FILE (tem_fn
);
492 memcpy (dst
, SSDATA (tem_fn
), (srclen
= SBYTES (tem_fn
)) + 1);
498 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
499 Sfile_name_as_directory
, 1, 1, 0,
500 doc
: /* Return a string representing the file name FILE interpreted as a directory.
501 This operation exists because a directory is also a file, but its name as
502 a directory is different from its name as a file.
503 The result can be used as the value of `default-directory'
504 or passed as second argument to `expand-file-name'.
505 For a Unix-syntax file name, just appends a slash. */)
516 /* If the file name has special constructs in it,
517 call the corresponding file handler. */
518 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
521 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
523 if (STRINGP (handled_name
))
525 error ("Invalid handler in `file-name-handler-alist'");
528 buf
= alloca (SBYTES (file
) + 10);
529 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
));
530 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
533 /* Convert from directory name SRC of length SRCLEN to
534 file name in DST. On UNIX, just make sure there isn't
535 a terminating /. Return the length of DST in bytes. */
538 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
)
540 /* Process as Unix format: just remove any final slash.
541 But leave "/" unchanged; do not change it to "". */
544 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
546 && !IS_ANY_SEP (dst
[srclen
- 2])
555 Lisp_Object tem_fn
= make_specified_string (dst
, -1, srclen
, 1);
557 tem_fn
= ENCODE_FILE (tem_fn
);
558 dostounix_filename (SSDATA (tem_fn
));
559 tem_fn
= DECODE_FILE (tem_fn
);
560 memcpy (dst
, SSDATA (tem_fn
), (srclen
= SBYTES (tem_fn
)) + 1);
566 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
568 doc
: /* Returns the file name of the directory named DIRECTORY.
569 This is the name of the file that holds the data for the directory DIRECTORY.
570 This operation exists because a directory is also a file, but its name as
571 a directory is different from its name as a file.
572 In Unix-syntax, this function just removes the final slash. */)
573 (Lisp_Object directory
)
579 CHECK_STRING (directory
);
581 if (NILP (directory
))
584 /* If the file name has special constructs in it,
585 call the corresponding file handler. */
586 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
589 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
591 if (STRINGP (handled_name
))
593 error ("Invalid handler in `file-name-handler-alist'");
596 buf
= alloca (SBYTES (directory
) + 20);
597 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
));
598 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
601 static const char make_temp_name_tbl
[64] =
603 'A','B','C','D','E','F','G','H',
604 'I','J','K','L','M','N','O','P',
605 'Q','R','S','T','U','V','W','X',
606 'Y','Z','a','b','c','d','e','f',
607 'g','h','i','j','k','l','m','n',
608 'o','p','q','r','s','t','u','v',
609 'w','x','y','z','0','1','2','3',
610 '4','5','6','7','8','9','-','_'
613 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
615 /* Value is a temporary file name starting with PREFIX, a string.
617 The Emacs process number forms part of the result, so there is
618 no danger of generating a name being used by another process.
619 In addition, this function makes an attempt to choose a name
620 which has no existing file. To make this work, PREFIX should be
621 an absolute file name.
623 BASE64_P means add the pid as 3 characters in base64
624 encoding. In this case, 6 characters will be added to PREFIX to
625 form the file name. Otherwise, if Emacs is running on a system
626 with long file names, add the pid as a decimal number.
628 This function signals an error if no unique file name could be
632 make_temp_name (Lisp_Object prefix
, bool base64_p
)
638 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
641 CHECK_STRING (prefix
);
643 /* VAL is created by adding 6 characters to PREFIX. The first
644 three are the PID of this process, in base 64, and the second
645 three are incremented if the file already exists. This ensures
646 262144 unique file names per PID per PREFIX. */
652 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
653 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
654 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
659 #ifdef HAVE_LONG_FILE_NAMES
660 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
662 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
663 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
664 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
669 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
670 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
671 if (!STRING_MULTIBYTE (prefix
))
672 STRING_SET_UNIBYTE (val
);
674 memcpy (data
, SSDATA (prefix
), len
);
677 memcpy (p
, pidbuf
, pidlen
);
680 /* Here we try to minimize useless stat'ing when this function is
681 invoked many times successively with the same PREFIX. We achieve
682 this by initializing count to a random value, and incrementing it
685 We don't want make-temp-name to be called while dumping,
686 because then make_temp_name_count_initialized_p would get set
687 and then make_temp_name_count would not be set when Emacs starts. */
689 if (!make_temp_name_count_initialized_p
)
691 make_temp_name_count
= time (NULL
);
692 make_temp_name_count_initialized_p
= 1;
697 unsigned num
= make_temp_name_count
;
699 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
700 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
701 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
703 /* Poor man's congruential RN generator. Replace with
704 ++make_temp_name_count for debugging. */
705 make_temp_name_count
+= 25229;
706 make_temp_name_count
%= 225307;
708 if (!check_existing (data
))
710 /* We want to return only if errno is ENOENT. */
714 /* The error here is dubious, but there is little else we
715 can do. The alternatives are to return nil, which is
716 as bad as (and in many cases worse than) throwing the
717 error, or to ignore the error, which will likely result
718 in looping through 225307 stat's, which is not only
719 dog-slow, but also useless since eventually nil would
720 have to be returned anyway. */
721 report_file_error ("Cannot create temporary name for prefix",
722 Fcons (prefix
, Qnil
));
729 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
730 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
731 The Emacs process number forms part of the result,
732 so there is no danger of generating a name being used by another process.
734 In addition, this function makes an attempt to choose a name
735 which has no existing file. To make this work,
736 PREFIX should be an absolute file name.
738 There is a race condition between calling `make-temp-name' and creating the
739 file which opens all kinds of security holes. For that reason, you should
740 probably use `make-temp-file' instead, except in three circumstances:
742 * If you are creating the file in the user's home directory.
743 * If you are creating a directory rather than an ordinary file.
744 * If you are taking special precautions as `make-temp-file' does. */)
747 return make_temp_name (prefix
, 0);
752 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
753 doc
: /* Convert filename NAME to absolute, and canonicalize it.
754 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
755 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
756 the current buffer's value of `default-directory' is used.
757 NAME should be a string that is a valid file name for the underlying
759 File name components that are `.' are removed, and
760 so are file name components followed by `..', along with the `..' itself;
761 note that these simplifications are done without checking the resulting
762 file names in the file system.
763 Multiple consecutive slashes are collapsed into a single slash,
764 except at the beginning of the file name when they are significant (e.g.,
765 UNC file names on MS-Windows.)
766 An initial `~/' expands to your home directory.
767 An initial `~USER/' expands to USER's home directory.
768 See also the function `substitute-in-file-name'.
770 For technical reasons, this function can return correct but
771 non-intuitive results for the root directory; for instance,
772 \(expand-file-name ".." "/") returns "/..". For this reason, use
773 \(directory-file-name (file-name-directory dirname)) to traverse a
774 filesystem tree, not (expand-file-name ".." dirname). */)
775 (Lisp_Object name
, Lisp_Object default_directory
)
777 /* These point to SDATA and need to be careful with string-relocation
778 during GC (via DECODE_FILE). */
781 /* This should only point to alloca'd data. */
788 bool collapse_newdir
= 1;
792 Lisp_Object handler
, result
, handled_name
;
798 /* If the file name has special constructs in it,
799 call the corresponding file handler. */
800 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
803 handled_name
= call3 (handler
, Qexpand_file_name
,
804 name
, default_directory
);
805 if (STRINGP (handled_name
))
807 error ("Invalid handler in `file-name-handler-alist'");
811 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
812 if (NILP (default_directory
))
813 default_directory
= BVAR (current_buffer
, directory
);
814 if (! STRINGP (default_directory
))
817 /* "/" is not considered a root directory on DOS_NT, so using "/"
818 here causes an infinite recursion in, e.g., the following:
820 (let (default-directory)
821 (expand-file-name "a"))
823 To avoid this, we set default_directory to the root of the
825 default_directory
= build_string (emacs_root_dir ());
827 default_directory
= build_string ("/");
831 if (!NILP (default_directory
))
833 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
836 handled_name
= call3 (handler
, Qexpand_file_name
,
837 name
, default_directory
);
838 if (STRINGP (handled_name
))
840 error ("Invalid handler in `file-name-handler-alist'");
845 char *o
= SSDATA (default_directory
);
847 /* Make sure DEFAULT_DIRECTORY is properly expanded.
848 It would be better to do this down below where we actually use
849 default_directory. Unfortunately, calling Fexpand_file_name recursively
850 could invoke GC, and the strings might be relocated. This would
851 be annoying because we have pointers into strings lying around
852 that would need adjusting, and people would add new pointers to
853 the code and forget to adjust them, resulting in intermittent bugs.
854 Putting this call here avoids all that crud.
856 The EQ test avoids infinite recursion. */
857 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
858 /* Save time in some common cases - as long as default_directory
859 is not relative, it can be canonicalized with name below (if it
860 is needed at all) without requiring it to be expanded now. */
862 /* Detect MSDOS file names with drive specifiers. */
863 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
864 && IS_DIRECTORY_SEP (o
[2]))
866 /* Detect Windows file names in UNC format. */
867 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
869 #else /* not DOS_NT */
870 /* Detect Unix absolute file names (/... alone is not absolute on
872 && ! (IS_DIRECTORY_SEP (o
[0]))
873 #endif /* not DOS_NT */
879 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
883 multibyte
= STRING_MULTIBYTE (name
);
884 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
887 default_directory
= string_to_multibyte (default_directory
);
890 name
= string_to_multibyte (name
);
895 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
896 nm
= alloca (SBYTES (name
) + 1);
897 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
900 /* Note if special escape prefix is present, but remove for now. */
901 if (nm
[0] == '/' && nm
[1] == ':')
907 /* Find and remove drive specifier if present; this makes nm absolute
908 even if the rest of the name appears to be relative. Only look for
909 drive specifier at the beginning. */
910 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
912 drive
= (unsigned char) nm
[0];
917 /* If we see "c://somedir", we want to strip the first slash after the
918 colon when stripping the drive letter. Otherwise, this expands to
920 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
923 /* Discard any previous drive specifier if nm is now in UNC format. */
924 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
928 #endif /* WINDOWSNT */
931 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
932 none are found, we can probably return right away. We will avoid
933 allocating a new string if name is already fully expanded. */
935 IS_DIRECTORY_SEP (nm
[0])
937 && drive
&& !is_escaped
940 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
944 /* If it turns out that the filename we want to return is just a
945 suffix of FILENAME, we don't need to go through and edit
946 things; we just need to construct a new string using data
947 starting at the middle of FILENAME. If we set LOSE, that
948 means we've discovered that we can't do that cool trick. */
954 /* Since we know the name is absolute, we can assume that each
955 element starts with a "/". */
957 /* "." and ".." are hairy. */
958 if (IS_DIRECTORY_SEP (p
[0])
960 && (IS_DIRECTORY_SEP (p
[2])
962 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
965 /* We want to replace multiple `/' in a row with a single
968 && IS_DIRECTORY_SEP (p
[0])
969 && IS_DIRECTORY_SEP (p
[1]))
976 /* Make sure directories are all separated with /, but
977 avoid allocation of a new string when not required. */
980 Lisp_Object tem_name
= make_specified_string (nm
, -1, strlen (nm
),
983 tem_name
= ENCODE_FILE (tem_name
);
984 dostounix_filename (SSDATA (tem_name
));
985 tem_name
= DECODE_FILE (tem_name
);
986 memcpy (nm
, SSDATA (tem_name
), SBYTES (tem_name
) + 1);
989 dostounix_filename (nm
);
991 if (IS_DIRECTORY_SEP (nm
[1]))
993 if (strcmp (nm
, SSDATA (name
)) != 0)
994 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
998 /* Drive must be set, so this is okay. */
999 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1003 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1004 temp
[0] = DRIVE_LETTER (drive
);
1005 name
= concat2 (build_string (temp
), name
);
1008 #else /* not DOS_NT */
1009 if (strcmp (nm
, SSDATA (name
)) == 0)
1011 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1012 #endif /* not DOS_NT */
1016 /* At this point, nm might or might not be an absolute file name. We
1017 need to expand ~ or ~user if present, otherwise prefix nm with
1018 default_directory if nm is not absolute, and finally collapse /./
1019 and /foo/../ sequences.
1021 We set newdir to be the appropriate prefix if one is needed:
1022 - the relevant user directory if nm starts with ~ or ~user
1023 - the specified drive's working dir (DOS/NT only) if nm does not
1025 - the value of default_directory.
1027 Note that these prefixes are not guaranteed to be absolute (except
1028 for the working dir of a drive). Therefore, to ensure we always
1029 return an absolute name, if the final prefix is not absolute we
1030 append it to the current working directory. */
1034 if (nm
[0] == '~') /* prefix ~ */
1036 if (IS_DIRECTORY_SEP (nm
[1])
1037 || nm
[1] == 0) /* ~ by itself */
1041 if (!(newdir
= egetenv ("HOME")))
1044 /* `egetenv' may return a unibyte string, which will bite us since
1045 we expect the directory to be multibyte. */
1046 tem
= build_string (newdir
);
1047 if (!STRING_MULTIBYTE (tem
))
1049 hdir
= DECODE_FILE (tem
);
1050 newdir
= SSDATA (hdir
);
1053 collapse_newdir
= 0;
1056 else /* ~user/filename */
1059 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1060 o
= alloca (p
- nm
+ 1);
1061 memcpy (o
, nm
, p
- nm
);
1065 pw
= getpwnam (o
+ 1);
1069 newdir
= pw
->pw_dir
;
1072 collapse_newdir
= 0;
1076 /* If we don't find a user of that name, leave the name
1077 unchanged; don't move nm forward to p. */
1082 /* On DOS and Windows, nm is absolute if a drive name was specified;
1083 use the drive's current directory as the prefix if needed. */
1084 if (!newdir
&& drive
)
1086 /* Get default directory if needed to make nm absolute. */
1088 if (!IS_DIRECTORY_SEP (nm
[0]))
1090 adir
= alloca (MAXPATHLEN
+ 1);
1091 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1096 /* Either nm starts with /, or drive isn't mounted. */
1098 adir
[0] = DRIVE_LETTER (drive
);
1107 /* Finally, if no prefix has been specified and nm is not absolute,
1108 then it must be expanded relative to default_directory. */
1112 /* /... alone is not absolute on DOS and Windows. */
1113 && !IS_DIRECTORY_SEP (nm
[0])
1116 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1120 newdir
= SSDATA (default_directory
);
1122 /* Note if special escape prefix is present, but remove for now. */
1123 if (newdir
[0] == '/' && newdir
[1] == ':')
1134 /* First ensure newdir is an absolute name. */
1136 /* Detect MSDOS file names with drive specifiers. */
1137 ! (IS_DRIVE (newdir
[0])
1138 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1140 /* Detect Windows file names in UNC format. */
1141 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1145 /* Effectively, let newdir be (expand-file-name newdir cwd).
1146 Because of the admonition against calling expand-file-name
1147 when we have pointers into lisp strings, we accomplish this
1148 indirectly by prepending newdir to nm if necessary, and using
1149 cwd (or the wd of newdir's drive) as the new newdir. */
1151 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1153 drive
= (unsigned char) newdir
[0];
1156 if (!IS_DIRECTORY_SEP (nm
[0]))
1158 ptrdiff_t newlen
= strlen (newdir
);
1159 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1160 file_name_as_directory (tmp
, newdir
, newlen
);
1164 adir
= alloca (MAXPATHLEN
+ 1);
1167 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1171 getcwd (adir
, MAXPATHLEN
+ 1);
1175 /* Strip off drive name from prefix, if present. */
1176 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1182 /* Keep only a prefix from newdir if nm starts with slash
1183 (//server/share for UNC, nothing otherwise). */
1184 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1187 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1189 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1191 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1193 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1206 /* Get rid of any slash at the end of newdir, unless newdir is
1207 just / or // (an incomplete UNC name). */
1208 length
= strlen (newdir
);
1210 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1212 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1216 char *temp
= alloca (length
);
1217 memcpy (temp
, newdir
, length
- 1);
1218 temp
[length
- 1] = 0;
1229 /* Now concatenate the directory and name to new space in the stack frame. */
1230 tlen
+= strlen (nm
) + 1;
1232 /* Reserve space for drive specifier and escape prefix, since either
1233 or both may need to be inserted. (The Microsoft x86 compiler
1234 produces incorrect code if the following two lines are combined.) */
1235 target
= alloca (tlen
+ 4);
1237 #else /* not DOS_NT */
1238 target
= alloca (tlen
);
1239 #endif /* not DOS_NT */
1244 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1247 /* If newdir is effectively "C:/", then the drive letter will have
1248 been stripped and newdir will be "/". Concatenating with an
1249 absolute directory in nm produces "//", which will then be
1250 incorrectly treated as a network share. Ignore newdir in
1251 this case (keeping the drive letter). */
1252 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1253 && newdir
[1] == '\0'))
1255 strcpy (target
, newdir
);
1258 file_name_as_directory (target
, newdir
, length
);
1261 strcat (target
, nm
);
1263 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1271 if (!IS_DIRECTORY_SEP (*p
))
1275 else if (p
[1] == '.'
1276 && (IS_DIRECTORY_SEP (p
[2])
1279 /* If "/." is the entire filename, keep the "/". Otherwise,
1280 just delete the whole "/.". */
1281 if (o
== target
&& p
[2] == '\0')
1285 else if (p
[1] == '.' && p
[2] == '.'
1286 /* `/../' is the "superroot" on certain file systems.
1287 Turned off on DOS_NT systems because they have no
1288 "superroot" and because this causes us to produce
1289 file names like "d:/../foo" which fail file-related
1290 functions of the underlying OS. (To reproduce, try a
1291 long series of "../../" in default_directory, longer
1292 than the number of levels from the root.) */
1296 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1301 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1304 /* Don't go below server level in UNC filenames. */
1305 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1306 && IS_DIRECTORY_SEP (*target
))
1310 /* Keep initial / only if this is the whole name. */
1311 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1315 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1316 /* Collapse multiple `/' in a row. */
1325 /* At last, set drive name. */
1327 /* Except for network file name. */
1328 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1329 #endif /* WINDOWSNT */
1331 if (!drive
) emacs_abort ();
1333 target
[0] = DRIVE_LETTER (drive
);
1336 /* Reinsert the escape prefix if required. */
1343 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1344 result
= ENCODE_FILE (result
);
1345 dostounix_filename (SSDATA (result
));
1346 result
= DECODE_FILE (result
);
1348 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1349 #endif /* !DOS_NT */
1352 /* Again look to see if the file name has special constructs in it
1353 and perhaps call the corresponding file handler. This is needed
1354 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1355 the ".." component gives us "/user@host:/bar/../baz" which needs
1356 to be expanded again. */
1357 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1358 if (!NILP (handler
))
1360 handled_name
= call3 (handler
, Qexpand_file_name
,
1361 result
, default_directory
);
1362 if (STRINGP (handled_name
))
1363 return handled_name
;
1364 error ("Invalid handler in `file-name-handler-alist'");
1371 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1372 This is the old version of expand-file-name, before it was thoroughly
1373 rewritten for Emacs 10.31. We leave this version here commented-out,
1374 because the code is very complex and likely to have subtle bugs. If
1375 bugs _are_ found, it might be of interest to look at the old code and
1376 see what did it do in the relevant situation.
1378 Don't remove this code: it's true that it will be accessible
1379 from the repository, but a few years from deletion, people will
1380 forget it is there. */
1382 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1383 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1384 "Convert FILENAME to absolute, and canonicalize it.\n\
1385 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1386 \(does not start with slash); if DEFAULT is nil or missing,\n\
1387 the current buffer's value of default-directory is used.\n\
1388 Filenames containing `.' or `..' as components are simplified;\n\
1389 initial `~/' expands to your home directory.\n\
1390 See also the function `substitute-in-file-name'.")
1392 Lisp_Object name
, defalt
;
1396 register unsigned char *newdir
, *p
, *o
;
1398 unsigned char *target
;
1401 CHECK_STRING (name
);
1404 /* If nm is absolute, flush ...// and detect /./ and /../.
1405 If no /./ or /../ we can return right away. */
1412 if (p
[0] == '/' && p
[1] == '/')
1414 if (p
[0] == '/' && p
[1] == '~')
1415 nm
= p
+ 1, lose
= 1;
1416 if (p
[0] == '/' && p
[1] == '.'
1417 && (p
[2] == '/' || p
[2] == 0
1418 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1424 if (nm
== SDATA (name
))
1426 return build_string (nm
);
1430 /* Now determine directory to start with and put it in NEWDIR. */
1434 if (nm
[0] == '~') /* prefix ~ */
1435 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1437 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1438 newdir
= (unsigned char *) "";
1441 else /* ~user/filename */
1443 /* Get past ~ to user. */
1444 unsigned char *user
= nm
+ 1;
1445 /* Find end of name. */
1446 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1447 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1448 /* Copy the user name into temp storage. */
1449 o
= alloca (len
+ 1);
1450 memcpy (o
, user
, len
);
1453 /* Look up the user name. */
1455 pw
= (struct passwd
*) getpwnam (o
+ 1);
1458 error ("\"%s\" isn't a registered user", o
+ 1);
1460 newdir
= (unsigned char *) pw
->pw_dir
;
1462 /* Discard the user name from NM. */
1466 if (nm
[0] != '/' && !newdir
)
1469 defalt
= current_buffer
->directory
;
1470 CHECK_STRING (defalt
);
1471 newdir
= SDATA (defalt
);
1474 /* Now concatenate the directory and name to new space in the stack frame. */
1476 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1477 target
= alloca (tlen
);
1482 if (nm
[0] == 0 || nm
[0] == '/')
1483 strcpy (target
, newdir
);
1485 file_name_as_directory (target
, newdir
);
1488 strcat (target
, nm
);
1490 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1501 else if (!strncmp (p
, "//", 2)
1507 else if (p
[0] == '/' && p
[1] == '.'
1508 && (p
[2] == '/' || p
[2] == 0))
1510 else if (!strncmp (p
, "/..", 3)
1511 /* `/../' is the "superroot" on certain file systems. */
1513 && (p
[3] == '/' || p
[3] == 0))
1515 while (o
!= target
&& *--o
!= '/')
1517 if (o
== target
&& *o
== '/')
1527 return make_string (target
, o
- target
);
1531 /* If /~ or // appears, discard everything through first slash. */
1533 file_name_absolute_p (const char *filename
)
1536 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1538 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1539 && IS_DIRECTORY_SEP (filename
[2]))
1545 search_embedded_absfilename (char *nm
, char *endp
)
1549 for (p
= nm
+ 1; p
< endp
; p
++)
1551 if (IS_DIRECTORY_SEP (p
[-1])
1552 && file_name_absolute_p (p
)
1553 #if defined (WINDOWSNT) || defined (CYGWIN)
1554 /* // at start of file name is meaningful in Apollo,
1555 WindowsNT and Cygwin systems. */
1556 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1557 #endif /* not (WINDOWSNT || CYGWIN) */
1560 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1561 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1563 char *o
= alloca (s
- p
+ 1);
1565 memcpy (o
, p
, s
- p
);
1568 /* If we have ~user and `user' exists, discard
1569 everything up to ~. But if `user' does not exist, leave
1570 ~user alone, it might be a literal file name. */
1572 pw
= getpwnam (o
+ 1);
1584 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1585 Ssubstitute_in_file_name
, 1, 1, 0,
1586 doc
: /* Substitute environment variables referred to in FILENAME.
1587 `$FOO' where FOO is an environment variable name means to substitute
1588 the value of that variable. The variable name should be terminated
1589 with a character not a letter, digit or underscore; otherwise, enclose
1590 the entire variable name in braces.
1592 If `/~' appears, all of FILENAME through that `/' is discarded.
1593 If `//' appears, everything up to and including the first of
1594 those `/' is discarded. */)
1595 (Lisp_Object filename
)
1597 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1598 char *target
= NULL
;
1599 ptrdiff_t total
= 0;
1600 bool substituted
= 0;
1603 Lisp_Object handler
;
1605 CHECK_STRING (filename
);
1607 multibyte
= STRING_MULTIBYTE (filename
);
1609 /* If the file name has special constructs in it,
1610 call the corresponding file handler. */
1611 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1612 if (!NILP (handler
))
1614 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1616 if (STRINGP (handled_name
))
1617 return handled_name
;
1618 error ("Invalid handler in `file-name-handler-alist'");
1621 /* Always work on a copy of the string, in case GC happens during
1622 decode of environment variables, causing the original Lisp_String
1623 data to be relocated. */
1624 nm
= alloca (SBYTES (filename
) + 1);
1625 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1629 Lisp_Object encoded_filename
= ENCODE_FILE (filename
);
1632 dostounix_filename (SDATA (encoded_filename
));
1633 tem_fn
= DECODE_FILE (encoded_filename
);
1634 nm
= alloca (SBYTES (tem_fn
) + 1);
1635 memcpy (nm
, SDATA (tem_fn
), SBYTES (tem_fn
) + 1);
1636 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1641 endp
= nm
+ SBYTES (filename
);
1643 /* If /~ or // appears, discard everything through first slash. */
1644 p
= search_embedded_absfilename (nm
, endp
);
1646 /* Start over with the new string, so we check the file-name-handler
1647 again. Important with filenames like "/home/foo//:/hello///there"
1648 which would substitute to "/:/hello///there" rather than "/there". */
1649 return Fsubstitute_in_file_name
1650 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1652 /* See if any variables are substituted into the string
1653 and find the total length of their values in `total'. */
1655 for (p
= nm
; p
!= endp
;)
1665 /* "$$" means a single "$". */
1674 while (p
!= endp
&& *p
!= '}') p
++;
1675 if (*p
!= '}') goto missingclose
;
1681 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1685 /* Copy out the variable name. */
1686 target
= alloca (s
- o
+ 1);
1687 memcpy (target
, o
, s
- o
);
1690 strupr (target
); /* $home == $HOME etc. */
1693 /* Get variable value. */
1694 o
= egetenv (target
);
1697 /* Don't try to guess a maximum length - UTF8 can use up to
1698 four bytes per character. This code is unlikely to run
1699 in a situation that requires performance, so decoding the
1700 env variables twice should be acceptable. Note that
1701 decoding may cause a garbage collect. */
1702 Lisp_Object orig
, decoded
;
1703 orig
= build_unibyte_string (o
);
1704 decoded
= DECODE_FILE (orig
);
1705 total
+= SBYTES (decoded
);
1715 /* If substitution required, recopy the string and do it. */
1716 /* Make space in stack frame for the new copy. */
1717 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1720 /* Copy the rest of the name through, replacing $ constructs with values. */
1737 while (p
!= endp
&& *p
!= '}') p
++;
1738 if (*p
!= '}') goto missingclose
;
1744 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1748 /* Copy out the variable name. */
1749 target
= alloca (s
- o
+ 1);
1750 memcpy (target
, o
, s
- o
);
1753 strupr (target
); /* $home == $HOME etc. */
1756 /* Get variable value. */
1757 o
= egetenv (target
);
1761 strcpy (x
, target
); x
+= strlen (target
);
1765 Lisp_Object orig
, decoded
;
1766 ptrdiff_t orig_length
, decoded_length
;
1767 orig_length
= strlen (o
);
1768 orig
= make_unibyte_string (o
, orig_length
);
1769 decoded
= DECODE_FILE (orig
);
1770 decoded_length
= SBYTES (decoded
);
1771 memcpy (x
, SDATA (decoded
), decoded_length
);
1772 x
+= decoded_length
;
1774 /* If environment variable needed decoding, return value
1775 needs to be multibyte. */
1776 if (decoded_length
!= orig_length
1777 || memcmp (SDATA (decoded
), o
, orig_length
))
1784 /* If /~ or // appears, discard everything through first slash. */
1785 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1786 /* This time we do not start over because we've already expanded envvars
1787 and replaced $$ with $. Maybe we should start over as well, but we'd
1788 need to quote some $ to $$ first. */
1791 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1794 error ("Bad format environment-variable substitution");
1796 error ("Missing \"}\" in environment-variable substitution");
1798 error ("Substituting nonexistent environment variable \"%s\"", target
);
1804 /* A slightly faster and more convenient way to get
1805 (directory-file-name (expand-file-name FOO)). */
1808 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1810 register Lisp_Object absname
;
1812 absname
= Fexpand_file_name (filename
, defdir
);
1814 /* Remove final slash, if any (unless this is the root dir).
1815 stat behaves differently depending! */
1816 if (SCHARS (absname
) > 1
1817 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1818 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1819 /* We cannot take shortcuts; they might be wrong for magic file names. */
1820 absname
= Fdirectory_file_name (absname
);
1824 /* Signal an error if the file ABSNAME already exists.
1825 If INTERACTIVE, ask the user whether to proceed,
1826 and bypass the error if the user says to go ahead.
1827 QUERYSTRING is a name for the action that is being considered
1830 *STATPTR is used to store the stat information if the file exists.
1831 If the file does not exist, STATPTR->st_mode is set to 0.
1832 If STATPTR is null, we don't store into it.
1834 If QUICK, ask for y or n, not yes or no. */
1837 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1838 bool interactive
, struct stat
*statptr
,
1841 Lisp_Object tem
, encoded_filename
;
1842 struct stat statbuf
;
1843 struct gcpro gcpro1
;
1845 encoded_filename
= ENCODE_FILE (absname
);
1847 /* `stat' is a good way to tell whether the file exists,
1848 regardless of what access permissions it has. */
1849 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1851 if (S_ISDIR (statbuf
.st_mode
))
1852 xsignal2 (Qfile_error
,
1853 build_string ("File is a directory"), absname
);
1856 xsignal2 (Qfile_already_exists
,
1857 build_string ("File already exists"), absname
);
1859 tem
= format2 ("File %s already exists; %s anyway? ",
1860 absname
, build_string (querystring
));
1862 tem
= call1 (intern ("y-or-n-p"), tem
);
1864 tem
= do_yes_or_no_p (tem
);
1867 xsignal2 (Qfile_already_exists
,
1868 build_string ("File already exists"), absname
);
1875 statptr
->st_mode
= 0;
1880 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1881 "fCopy file: \nGCopy %s to file: \np\nP",
1882 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1883 If NEWNAME names a directory, copy FILE there.
1885 This function always sets the file modes of the output file to match
1888 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1889 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1890 signal a `file-already-exists' error without overwriting. If
1891 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1892 about overwriting; this is what happens in interactive use with M-x.
1893 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1896 Fourth arg KEEP-TIME non-nil means give the output file the same
1897 last-modified time as the old one. (This works on only some systems.)
1899 A prefix arg makes KEEP-TIME non-nil.
1901 If PRESERVE-UID-GID is non-nil, we try to transfer the
1902 uid and gid of FILE to NEWNAME.
1904 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1905 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1906 entries (depending on how Emacs was built). */)
1907 (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
)
1911 char buf
[16 * 1024];
1912 struct stat st
, out_st
;
1913 Lisp_Object handler
;
1914 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1915 ptrdiff_t count
= SPECPDL_INDEX ();
1916 Lisp_Object encoded_file
, encoded_newname
;
1918 security_context_t con
;
1921 #ifdef HAVE_POSIX_ACL
1925 encoded_file
= encoded_newname
= Qnil
;
1926 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1927 CHECK_STRING (file
);
1928 CHECK_STRING (newname
);
1930 if (!NILP (Ffile_directory_p (newname
)))
1931 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1933 newname
= Fexpand_file_name (newname
, Qnil
);
1935 file
= Fexpand_file_name (file
, Qnil
);
1937 /* If the input file name has special constructs in it,
1938 call the corresponding file handler. */
1939 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1940 /* Likewise for output file name. */
1942 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1943 if (!NILP (handler
))
1944 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1945 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1946 preserve_extended_attributes
));
1948 encoded_file
= ENCODE_FILE (file
);
1949 encoded_newname
= ENCODE_FILE (newname
);
1951 if (NILP (ok_if_already_exists
)
1952 || INTEGERP (ok_if_already_exists
))
1953 barf_or_query_if_file_exists (newname
, "copy to it",
1954 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1955 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1959 if (!NILP (preserve_extended_attributes
))
1961 #ifdef HAVE_POSIX_ACL
1962 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
1963 if (acl
== NULL
&& errno
!= ENOTSUP
)
1964 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
1967 if (!CopyFile (SDATA (encoded_file
),
1968 SDATA (encoded_newname
),
1970 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1971 /* CopyFile retains the timestamp by default. */
1972 else if (NILP (keep_time
))
1978 filename
= SDATA (encoded_newname
);
1980 /* Ensure file is writable while its modified time is set. */
1981 attributes
= GetFileAttributes (filename
);
1982 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1983 now
= current_emacs_time ();
1984 if (set_file_times (-1, filename
, now
, now
))
1986 /* Restore original attributes. */
1987 SetFileAttributes (filename
, attributes
);
1988 xsignal2 (Qfile_date_error
,
1989 build_string ("Cannot set file date"), newname
);
1991 /* Restore original attributes. */
1992 SetFileAttributes (filename
, attributes
);
1994 #ifdef HAVE_POSIX_ACL
1998 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
1999 if (fail
&& errno
!= ENOTSUP
)
2000 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2005 #else /* not WINDOWSNT */
2007 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2011 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2013 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2015 if (fstat (ifd
, &st
) != 0)
2016 report_file_error ("Input file status", Fcons (file
, Qnil
));
2018 if (!NILP (preserve_extended_attributes
))
2021 if (is_selinux_enabled ())
2023 conlength
= fgetfilecon (ifd
, &con
);
2024 if (conlength
== -1)
2025 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
2029 #ifdef HAVE_POSIX_ACL
2030 acl
= acl_get_fd (ifd
);
2031 if (acl
== NULL
&& errno
!= ENOTSUP
)
2032 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2036 if (out_st
.st_mode
!= 0
2037 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2040 report_file_error ("Input and output files are the same",
2041 Fcons (file
, Fcons (newname
, Qnil
)));
2044 /* We can copy only regular files. */
2045 if (!S_ISREG (st
.st_mode
))
2047 /* Get a better looking error message. */
2048 errno
= S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
;
2049 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2053 /* System's default file type was set to binary by _fmode in emacs.c. */
2054 ofd
= emacs_open (SDATA (encoded_newname
),
2055 O_WRONLY
| O_TRUNC
| O_CREAT
2056 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2057 S_IREAD
| S_IWRITE
);
2058 #else /* not MSDOS */
2060 mode_t new_mask
= !NILP (preserve_uid_gid
) ? 0600 : 0666;
2061 new_mask
&= st
.st_mode
;
2062 ofd
= emacs_open (SSDATA (encoded_newname
),
2063 (O_WRONLY
| O_TRUNC
| O_CREAT
2064 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2067 #endif /* not MSDOS */
2069 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2071 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2075 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2076 if (emacs_write (ofd
, buf
, n
) != n
)
2077 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2081 /* Preserve the original file modes, and if requested, also its
2084 mode_t mode_mask
= 07777;
2085 if (!NILP (preserve_uid_gid
))
2087 /* Attempt to change owner and group. If that doesn't work
2088 attempt to change just the group, as that is sometimes allowed.
2089 Adjust the mode mask to eliminate setuid or setgid bits
2090 that are inappropriate if the owner and group are wrong. */
2091 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2093 mode_mask
&= ~06000;
2094 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2098 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2099 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2101 #endif /* not MSDOS */
2106 /* Set the modified context back to the file. */
2107 bool fail
= fsetfilecon (ofd
, con
) != 0;
2108 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2109 if (fail
&& errno
!= ENOTSUP
)
2110 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2116 #ifdef HAVE_POSIX_ACL
2119 bool fail
= acl_set_fd (ofd
, acl
) != 0;
2120 if (fail
&& errno
!= ENOTSUP
)
2121 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2127 if (!NILP (keep_time
))
2129 EMACS_TIME atime
= get_stat_atime (&st
);
2130 EMACS_TIME mtime
= get_stat_mtime (&st
);
2131 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2132 xsignal2 (Qfile_date_error
,
2133 build_string ("Cannot set file date"), newname
);
2136 if (emacs_close (ofd
) < 0)
2137 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2142 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2143 and if it can't, it tells so. Otherwise, under MSDOS we usually
2144 get only the READ bit, which will make the copied file read-only,
2145 so it's better not to chmod at all. */
2146 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2147 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2149 #endif /* not WINDOWSNT */
2151 /* Discard the unwind protects. */
2152 specpdl_ptr
= specpdl
+ count
;
2158 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2159 Smake_directory_internal
, 1, 1, 0,
2160 doc
: /* Create a new directory named DIRECTORY. */)
2161 (Lisp_Object directory
)
2164 Lisp_Object handler
;
2165 Lisp_Object encoded_dir
;
2167 CHECK_STRING (directory
);
2168 directory
= Fexpand_file_name (directory
, Qnil
);
2170 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2171 if (!NILP (handler
))
2172 return call2 (handler
, Qmake_directory_internal
, directory
);
2174 encoded_dir
= ENCODE_FILE (directory
);
2176 dir
= SSDATA (encoded_dir
);
2179 if (mkdir (dir
) != 0)
2181 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2183 report_file_error ("Creating directory", list1 (directory
));
2188 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2189 Sdelete_directory_internal
, 1, 1, 0,
2190 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2191 (Lisp_Object directory
)
2194 Lisp_Object encoded_dir
;
2196 CHECK_STRING (directory
);
2197 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2198 encoded_dir
= ENCODE_FILE (directory
);
2199 dir
= SSDATA (encoded_dir
);
2201 if (rmdir (dir
) != 0)
2202 report_file_error ("Removing directory", list1 (directory
));
2207 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2208 "(list (read-file-name \
2209 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2210 \"Move file to trash: \" \"Delete file: \") \
2211 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2212 (null current-prefix-arg))",
2213 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2214 If file has multiple names, it continues to exist with the other names.
2215 TRASH non-nil means to trash the file instead of deleting, provided
2216 `delete-by-moving-to-trash' is non-nil.
2218 When called interactively, TRASH is t if no prefix argument is given.
2219 With a prefix argument, TRASH is nil. */)
2220 (Lisp_Object filename
, Lisp_Object trash
)
2222 Lisp_Object handler
;
2223 Lisp_Object encoded_file
;
2224 struct gcpro gcpro1
;
2227 if (!NILP (Ffile_directory_p (filename
))
2228 && NILP (Ffile_symlink_p (filename
)))
2229 xsignal2 (Qfile_error
,
2230 build_string ("Removing old name: is a directory"),
2233 filename
= Fexpand_file_name (filename
, Qnil
);
2235 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2236 if (!NILP (handler
))
2237 return call3 (handler
, Qdelete_file
, filename
, trash
);
2239 if (delete_by_moving_to_trash
&& !NILP (trash
))
2240 return call1 (Qmove_file_to_trash
, filename
);
2242 encoded_file
= ENCODE_FILE (filename
);
2244 if (unlink (SSDATA (encoded_file
)) < 0)
2245 report_file_error ("Removing old name", list1 (filename
));
2250 internal_delete_file_1 (Lisp_Object ignore
)
2255 /* Delete file FILENAME, returning true if successful.
2256 This ignores `delete-by-moving-to-trash'. */
2259 internal_delete_file (Lisp_Object filename
)
2263 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2264 Qt
, internal_delete_file_1
);
2268 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2269 "fRename file: \nGRename %s to file: \np",
2270 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2271 If file has names other than FILE, it continues to have those names.
2272 Signals a `file-already-exists' error if a file NEWNAME already exists
2273 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2274 A number as third arg means request confirmation if NEWNAME already exists.
2275 This is what happens in interactive use with M-x. */)
2276 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2278 Lisp_Object handler
;
2279 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2280 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2282 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2283 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2284 CHECK_STRING (file
);
2285 CHECK_STRING (newname
);
2286 file
= Fexpand_file_name (file
, Qnil
);
2288 if ((!NILP (Ffile_directory_p (newname
)))
2290 /* If the file names are identical but for the case,
2291 don't attempt to move directory to itself. */
2292 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2296 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2297 ? file
: Fdirectory_file_name (file
));
2298 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2301 newname
= Fexpand_file_name (newname
, Qnil
);
2303 /* If the file name has special constructs in it,
2304 call the corresponding file handler. */
2305 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2307 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2308 if (!NILP (handler
))
2309 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2310 file
, newname
, ok_if_already_exists
));
2312 encoded_file
= ENCODE_FILE (file
);
2313 encoded_newname
= ENCODE_FILE (newname
);
2316 /* If the file names are identical but for the case, don't ask for
2317 confirmation: they simply want to change the letter-case of the
2319 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2321 if (NILP (ok_if_already_exists
)
2322 || INTEGERP (ok_if_already_exists
))
2323 barf_or_query_if_file_exists (newname
, "rename to it",
2324 INTEGERP (ok_if_already_exists
), 0, 0);
2325 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2330 symlink_target
= Ffile_symlink_p (file
);
2331 if (! NILP (symlink_target
))
2332 Fmake_symbolic_link (symlink_target
, newname
,
2333 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2334 else if (!NILP (Ffile_directory_p (file
)))
2335 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2337 /* We have already prompted if it was an integer, so don't
2338 have copy-file prompt again. */
2339 Fcopy_file (file
, newname
,
2340 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2343 count
= SPECPDL_INDEX ();
2344 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2346 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2347 call2 (Qdelete_directory
, file
, Qt
);
2349 Fdelete_file (file
, Qnil
);
2350 unbind_to (count
, Qnil
);
2353 report_file_error ("Renaming", list2 (file
, newname
));
2359 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2360 "fAdd name to file: \nGName to add to %s: \np",
2361 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2362 Signals a `file-already-exists' error if a file NEWNAME already exists
2363 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2364 A number as third arg means request confirmation if NEWNAME already exists.
2365 This is what happens in interactive use with M-x. */)
2366 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2368 Lisp_Object handler
;
2369 Lisp_Object encoded_file
, encoded_newname
;
2370 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2372 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2373 encoded_file
= encoded_newname
= Qnil
;
2374 CHECK_STRING (file
);
2375 CHECK_STRING (newname
);
2376 file
= Fexpand_file_name (file
, Qnil
);
2378 if (!NILP (Ffile_directory_p (newname
)))
2379 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2381 newname
= Fexpand_file_name (newname
, Qnil
);
2383 /* If the file name has special constructs in it,
2384 call the corresponding file handler. */
2385 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2386 if (!NILP (handler
))
2387 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2388 newname
, ok_if_already_exists
));
2390 /* If the new name has special constructs in it,
2391 call the corresponding file handler. */
2392 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2393 if (!NILP (handler
))
2394 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2395 newname
, ok_if_already_exists
));
2397 encoded_file
= ENCODE_FILE (file
);
2398 encoded_newname
= ENCODE_FILE (newname
);
2400 if (NILP (ok_if_already_exists
)
2401 || INTEGERP (ok_if_already_exists
))
2402 barf_or_query_if_file_exists (newname
, "make it a new name",
2403 INTEGERP (ok_if_already_exists
), 0, 0);
2405 unlink (SSDATA (newname
));
2406 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2407 report_file_error ("Adding new name", list2 (file
, newname
));
2413 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2414 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2415 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2416 Both args must be strings.
2417 Signals a `file-already-exists' error if a file LINKNAME already exists
2418 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2419 A number as third arg means request confirmation if LINKNAME already exists.
2420 This happens for interactive use with M-x. */)
2421 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2423 Lisp_Object handler
;
2424 Lisp_Object encoded_filename
, encoded_linkname
;
2425 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2427 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2428 encoded_filename
= encoded_linkname
= Qnil
;
2429 CHECK_STRING (filename
);
2430 CHECK_STRING (linkname
);
2431 /* If the link target has a ~, we must expand it to get
2432 a truly valid file name. Otherwise, do not expand;
2433 we want to permit links to relative file names. */
2434 if (SREF (filename
, 0) == '~')
2435 filename
= Fexpand_file_name (filename
, Qnil
);
2437 if (!NILP (Ffile_directory_p (linkname
)))
2438 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2440 linkname
= Fexpand_file_name (linkname
, Qnil
);
2442 /* If the file name has special constructs in it,
2443 call the corresponding file handler. */
2444 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2445 if (!NILP (handler
))
2446 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2447 linkname
, ok_if_already_exists
));
2449 /* If the new link name has special constructs in it,
2450 call the corresponding file handler. */
2451 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2452 if (!NILP (handler
))
2453 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2454 linkname
, ok_if_already_exists
));
2456 encoded_filename
= ENCODE_FILE (filename
);
2457 encoded_linkname
= ENCODE_FILE (linkname
);
2459 if (NILP (ok_if_already_exists
)
2460 || INTEGERP (ok_if_already_exists
))
2461 barf_or_query_if_file_exists (linkname
, "make it a link",
2462 INTEGERP (ok_if_already_exists
), 0, 0);
2463 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2465 /* If we didn't complain already, silently delete existing file. */
2466 if (errno
== EEXIST
)
2468 unlink (SSDATA (encoded_linkname
));
2469 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2476 if (errno
== ENOSYS
)
2479 xsignal1 (Qfile_error
,
2480 build_string ("Symbolic links are not supported"));
2483 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2490 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2492 doc
: /* Return t if file FILENAME specifies an absolute file name.
2493 On Unix, this is a name starting with a `/' or a `~'. */)
2494 (Lisp_Object filename
)
2496 CHECK_STRING (filename
);
2497 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2500 /* Return true if FILENAME exists. */
2502 check_existing (const char *filename
)
2504 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2507 /* Return true if file FILENAME exists and can be executed. */
2510 check_executable (char *filename
)
2512 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2515 /* Return true if file FILENAME exists and can be accessed
2516 according to AMODE, which should include W_OK.
2517 On failure, return false and set errno. */
2520 check_writable (const char *filename
, int amode
)
2523 /* FIXME: an faccessat implementation should be added to the
2524 DOS/Windows ports and this #ifdef branch should be removed. */
2526 if (stat (filename
, &st
) < 0)
2529 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2530 #else /* not MSDOS */
2531 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2533 /* faccessat may have returned failure because Cygwin couldn't
2534 determine the file's UID or GID; if so, we return success. */
2537 int faccessat_errno
= errno
;
2539 if (stat (filename
, &st
) < 0)
2541 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2542 errno
= faccessat_errno
;
2546 #endif /* not MSDOS */
2549 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2550 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2551 See also `file-readable-p' and `file-attributes'.
2552 This returns nil for a symlink to a nonexistent file.
2553 Use `file-symlink-p' to test for such links. */)
2554 (Lisp_Object filename
)
2556 Lisp_Object absname
;
2557 Lisp_Object handler
;
2559 CHECK_STRING (filename
);
2560 absname
= Fexpand_file_name (filename
, Qnil
);
2562 /* If the file name has special constructs in it,
2563 call the corresponding file handler. */
2564 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2565 if (!NILP (handler
))
2566 return call2 (handler
, Qfile_exists_p
, absname
);
2568 absname
= ENCODE_FILE (absname
);
2570 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2573 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2574 doc
: /* Return t if FILENAME can be executed by you.
2575 For a directory, this means you can access files in that directory. */)
2576 (Lisp_Object filename
)
2578 Lisp_Object absname
;
2579 Lisp_Object handler
;
2581 CHECK_STRING (filename
);
2582 absname
= Fexpand_file_name (filename
, Qnil
);
2584 /* If the file name has special constructs in it,
2585 call the corresponding file handler. */
2586 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2587 if (!NILP (handler
))
2588 return call2 (handler
, Qfile_executable_p
, absname
);
2590 absname
= ENCODE_FILE (absname
);
2592 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2595 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2596 doc
: /* Return t if file FILENAME exists and you can read it.
2597 See also `file-exists-p' and `file-attributes'. */)
2598 (Lisp_Object filename
)
2600 Lisp_Object absname
;
2601 Lisp_Object handler
;
2603 CHECK_STRING (filename
);
2604 absname
= Fexpand_file_name (filename
, Qnil
);
2606 /* If the file name has special constructs in it,
2607 call the corresponding file handler. */
2608 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2609 if (!NILP (handler
))
2610 return call2 (handler
, Qfile_readable_p
, absname
);
2612 absname
= ENCODE_FILE (absname
);
2613 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2617 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2618 doc
: /* Return t if file FILENAME can be written or created by you. */)
2619 (Lisp_Object filename
)
2621 Lisp_Object absname
, dir
, encoded
;
2622 Lisp_Object handler
;
2624 CHECK_STRING (filename
);
2625 absname
= Fexpand_file_name (filename
, Qnil
);
2627 /* If the file name has special constructs in it,
2628 call the corresponding file handler. */
2629 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2630 if (!NILP (handler
))
2631 return call2 (handler
, Qfile_writable_p
, absname
);
2633 encoded
= ENCODE_FILE (absname
);
2634 if (check_writable (SSDATA (encoded
), W_OK
))
2636 if (errno
!= ENOENT
)
2639 dir
= Ffile_name_directory (absname
);
2640 eassert (!NILP (dir
));
2642 dir
= Fdirectory_file_name (dir
);
2645 dir
= ENCODE_FILE (dir
);
2647 /* The read-only attribute of the parent directory doesn't affect
2648 whether a file or directory can be created within it. Some day we
2649 should check ACLs though, which do affect this. */
2650 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2652 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2656 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2657 doc
: /* Access file FILENAME, and get an error if that does not work.
2658 The second argument STRING is used in the error message.
2659 If there is no error, returns nil. */)
2660 (Lisp_Object filename
, Lisp_Object string
)
2662 Lisp_Object handler
, encoded_filename
, absname
;
2665 CHECK_STRING (filename
);
2666 absname
= Fexpand_file_name (filename
, Qnil
);
2668 CHECK_STRING (string
);
2670 /* If the file name has special constructs in it,
2671 call the corresponding file handler. */
2672 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2673 if (!NILP (handler
))
2674 return call3 (handler
, Qaccess_file
, absname
, string
);
2676 encoded_filename
= ENCODE_FILE (absname
);
2678 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2680 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2686 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2687 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2688 The value is the link target, as a string.
2689 Otherwise it returns nil.
2691 This function returns t when given the name of a symlink that
2692 points to a nonexistent file. */)
2693 (Lisp_Object filename
)
2695 Lisp_Object handler
;
2698 char readlink_buf
[READLINK_BUFSIZE
];
2700 CHECK_STRING (filename
);
2701 filename
= Fexpand_file_name (filename
, Qnil
);
2703 /* If the file name has special constructs in it,
2704 call the corresponding file handler. */
2705 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2706 if (!NILP (handler
))
2707 return call2 (handler
, Qfile_symlink_p
, filename
);
2709 filename
= ENCODE_FILE (filename
);
2711 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2715 val
= build_string (buf
);
2716 if (buf
[0] == '/' && strchr (buf
, ':'))
2717 val
= concat2 (build_string ("/:"), val
);
2718 if (buf
!= readlink_buf
)
2720 val
= DECODE_FILE (val
);
2724 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2725 doc
: /* Return t if FILENAME names an existing directory.
2726 Symbolic links to directories count as directories.
2727 See `file-symlink-p' to distinguish symlinks. */)
2728 (Lisp_Object filename
)
2730 Lisp_Object absname
;
2731 Lisp_Object handler
;
2733 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2735 /* If the file name has special constructs in it,
2736 call the corresponding file handler. */
2737 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2738 if (!NILP (handler
))
2739 return call2 (handler
, Qfile_directory_p
, absname
);
2741 absname
= ENCODE_FILE (absname
);
2743 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2746 /* Return true if FILE is a directory or a symlink to a directory. */
2748 file_directory_p (char const *file
)
2751 /* This is cheaper than 'stat'. */
2752 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2755 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2759 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2760 Sfile_accessible_directory_p
, 1, 1, 0,
2761 doc
: /* Return t if file FILENAME names a directory you can open.
2762 For the value to be t, FILENAME must specify the name of a directory as a file,
2763 and the directory must allow you to open files in it. In order to use a
2764 directory as a buffer's current directory, this predicate must return true.
2765 A directory name spec may be given instead; then the value is t
2766 if the directory so specified exists and really is a readable and
2767 searchable directory. */)
2768 (Lisp_Object filename
)
2770 Lisp_Object absname
;
2771 Lisp_Object handler
;
2773 CHECK_STRING (filename
);
2774 absname
= Fexpand_file_name (filename
, Qnil
);
2776 /* If the file name has special constructs in it,
2777 call the corresponding file handler. */
2778 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2779 if (!NILP (handler
))
2780 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2782 absname
= ENCODE_FILE (absname
);
2783 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2786 /* If FILE is a searchable directory or a symlink to a
2787 searchable directory, return true. Otherwise return
2788 false and set errno to an error number. */
2790 file_accessible_directory_p (char const *file
)
2793 /* There's no need to test whether FILE is searchable, as the
2794 searchable/executable bit is invented on DOS_NT platforms. */
2795 return file_directory_p (file
);
2797 /* On POSIXish platforms, use just one system call; this avoids a
2798 race and is typically faster. */
2799 ptrdiff_t len
= strlen (file
);
2805 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2806 There are three exceptions: "", "/", and "//". Leave "" alone,
2807 as it's invalid. Append only "." to the other two exceptions as
2808 "/" and "//" are distinct on some platforms, whereas "/", "///",
2809 "////", etc. are all equivalent. */
2814 /* Just check for trailing '/' when deciding whether to append '/'.
2815 That's simpler than testing the two special cases "/" and "//",
2816 and it's a safe optimization here. */
2817 char *buf
= SAFE_ALLOCA (len
+ 3);
2818 memcpy (buf
, file
, len
);
2819 strcpy (buf
+ len
, "/." + (file
[len
- 1] == '/'));
2823 ok
= check_existing (dir
);
2824 saved_errno
= errno
;
2826 errno
= saved_errno
;
2831 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2832 doc
: /* Return t if FILENAME names a regular file.
2833 This is the sort of file that holds an ordinary stream of data bytes.
2834 Symbolic links to regular files count as regular files.
2835 See `file-symlink-p' to distinguish symlinks. */)
2836 (Lisp_Object filename
)
2838 register Lisp_Object absname
;
2840 Lisp_Object handler
;
2842 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2844 /* If the file name has special constructs in it,
2845 call the corresponding file handler. */
2846 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2847 if (!NILP (handler
))
2848 return call2 (handler
, Qfile_regular_p
, absname
);
2850 absname
= ENCODE_FILE (absname
);
2855 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2857 /* Tell stat to use expensive method to get accurate info. */
2858 Vw32_get_true_file_attributes
= Qt
;
2859 result
= stat (SDATA (absname
), &st
);
2860 Vw32_get_true_file_attributes
= tem
;
2864 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2867 if (stat (SSDATA (absname
), &st
) < 0)
2869 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2873 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2874 Sfile_selinux_context
, 1, 1, 0,
2875 doc
: /* Return SELinux context of file named FILENAME.
2876 The return value is a list (USER ROLE TYPE RANGE), where the list
2877 elements are strings naming the user, role, type, and range of the
2878 file's SELinux security context.
2880 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2881 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2882 (Lisp_Object filename
)
2884 Lisp_Object absname
;
2885 Lisp_Object values
[4];
2886 Lisp_Object handler
;
2888 security_context_t con
;
2893 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2895 /* If the file name has special constructs in it,
2896 call the corresponding file handler. */
2897 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2898 if (!NILP (handler
))
2899 return call2 (handler
, Qfile_selinux_context
, absname
);
2901 absname
= ENCODE_FILE (absname
);
2908 if (is_selinux_enabled ())
2910 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2913 context
= context_new (con
);
2914 if (context_user_get (context
))
2915 values
[0] = build_string (context_user_get (context
));
2916 if (context_role_get (context
))
2917 values
[1] = build_string (context_role_get (context
));
2918 if (context_type_get (context
))
2919 values
[2] = build_string (context_type_get (context
));
2920 if (context_range_get (context
))
2921 values
[3] = build_string (context_range_get (context
));
2922 context_free (context
);
2928 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2931 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2932 Sset_file_selinux_context
, 2, 2, 0,
2933 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2934 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2935 elements are strings naming the components of a SELinux context.
2937 This function does nothing if SELinux is disabled, or if Emacs was not
2938 compiled with SELinux support. */)
2939 (Lisp_Object filename
, Lisp_Object context
)
2941 Lisp_Object absname
;
2942 Lisp_Object handler
;
2944 Lisp_Object encoded_absname
;
2945 Lisp_Object user
= CAR_SAFE (context
);
2946 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2947 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2948 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2949 security_context_t con
;
2952 context_t parsed_con
;
2955 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2957 /* If the file name has special constructs in it,
2958 call the corresponding file handler. */
2959 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2960 if (!NILP (handler
))
2961 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2964 if (is_selinux_enabled ())
2966 /* Get current file context. */
2967 encoded_absname
= ENCODE_FILE (absname
);
2968 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2971 parsed_con
= context_new (con
);
2972 /* Change the parts defined in the parameter.*/
2975 if (context_user_set (parsed_con
, SSDATA (user
)))
2976 error ("Doing context_user_set");
2980 if (context_role_set (parsed_con
, SSDATA (role
)))
2981 error ("Doing context_role_set");
2985 if (context_type_set (parsed_con
, SSDATA (type
)))
2986 error ("Doing context_type_set");
2988 if (STRINGP (range
))
2990 if (context_range_set (parsed_con
, SSDATA (range
)))
2991 error ("Doing context_range_set");
2994 /* Set the modified context back to the file. */
2995 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2996 context_str (parsed_con
))
2998 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2999 if (fail
&& errno
!= ENOTSUP
)
3000 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
3002 context_free (parsed_con
);
3006 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
3013 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3014 doc
: /* Return ACL entries of file named FILENAME, as a string.
3015 Return nil if file does not exist or is not accessible, or if Emacs
3016 was unable to determine the ACL entries. The latter can happen for
3017 local files if Emacs was not compiled with ACL support, or for remote
3018 files if the file handler returns nil for the file's ACL entries. */)
3019 (Lisp_Object filename
)
3021 Lisp_Object absname
;
3022 Lisp_Object handler
;
3023 #ifdef HAVE_POSIX_ACL
3025 Lisp_Object acl_string
;
3029 absname
= expand_and_dir_to_file (filename
,
3030 BVAR (current_buffer
, directory
));
3032 /* If the file name has special constructs in it,
3033 call the corresponding file handler. */
3034 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3035 if (!NILP (handler
))
3036 return call2 (handler
, Qfile_acl
, absname
);
3038 #ifdef HAVE_POSIX_ACL
3039 absname
= ENCODE_FILE (absname
);
3041 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3045 str
= acl_to_text (acl
, NULL
);
3052 acl_string
= build_string (str
);
3062 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3064 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3065 ACL-STRING should contain the textual representation of the ACL
3066 entries in a format suitable for the platform.
3068 Setting ACL for local files requires Emacs to be built with ACL
3070 (Lisp_Object filename
, Lisp_Object acl_string
)
3072 Lisp_Object absname
;
3073 Lisp_Object handler
;
3074 #ifdef HAVE_POSIX_ACL
3075 Lisp_Object encoded_absname
;
3080 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3082 /* If the file name has special constructs in it,
3083 call the corresponding file handler. */
3084 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3085 if (!NILP (handler
))
3086 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3088 #ifdef HAVE_POSIX_ACL
3089 if (STRINGP (acl_string
))
3091 acl
= acl_from_text (SSDATA (acl_string
));
3094 report_file_error ("Converting ACL", Fcons (absname
, Qnil
));
3098 encoded_absname
= ENCODE_FILE (absname
);
3100 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3103 if (fail
&& errno
!= ENOTSUP
)
3104 report_file_error ("Setting ACL", Fcons (absname
, Qnil
));
3113 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3114 doc
: /* Return mode bits of file named FILENAME, as an integer.
3115 Return nil, if file does not exist or is not accessible. */)
3116 (Lisp_Object filename
)
3118 Lisp_Object absname
;
3120 Lisp_Object handler
;
3122 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3124 /* If the file name has special constructs in it,
3125 call the corresponding file handler. */
3126 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3127 if (!NILP (handler
))
3128 return call2 (handler
, Qfile_modes
, absname
);
3130 absname
= ENCODE_FILE (absname
);
3132 if (stat (SSDATA (absname
), &st
) < 0)
3135 return make_number (st
.st_mode
& 07777);
3138 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3139 "(let ((file (read-file-name \"File: \"))) \
3140 (list file (read-file-modes nil file)))",
3141 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3142 Only the 12 low bits of MODE are used.
3144 Interactively, mode bits are read by `read-file-modes', which accepts
3145 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3146 (Lisp_Object filename
, Lisp_Object mode
)
3148 Lisp_Object absname
, encoded_absname
;
3149 Lisp_Object handler
;
3151 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3152 CHECK_NUMBER (mode
);
3154 /* If the file name has special constructs in it,
3155 call the corresponding file handler. */
3156 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3157 if (!NILP (handler
))
3158 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3160 encoded_absname
= ENCODE_FILE (absname
);
3162 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3163 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3168 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3169 doc
: /* Set the file permission bits for newly created files.
3170 The argument MODE should be an integer; only the low 9 bits are used.
3171 This setting is inherited by subprocesses. */)
3174 CHECK_NUMBER (mode
);
3176 umask ((~ XINT (mode
)) & 0777);
3181 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3182 doc
: /* Return the default file protection for created files.
3183 The value is an integer. */)
3190 realmask
= umask (0);
3194 XSETINT (value
, (~ realmask
) & 0777);
3199 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3200 doc
: /* Set times of file FILENAME to TIMESTAMP.
3201 Set both access and modification times.
3202 Return t on success, else nil.
3203 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3205 (Lisp_Object filename
, Lisp_Object timestamp
)
3207 Lisp_Object absname
, encoded_absname
;
3208 Lisp_Object handler
;
3209 EMACS_TIME t
= lisp_time_argument (timestamp
);
3211 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3213 /* If the file name has special constructs in it,
3214 call the corresponding file handler. */
3215 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3216 if (!NILP (handler
))
3217 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3219 encoded_absname
= ENCODE_FILE (absname
);
3222 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3225 /* Setting times on a directory always fails. */
3226 if (file_directory_p (SSDATA (encoded_absname
)))
3229 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3238 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3239 doc
: /* Tell Unix to finish all pending disk updates. */)
3246 #endif /* HAVE_SYNC */
3248 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3249 doc
: /* Return t if file FILE1 is newer than file FILE2.
3250 If FILE1 does not exist, the answer is nil;
3251 otherwise, if FILE2 does not exist, the answer is t. */)
3252 (Lisp_Object file1
, Lisp_Object file2
)
3254 Lisp_Object absname1
, absname2
;
3255 struct stat st1
, st2
;
3256 Lisp_Object handler
;
3257 struct gcpro gcpro1
, gcpro2
;
3259 CHECK_STRING (file1
);
3260 CHECK_STRING (file2
);
3263 GCPRO2 (absname1
, file2
);
3264 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3265 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3268 /* If the file name has special constructs in it,
3269 call the corresponding file handler. */
3270 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3272 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3273 if (!NILP (handler
))
3274 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3276 GCPRO2 (absname1
, absname2
);
3277 absname1
= ENCODE_FILE (absname1
);
3278 absname2
= ENCODE_FILE (absname2
);
3281 if (stat (SSDATA (absname1
), &st1
) < 0)
3284 if (stat (SSDATA (absname2
), &st2
) < 0)
3287 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3291 #ifndef READ_BUF_SIZE
3292 #define READ_BUF_SIZE (64 << 10)
3294 /* Some buffer offsets are stored in 'int' variables. */
3295 verify (READ_BUF_SIZE
<= INT_MAX
);
3297 /* This function is called after Lisp functions to decide a coding
3298 system are called, or when they cause an error. Before they are
3299 called, the current buffer is set unibyte and it contains only a
3300 newly inserted text (thus the buffer was empty before the
3303 The functions may set markers, overlays, text properties, or even
3304 alter the buffer contents, change the current buffer.
3306 Here, we reset all those changes by:
3307 o set back the current buffer.
3308 o move all markers and overlays to BEG.
3309 o remove all text properties.
3310 o set back the buffer multibyteness. */
3313 decide_coding_unwind (Lisp_Object unwind_data
)
3315 Lisp_Object multibyte
, undo_list
, buffer
;
3317 multibyte
= XCAR (unwind_data
);
3318 unwind_data
= XCDR (unwind_data
);
3319 undo_list
= XCAR (unwind_data
);
3320 buffer
= XCDR (unwind_data
);
3322 set_buffer_internal (XBUFFER (buffer
));
3323 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3324 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3325 set_buffer_intervals (current_buffer
, NULL
);
3326 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3328 /* Now we are safe to change the buffer's multibyteness directly. */
3329 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3330 bset_undo_list (current_buffer
, undo_list
);
3336 /* Used to pass values from insert-file-contents to read_non_regular. */
3338 static int non_regular_fd
;
3339 static ptrdiff_t non_regular_inserted
;
3340 static int non_regular_nbytes
;
3343 /* Read from a non-regular file.
3344 Read non_regular_nbytes bytes max from non_regular_fd.
3345 Non_regular_inserted specifies where to put the read bytes.
3346 Value is the number of bytes read. */
3349 read_non_regular (Lisp_Object ignore
)
3355 nbytes
= emacs_read (non_regular_fd
,
3356 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3357 + non_regular_inserted
),
3358 non_regular_nbytes
);
3360 return make_number (nbytes
);
3364 /* Condition-case handler used when reading from non-regular files
3365 in insert-file-contents. */
3368 read_non_regular_quit (Lisp_Object ignore
)
3373 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3374 except that it also tests for OFFSET being out of lseek's range. */
3376 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3378 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3379 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3380 if (! ((offset
>= TYPE_MINIMUM (off_t
)) & (offset
<= TYPE_MAXIMUM (off_t
))))
3385 return lseek (fd
, offset
, whence
);
3388 /* Return a special time value indicating the error number ERRNUM. */
3390 time_error_value (int errnum
)
3392 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3393 ? NONEXISTENT_MODTIME_NSECS
3394 : UNKNOWN_MODTIME_NSECS
);
3395 return make_emacs_time (0, ns
);
3398 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3400 doc
: /* Insert contents of file FILENAME after point.
3401 Returns list of absolute file name and number of characters inserted.
3402 If second argument VISIT is non-nil, the buffer's visited filename and
3403 last save file modtime are set, and it is marked unmodified. If
3404 visiting and the file does not exist, visiting is completed before the
3407 The optional third and fourth arguments BEG and END specify what portion
3408 of the file to insert. These arguments count bytes in the file, not
3409 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3411 If optional fifth argument REPLACE is non-nil, replace the current
3412 buffer contents (in the accessible portion) with the file contents.
3413 This is better than simply deleting and inserting the whole thing
3414 because (1) it preserves some marker positions and (2) it puts less data
3415 in the undo list. When REPLACE is non-nil, the second return value is
3416 the number of characters that replace previous buffer contents.
3418 This function does code conversion according to the value of
3419 `coding-system-for-read' or `file-coding-system-alist', and sets the
3420 variable `last-coding-system-used' to the coding system actually used.
3422 In addition, this function decodes the inserted text from known formats
3423 by calling `format-decode', which see. */)
3424 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3430 ptrdiff_t inserted
= 0;
3433 off_t beg_offset
, end_offset
;
3435 ptrdiff_t count
= SPECPDL_INDEX ();
3436 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3437 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3439 ptrdiff_t total
= 0;
3440 bool not_regular
= 0;
3442 char read_buf
[READ_BUF_SIZE
];
3443 struct coding_system coding
;
3444 char buffer
[1 << 14];
3445 bool replace_handled
= 0;
3446 bool set_coding_system
= 0;
3447 Lisp_Object coding_system
;
3449 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3450 bool we_locked_file
= 0;
3451 bool deferred_remove_unwind_protect
= 0;
3453 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3454 error ("Cannot do file visiting in an indirect buffer");
3456 if (!NILP (BVAR (current_buffer
, read_only
)))
3457 Fbarf_if_buffer_read_only ();
3461 orig_filename
= Qnil
;
3464 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3466 CHECK_STRING (filename
);
3467 filename
= Fexpand_file_name (filename
, Qnil
);
3469 /* The value Qnil means that the coding system is not yet
3471 coding_system
= Qnil
;
3473 /* If the file name has special constructs in it,
3474 call the corresponding file handler. */
3475 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3476 if (!NILP (handler
))
3478 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3479 visit
, beg
, end
, replace
);
3480 if (CONSP (val
) && CONSP (XCDR (val
))
3481 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3482 inserted
= XINT (XCAR (XCDR (val
)));
3486 orig_filename
= filename
;
3487 filename
= ENCODE_FILE (filename
);
3493 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3495 /* Tell stat to use expensive method to get accurate info. */
3496 Vw32_get_true_file_attributes
= Qt
;
3497 file_status
= stat (SSDATA (filename
), &st
);
3498 Vw32_get_true_file_attributes
= tem
;
3501 file_status
= stat (SSDATA (filename
), &st
);
3502 #endif /* WINDOWSNT */
3504 if (file_status
== 0)
3505 mtime
= get_stat_mtime (&st
);
3511 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3512 mtime
= time_error_value (save_errno
);
3515 if (!NILP (Vcoding_system_for_read
))
3516 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3520 /* This code will need to be changed in order to work on named
3521 pipes, and it's probably just not worth it. So we should at
3522 least signal an error. */
3523 if (!S_ISREG (st
.st_mode
))
3530 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3531 xsignal2 (Qfile_error
,
3532 build_string ("not a regular file"), orig_filename
);
3536 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3539 /* Replacement should preserve point as it preserves markers. */
3540 if (!NILP (replace
))
3541 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3543 record_unwind_protect (close_file_unwind
, make_number (fd
));
3548 if (!NILP (beg
) || !NILP (end
))
3549 error ("Attempt to visit less than an entire file");
3550 if (BEG
< Z
&& NILP (replace
))
3551 error ("Cannot do file visiting in a non-empty buffer");
3556 if (! RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
)))
3557 wrong_type_argument (intern ("file-offset"), beg
);
3558 beg_offset
= XFASTINT (beg
);
3565 if (! RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
)))
3566 wrong_type_argument (intern ("file-offset"), end
);
3567 end_offset
= XFASTINT (end
);
3572 end_offset
= TYPE_MAXIMUM (off_t
);
3575 end_offset
= st
.st_size
;
3577 /* A negative size can happen on a platform that allows file
3578 sizes greater than the maximum off_t value. */
3582 /* The file size returned from stat may be zero, but data
3583 may be readable nonetheless, for example when this is a
3584 file in the /proc filesystem. */
3585 if (end_offset
== 0)
3586 end_offset
= READ_BUF_SIZE
;
3590 /* Check now whether the buffer will become too large,
3591 in the likely case where the file's length is not changing.
3592 This saves a lot of needless work before a buffer overflow. */
3595 /* The likely offset where we will stop reading. We could read
3596 more (or less), if the file grows (or shrinks) as we read it. */
3597 off_t likely_end
= min (end_offset
, st
.st_size
);
3599 if (beg_offset
< likely_end
)
3602 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3603 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3604 off_t likely_growth
= likely_end
- beg_offset
;
3605 if (buf_growth_max
< likely_growth
)
3610 /* Prevent redisplay optimizations. */
3611 current_buffer
->clip_changed
= 1;
3613 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3615 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3616 setup_coding_system (coding_system
, &coding
);
3617 /* Ensure we set Vlast_coding_system_used. */
3618 set_coding_system
= 1;
3622 /* Decide the coding system to use for reading the file now
3623 because we can't use an optimized method for handling
3624 `coding:' tag if the current buffer is not empty. */
3625 if (!NILP (Vcoding_system_for_read
))
3626 coding_system
= Vcoding_system_for_read
;
3629 /* Don't try looking inside a file for a coding system
3630 specification if it is not seekable. */
3631 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3633 /* Find a coding system specified in the heading two
3634 lines or in the tailing several lines of the file.
3635 We assume that the 1K-byte and 3K-byte for heading
3636 and tailing respectively are sufficient for this
3640 if (st
.st_size
<= (1024 * 4))
3641 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3644 nread
= emacs_read (fd
, read_buf
, 1024);
3648 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3649 report_file_error ("Setting file position",
3650 Fcons (orig_filename
, Qnil
));
3651 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3652 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3657 error ("IO error reading %s: %s",
3658 SDATA (orig_filename
), emacs_strerror (errno
));
3661 struct buffer
*prev
= current_buffer
;
3662 Lisp_Object workbuf
;
3665 record_unwind_current_buffer ();
3667 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3668 buf
= XBUFFER (workbuf
);
3670 delete_all_overlays (buf
);
3671 bset_directory (buf
, BVAR (current_buffer
, directory
));
3672 bset_read_only (buf
, Qnil
);
3673 bset_filename (buf
, Qnil
);
3674 bset_undo_list (buf
, Qt
);
3675 eassert (buf
->overlays_before
== NULL
);
3676 eassert (buf
->overlays_after
== NULL
);
3678 set_buffer_internal (buf
);
3680 bset_enable_multibyte_characters (buf
, Qnil
);
3682 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3683 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3684 coding_system
= call2 (Vset_auto_coding_function
,
3685 filename
, make_number (nread
));
3686 set_buffer_internal (prev
);
3688 /* Discard the unwind protect for recovering the
3692 /* Rewind the file for the actual read done later. */
3693 if (lseek (fd
, 0, SEEK_SET
) < 0)
3694 report_file_error ("Setting file position",
3695 Fcons (orig_filename
, Qnil
));
3699 if (NILP (coding_system
))
3701 /* If we have not yet decided a coding system, check
3702 file-coding-system-alist. */
3703 Lisp_Object args
[6];
3705 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3706 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3707 coding_system
= Ffind_operation_coding_system (6, args
);
3708 if (CONSP (coding_system
))
3709 coding_system
= XCAR (coding_system
);
3713 if (NILP (coding_system
))
3714 coding_system
= Qundecided
;
3716 CHECK_CODING_SYSTEM (coding_system
);
3718 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3719 /* We must suppress all character code conversion except for
3720 end-of-line conversion. */
3721 coding_system
= raw_text_coding_system (coding_system
);
3723 setup_coding_system (coding_system
, &coding
);
3724 /* Ensure we set Vlast_coding_system_used. */
3725 set_coding_system
= 1;
3728 /* If requested, replace the accessible part of the buffer
3729 with the file contents. Avoid replacing text at the
3730 beginning or end of the buffer that matches the file contents;
3731 that preserves markers pointing to the unchanged parts.
3733 Here we implement this feature in an optimized way
3734 for the case where code conversion is NOT needed.
3735 The following if-statement handles the case of conversion
3736 in a less optimal way.
3738 If the code conversion is "automatic" then we try using this
3739 method and hope for the best.
3740 But if we discover the need for conversion, we give up on this method
3741 and let the following if-statement handle the replace job. */
3744 && (NILP (coding_system
)
3745 || ! CODING_REQUIRE_DECODING (&coding
)))
3747 /* same_at_start and same_at_end count bytes,
3748 because file access counts bytes
3749 and BEG and END count bytes. */
3750 ptrdiff_t same_at_start
= BEGV_BYTE
;
3751 ptrdiff_t same_at_end
= ZV_BYTE
;
3753 /* There is still a possibility we will find the need to do code
3754 conversion. If that happens, set this variable to
3755 give up on handling REPLACE in the optimized way. */
3756 bool giveup_match_end
= 0;
3758 if (beg_offset
!= 0)
3760 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3761 report_file_error ("Setting file position",
3762 Fcons (orig_filename
, Qnil
));
3767 /* Count how many chars at the start of the file
3768 match the text at the beginning of the buffer. */
3773 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3775 error ("IO error reading %s: %s",
3776 SSDATA (orig_filename
), emacs_strerror (errno
));
3777 else if (nread
== 0)
3780 if (CODING_REQUIRE_DETECTION (&coding
))
3782 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3785 setup_coding_system (coding_system
, &coding
);
3788 if (CODING_REQUIRE_DECODING (&coding
))
3789 /* We found that the file should be decoded somehow.
3790 Let's give up here. */
3792 giveup_match_end
= 1;
3797 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3798 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3799 same_at_start
++, bufpos
++;
3800 /* If we found a discrepancy, stop the scan.
3801 Otherwise loop around and scan the next bufferful. */
3802 if (bufpos
!= nread
)
3806 /* If the file matches the buffer completely,
3807 there's no need to replace anything. */
3808 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3812 /* Truncate the buffer to the size of the file. */
3813 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3818 /* Count how many chars at the end of the file
3819 match the text at the end of the buffer. But, if we have
3820 already found that decoding is necessary, don't waste time. */
3821 while (!giveup_match_end
)
3823 int total_read
, nread
, bufpos
, trial
;
3826 /* At what file position are we now scanning? */
3827 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3828 /* If the entire file matches the buffer tail, stop the scan. */
3831 /* How much can we scan in the next step? */
3832 trial
= min (curpos
, sizeof buffer
);
3833 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3834 report_file_error ("Setting file position",
3835 Fcons (orig_filename
, Qnil
));
3837 total_read
= nread
= 0;
3838 while (total_read
< trial
)
3840 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3842 error ("IO error reading %s: %s",
3843 SDATA (orig_filename
), emacs_strerror (errno
));
3844 else if (nread
== 0)
3846 total_read
+= nread
;
3849 /* Scan this bufferful from the end, comparing with
3850 the Emacs buffer. */
3851 bufpos
= total_read
;
3853 /* Compare with same_at_start to avoid counting some buffer text
3854 as matching both at the file's beginning and at the end. */
3855 while (bufpos
> 0 && same_at_end
> same_at_start
3856 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3857 same_at_end
--, bufpos
--;
3859 /* If we found a discrepancy, stop the scan.
3860 Otherwise loop around and scan the preceding bufferful. */
3863 /* If this discrepancy is because of code conversion,
3864 we cannot use this method; giveup and try the other. */
3865 if (same_at_end
> same_at_start
3866 && FETCH_BYTE (same_at_end
- 1) >= 0200
3867 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3868 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3869 giveup_match_end
= 1;
3878 if (! giveup_match_end
)
3882 /* We win! We can handle REPLACE the optimized way. */
3884 /* Extend the start of non-matching text area to multibyte
3885 character boundary. */
3886 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3887 while (same_at_start
> BEGV_BYTE
3888 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3891 /* Extend the end of non-matching text area to multibyte
3892 character boundary. */
3893 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3894 while (same_at_end
< ZV_BYTE
3895 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3898 /* Don't try to reuse the same piece of text twice. */
3899 overlap
= (same_at_start
- BEGV_BYTE
3901 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3903 same_at_end
+= overlap
;
3905 /* Arrange to read only the nonmatching middle part of the file. */
3906 beg_offset
+= same_at_start
- BEGV_BYTE
;
3907 end_offset
-= ZV_BYTE
- same_at_end
;
3909 del_range_byte (same_at_start
, same_at_end
, 0);
3910 /* Insert from the file at the proper position. */
3911 temp
= BYTE_TO_CHAR (same_at_start
);
3912 SET_PT_BOTH (temp
, same_at_start
);
3914 /* If display currently starts at beginning of line,
3915 keep it that way. */
3916 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3917 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3919 replace_handled
= 1;
3923 /* If requested, replace the accessible part of the buffer
3924 with the file contents. Avoid replacing text at the
3925 beginning or end of the buffer that matches the file contents;
3926 that preserves markers pointing to the unchanged parts.
3928 Here we implement this feature for the case where code conversion
3929 is needed, in a simple way that needs a lot of memory.
3930 The preceding if-statement handles the case of no conversion
3931 in a more optimized way. */
3932 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3934 ptrdiff_t same_at_start
= BEGV_BYTE
;
3935 ptrdiff_t same_at_end
= ZV_BYTE
;
3936 ptrdiff_t same_at_start_charpos
;
3937 ptrdiff_t inserted_chars
;
3940 unsigned char *decoded
;
3943 ptrdiff_t this_count
= SPECPDL_INDEX ();
3945 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3946 Lisp_Object conversion_buffer
;
3947 struct gcpro gcpro1
;
3949 conversion_buffer
= code_conversion_save (1, multibyte
);
3951 /* First read the whole file, performing code conversion into
3952 CONVERSION_BUFFER. */
3954 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3955 report_file_error ("Setting file position",
3956 Fcons (orig_filename
, Qnil
));
3958 total
= st
.st_size
; /* Total bytes in the file. */
3959 how_much
= 0; /* Bytes read from file so far. */
3960 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3961 unprocessed
= 0; /* Bytes not processed in previous loop. */
3963 GCPRO1 (conversion_buffer
);
3964 while (how_much
< total
)
3966 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3967 quitting while reading a huge while. */
3968 /* `try'' is reserved in some compilers (Microsoft C). */
3969 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3971 /* Allow quitting out of the actual I/O. */
3974 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3982 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3983 BUF_Z (XBUFFER (conversion_buffer
)));
3984 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3985 unprocessed
+ this, conversion_buffer
);
3986 unprocessed
= coding
.carryover_bytes
;
3987 if (coding
.carryover_bytes
> 0)
3988 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3993 /* We should remove the unwind_protect calling
3994 close_file_unwind, but other stuff has been added the stack,
3995 so defer the removal till we reach the `handled' label. */
3996 deferred_remove_unwind_protect
= 1;
3998 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3999 if we couldn't read the file. */
4002 error ("IO error reading %s: %s",
4003 SDATA (orig_filename
), emacs_strerror (errno
));
4005 if (unprocessed
> 0)
4007 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4008 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4009 unprocessed
, conversion_buffer
);
4010 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4013 coding_system
= CODING_ID_NAME (coding
.id
);
4014 set_coding_system
= 1;
4015 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4016 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4017 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4019 /* Compare the beginning of the converted string with the buffer
4023 while (bufpos
< inserted
&& same_at_start
< same_at_end
4024 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4025 same_at_start
++, bufpos
++;
4027 /* If the file matches the head of buffer completely,
4028 there's no need to replace anything. */
4030 if (bufpos
== inserted
)
4032 /* Truncate the buffer to the size of the file. */
4033 if (same_at_start
== same_at_end
)
4036 del_range_byte (same_at_start
, same_at_end
, 0);
4039 unbind_to (this_count
, Qnil
);
4043 /* Extend the start of non-matching text area to the previous
4044 multibyte character boundary. */
4045 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4046 while (same_at_start
> BEGV_BYTE
4047 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4050 /* Scan this bufferful from the end, comparing with
4051 the Emacs buffer. */
4054 /* Compare with same_at_start to avoid counting some buffer text
4055 as matching both at the file's beginning and at the end. */
4056 while (bufpos
> 0 && same_at_end
> same_at_start
4057 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4058 same_at_end
--, bufpos
--;
4060 /* Extend the end of non-matching text area to the next
4061 multibyte character boundary. */
4062 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4063 while (same_at_end
< ZV_BYTE
4064 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4067 /* Don't try to reuse the same piece of text twice. */
4068 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4070 same_at_end
+= overlap
;
4072 /* If display currently starts at beginning of line,
4073 keep it that way. */
4074 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4075 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4077 /* Replace the chars that we need to replace,
4078 and update INSERTED to equal the number of bytes
4079 we are taking from the decoded string. */
4080 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4082 if (same_at_end
!= same_at_start
)
4084 del_range_byte (same_at_start
, same_at_end
, 0);
4086 same_at_start
= GPT_BYTE
;
4090 temp
= BYTE_TO_CHAR (same_at_start
);
4092 /* Insert from the file at the proper position. */
4093 SET_PT_BOTH (temp
, same_at_start
);
4094 same_at_start_charpos
4095 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4096 same_at_start
- BEGV_BYTE
4097 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4099 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4100 same_at_start
+ inserted
- BEGV_BYTE
4101 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4102 - same_at_start_charpos
);
4103 /* This binding is to avoid ask-user-about-supersession-threat
4104 being called in insert_from_buffer (via in
4105 prepare_to_modify_buffer). */
4106 specbind (intern ("buffer-file-name"), Qnil
);
4107 insert_from_buffer (XBUFFER (conversion_buffer
),
4108 same_at_start_charpos
, inserted_chars
, 0);
4109 /* Set `inserted' to the number of inserted characters. */
4110 inserted
= PT
- temp
;
4111 /* Set point before the inserted characters. */
4112 SET_PT_BOTH (temp
, same_at_start
);
4114 unbind_to (this_count
, Qnil
);
4120 total
= end_offset
- beg_offset
;
4122 /* For a special file, all we can do is guess. */
4123 total
= READ_BUF_SIZE
;
4125 if (NILP (visit
) && total
> 0)
4127 #ifdef CLASH_DETECTION
4128 if (!NILP (BVAR (current_buffer
, file_truename
))
4129 /* Make binding buffer-file-name to nil effective. */
4130 && !NILP (BVAR (current_buffer
, filename
))
4131 && SAVE_MODIFF
>= MODIFF
)
4133 #endif /* CLASH_DETECTION */
4134 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4137 move_gap_both (PT
, PT_BYTE
);
4138 if (GAP_SIZE
< total
)
4139 make_gap (total
- GAP_SIZE
);
4141 if (beg_offset
!= 0 || !NILP (replace
))
4143 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4144 report_file_error ("Setting file position",
4145 Fcons (orig_filename
, Qnil
));
4148 /* In the following loop, HOW_MUCH contains the total bytes read so
4149 far for a regular file, and not changed for a special file. But,
4150 before exiting the loop, it is set to a negative value if I/O
4154 /* Total bytes inserted. */
4157 /* Here, we don't do code conversion in the loop. It is done by
4158 decode_coding_gap after all data are read into the buffer. */
4160 ptrdiff_t gap_size
= GAP_SIZE
;
4162 while (how_much
< total
)
4164 /* try is reserved in some compilers (Microsoft C) */
4165 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4172 /* Maybe make more room. */
4173 if (gap_size
< trytry
)
4175 make_gap (total
- gap_size
);
4176 gap_size
= GAP_SIZE
;
4179 /* Read from the file, capturing `quit'. When an
4180 error occurs, end the loop, and arrange for a quit
4181 to be signaled after decoding the text we read. */
4182 non_regular_fd
= fd
;
4183 non_regular_inserted
= inserted
;
4184 non_regular_nbytes
= trytry
;
4185 nbytes
= internal_condition_case_1 (read_non_regular
,
4187 read_non_regular_quit
);
4194 this = XINT (nbytes
);
4198 /* Allow quitting out of the actual I/O. We don't make text
4199 part of the buffer until all the reading is done, so a C-g
4200 here doesn't do any harm. */
4203 this = emacs_read (fd
,
4204 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4218 /* For a regular file, where TOTAL is the real size,
4219 count HOW_MUCH to compare with it.
4220 For a special file, where TOTAL is just a buffer size,
4221 so don't bother counting in HOW_MUCH.
4222 (INSERTED is where we count the number of characters inserted.) */
4229 /* Now we have read all the file data into the gap.
4230 If it was empty, undo marking the buffer modified. */
4234 #ifdef CLASH_DETECTION
4236 unlock_file (BVAR (current_buffer
, file_truename
));
4238 Vdeactivate_mark
= old_Vdeactivate_mark
;
4241 Vdeactivate_mark
= Qt
;
4243 /* Make the text read part of the buffer. */
4244 GAP_SIZE
-= inserted
;
4246 GPT_BYTE
+= inserted
;
4248 ZV_BYTE
+= inserted
;
4253 /* Put an anchor to ensure multi-byte form ends at gap. */
4258 /* Discard the unwind protect for closing the file. */
4262 error ("IO error reading %s: %s",
4263 SDATA (orig_filename
), emacs_strerror (errno
));
4267 if (NILP (coding_system
))
4269 /* The coding system is not yet decided. Decide it by an
4270 optimized method for handling `coding:' tag.
4272 Note that we can get here only if the buffer was empty
4273 before the insertion. */
4275 if (!NILP (Vcoding_system_for_read
))
4276 coding_system
= Vcoding_system_for_read
;
4279 /* Since we are sure that the current buffer was empty
4280 before the insertion, we can toggle
4281 enable-multibyte-characters directly here without taking
4282 care of marker adjustment. By this way, we can run Lisp
4283 program safely before decoding the inserted text. */
4284 Lisp_Object unwind_data
;
4285 ptrdiff_t count1
= SPECPDL_INDEX ();
4287 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4288 Fcons (BVAR (current_buffer
, undo_list
),
4289 Fcurrent_buffer ()));
4290 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4291 bset_undo_list (current_buffer
, Qt
);
4292 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4294 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4296 coding_system
= call2 (Vset_auto_coding_function
,
4297 filename
, make_number (inserted
));
4300 if (NILP (coding_system
))
4302 /* If the coding system is not yet decided, check
4303 file-coding-system-alist. */
4304 Lisp_Object args
[6];
4306 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4307 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4308 coding_system
= Ffind_operation_coding_system (6, args
);
4309 if (CONSP (coding_system
))
4310 coding_system
= XCAR (coding_system
);
4312 unbind_to (count1
, Qnil
);
4313 inserted
= Z_BYTE
- BEG_BYTE
;
4316 if (NILP (coding_system
))
4317 coding_system
= Qundecided
;
4319 CHECK_CODING_SYSTEM (coding_system
);
4321 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4322 /* We must suppress all character code conversion except for
4323 end-of-line conversion. */
4324 coding_system
= raw_text_coding_system (coding_system
);
4325 setup_coding_system (coding_system
, &coding
);
4326 /* Ensure we set Vlast_coding_system_used. */
4327 set_coding_system
= 1;
4332 /* When we visit a file by raw-text, we change the buffer to
4334 if (CODING_FOR_UNIBYTE (&coding
)
4335 /* Can't do this if part of the buffer might be preserved. */
4337 /* Visiting a file with these coding system makes the buffer
4339 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4342 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4343 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4344 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4346 move_gap_both (PT
, PT_BYTE
);
4347 GAP_SIZE
+= inserted
;
4348 ZV_BYTE
-= inserted
;
4352 decode_coding_gap (&coding
, inserted
, inserted
);
4353 inserted
= coding
.produced_char
;
4354 coding_system
= CODING_ID_NAME (coding
.id
);
4356 else if (inserted
> 0)
4357 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4360 /* Call after-change hooks for the inserted text, aside from the case
4361 of normal visiting (not with REPLACE), which is done in a new buffer
4362 "before" the buffer is changed. */
4363 if (inserted
> 0 && total
> 0
4364 && (NILP (visit
) || !NILP (replace
)))
4366 signal_after_change (PT
, 0, inserted
);
4367 update_compositions (PT
, PT
, CHECK_BORDER
);
4370 /* Now INSERTED is measured in characters. */
4374 if (deferred_remove_unwind_protect
)
4375 /* If requested above, discard the unwind protect for closing the
4381 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4382 bset_undo_list (current_buffer
, Qnil
);
4386 current_buffer
->modtime
= mtime
;
4387 current_buffer
->modtime_size
= st
.st_size
;
4388 bset_filename (current_buffer
, orig_filename
);
4391 SAVE_MODIFF
= MODIFF
;
4392 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4393 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4394 #ifdef CLASH_DETECTION
4397 if (!NILP (BVAR (current_buffer
, file_truename
)))
4398 unlock_file (BVAR (current_buffer
, file_truename
));
4399 unlock_file (filename
);
4401 #endif /* CLASH_DETECTION */
4403 xsignal2 (Qfile_error
,
4404 build_string ("not a regular file"), orig_filename
);
4407 if (set_coding_system
)
4408 Vlast_coding_system_used
= coding_system
;
4410 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4412 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4414 if (! NILP (insval
))
4416 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4417 wrong_type_argument (intern ("inserted-chars"), insval
);
4418 inserted
= XFASTINT (insval
);
4422 /* Decode file format. */
4425 /* Don't run point motion or modification hooks when decoding. */
4426 ptrdiff_t count1
= SPECPDL_INDEX ();
4427 ptrdiff_t old_inserted
= inserted
;
4428 specbind (Qinhibit_point_motion_hooks
, Qt
);
4429 specbind (Qinhibit_modification_hooks
, Qt
);
4431 /* Save old undo list and don't record undo for decoding. */
4432 old_undo
= BVAR (current_buffer
, undo_list
);
4433 bset_undo_list (current_buffer
, Qt
);
4437 insval
= call3 (Qformat_decode
,
4438 Qnil
, make_number (inserted
), visit
);
4439 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4440 wrong_type_argument (intern ("inserted-chars"), insval
);
4441 inserted
= XFASTINT (insval
);
4445 /* If REPLACE is non-nil and we succeeded in not replacing the
4446 beginning or end of the buffer text with the file's contents,
4447 call format-decode with `point' positioned at the beginning
4448 of the buffer and `inserted' equaling the number of
4449 characters in the buffer. Otherwise, format-decode might
4450 fail to correctly analyze the beginning or end of the buffer.
4451 Hence we temporarily save `point' and `inserted' here and
4452 restore `point' iff format-decode did not insert or delete
4453 any text. Otherwise we leave `point' at point-min. */
4454 ptrdiff_t opoint
= PT
;
4455 ptrdiff_t opoint_byte
= PT_BYTE
;
4456 ptrdiff_t oinserted
= ZV
- BEGV
;
4457 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4459 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4460 insval
= call3 (Qformat_decode
,
4461 Qnil
, make_number (oinserted
), visit
);
4462 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4463 wrong_type_argument (intern ("inserted-chars"), insval
);
4464 if (ochars_modiff
== CHARS_MODIFF
)
4465 /* format_decode didn't modify buffer's characters => move
4466 point back to position before inserted text and leave
4467 value of inserted alone. */
4468 SET_PT_BOTH (opoint
, opoint_byte
);
4470 /* format_decode modified buffer's characters => consider
4471 entire buffer changed and leave point at point-min. */
4472 inserted
= XFASTINT (insval
);
4475 /* For consistency with format-decode call these now iff inserted > 0
4476 (martin 2007-06-28). */
4477 p
= Vafter_insert_file_functions
;
4482 insval
= call1 (XCAR (p
), make_number (inserted
));
4485 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4486 wrong_type_argument (intern ("inserted-chars"), insval
);
4487 inserted
= XFASTINT (insval
);
4492 /* For the rationale of this see the comment on
4493 format-decode above. */
4494 ptrdiff_t opoint
= PT
;
4495 ptrdiff_t opoint_byte
= PT_BYTE
;
4496 ptrdiff_t oinserted
= ZV
- BEGV
;
4497 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4499 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4500 insval
= call1 (XCAR (p
), make_number (oinserted
));
4503 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4504 wrong_type_argument (intern ("inserted-chars"), insval
);
4505 if (ochars_modiff
== CHARS_MODIFF
)
4506 /* after_insert_file_functions didn't modify
4507 buffer's characters => move point back to
4508 position before inserted text and leave value of
4510 SET_PT_BOTH (opoint
, opoint_byte
);
4512 /* after_insert_file_functions did modify buffer's
4513 characters => consider entire buffer changed and
4514 leave point at point-min. */
4515 inserted
= XFASTINT (insval
);
4525 bset_undo_list (current_buffer
, old_undo
);
4526 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4528 /* Adjust the last undo record for the size change during
4529 the format conversion. */
4530 Lisp_Object tem
= XCAR (old_undo
);
4531 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4532 && INTEGERP (XCDR (tem
))
4533 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4534 XSETCDR (tem
, make_number (PT
+ inserted
));
4538 /* If undo_list was Qt before, keep it that way.
4539 Otherwise start with an empty undo_list. */
4540 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4542 unbind_to (count1
, Qnil
);
4546 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4548 /* If visiting nonexistent file, return nil. */
4550 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4554 Fsignal (Qquit
, Qnil
);
4556 /* ??? Retval needs to be dealt with in all cases consistently. */
4558 val
= Fcons (orig_filename
,
4559 Fcons (make_number (inserted
),
4562 RETURN_UNGCPRO (unbind_to (count
, val
));
4565 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4568 build_annotations_unwind (Lisp_Object arg
)
4570 Vwrite_region_annotation_buffers
= arg
;
4574 /* Decide the coding-system to encode the data with. */
4577 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4578 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4579 struct coding_system
*coding
)
4582 Lisp_Object eol_parent
= Qnil
;
4585 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4586 BVAR (current_buffer
, auto_save_file_name
))))
4591 else if (!NILP (Vcoding_system_for_write
))
4593 val
= Vcoding_system_for_write
;
4594 if (coding_system_require_warning
4595 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4596 /* Confirm that VAL can surely encode the current region. */
4597 val
= call5 (Vselect_safe_coding_system_function
,
4598 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4603 /* If the variable `buffer-file-coding-system' is set locally,
4604 it means that the file was read with some kind of code
4605 conversion or the variable is explicitly set by users. We
4606 had better write it out with the same coding system even if
4607 `enable-multibyte-characters' is nil.
4609 If it is not set locally, we anyway have to convert EOL
4610 format if the default value of `buffer-file-coding-system'
4611 tells that it is not Unix-like (LF only) format. */
4612 bool using_default_coding
= 0;
4613 bool force_raw_text
= 0;
4615 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4617 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4620 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4626 /* Check file-coding-system-alist. */
4627 Lisp_Object args
[7], coding_systems
;
4629 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4630 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4632 coding_systems
= Ffind_operation_coding_system (7, args
);
4633 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4634 val
= XCDR (coding_systems
);
4639 /* If we still have not decided a coding system, use the
4640 default value of buffer-file-coding-system. */
4641 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4642 using_default_coding
= 1;
4645 if (! NILP (val
) && ! force_raw_text
)
4647 Lisp_Object spec
, attrs
;
4649 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4650 attrs
= AREF (spec
, 0);
4651 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4656 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4657 /* Confirm that VAL can surely encode the current region. */
4658 val
= call5 (Vselect_safe_coding_system_function
,
4659 start
, end
, val
, Qnil
, filename
);
4661 /* If the decided coding-system doesn't specify end-of-line
4662 format, we use that of
4663 `default-buffer-file-coding-system'. */
4664 if (! using_default_coding
4665 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4666 val
= (coding_inherit_eol_type
4667 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4669 /* If we decide not to encode text, use `raw-text' or one of its
4672 val
= raw_text_coding_system (val
);
4675 val
= coding_inherit_eol_type (val
, eol_parent
);
4676 setup_coding_system (val
, coding
);
4678 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4679 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4683 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4684 "r\nFWrite region to file: \ni\ni\ni\np",
4685 doc
: /* Write current region into specified file.
4686 When called from a program, requires three arguments:
4687 START, END and FILENAME. START and END are normally buffer positions
4688 specifying the part of the buffer to write.
4689 If START is nil, that means to use the entire buffer contents.
4690 If START is a string, then output that string to the file
4691 instead of any buffer contents; END is ignored.
4693 Optional fourth argument APPEND if non-nil means
4694 append to existing file contents (if any). If it is an integer,
4695 seek to that offset in the file before writing.
4696 Optional fifth argument VISIT, if t or a string, means
4697 set the last-save-file-modtime of buffer to this file's modtime
4698 and mark buffer not modified.
4699 If VISIT is a string, it is a second file name;
4700 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4701 VISIT is also the file name to lock and unlock for clash detection.
4702 If VISIT is neither t nor nil nor a string,
4703 that means do not display the \"Wrote file\" message.
4704 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4705 use for locking and unlocking, overriding FILENAME and VISIT.
4706 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4707 for an existing file with the same name. If MUSTBENEW is `excl',
4708 that means to get an error if the file already exists; never overwrite.
4709 If MUSTBENEW is neither nil nor `excl', that means ask for
4710 confirmation before overwriting, but do go ahead and overwrite the file
4711 if the user confirms.
4713 This does code conversion according to the value of
4714 `coding-system-for-write', `buffer-file-coding-system', or
4715 `file-coding-system-alist', and sets the variable
4716 `last-coding-system-used' to the coding system actually used.
4718 This calls `write-region-annotate-functions' at the start, and
4719 `write-region-post-annotation-function' at the end. */)
4720 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4728 ptrdiff_t count
= SPECPDL_INDEX ();
4730 Lisp_Object handler
;
4731 Lisp_Object visit_file
;
4732 Lisp_Object annotations
;
4733 Lisp_Object encoded_filename
;
4734 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4735 bool quietly
= !NILP (visit
);
4736 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4737 struct buffer
*given_buffer
;
4738 struct coding_system coding
;
4740 if (current_buffer
->base_buffer
&& visiting
)
4741 error ("Cannot do file visiting in an indirect buffer");
4743 if (!NILP (start
) && !STRINGP (start
))
4744 validate_region (&start
, &end
);
4747 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4749 filename
= Fexpand_file_name (filename
, Qnil
);
4751 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4752 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4754 if (STRINGP (visit
))
4755 visit_file
= Fexpand_file_name (visit
, Qnil
);
4757 visit_file
= filename
;
4759 if (NILP (lockname
))
4760 lockname
= visit_file
;
4764 /* If the file name has special constructs in it,
4765 call the corresponding file handler. */
4766 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4767 /* If FILENAME has no handler, see if VISIT has one. */
4768 if (NILP (handler
) && STRINGP (visit
))
4769 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4771 if (!NILP (handler
))
4774 val
= call6 (handler
, Qwrite_region
, start
, end
,
4775 filename
, append
, visit
);
4779 SAVE_MODIFF
= MODIFF
;
4780 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4781 bset_filename (current_buffer
, visit_file
);
4787 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4789 /* Special kludge to simplify auto-saving. */
4792 /* Do it later, so write-region-annotate-function can work differently
4793 if we save "the buffer" vs "a region".
4794 This is useful in tar-mode. --Stef
4795 XSETFASTINT (start, BEG);
4796 XSETFASTINT (end, Z); */
4800 record_unwind_protect (build_annotations_unwind
,
4801 Vwrite_region_annotation_buffers
);
4802 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4803 count1
= SPECPDL_INDEX ();
4805 given_buffer
= current_buffer
;
4807 if (!STRINGP (start
))
4809 annotations
= build_annotations (start
, end
);
4811 if (current_buffer
!= given_buffer
)
4813 XSETFASTINT (start
, BEGV
);
4814 XSETFASTINT (end
, ZV
);
4820 XSETFASTINT (start
, BEGV
);
4821 XSETFASTINT (end
, ZV
);
4826 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4828 /* Decide the coding-system to encode the data with.
4829 We used to make this choice before calling build_annotations, but that
4830 leads to problems when a write-annotate-function takes care of
4831 unsavable chars (as was the case with X-Symbol). */
4832 Vlast_coding_system_used
4833 = choose_write_coding_system (start
, end
, filename
,
4834 append
, visit
, lockname
, &coding
);
4836 #ifdef CLASH_DETECTION
4838 lock_file (lockname
);
4839 #endif /* CLASH_DETECTION */
4841 encoded_filename
= ENCODE_FILE (filename
);
4843 fn
= SSDATA (encoded_filename
);
4847 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4848 #else /* not DOS_NT */
4849 desc
= emacs_open (fn
, O_WRONLY
, 0);
4850 #endif /* not DOS_NT */
4852 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4854 desc
= emacs_open (fn
,
4855 O_WRONLY
| O_CREAT
| O_BINARY
4856 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4857 S_IREAD
| S_IWRITE
);
4858 #else /* not DOS_NT */
4859 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4860 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4861 auto_saving
? auto_save_mode_bits
: 0666);
4862 #endif /* not DOS_NT */
4866 #ifdef CLASH_DETECTION
4868 if (!auto_saving
) unlock_file (lockname
);
4870 #endif /* CLASH_DETECTION */
4872 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4875 record_unwind_protect (close_file_unwind
, make_number (desc
));
4877 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4881 if (NUMBERP (append
))
4882 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4884 ret
= lseek (desc
, 0, SEEK_END
);
4887 #ifdef CLASH_DETECTION
4889 if (!auto_saving
) unlock_file (lockname
);
4891 #endif /* CLASH_DETECTION */
4893 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4901 if (STRINGP (start
))
4902 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4903 else if (XINT (start
) != XINT (end
))
4904 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4905 &annotations
, &coding
);
4908 /* If file was empty, still need to write the annotations. */
4909 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4910 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4914 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4915 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4917 /* We have to flush out a data. */
4918 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4919 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4926 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4927 Disk full in NFS may be reported here. */
4928 /* mib says that closing the file will try to write as fast as NFS can do
4929 it, and that means the fsync here is not crucial for autosave files. */
4930 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4932 /* If fsync fails with EINTR, don't treat that as serious. Also
4933 ignore EINVAL which happens when fsync is not supported on this
4935 if (errno
!= EINTR
&& errno
!= EINVAL
)
4936 ok
= 0, save_errno
= errno
;
4940 modtime
= invalid_emacs_time ();
4943 if (fstat (desc
, &st
) == 0)
4944 modtime
= get_stat_mtime (&st
);
4946 ok
= 0, save_errno
= errno
;
4949 /* NFS can report a write failure now. */
4950 if (emacs_close (desc
) < 0)
4951 ok
= 0, save_errno
= errno
;
4953 /* Discard the unwind protect for close_file_unwind. */
4954 specpdl_ptr
= specpdl
+ count1
;
4956 /* Call write-region-post-annotation-function. */
4957 while (CONSP (Vwrite_region_annotation_buffers
))
4959 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4960 if (!NILP (Fbuffer_live_p (buf
)))
4963 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4964 call0 (Vwrite_region_post_annotation_function
);
4966 Vwrite_region_annotation_buffers
4967 = XCDR (Vwrite_region_annotation_buffers
);
4970 unbind_to (count
, Qnil
);
4972 #ifdef CLASH_DETECTION
4974 unlock_file (lockname
);
4975 #endif /* CLASH_DETECTION */
4977 /* Do this before reporting IO error
4978 to avoid a "file has changed on disk" warning on
4979 next attempt to save. */
4980 if (EMACS_TIME_VALID_P (modtime
))
4982 current_buffer
->modtime
= modtime
;
4983 current_buffer
->modtime_size
= st
.st_size
;
4987 error ("IO error writing %s: %s", SDATA (filename
),
4988 emacs_strerror (save_errno
));
4992 SAVE_MODIFF
= MODIFF
;
4993 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4994 bset_filename (current_buffer
, visit_file
);
4995 update_mode_lines
++;
5000 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5001 BVAR (current_buffer
, auto_save_file_name
))))
5002 SAVE_MODIFF
= MODIFF
;
5008 message_with_string ((INTEGERP (append
)
5018 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
5020 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5021 doc
: /* Return t if (car A) is numerically less than (car B). */)
5022 (Lisp_Object a
, Lisp_Object b
)
5024 return Flss (Fcar (a
), Fcar (b
));
5027 /* Build the complete list of annotations appropriate for writing out
5028 the text between START and END, by calling all the functions in
5029 write-region-annotate-functions and merging the lists they return.
5030 If one of these functions switches to a different buffer, we assume
5031 that buffer contains altered text. Therefore, the caller must
5032 make sure to restore the current buffer in all cases,
5033 as save-excursion would do. */
5036 build_annotations (Lisp_Object start
, Lisp_Object end
)
5038 Lisp_Object annotations
;
5040 struct gcpro gcpro1
, gcpro2
;
5041 Lisp_Object original_buffer
;
5043 bool used_global
= 0;
5045 XSETBUFFER (original_buffer
, current_buffer
);
5048 p
= Vwrite_region_annotate_functions
;
5049 GCPRO2 (annotations
, p
);
5052 struct buffer
*given_buffer
= current_buffer
;
5053 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5054 { /* Use the global value of the hook. */
5057 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5059 p
= Fappend (2, arg
);
5062 Vwrite_region_annotations_so_far
= annotations
;
5063 res
= call2 (XCAR (p
), start
, end
);
5064 /* If the function makes a different buffer current,
5065 assume that means this buffer contains altered text to be output.
5066 Reset START and END from the buffer bounds
5067 and discard all previous annotations because they should have
5068 been dealt with by this function. */
5069 if (current_buffer
!= given_buffer
)
5071 Vwrite_region_annotation_buffers
5072 = Fcons (Fcurrent_buffer (),
5073 Vwrite_region_annotation_buffers
);
5074 XSETFASTINT (start
, BEGV
);
5075 XSETFASTINT (end
, ZV
);
5078 Flength (res
); /* Check basic validity of return value */
5079 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5083 /* Now do the same for annotation functions implied by the file-format */
5084 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5085 p
= BVAR (current_buffer
, auto_save_file_format
);
5087 p
= BVAR (current_buffer
, file_format
);
5088 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5090 struct buffer
*given_buffer
= current_buffer
;
5092 Vwrite_region_annotations_so_far
= annotations
;
5094 /* Value is either a list of annotations or nil if the function
5095 has written annotations to a temporary buffer, which is now
5097 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5098 original_buffer
, make_number (i
));
5099 if (current_buffer
!= given_buffer
)
5101 XSETFASTINT (start
, BEGV
);
5102 XSETFASTINT (end
, ZV
);
5107 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5115 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5116 If STRING is nil, POS is the character position in the current buffer.
5117 Intersperse with them the annotations from *ANNOT
5118 which fall within the range of POS to POS + NCHARS,
5119 each at its appropriate position.
5121 We modify *ANNOT by discarding elements as we use them up.
5123 Return true if successful. */
5126 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5127 ptrdiff_t nchars
, Lisp_Object
*annot
,
5128 struct coding_system
*coding
)
5132 ptrdiff_t lastpos
= pos
+ nchars
;
5134 while (NILP (*annot
) || CONSP (*annot
))
5136 tem
= Fcar_safe (Fcar (*annot
));
5139 nextpos
= XFASTINT (tem
);
5141 /* If there are no more annotations in this range,
5142 output the rest of the range all at once. */
5143 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5144 return e_write (desc
, string
, pos
, lastpos
, coding
);
5146 /* Output buffer text up to the next annotation's position. */
5149 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5153 /* Output the annotation. */
5154 tem
= Fcdr (Fcar (*annot
));
5157 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5160 *annot
= Fcdr (*annot
);
5166 /* Write text in the range START and END into descriptor DESC,
5167 encoding them with coding system CODING. If STRING is nil, START
5168 and END are character positions of the current buffer, else they
5169 are indexes to the string STRING. Return true if successful. */
5172 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5173 struct coding_system
*coding
)
5175 if (STRINGP (string
))
5178 end
= SCHARS (string
);
5181 /* We used to have a code for handling selective display here. But,
5182 now it is handled within encode_coding. */
5186 if (STRINGP (string
))
5188 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5189 if (CODING_REQUIRE_ENCODING (coding
))
5191 encode_coding_object (coding
, string
,
5192 start
, string_char_to_byte (string
, start
),
5193 end
, string_char_to_byte (string
, end
), Qt
);
5197 coding
->dst_object
= string
;
5198 coding
->consumed_char
= SCHARS (string
);
5199 coding
->produced
= SBYTES (string
);
5204 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5205 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5207 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5208 if (CODING_REQUIRE_ENCODING (coding
))
5210 encode_coding_object (coding
, Fcurrent_buffer (),
5211 start
, start_byte
, end
, end_byte
, Qt
);
5215 coding
->dst_object
= Qnil
;
5216 coding
->dst_pos_byte
= start_byte
;
5217 if (start
>= GPT
|| end
<= GPT
)
5219 coding
->consumed_char
= end
- start
;
5220 coding
->produced
= end_byte
- start_byte
;
5224 coding
->consumed_char
= GPT
- start
;
5225 coding
->produced
= GPT_BYTE
- start_byte
;
5230 if (coding
->produced
> 0)
5233 -= emacs_write (desc
,
5234 STRINGP (coding
->dst_object
)
5235 ? SSDATA (coding
->dst_object
)
5236 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5239 if (coding
->produced
)
5242 start
+= coding
->consumed_char
;
5248 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5249 Sverify_visited_file_modtime
, 0, 1, 0,
5250 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5251 This means that the file has not been changed since it was visited or saved.
5252 If BUF is omitted or nil, it defaults to the current buffer.
5253 See Info node `(elisp)Modification Time' for more details. */)
5258 Lisp_Object handler
;
5259 Lisp_Object filename
;
5270 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5271 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5273 /* If the file name has special constructs in it,
5274 call the corresponding file handler. */
5275 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5276 Qverify_visited_file_modtime
);
5277 if (!NILP (handler
))
5278 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5280 filename
= ENCODE_FILE (BVAR (b
, filename
));
5282 mtime
= (stat (SSDATA (filename
), &st
) == 0
5283 ? get_stat_mtime (&st
)
5284 : time_error_value (errno
));
5285 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5286 && (b
->modtime_size
< 0
5287 || st
.st_size
== b
->modtime_size
))
5292 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5293 Sclear_visited_file_modtime
, 0, 0, 0,
5294 doc
: /* Clear out records of last mod time of visited file.
5295 Next attempt to save will certainly not complain of a discrepancy. */)
5298 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5299 current_buffer
->modtime_size
= -1;
5303 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5304 Svisited_file_modtime
, 0, 0, 0,
5305 doc
: /* Return the current buffer's recorded visited file modification time.
5306 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5307 `file-attributes' returns. If the current buffer has no recorded file
5308 modification time, this function returns 0. If the visited file
5309 doesn't exist, HIGH will be -1.
5310 See Info node `(elisp)Modification Time' for more details. */)
5313 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5315 if (EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
5317 /* make_lisp_time won't work here if time_t is unsigned. */
5318 return list4 (make_number (-1), make_number (65535),
5319 make_number (0), make_number (0));
5321 return make_number (0);
5323 return make_lisp_time (current_buffer
->modtime
);
5326 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5327 Sset_visited_file_modtime
, 0, 1, 0,
5328 doc
: /* Update buffer's recorded modification time from the visited file's time.
5329 Useful if the buffer was not read from the file normally
5330 or if the file itself has been changed for some known benign reason.
5331 An argument specifies the modification time value to use
5332 \(instead of that of the visited file), in the form of a list
5333 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5334 (Lisp_Object time_list
)
5336 if (!NILP (time_list
))
5338 current_buffer
->modtime
= lisp_time_argument (time_list
);
5339 current_buffer
->modtime_size
= -1;
5343 register Lisp_Object filename
;
5345 Lisp_Object handler
;
5347 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5349 /* If the file name has special constructs in it,
5350 call the corresponding file handler. */
5351 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5352 if (!NILP (handler
))
5353 /* The handler can find the file name the same way we did. */
5354 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5356 filename
= ENCODE_FILE (filename
);
5358 if (stat (SSDATA (filename
), &st
) >= 0)
5360 current_buffer
->modtime
= get_stat_mtime (&st
);
5361 current_buffer
->modtime_size
= st
.st_size
;
5369 auto_save_error (Lisp_Object error_val
)
5371 Lisp_Object args
[3], msg
;
5373 struct gcpro gcpro1
;
5377 auto_save_error_occurred
= 1;
5379 ring_bell (XFRAME (selected_frame
));
5381 args
[0] = build_string ("Auto-saving %s: %s");
5382 args
[1] = BVAR (current_buffer
, name
);
5383 args
[2] = Ferror_message_string (error_val
);
5384 msg
= Fformat (3, args
);
5386 nbytes
= SBYTES (msg
);
5387 msgbuf
= SAFE_ALLOCA (nbytes
);
5388 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5390 for (i
= 0; i
< 3; ++i
)
5393 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5395 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5396 Fsleep_for (make_number (1), Qnil
);
5410 auto_save_mode_bits
= 0666;
5412 /* Get visited file's mode to become the auto save file's mode. */
5413 if (! NILP (BVAR (current_buffer
, filename
)))
5415 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5416 /* But make sure we can overwrite it later! */
5417 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5418 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5420 /* Remote files don't cooperate with stat. */
5421 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5425 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5426 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5431 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5434 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5446 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5449 minibuffer_auto_raise
= XINT (value
);
5454 do_auto_save_make_dir (Lisp_Object dir
)
5458 auto_saving_dir_umask
= 077;
5459 result
= call2 (Qmake_directory
, dir
, Qt
);
5460 auto_saving_dir_umask
= 0;
5465 do_auto_save_eh (Lisp_Object ignore
)
5467 auto_saving_dir_umask
= 0;
5471 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5472 doc
: /* Auto-save all buffers that need it.
5473 This is all buffers that have auto-saving enabled
5474 and are changed since last auto-saved.
5475 Auto-saving writes the buffer into a file
5476 so that your editing is not lost if the system crashes.
5477 This file is not the file you visited; that changes only when you save.
5478 Normally we run the normal hook `auto-save-hook' before saving.
5480 A non-nil NO-MESSAGE argument means do not print any message if successful.
5481 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5482 (Lisp_Object no_message
, Lisp_Object current_only
)
5484 struct buffer
*old
= current_buffer
, *b
;
5485 Lisp_Object tail
, buf
, hook
;
5486 bool auto_saved
= 0;
5487 int do_handled_files
;
5489 FILE *stream
= NULL
;
5490 ptrdiff_t count
= SPECPDL_INDEX ();
5491 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5492 bool old_message_p
= 0;
5493 struct gcpro gcpro1
, gcpro2
;
5495 if (max_specpdl_size
< specpdl_size
+ 40)
5496 max_specpdl_size
= specpdl_size
+ 40;
5501 if (NILP (no_message
))
5503 old_message_p
= push_message ();
5504 record_unwind_protect (pop_message_unwind
, Qnil
);
5507 /* Ordinarily don't quit within this function,
5508 but don't make it impossible to quit (in case we get hung in I/O). */
5512 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5513 point to non-strings reached from Vbuffer_alist. */
5515 hook
= intern ("auto-save-hook");
5516 Frun_hooks (1, &hook
);
5518 if (STRINGP (Vauto_save_list_file_name
))
5520 Lisp_Object listfile
;
5522 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5524 /* Don't try to create the directory when shutting down Emacs,
5525 because creating the directory might signal an error, and
5526 that would leave Emacs in a strange state. */
5527 if (!NILP (Vrun_hooks
))
5531 GCPRO2 (dir
, listfile
);
5532 dir
= Ffile_name_directory (listfile
);
5533 if (NILP (Ffile_directory_p (dir
)))
5534 internal_condition_case_1 (do_auto_save_make_dir
,
5540 stream
= fopen (SSDATA (listfile
), "w");
5543 record_unwind_protect (do_auto_save_unwind
,
5544 make_save_value (stream
, 0));
5545 record_unwind_protect (do_auto_save_unwind_1
,
5546 make_number (minibuffer_auto_raise
));
5547 minibuffer_auto_raise
= 0;
5549 auto_save_error_occurred
= 0;
5551 /* On first pass, save all files that don't have handlers.
5552 On second pass, save all files that do have handlers.
5554 If Emacs is crashing, the handlers may tweak what is causing
5555 Emacs to crash in the first place, and it would be a shame if
5556 Emacs failed to autosave perfectly ordinary files because it
5557 couldn't handle some ange-ftp'd file. */
5559 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5560 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5562 buf
= XCDR (XCAR (tail
));
5565 /* Record all the buffers that have auto save mode
5566 in the special file that lists them. For each of these buffers,
5567 Record visited name (if any) and auto save name. */
5568 if (STRINGP (BVAR (b
, auto_save_file_name
))
5569 && stream
!= NULL
&& do_handled_files
== 0)
5572 if (!NILP (BVAR (b
, filename
)))
5574 fwrite (SDATA (BVAR (b
, filename
)), 1,
5575 SBYTES (BVAR (b
, filename
)), stream
);
5577 putc ('\n', stream
);
5578 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5579 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5580 putc ('\n', stream
);
5584 if (!NILP (current_only
)
5585 && b
!= current_buffer
)
5588 /* Don't auto-save indirect buffers.
5589 The base buffer takes care of it. */
5593 /* Check for auto save enabled
5594 and file changed since last auto save
5595 and file changed since last real save. */
5596 if (STRINGP (BVAR (b
, auto_save_file_name
))
5597 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5598 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5599 /* -1 means we've turned off autosaving for a while--see below. */
5600 && XINT (BVAR (b
, save_length
)) >= 0
5601 && (do_handled_files
5602 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5605 EMACS_TIME before_time
= current_emacs_time ();
5606 EMACS_TIME after_time
;
5608 /* If we had a failure, don't try again for 20 minutes. */
5609 if (b
->auto_save_failure_time
> 0
5610 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5613 set_buffer_internal (b
);
5614 if (NILP (Vauto_save_include_big_deletions
)
5615 && (XFASTINT (BVAR (b
, save_length
)) * 10
5616 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5617 /* A short file is likely to change a large fraction;
5618 spare the user annoying messages. */
5619 && XFASTINT (BVAR (b
, save_length
)) > 5000
5620 /* These messages are frequent and annoying for `*mail*'. */
5621 && !EQ (BVAR (b
, filename
), Qnil
)
5622 && NILP (no_message
))
5624 /* It has shrunk too much; turn off auto-saving here. */
5625 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5626 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5628 minibuffer_auto_raise
= 0;
5629 /* Turn off auto-saving until there's a real save,
5630 and prevent any more warnings. */
5631 XSETINT (BVAR (b
, save_length
), -1);
5632 Fsleep_for (make_number (1), Qnil
);
5635 if (!auto_saved
&& NILP (no_message
))
5636 message1 ("Auto-saving...");
5637 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5639 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5640 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5641 set_buffer_internal (old
);
5643 after_time
= current_emacs_time ();
5645 /* If auto-save took more than 60 seconds,
5646 assume it was an NFS failure that got a timeout. */
5647 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5648 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5652 /* Prevent another auto save till enough input events come in. */
5653 record_auto_save ();
5655 if (auto_saved
&& NILP (no_message
))
5659 /* If we are going to restore an old message,
5660 give time to read ours. */
5661 sit_for (make_number (1), 0, 0);
5664 else if (!auto_save_error_occurred
)
5665 /* Don't overwrite the error message if an error occurred.
5666 If we displayed a message and then restored a state
5667 with no message, leave a "done" message on the screen. */
5668 message1 ("Auto-saving...done");
5673 /* This restores the message-stack status. */
5674 unbind_to (count
, Qnil
);
5678 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5679 Sset_buffer_auto_saved
, 0, 0, 0,
5680 doc
: /* Mark current buffer as auto-saved with its current text.
5681 No auto-save file will be written until the buffer changes again. */)
5684 /* FIXME: This should not be called in indirect buffers, since
5685 they're not autosaved. */
5686 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5687 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5688 current_buffer
->auto_save_failure_time
= 0;
5692 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5693 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5694 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5697 current_buffer
->auto_save_failure_time
= 0;
5701 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5703 doc
: /* Return t if current buffer has been auto-saved recently.
5704 More precisely, if it has been auto-saved since last read from or saved
5705 in the visited file. If the buffer has no visited file,
5706 then any auto-save counts as "recent". */)
5709 /* FIXME: maybe we should return nil for indirect buffers since
5710 they're never autosaved. */
5711 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5714 /* Reading and completing file names */
5716 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5717 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5718 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5719 The return value is only relevant for a call to `read-file-name' that happens
5720 before any other event (mouse or keypress) is handled. */)
5723 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5724 || defined (HAVE_NS)
5725 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5735 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5737 struct gcpro gcpro1
;
5738 Lisp_Object args
[7];
5740 GCPRO1 (default_filename
);
5741 args
[0] = intern ("read-file-name");
5744 args
[3] = default_filename
;
5745 args
[4] = mustmatch
;
5747 args
[6] = predicate
;
5748 RETURN_UNGCPRO (Ffuncall (7, args
));
5753 syms_of_fileio (void)
5755 DEFSYM (Qoperations
, "operations");
5756 DEFSYM (Qexpand_file_name
, "expand-file-name");
5757 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5758 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5759 DEFSYM (Qfile_name_directory
, "file-name-directory");
5760 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5761 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5762 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5763 DEFSYM (Qcopy_file
, "copy-file");
5764 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5765 DEFSYM (Qmake_directory
, "make-directory");
5766 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5767 DEFSYM (Qdelete_file
, "delete-file");
5768 DEFSYM (Qrename_file
, "rename-file");
5769 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5770 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5771 DEFSYM (Qfile_exists_p
, "file-exists-p");
5772 DEFSYM (Qfile_executable_p
, "file-executable-p");
5773 DEFSYM (Qfile_readable_p
, "file-readable-p");
5774 DEFSYM (Qfile_writable_p
, "file-writable-p");
5775 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5776 DEFSYM (Qaccess_file
, "access-file");
5777 DEFSYM (Qfile_directory_p
, "file-directory-p");
5778 DEFSYM (Qfile_regular_p
, "file-regular-p");
5779 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5780 DEFSYM (Qfile_modes
, "file-modes");
5781 DEFSYM (Qset_file_modes
, "set-file-modes");
5782 DEFSYM (Qset_file_times
, "set-file-times");
5783 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5784 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5785 DEFSYM (Qfile_acl
, "file-acl");
5786 DEFSYM (Qset_file_acl
, "set-file-acl");
5787 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5788 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5789 DEFSYM (Qwrite_region
, "write-region");
5790 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5791 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5792 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5794 DEFSYM (Qfile_name_history
, "file-name-history");
5795 Fset (Qfile_name_history
, Qnil
);
5797 DEFSYM (Qfile_error
, "file-error");
5798 DEFSYM (Qfile_already_exists
, "file-already-exists");
5799 DEFSYM (Qfile_date_error
, "file-date-error");
5800 DEFSYM (Qexcl
, "excl");
5802 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5803 doc
: /* Coding system for encoding file names.
5804 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5805 Vfile_name_coding_system
= Qnil
;
5807 DEFVAR_LISP ("default-file-name-coding-system",
5808 Vdefault_file_name_coding_system
,
5809 doc
: /* Default coding system for encoding file names.
5810 This variable is used only when `file-name-coding-system' is nil.
5812 This variable is set/changed by the command `set-language-environment'.
5813 User should not set this variable manually,
5814 instead use `file-name-coding-system' to get a constant encoding
5815 of file names regardless of the current language environment. */);
5816 Vdefault_file_name_coding_system
= Qnil
;
5818 DEFSYM (Qformat_decode
, "format-decode");
5819 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5820 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5821 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5823 Fput (Qfile_error
, Qerror_conditions
,
5824 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5825 Fput (Qfile_error
, Qerror_message
,
5826 build_pure_c_string ("File error"));
5828 Fput (Qfile_already_exists
, Qerror_conditions
,
5829 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5830 Fput (Qfile_already_exists
, Qerror_message
,
5831 build_pure_c_string ("File already exists"));
5833 Fput (Qfile_date_error
, Qerror_conditions
,
5834 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5835 Fput (Qfile_date_error
, Qerror_message
,
5836 build_pure_c_string ("Cannot set file date"));
5838 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5839 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5840 If a file name matches REGEXP, all I/O on that file is done by calling
5841 HANDLER. If a file name matches more than one handler, the handler
5842 whose match starts last in the file name gets precedence. The
5843 function `find-file-name-handler' checks this list for a handler for
5846 HANDLER should be a function. The first argument given to it is the
5847 name of the I/O primitive to be handled; the remaining arguments are
5848 the arguments that were passed to that primitive. For example, if you
5849 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5850 HANDLER is called like this:
5852 (funcall HANDLER 'file-exists-p FILENAME)
5854 Note that HANDLER must be able to handle all I/O primitives; if it has
5855 nothing special to do for a primitive, it should reinvoke the
5856 primitive to handle the operation \"the usual way\".
5857 See Info node `(elisp)Magic File Names' for more details. */);
5858 Vfile_name_handler_alist
= Qnil
;
5860 DEFVAR_LISP ("set-auto-coding-function",
5861 Vset_auto_coding_function
,
5862 doc
: /* If non-nil, a function to call to decide a coding system of file.
5863 Two arguments are passed to this function: the file name
5864 and the length of a file contents following the point.
5865 This function should return a coding system to decode the file contents.
5866 It should check the file name against `auto-coding-alist'.
5867 If no coding system is decided, it should check a coding system
5868 specified in the heading lines with the format:
5869 -*- ... coding: CODING-SYSTEM; ... -*-
5870 or local variable spec of the tailing lines with `coding:' tag. */);
5871 Vset_auto_coding_function
= Qnil
;
5873 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5874 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5875 Each is passed one argument, the number of characters inserted,
5876 with point at the start of the inserted text. Each function
5877 should leave point the same, and return the new character count.
5878 If `insert-file-contents' is intercepted by a handler from
5879 `file-name-handler-alist', that handler is responsible for calling the
5880 functions in `after-insert-file-functions' if appropriate. */);
5881 Vafter_insert_file_functions
= Qnil
;
5883 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5884 doc
: /* A list of functions to be called at the start of `write-region'.
5885 Each is passed two arguments, START and END as for `write-region'.
5886 These are usually two numbers but not always; see the documentation
5887 for `write-region'. The function should return a list of pairs
5888 of the form (POSITION . STRING), consisting of strings to be effectively
5889 inserted at the specified positions of the file being written (1 means to
5890 insert before the first byte written). The POSITIONs must be sorted into
5893 If there are several annotation functions, the lists returned by these
5894 functions are merged destructively. As each annotation function runs,
5895 the variable `write-region-annotations-so-far' contains a list of all
5896 annotations returned by previous annotation functions.
5898 An annotation function can return with a different buffer current.
5899 Doing so removes the annotations returned by previous functions, and
5900 resets START and END to `point-min' and `point-max' of the new buffer.
5902 After `write-region' completes, Emacs calls the function stored in
5903 `write-region-post-annotation-function', once for each buffer that was
5904 current when building the annotations (i.e., at least once), with that
5905 buffer current. */);
5906 Vwrite_region_annotate_functions
= Qnil
;
5907 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5909 DEFVAR_LISP ("write-region-post-annotation-function",
5910 Vwrite_region_post_annotation_function
,
5911 doc
: /* Function to call after `write-region' completes.
5912 The function is called with no arguments. If one or more of the
5913 annotation functions in `write-region-annotate-functions' changed the
5914 current buffer, the function stored in this variable is called for
5915 each of those additional buffers as well, in addition to the original
5916 buffer. The relevant buffer is current during each function call. */);
5917 Vwrite_region_post_annotation_function
= Qnil
;
5918 staticpro (&Vwrite_region_annotation_buffers
);
5920 DEFVAR_LISP ("write-region-annotations-so-far",
5921 Vwrite_region_annotations_so_far
,
5922 doc
: /* When an annotation function is called, this holds the previous annotations.
5923 These are the annotations made by other annotation functions
5924 that were already called. See also `write-region-annotate-functions'. */);
5925 Vwrite_region_annotations_so_far
= Qnil
;
5927 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5928 doc
: /* A list of file name handlers that temporarily should not be used.
5929 This applies only to the operation `inhibit-file-name-operation'. */);
5930 Vinhibit_file_name_handlers
= Qnil
;
5932 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5933 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5934 Vinhibit_file_name_operation
= Qnil
;
5936 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5937 doc
: /* File name in which we write a list of all auto save file names.
5938 This variable is initialized automatically from `auto-save-list-file-prefix'
5939 shortly after Emacs reads your init file, if you have not yet given it
5940 a non-nil value. */);
5941 Vauto_save_list_file_name
= Qnil
;
5943 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5944 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5945 Normally auto-save files are written under other names. */);
5946 Vauto_save_visited_file_name
= Qnil
;
5948 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5949 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5950 If nil, deleting a substantial portion of the text disables auto-save
5951 in the buffer; this is the default behavior, because the auto-save
5952 file is usually more useful if it contains the deleted text. */);
5953 Vauto_save_include_big_deletions
= Qnil
;
5956 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5957 doc
: /* Non-nil means don't call fsync in `write-region'.
5958 This variable affects calls to `write-region' as well as save commands.
5959 A non-nil value may result in data loss! */);
5960 write_region_inhibit_fsync
= 0;
5963 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5964 doc
: /* Specifies whether to use the system's trash can.
5965 When non-nil, certain file deletion commands use the function
5966 `move-file-to-trash' instead of deleting files outright.
5967 This includes interactive calls to `delete-file' and
5968 `delete-directory' and the Dired deletion commands. */);
5969 delete_by_moving_to_trash
= 0;
5970 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5972 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5973 DEFSYM (Qcopy_directory
, "copy-directory");
5974 DEFSYM (Qdelete_directory
, "delete-directory");
5976 defsubr (&Sfind_file_name_handler
);
5977 defsubr (&Sfile_name_directory
);
5978 defsubr (&Sfile_name_nondirectory
);
5979 defsubr (&Sunhandled_file_name_directory
);
5980 defsubr (&Sfile_name_as_directory
);
5981 defsubr (&Sdirectory_file_name
);
5982 defsubr (&Smake_temp_name
);
5983 defsubr (&Sexpand_file_name
);
5984 defsubr (&Ssubstitute_in_file_name
);
5985 defsubr (&Scopy_file
);
5986 defsubr (&Smake_directory_internal
);
5987 defsubr (&Sdelete_directory_internal
);
5988 defsubr (&Sdelete_file
);
5989 defsubr (&Srename_file
);
5990 defsubr (&Sadd_name_to_file
);
5991 defsubr (&Smake_symbolic_link
);
5992 defsubr (&Sfile_name_absolute_p
);
5993 defsubr (&Sfile_exists_p
);
5994 defsubr (&Sfile_executable_p
);
5995 defsubr (&Sfile_readable_p
);
5996 defsubr (&Sfile_writable_p
);
5997 defsubr (&Saccess_file
);
5998 defsubr (&Sfile_symlink_p
);
5999 defsubr (&Sfile_directory_p
);
6000 defsubr (&Sfile_accessible_directory_p
);
6001 defsubr (&Sfile_regular_p
);
6002 defsubr (&Sfile_modes
);
6003 defsubr (&Sset_file_modes
);
6004 defsubr (&Sset_file_times
);
6005 defsubr (&Sfile_selinux_context
);
6006 defsubr (&Sfile_acl
);
6007 defsubr (&Sset_file_acl
);
6008 defsubr (&Sset_file_selinux_context
);
6009 defsubr (&Sset_default_file_modes
);
6010 defsubr (&Sdefault_file_modes
);
6011 defsubr (&Sfile_newer_than_file_p
);
6012 defsubr (&Sinsert_file_contents
);
6013 defsubr (&Swrite_region
);
6014 defsubr (&Scar_less_than_car
);
6015 defsubr (&Sverify_visited_file_modtime
);
6016 defsubr (&Sclear_visited_file_modtime
);
6017 defsubr (&Svisited_file_modtime
);
6018 defsubr (&Sset_visited_file_modtime
);
6019 defsubr (&Sdo_auto_save
);
6020 defsubr (&Sset_buffer_auto_saved
);
6021 defsubr (&Sclear_buffer_auto_save_failure
);
6022 defsubr (&Srecent_auto_save_p
);
6024 defsubr (&Snext_read_file_uses_dialog_p
);
6027 defsubr (&Sunix_sync
);