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>
42 #include "intervals.h"
43 #include "character.h"
47 #include "blockinput.h"
49 #include "dispextern.h"
57 #endif /* not WINDOWSNT */
61 #include <sys/param.h>
66 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
67 redirector allows the six letters between 'Z' and 'a' as well. */
69 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
72 #define IS_DRIVE(x) c_isalpha (x)
74 /* Need to lower-case the drive letter, or else expanded
75 filenames will sometimes compare unequal, because
76 `expand-file-name' doesn't always down-case the drive letter. */
77 #define DRIVE_LETTER(x) c_tolower (x)
81 #include <stat-time.h>
89 /* True during writing of auto-save files. */
90 static bool auto_saving
;
92 /* Nonzero umask during creation of auto-save directories. */
93 static mode_t auto_saving_dir_umask
;
95 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
96 a new file with the same mode as the original. */
97 static mode_t auto_save_mode_bits
;
99 /* Set by auto_save_1 if an error occurred during the last auto-save. */
100 static bool auto_save_error_occurred
;
102 /* The symbol bound to coding-system-for-read when
103 insert-file-contents is called for recovering a file. This is not
104 an actual coding system name, but just an indicator to tell
105 insert-file-contents to use `emacs-mule' with a special flag for
106 auto saving and recovering a file. */
107 static Lisp_Object Qauto_save_coding
;
109 /* Property name of a file name handler,
110 which gives a list of operations it handles.. */
111 static Lisp_Object Qoperations
;
113 /* Lisp functions for translating file formats. */
114 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
116 /* Lisp function for setting buffer-file-coding-system and the
117 multibyteness of the current buffer after inserting a file. */
118 static Lisp_Object Qafter_insert_file_set_coding
;
120 static Lisp_Object Qwrite_region_annotate_functions
;
121 /* Each time an annotation function changes the buffer, the new buffer
123 static Lisp_Object Vwrite_region_annotation_buffers
;
128 static Lisp_Object Qdelete_by_moving_to_trash
;
130 /* Lisp function for moving files to trash. */
131 static Lisp_Object Qmove_file_to_trash
;
133 /* Lisp function for recursively copying directories. */
134 static Lisp_Object Qcopy_directory
;
136 /* Lisp function for recursively deleting directories. */
137 static Lisp_Object Qdelete_directory
;
142 Lisp_Object Qfile_error
;
143 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
144 static Lisp_Object Qexcl
;
145 Lisp_Object Qfile_name_history
;
147 static Lisp_Object Qcar_less_than_car
;
149 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
150 Lisp_Object
*, struct coding_system
*);
151 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
152 struct coding_system
*);
156 report_file_error (const char *string
, Lisp_Object data
)
158 Lisp_Object errstring
;
162 synchronize_system_messages_locale ();
163 str
= strerror (errorno
);
164 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
165 Vlocale_coding_system
, 0);
171 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
174 /* System error messages are capitalized. Downcase the initial
175 unless it is followed by a slash. (The slash case caters to
176 error messages that begin with "I/O" or, in German, "E/A".) */
177 if (STRING_MULTIBYTE (errstring
)
178 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
182 str
= SSDATA (errstring
);
183 c
= STRING_CHAR ((unsigned char *) str
);
184 Faset (errstring
, make_number (0), make_number (downcase (c
)));
187 xsignal (Qfile_error
,
188 Fcons (build_string (string
), Fcons (errstring
, data
)));
193 close_file_unwind (Lisp_Object fd
)
195 emacs_close (XFASTINT (fd
));
199 /* Restore point, having saved it as a marker. */
202 restore_point_unwind (Lisp_Object location
)
204 Fgoto_char (location
);
205 Fset_marker (location
, Qnil
, Qnil
);
210 static Lisp_Object Qexpand_file_name
;
211 static Lisp_Object Qsubstitute_in_file_name
;
212 static Lisp_Object Qdirectory_file_name
;
213 static Lisp_Object Qfile_name_directory
;
214 static Lisp_Object Qfile_name_nondirectory
;
215 static Lisp_Object Qunhandled_file_name_directory
;
216 static Lisp_Object Qfile_name_as_directory
;
217 static Lisp_Object Qcopy_file
;
218 static Lisp_Object Qmake_directory_internal
;
219 static Lisp_Object Qmake_directory
;
220 static Lisp_Object Qdelete_directory_internal
;
221 Lisp_Object Qdelete_file
;
222 static Lisp_Object Qrename_file
;
223 static Lisp_Object Qadd_name_to_file
;
224 static Lisp_Object Qmake_symbolic_link
;
225 Lisp_Object Qfile_exists_p
;
226 static Lisp_Object Qfile_executable_p
;
227 static Lisp_Object Qfile_readable_p
;
228 static Lisp_Object Qfile_writable_p
;
229 static Lisp_Object Qfile_symlink_p
;
230 static Lisp_Object Qaccess_file
;
231 Lisp_Object Qfile_directory_p
;
232 static Lisp_Object Qfile_regular_p
;
233 static Lisp_Object Qfile_accessible_directory_p
;
234 static Lisp_Object Qfile_modes
;
235 static Lisp_Object Qset_file_modes
;
236 static Lisp_Object Qset_file_times
;
237 static Lisp_Object Qfile_selinux_context
;
238 static Lisp_Object Qset_file_selinux_context
;
239 static Lisp_Object Qfile_newer_than_file_p
;
240 Lisp_Object Qinsert_file_contents
;
241 Lisp_Object Qwrite_region
;
242 static Lisp_Object Qverify_visited_file_modtime
;
243 static Lisp_Object Qset_visited_file_modtime
;
245 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
246 Sfind_file_name_handler
, 2, 2, 0,
247 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
248 Otherwise, return nil.
249 A file name is handled if one of the regular expressions in
250 `file-name-handler-alist' matches it.
252 If OPERATION equals `inhibit-file-name-operation', then we ignore
253 any handlers that are members of `inhibit-file-name-handlers',
254 but we still do run any other handlers. This lets handlers
255 use the standard functions without calling themselves recursively. */)
256 (Lisp_Object filename
, Lisp_Object operation
)
258 /* This function must not munge the match data. */
259 Lisp_Object chain
, inhibited_handlers
, result
;
263 CHECK_STRING (filename
);
265 if (EQ (operation
, Vinhibit_file_name_operation
))
266 inhibited_handlers
= Vinhibit_file_name_handlers
;
268 inhibited_handlers
= Qnil
;
270 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
271 chain
= XCDR (chain
))
277 Lisp_Object string
= XCAR (elt
);
279 Lisp_Object handler
= XCDR (elt
);
280 Lisp_Object operations
= Qnil
;
282 if (SYMBOLP (handler
))
283 operations
= Fget (handler
, Qoperations
);
286 && (match_pos
= fast_string_match (string
, filename
)) > pos
287 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
291 handler
= XCDR (elt
);
292 tem
= Fmemq (handler
, inhibited_handlers
);
306 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
308 doc
: /* Return the directory component in file name FILENAME.
309 Return nil if FILENAME does not include a directory.
310 Otherwise return a directory name.
311 Given a Unix syntax file name, returns a string ending in slash. */)
312 (Lisp_Object filename
)
315 register const char *beg
;
320 register const char *p
;
323 CHECK_STRING (filename
);
325 /* If the file name has special constructs in it,
326 call the corresponding file handler. */
327 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
330 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
332 return STRINGP (handled_name
) ? handled_name
: Qnil
;
336 beg
= alloca (SBYTES (filename
) + 1);
337 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
339 beg
= SSDATA (filename
);
341 p
= beg
+ SBYTES (filename
);
343 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
345 /* only recognize drive specifier at the beginning */
347 /* handle the "/:d:foo" and "/:foo" cases correctly */
348 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
349 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
356 /* Expansion of "c:" to drive and default directory. */
359 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
360 char *res
= alloca (MAXPATHLEN
+ 1);
363 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
365 memcpy (res
, beg
, 2);
370 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
372 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
375 p
= beg
+ strlen (beg
);
378 tem_fn
= ENCODE_FILE (make_specified_string (beg
, -1, p
- beg
,
379 STRING_MULTIBYTE (filename
)));
380 dostounix_filename (SSDATA (tem_fn
));
381 return DECODE_FILE (tem_fn
);
383 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
387 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
388 Sfile_name_nondirectory
, 1, 1, 0,
389 doc
: /* Return file name FILENAME sans its directory.
390 For example, in a Unix-syntax file name,
391 this is everything after the last slash,
392 or the entire name if it contains no slash. */)
393 (Lisp_Object filename
)
395 register const char *beg
, *p
, *end
;
398 CHECK_STRING (filename
);
400 /* If the file name has special constructs in it,
401 call the corresponding file handler. */
402 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
405 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
407 if (STRINGP (handled_name
))
409 error ("Invalid handler in `file-name-handler-alist'");
412 beg
= SSDATA (filename
);
413 end
= p
= beg
+ SBYTES (filename
);
415 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
417 /* only recognize drive specifier at beginning */
419 /* handle the "/:d:foo" case correctly */
420 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
425 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
428 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
429 Sunhandled_file_name_directory
, 1, 1, 0,
430 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
431 A `directly usable' directory name is one that may be used without the
432 intervention of any file handler.
433 If FILENAME is a directly usable file itself, return
434 \(file-name-directory FILENAME).
435 If FILENAME refers to a file which is not accessible from a local process,
436 then this should return nil.
437 The `call-process' and `start-process' functions use this function to
438 get a current directory to run processes in. */)
439 (Lisp_Object filename
)
443 /* If the file name has special constructs in it,
444 call the corresponding file handler. */
445 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
448 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
450 return STRINGP (handled_name
) ? handled_name
: Qnil
;
453 return Ffile_name_directory (filename
);
456 /* Convert from file name SRC of length SRCLEN to directory name
457 in DST. On UNIX, just make sure there is a terminating /.
458 Return the length of DST in bytes. */
461 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
)
473 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
475 dst
[srclen
] = DIRECTORY_SEP
;
476 dst
[srclen
+ 1] = '\0';
481 Lisp_Object tem_fn
= make_specified_string (dst
, -1, srclen
, 1);
483 tem_fn
= ENCODE_FILE (tem_fn
);
484 dostounix_filename (SSDATA (tem_fn
));
485 tem_fn
= DECODE_FILE (tem_fn
);
486 memcpy (dst
, SSDATA (tem_fn
), (srclen
= SBYTES (tem_fn
)) + 1);
492 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
493 Sfile_name_as_directory
, 1, 1, 0,
494 doc
: /* Return a string representing the file name FILE interpreted as a directory.
495 This operation exists because a directory is also a file, but its name as
496 a directory is different from its name as a file.
497 The result can be used as the value of `default-directory'
498 or passed as second argument to `expand-file-name'.
499 For a Unix-syntax file name, just appends a slash. */)
510 /* If the file name has special constructs in it,
511 call the corresponding file handler. */
512 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
515 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
517 if (STRINGP (handled_name
))
519 error ("Invalid handler in `file-name-handler-alist'");
522 buf
= alloca (SBYTES (file
) + 10);
523 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
));
524 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
527 /* Convert from directory name SRC of length SRCLEN to
528 file name in DST. On UNIX, just make sure there isn't
529 a terminating /. Return the length of DST in bytes. */
532 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
)
534 /* Process as Unix format: just remove any final slash.
535 But leave "/" unchanged; do not change it to "". */
538 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
540 && !IS_ANY_SEP (dst
[srclen
- 2])
549 Lisp_Object tem_fn
= make_specified_string (dst
, -1, srclen
, 1);
551 tem_fn
= ENCODE_FILE (tem_fn
);
552 dostounix_filename (SSDATA (tem_fn
));
553 tem_fn
= DECODE_FILE (tem_fn
);
554 memcpy (dst
, SSDATA (tem_fn
), (srclen
= SBYTES (tem_fn
)) + 1);
560 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
562 doc
: /* Returns the file name of the directory named DIRECTORY.
563 This is the name of the file that holds the data for the directory DIRECTORY.
564 This operation exists because a directory is also a file, but its name as
565 a directory is different from its name as a file.
566 In Unix-syntax, this function just removes the final slash. */)
567 (Lisp_Object directory
)
573 CHECK_STRING (directory
);
575 if (NILP (directory
))
578 /* If the file name has special constructs in it,
579 call the corresponding file handler. */
580 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
583 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
585 if (STRINGP (handled_name
))
587 error ("Invalid handler in `file-name-handler-alist'");
590 buf
= alloca (SBYTES (directory
) + 20);
591 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
));
592 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
595 static const char make_temp_name_tbl
[64] =
597 'A','B','C','D','E','F','G','H',
598 'I','J','K','L','M','N','O','P',
599 'Q','R','S','T','U','V','W','X',
600 'Y','Z','a','b','c','d','e','f',
601 'g','h','i','j','k','l','m','n',
602 'o','p','q','r','s','t','u','v',
603 'w','x','y','z','0','1','2','3',
604 '4','5','6','7','8','9','-','_'
607 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
609 /* Value is a temporary file name starting with PREFIX, a string.
611 The Emacs process number forms part of the result, so there is
612 no danger of generating a name being used by another process.
613 In addition, this function makes an attempt to choose a name
614 which has no existing file. To make this work, PREFIX should be
615 an absolute file name.
617 BASE64_P means add the pid as 3 characters in base64
618 encoding. In this case, 6 characters will be added to PREFIX to
619 form the file name. Otherwise, if Emacs is running on a system
620 with long file names, add the pid as a decimal number.
622 This function signals an error if no unique file name could be
626 make_temp_name (Lisp_Object prefix
, bool base64_p
)
632 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
635 CHECK_STRING (prefix
);
637 /* VAL is created by adding 6 characters to PREFIX. The first
638 three are the PID of this process, in base 64, and the second
639 three are incremented if the file already exists. This ensures
640 262144 unique file names per PID per PREFIX. */
646 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
647 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
648 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
653 #ifdef HAVE_LONG_FILE_NAMES
654 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
656 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
657 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
658 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
663 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
664 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
665 if (!STRING_MULTIBYTE (prefix
))
666 STRING_SET_UNIBYTE (val
);
668 memcpy (data
, SSDATA (prefix
), len
);
671 memcpy (p
, pidbuf
, pidlen
);
674 /* Here we try to minimize useless stat'ing when this function is
675 invoked many times successively with the same PREFIX. We achieve
676 this by initializing count to a random value, and incrementing it
679 We don't want make-temp-name to be called while dumping,
680 because then make_temp_name_count_initialized_p would get set
681 and then make_temp_name_count would not be set when Emacs starts. */
683 if (!make_temp_name_count_initialized_p
)
685 make_temp_name_count
= time (NULL
);
686 make_temp_name_count_initialized_p
= 1;
691 unsigned num
= make_temp_name_count
;
693 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
694 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
695 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
697 /* Poor man's congruential RN generator. Replace with
698 ++make_temp_name_count for debugging. */
699 make_temp_name_count
+= 25229;
700 make_temp_name_count
%= 225307;
702 if (!check_existing (data
))
704 /* We want to return only if errno is ENOENT. */
708 /* The error here is dubious, but there is little else we
709 can do. The alternatives are to return nil, which is
710 as bad as (and in many cases worse than) throwing the
711 error, or to ignore the error, which will likely result
712 in looping through 225307 stat's, which is not only
713 dog-slow, but also useless since eventually nil would
714 have to be returned anyway. */
715 report_file_error ("Cannot create temporary name for prefix",
716 Fcons (prefix
, Qnil
));
723 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
724 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
725 The Emacs process number forms part of the result,
726 so there is no danger of generating a name being used by another process.
728 In addition, this function makes an attempt to choose a name
729 which has no existing file. To make this work,
730 PREFIX should be an absolute file name.
732 There is a race condition between calling `make-temp-name' and creating the
733 file which opens all kinds of security holes. For that reason, you should
734 probably use `make-temp-file' instead, except in three circumstances:
736 * If you are creating the file in the user's home directory.
737 * If you are creating a directory rather than an ordinary file.
738 * If you are taking special precautions as `make-temp-file' does. */)
741 return make_temp_name (prefix
, 0);
746 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
747 doc
: /* Convert filename NAME to absolute, and canonicalize it.
748 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
749 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
750 the current buffer's value of `default-directory' is used.
751 NAME should be a string that is a valid file name for the underlying
753 File name components that are `.' are removed, and
754 so are file name components followed by `..', along with the `..' itself;
755 note that these simplifications are done without checking the resulting
756 file names in the file system.
757 Multiple consecutive slashes are collapsed into a single slash,
758 except at the beginning of the file name when they are significant (e.g.,
759 UNC file names on MS-Windows.)
760 An initial `~/' expands to your home directory.
761 An initial `~USER/' expands to USER's home directory.
762 See also the function `substitute-in-file-name'.
764 For technical reasons, this function can return correct but
765 non-intuitive results for the root directory; for instance,
766 \(expand-file-name ".." "/") returns "/..". For this reason, use
767 \(directory-file-name (file-name-directory dirname)) to traverse a
768 filesystem tree, not (expand-file-name ".." dirname). */)
769 (Lisp_Object name
, Lisp_Object default_directory
)
771 /* These point to SDATA and need to be careful with string-relocation
772 during GC (via DECODE_FILE). */
775 /* This should only point to alloca'd data. */
782 bool collapse_newdir
= 1;
786 Lisp_Object handler
, result
, handled_name
;
792 /* If the file name has special constructs in it,
793 call the corresponding file handler. */
794 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
797 handled_name
= call3 (handler
, Qexpand_file_name
,
798 name
, default_directory
);
799 if (STRINGP (handled_name
))
801 error ("Invalid handler in `file-name-handler-alist'");
805 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
806 if (NILP (default_directory
))
807 default_directory
= BVAR (current_buffer
, directory
);
808 if (! STRINGP (default_directory
))
811 /* "/" is not considered a root directory on DOS_NT, so using "/"
812 here causes an infinite recursion in, e.g., the following:
814 (let (default-directory)
815 (expand-file-name "a"))
817 To avoid this, we set default_directory to the root of the
819 default_directory
= build_string (emacs_root_dir ());
821 default_directory
= build_string ("/");
825 if (!NILP (default_directory
))
827 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
830 handled_name
= call3 (handler
, Qexpand_file_name
,
831 name
, default_directory
);
832 if (STRINGP (handled_name
))
834 error ("Invalid handler in `file-name-handler-alist'");
839 char *o
= SSDATA (default_directory
);
841 /* Make sure DEFAULT_DIRECTORY is properly expanded.
842 It would be better to do this down below where we actually use
843 default_directory. Unfortunately, calling Fexpand_file_name recursively
844 could invoke GC, and the strings might be relocated. This would
845 be annoying because we have pointers into strings lying around
846 that would need adjusting, and people would add new pointers to
847 the code and forget to adjust them, resulting in intermittent bugs.
848 Putting this call here avoids all that crud.
850 The EQ test avoids infinite recursion. */
851 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
852 /* Save time in some common cases - as long as default_directory
853 is not relative, it can be canonicalized with name below (if it
854 is needed at all) without requiring it to be expanded now. */
856 /* Detect MSDOS file names with drive specifiers. */
857 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
858 && IS_DIRECTORY_SEP (o
[2]))
860 /* Detect Windows file names in UNC format. */
861 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
863 #else /* not DOS_NT */
864 /* Detect Unix absolute file names (/... alone is not absolute on
866 && ! (IS_DIRECTORY_SEP (o
[0]))
867 #endif /* not DOS_NT */
873 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
877 multibyte
= STRING_MULTIBYTE (name
);
878 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
881 default_directory
= string_to_multibyte (default_directory
);
884 name
= string_to_multibyte (name
);
889 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
890 nm
= alloca (SBYTES (name
) + 1);
891 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
894 /* Note if special escape prefix is present, but remove for now. */
895 if (nm
[0] == '/' && nm
[1] == ':')
901 /* Find and remove drive specifier if present; this makes nm absolute
902 even if the rest of the name appears to be relative. Only look for
903 drive specifier at the beginning. */
904 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
906 drive
= (unsigned char) nm
[0];
911 /* If we see "c://somedir", we want to strip the first slash after the
912 colon when stripping the drive letter. Otherwise, this expands to
914 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
917 /* Discard any previous drive specifier if nm is now in UNC format. */
918 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
922 #endif /* WINDOWSNT */
925 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
926 none are found, we can probably return right away. We will avoid
927 allocating a new string if name is already fully expanded. */
929 IS_DIRECTORY_SEP (nm
[0])
931 && drive
&& !is_escaped
934 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
938 /* If it turns out that the filename we want to return is just a
939 suffix of FILENAME, we don't need to go through and edit
940 things; we just need to construct a new string using data
941 starting at the middle of FILENAME. If we set LOSE, that
942 means we've discovered that we can't do that cool trick. */
948 /* Since we know the name is absolute, we can assume that each
949 element starts with a "/". */
951 /* "." and ".." are hairy. */
952 if (IS_DIRECTORY_SEP (p
[0])
954 && (IS_DIRECTORY_SEP (p
[2])
956 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
959 /* We want to replace multiple `/' in a row with a single
962 && IS_DIRECTORY_SEP (p
[0])
963 && IS_DIRECTORY_SEP (p
[1]))
970 /* Make sure directories are all separated with /, but
971 avoid allocation of a new string when not required. */
974 Lisp_Object tem_name
= make_specified_string (nm
, -1, strlen (nm
),
977 tem_name
= ENCODE_FILE (tem_name
);
978 dostounix_filename (SSDATA (tem_name
));
979 tem_name
= DECODE_FILE (tem_name
);
980 memcpy (nm
, SSDATA (tem_name
), SBYTES (tem_name
) + 1);
983 dostounix_filename (nm
);
985 if (IS_DIRECTORY_SEP (nm
[1]))
987 if (strcmp (nm
, SSDATA (name
)) != 0)
988 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
992 /* Drive must be set, so this is okay. */
993 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
997 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
998 temp
[0] = DRIVE_LETTER (drive
);
999 name
= concat2 (build_string (temp
), name
);
1002 #else /* not DOS_NT */
1003 if (strcmp (nm
, SSDATA (name
)) == 0)
1005 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1006 #endif /* not DOS_NT */
1010 /* At this point, nm might or might not be an absolute file name. We
1011 need to expand ~ or ~user if present, otherwise prefix nm with
1012 default_directory if nm is not absolute, and finally collapse /./
1013 and /foo/../ sequences.
1015 We set newdir to be the appropriate prefix if one is needed:
1016 - the relevant user directory if nm starts with ~ or ~user
1017 - the specified drive's working dir (DOS/NT only) if nm does not
1019 - the value of default_directory.
1021 Note that these prefixes are not guaranteed to be absolute (except
1022 for the working dir of a drive). Therefore, to ensure we always
1023 return an absolute name, if the final prefix is not absolute we
1024 append it to the current working directory. */
1028 if (nm
[0] == '~') /* prefix ~ */
1030 if (IS_DIRECTORY_SEP (nm
[1])
1031 || nm
[1] == 0) /* ~ by itself */
1035 if (!(newdir
= egetenv ("HOME")))
1038 /* `egetenv' may return a unibyte string, which will bite us since
1039 we expect the directory to be multibyte. */
1040 tem
= build_string (newdir
);
1041 if (!STRING_MULTIBYTE (tem
))
1043 hdir
= DECODE_FILE (tem
);
1044 newdir
= SSDATA (hdir
);
1047 collapse_newdir
= 0;
1050 else /* ~user/filename */
1053 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1054 o
= alloca (p
- nm
+ 1);
1055 memcpy (o
, nm
, p
- nm
);
1059 pw
= getpwnam (o
+ 1);
1063 newdir
= pw
->pw_dir
;
1066 collapse_newdir
= 0;
1070 /* If we don't find a user of that name, leave the name
1071 unchanged; don't move nm forward to p. */
1076 /* On DOS and Windows, nm is absolute if a drive name was specified;
1077 use the drive's current directory as the prefix if needed. */
1078 if (!newdir
&& drive
)
1080 /* Get default directory if needed to make nm absolute. */
1082 if (!IS_DIRECTORY_SEP (nm
[0]))
1084 adir
= alloca (MAXPATHLEN
+ 1);
1085 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1090 /* Either nm starts with /, or drive isn't mounted. */
1092 adir
[0] = DRIVE_LETTER (drive
);
1101 /* Finally, if no prefix has been specified and nm is not absolute,
1102 then it must be expanded relative to default_directory. */
1106 /* /... alone is not absolute on DOS and Windows. */
1107 && !IS_DIRECTORY_SEP (nm
[0])
1110 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1114 newdir
= SSDATA (default_directory
);
1116 /* Note if special escape prefix is present, but remove for now. */
1117 if (newdir
[0] == '/' && newdir
[1] == ':')
1128 /* First ensure newdir is an absolute name. */
1130 /* Detect MSDOS file names with drive specifiers. */
1131 ! (IS_DRIVE (newdir
[0])
1132 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1134 /* Detect Windows file names in UNC format. */
1135 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1139 /* Effectively, let newdir be (expand-file-name newdir cwd).
1140 Because of the admonition against calling expand-file-name
1141 when we have pointers into lisp strings, we accomplish this
1142 indirectly by prepending newdir to nm if necessary, and using
1143 cwd (or the wd of newdir's drive) as the new newdir. */
1145 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1147 drive
= (unsigned char) newdir
[0];
1150 if (!IS_DIRECTORY_SEP (nm
[0]))
1152 ptrdiff_t newlen
= strlen (newdir
);
1153 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1154 file_name_as_directory (tmp
, newdir
, newlen
);
1158 adir
= alloca (MAXPATHLEN
+ 1);
1161 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1165 getcwd (adir
, MAXPATHLEN
+ 1);
1169 /* Strip off drive name from prefix, if present. */
1170 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1176 /* Keep only a prefix from newdir if nm starts with slash
1177 (//server/share for UNC, nothing otherwise). */
1178 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1181 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1183 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1185 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1187 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1200 /* Get rid of any slash at the end of newdir, unless newdir is
1201 just / or // (an incomplete UNC name). */
1202 length
= strlen (newdir
);
1204 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1206 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1210 char *temp
= alloca (length
);
1211 memcpy (temp
, newdir
, length
- 1);
1212 temp
[length
- 1] = 0;
1223 /* Now concatenate the directory and name to new space in the stack frame. */
1224 tlen
+= strlen (nm
) + 1;
1226 /* Reserve space for drive specifier and escape prefix, since either
1227 or both may need to be inserted. (The Microsoft x86 compiler
1228 produces incorrect code if the following two lines are combined.) */
1229 target
= alloca (tlen
+ 4);
1231 #else /* not DOS_NT */
1232 target
= alloca (tlen
);
1233 #endif /* not DOS_NT */
1238 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1241 /* If newdir is effectively "C:/", then the drive letter will have
1242 been stripped and newdir will be "/". Concatenating with an
1243 absolute directory in nm produces "//", which will then be
1244 incorrectly treated as a network share. Ignore newdir in
1245 this case (keeping the drive letter). */
1246 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1247 && newdir
[1] == '\0'))
1249 strcpy (target
, newdir
);
1252 file_name_as_directory (target
, newdir
, length
);
1255 strcat (target
, nm
);
1257 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1265 if (!IS_DIRECTORY_SEP (*p
))
1269 else if (p
[1] == '.'
1270 && (IS_DIRECTORY_SEP (p
[2])
1273 /* If "/." is the entire filename, keep the "/". Otherwise,
1274 just delete the whole "/.". */
1275 if (o
== target
&& p
[2] == '\0')
1279 else if (p
[1] == '.' && p
[2] == '.'
1280 /* `/../' is the "superroot" on certain file systems.
1281 Turned off on DOS_NT systems because they have no
1282 "superroot" and because this causes us to produce
1283 file names like "d:/../foo" which fail file-related
1284 functions of the underlying OS. (To reproduce, try a
1285 long series of "../../" in default_directory, longer
1286 than the number of levels from the root.) */
1290 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1295 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1298 /* Don't go below server level in UNC filenames. */
1299 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1300 && IS_DIRECTORY_SEP (*target
))
1304 /* Keep initial / only if this is the whole name. */
1305 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1309 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1310 /* Collapse multiple `/' in a row. */
1319 /* At last, set drive name. */
1321 /* Except for network file name. */
1322 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1323 #endif /* WINDOWSNT */
1325 if (!drive
) emacs_abort ();
1327 target
[0] = DRIVE_LETTER (drive
);
1330 /* Reinsert the escape prefix if required. */
1337 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1338 result
= ENCODE_FILE (result
);
1339 dostounix_filename (SSDATA (result
));
1340 result
= DECODE_FILE (result
);
1342 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1343 #endif /* !DOS_NT */
1346 /* Again look to see if the file name has special constructs in it
1347 and perhaps call the corresponding file handler. This is needed
1348 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1349 the ".." component gives us "/user@host:/bar/../baz" which needs
1350 to be expanded again. */
1351 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1352 if (!NILP (handler
))
1354 handled_name
= call3 (handler
, Qexpand_file_name
,
1355 result
, default_directory
);
1356 if (STRINGP (handled_name
))
1357 return handled_name
;
1358 error ("Invalid handler in `file-name-handler-alist'");
1365 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1366 This is the old version of expand-file-name, before it was thoroughly
1367 rewritten for Emacs 10.31. We leave this version here commented-out,
1368 because the code is very complex and likely to have subtle bugs. If
1369 bugs _are_ found, it might be of interest to look at the old code and
1370 see what did it do in the relevant situation.
1372 Don't remove this code: it's true that it will be accessible
1373 from the repository, but a few years from deletion, people will
1374 forget it is there. */
1376 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1377 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1378 "Convert FILENAME to absolute, and canonicalize it.\n\
1379 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1380 \(does not start with slash); if DEFAULT is nil or missing,\n\
1381 the current buffer's value of default-directory is used.\n\
1382 Filenames containing `.' or `..' as components are simplified;\n\
1383 initial `~/' expands to your home directory.\n\
1384 See also the function `substitute-in-file-name'.")
1386 Lisp_Object name
, defalt
;
1390 register unsigned char *newdir
, *p
, *o
;
1392 unsigned char *target
;
1395 CHECK_STRING (name
);
1398 /* If nm is absolute, flush ...// and detect /./ and /../.
1399 If no /./ or /../ we can return right away. */
1406 if (p
[0] == '/' && p
[1] == '/')
1408 if (p
[0] == '/' && p
[1] == '~')
1409 nm
= p
+ 1, lose
= 1;
1410 if (p
[0] == '/' && p
[1] == '.'
1411 && (p
[2] == '/' || p
[2] == 0
1412 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1418 if (nm
== SDATA (name
))
1420 return build_string (nm
);
1424 /* Now determine directory to start with and put it in NEWDIR. */
1428 if (nm
[0] == '~') /* prefix ~ */
1429 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1431 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1432 newdir
= (unsigned char *) "";
1435 else /* ~user/filename */
1437 /* Get past ~ to user. */
1438 unsigned char *user
= nm
+ 1;
1439 /* Find end of name. */
1440 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1441 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1442 /* Copy the user name into temp storage. */
1443 o
= alloca (len
+ 1);
1444 memcpy (o
, user
, len
);
1447 /* Look up the user name. */
1449 pw
= (struct passwd
*) getpwnam (o
+ 1);
1452 error ("\"%s\" isn't a registered user", o
+ 1);
1454 newdir
= (unsigned char *) pw
->pw_dir
;
1456 /* Discard the user name from NM. */
1460 if (nm
[0] != '/' && !newdir
)
1463 defalt
= current_buffer
->directory
;
1464 CHECK_STRING (defalt
);
1465 newdir
= SDATA (defalt
);
1468 /* Now concatenate the directory and name to new space in the stack frame. */
1470 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1471 target
= alloca (tlen
);
1476 if (nm
[0] == 0 || nm
[0] == '/')
1477 strcpy (target
, newdir
);
1479 file_name_as_directory (target
, newdir
);
1482 strcat (target
, nm
);
1484 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1495 else if (!strncmp (p
, "//", 2)
1501 else if (p
[0] == '/' && p
[1] == '.'
1502 && (p
[2] == '/' || p
[2] == 0))
1504 else if (!strncmp (p
, "/..", 3)
1505 /* `/../' is the "superroot" on certain file systems. */
1507 && (p
[3] == '/' || p
[3] == 0))
1509 while (o
!= target
&& *--o
!= '/')
1511 if (o
== target
&& *o
== '/')
1521 return make_string (target
, o
- target
);
1525 /* If /~ or // appears, discard everything through first slash. */
1527 file_name_absolute_p (const char *filename
)
1530 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1532 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1533 && IS_DIRECTORY_SEP (filename
[2]))
1539 search_embedded_absfilename (char *nm
, char *endp
)
1543 for (p
= nm
+ 1; p
< endp
; p
++)
1545 if (IS_DIRECTORY_SEP (p
[-1])
1546 && file_name_absolute_p (p
)
1547 #if defined (WINDOWSNT) || defined (CYGWIN)
1548 /* // at start of file name is meaningful in Apollo,
1549 WindowsNT and Cygwin systems. */
1550 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1551 #endif /* not (WINDOWSNT || CYGWIN) */
1554 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1555 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1557 char *o
= alloca (s
- p
+ 1);
1559 memcpy (o
, p
, s
- p
);
1562 /* If we have ~user and `user' exists, discard
1563 everything up to ~. But if `user' does not exist, leave
1564 ~user alone, it might be a literal file name. */
1566 pw
= getpwnam (o
+ 1);
1578 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1579 Ssubstitute_in_file_name
, 1, 1, 0,
1580 doc
: /* Substitute environment variables referred to in FILENAME.
1581 `$FOO' where FOO is an environment variable name means to substitute
1582 the value of that variable. The variable name should be terminated
1583 with a character not a letter, digit or underscore; otherwise, enclose
1584 the entire variable name in braces.
1586 If `/~' appears, all of FILENAME through that `/' is discarded.
1587 If `//' appears, everything up to and including the first of
1588 those `/' is discarded. */)
1589 (Lisp_Object filename
)
1591 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1592 char *target
= NULL
;
1593 ptrdiff_t total
= 0;
1594 bool substituted
= 0;
1597 Lisp_Object handler
;
1599 CHECK_STRING (filename
);
1601 multibyte
= STRING_MULTIBYTE (filename
);
1603 /* If the file name has special constructs in it,
1604 call the corresponding file handler. */
1605 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1606 if (!NILP (handler
))
1608 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1610 if (STRINGP (handled_name
))
1611 return handled_name
;
1612 error ("Invalid handler in `file-name-handler-alist'");
1615 /* Always work on a copy of the string, in case GC happens during
1616 decode of environment variables, causing the original Lisp_String
1617 data to be relocated. */
1618 nm
= alloca (SBYTES (filename
) + 1);
1619 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1623 Lisp_Object encoded_filename
= ENCODE_FILE (filename
);
1626 dostounix_filename (SDATA (encoded_filename
));
1627 tem_fn
= DECODE_FILE (encoded_filename
);
1628 nm
= alloca (SBYTES (tem_fn
) + 1);
1629 memcpy (nm
, SDATA (tem_fn
), SBYTES (tem_fn
) + 1);
1630 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1635 endp
= nm
+ SBYTES (filename
);
1637 /* If /~ or // appears, discard everything through first slash. */
1638 p
= search_embedded_absfilename (nm
, endp
);
1640 /* Start over with the new string, so we check the file-name-handler
1641 again. Important with filenames like "/home/foo//:/hello///there"
1642 which would substitute to "/:/hello///there" rather than "/there". */
1643 return Fsubstitute_in_file_name
1644 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1646 /* See if any variables are substituted into the string
1647 and find the total length of their values in `total'. */
1649 for (p
= nm
; p
!= endp
;)
1659 /* "$$" means a single "$". */
1668 while (p
!= endp
&& *p
!= '}') p
++;
1669 if (*p
!= '}') goto missingclose
;
1675 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1679 /* Copy out the variable name. */
1680 target
= alloca (s
- o
+ 1);
1681 memcpy (target
, o
, s
- o
);
1684 strupr (target
); /* $home == $HOME etc. */
1687 /* Get variable value. */
1688 o
= egetenv (target
);
1691 /* Don't try to guess a maximum length - UTF8 can use up to
1692 four bytes per character. This code is unlikely to run
1693 in a situation that requires performance, so decoding the
1694 env variables twice should be acceptable. Note that
1695 decoding may cause a garbage collect. */
1696 Lisp_Object orig
, decoded
;
1697 orig
= build_unibyte_string (o
);
1698 decoded
= DECODE_FILE (orig
);
1699 total
+= SBYTES (decoded
);
1709 /* If substitution required, recopy the string and do it. */
1710 /* Make space in stack frame for the new copy. */
1711 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1714 /* Copy the rest of the name through, replacing $ constructs with values. */
1731 while (p
!= endp
&& *p
!= '}') p
++;
1732 if (*p
!= '}') goto missingclose
;
1738 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1742 /* Copy out the variable name. */
1743 target
= alloca (s
- o
+ 1);
1744 memcpy (target
, o
, s
- o
);
1747 strupr (target
); /* $home == $HOME etc. */
1750 /* Get variable value. */
1751 o
= egetenv (target
);
1755 strcpy (x
, target
); x
+= strlen (target
);
1759 Lisp_Object orig
, decoded
;
1760 ptrdiff_t orig_length
, decoded_length
;
1761 orig_length
= strlen (o
);
1762 orig
= make_unibyte_string (o
, orig_length
);
1763 decoded
= DECODE_FILE (orig
);
1764 decoded_length
= SBYTES (decoded
);
1765 memcpy (x
, SDATA (decoded
), decoded_length
);
1766 x
+= decoded_length
;
1768 /* If environment variable needed decoding, return value
1769 needs to be multibyte. */
1770 if (decoded_length
!= orig_length
1771 || memcmp (SDATA (decoded
), o
, orig_length
))
1778 /* If /~ or // appears, discard everything through first slash. */
1779 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1780 /* This time we do not start over because we've already expanded envvars
1781 and replaced $$ with $. Maybe we should start over as well, but we'd
1782 need to quote some $ to $$ first. */
1785 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1788 error ("Bad format environment-variable substitution");
1790 error ("Missing \"}\" in environment-variable substitution");
1792 error ("Substituting nonexistent environment variable \"%s\"", target
);
1798 /* A slightly faster and more convenient way to get
1799 (directory-file-name (expand-file-name FOO)). */
1802 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1804 register Lisp_Object absname
;
1806 absname
= Fexpand_file_name (filename
, defdir
);
1808 /* Remove final slash, if any (unless this is the root dir).
1809 stat behaves differently depending! */
1810 if (SCHARS (absname
) > 1
1811 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1812 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1813 /* We cannot take shortcuts; they might be wrong for magic file names. */
1814 absname
= Fdirectory_file_name (absname
);
1818 /* Signal an error if the file ABSNAME already exists.
1819 If INTERACTIVE, ask the user whether to proceed,
1820 and bypass the error if the user says to go ahead.
1821 QUERYSTRING is a name for the action that is being considered
1824 *STATPTR is used to store the stat information if the file exists.
1825 If the file does not exist, STATPTR->st_mode is set to 0.
1826 If STATPTR is null, we don't store into it.
1828 If QUICK, ask for y or n, not yes or no. */
1831 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1832 bool interactive
, struct stat
*statptr
,
1835 Lisp_Object tem
, encoded_filename
;
1836 struct stat statbuf
;
1837 struct gcpro gcpro1
;
1839 encoded_filename
= ENCODE_FILE (absname
);
1841 /* `stat' is a good way to tell whether the file exists,
1842 regardless of what access permissions it has. */
1843 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1845 if (S_ISDIR (statbuf
.st_mode
))
1846 xsignal2 (Qfile_error
,
1847 build_string ("File is a directory"), absname
);
1850 xsignal2 (Qfile_already_exists
,
1851 build_string ("File already exists"), absname
);
1853 tem
= format2 ("File %s already exists; %s anyway? ",
1854 absname
, build_string (querystring
));
1856 tem
= call1 (intern ("y-or-n-p"), tem
);
1858 tem
= do_yes_or_no_p (tem
);
1861 xsignal2 (Qfile_already_exists
,
1862 build_string ("File already exists"), absname
);
1869 statptr
->st_mode
= 0;
1874 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1875 "fCopy file: \nGCopy %s to file: \np\nP",
1876 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1877 If NEWNAME names a directory, copy FILE there.
1879 This function always sets the file modes of the output file to match
1882 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1883 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1884 signal a `file-already-exists' error without overwriting. If
1885 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1886 about overwriting; this is what happens in interactive use with M-x.
1887 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1890 Fourth arg KEEP-TIME non-nil means give the output file the same
1891 last-modified time as the old one. (This works on only some systems.)
1893 A prefix arg makes KEEP-TIME non-nil.
1895 If PRESERVE-UID-GID is non-nil, we try to transfer the
1896 uid and gid of FILE to NEWNAME.
1898 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1899 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1900 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
, Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
, Lisp_Object preserve_selinux_context
)
1904 char buf
[16 * 1024];
1905 struct stat st
, out_st
;
1906 Lisp_Object handler
;
1907 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1908 ptrdiff_t count
= SPECPDL_INDEX ();
1909 Lisp_Object encoded_file
, encoded_newname
;
1911 security_context_t con
;
1915 encoded_file
= encoded_newname
= Qnil
;
1916 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1917 CHECK_STRING (file
);
1918 CHECK_STRING (newname
);
1920 if (!NILP (Ffile_directory_p (newname
)))
1921 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1923 newname
= Fexpand_file_name (newname
, Qnil
);
1925 file
= Fexpand_file_name (file
, Qnil
);
1927 /* If the input file name has special constructs in it,
1928 call the corresponding file handler. */
1929 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1930 /* Likewise for output file name. */
1932 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1933 if (!NILP (handler
))
1934 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1935 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1936 preserve_selinux_context
));
1938 encoded_file
= ENCODE_FILE (file
);
1939 encoded_newname
= ENCODE_FILE (newname
);
1941 if (NILP (ok_if_already_exists
)
1942 || INTEGERP (ok_if_already_exists
))
1943 barf_or_query_if_file_exists (newname
, "copy to it",
1944 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1945 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1949 if (!CopyFile (SDATA (encoded_file
),
1950 SDATA (encoded_newname
),
1952 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1953 /* CopyFile retains the timestamp by default. */
1954 else if (NILP (keep_time
))
1960 filename
= SDATA (encoded_newname
);
1962 /* Ensure file is writable while its modified time is set. */
1963 attributes
= GetFileAttributes (filename
);
1964 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1965 now
= current_emacs_time ();
1966 if (set_file_times (-1, filename
, now
, now
))
1968 /* Restore original attributes. */
1969 SetFileAttributes (filename
, attributes
);
1970 xsignal2 (Qfile_date_error
,
1971 build_string ("Cannot set file date"), newname
);
1973 /* Restore original attributes. */
1974 SetFileAttributes (filename
, attributes
);
1976 #else /* not WINDOWSNT */
1978 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1982 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1984 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1986 if (fstat (ifd
, &st
) != 0)
1987 report_file_error ("Input file status", Fcons (file
, Qnil
));
1990 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1992 conlength
= fgetfilecon (ifd
, &con
);
1993 if (conlength
== -1)
1994 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1998 if (out_st
.st_mode
!= 0
1999 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2002 report_file_error ("Input and output files are the same",
2003 Fcons (file
, Fcons (newname
, Qnil
)));
2006 /* We can copy only regular files. */
2007 if (!S_ISREG (st
.st_mode
))
2009 /* Get a better looking error message. */
2010 errno
= S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
;
2011 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2015 /* System's default file type was set to binary by _fmode in emacs.c. */
2016 ofd
= emacs_open (SDATA (encoded_newname
),
2017 O_WRONLY
| O_TRUNC
| O_CREAT
2018 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2019 S_IREAD
| S_IWRITE
);
2020 #else /* not MSDOS */
2022 mode_t new_mask
= !NILP (preserve_uid_gid
) ? 0600 : 0666;
2023 new_mask
&= st
.st_mode
;
2024 ofd
= emacs_open (SSDATA (encoded_newname
),
2025 (O_WRONLY
| O_TRUNC
| O_CREAT
2026 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2029 #endif /* not MSDOS */
2031 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2033 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2037 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2038 if (emacs_write (ofd
, buf
, n
) != n
)
2039 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2043 /* Preserve the original file modes, and if requested, also its
2046 mode_t mode_mask
= 07777;
2047 if (!NILP (preserve_uid_gid
))
2049 /* Attempt to change owner and group. If that doesn't work
2050 attempt to change just the group, as that is sometimes allowed.
2051 Adjust the mode mask to eliminate setuid or setgid bits
2052 that are inappropriate if the owner and group are wrong. */
2053 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2055 mode_mask
&= ~06000;
2056 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2060 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2061 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2063 #endif /* not MSDOS */
2068 /* Set the modified context back to the file. */
2069 bool fail
= fsetfilecon (ofd
, con
) != 0;
2070 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2071 if (fail
&& errno
!= ENOTSUP
)
2072 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2078 if (!NILP (keep_time
))
2080 EMACS_TIME atime
= get_stat_atime (&st
);
2081 EMACS_TIME mtime
= get_stat_mtime (&st
);
2082 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2083 xsignal2 (Qfile_date_error
,
2084 build_string ("Cannot set file date"), newname
);
2087 if (emacs_close (ofd
) < 0)
2088 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2093 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2094 and if it can't, it tells so. Otherwise, under MSDOS we usually
2095 get only the READ bit, which will make the copied file read-only,
2096 so it's better not to chmod at all. */
2097 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2098 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2100 #endif /* not WINDOWSNT */
2102 /* Discard the unwind protects. */
2103 specpdl_ptr
= specpdl
+ count
;
2109 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2110 Smake_directory_internal
, 1, 1, 0,
2111 doc
: /* Create a new directory named DIRECTORY. */)
2112 (Lisp_Object directory
)
2115 Lisp_Object handler
;
2116 Lisp_Object encoded_dir
;
2118 CHECK_STRING (directory
);
2119 directory
= Fexpand_file_name (directory
, Qnil
);
2121 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2122 if (!NILP (handler
))
2123 return call2 (handler
, Qmake_directory_internal
, directory
);
2125 encoded_dir
= ENCODE_FILE (directory
);
2127 dir
= SSDATA (encoded_dir
);
2130 if (mkdir (dir
) != 0)
2132 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2134 report_file_error ("Creating directory", list1 (directory
));
2139 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2140 Sdelete_directory_internal
, 1, 1, 0,
2141 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2142 (Lisp_Object directory
)
2145 Lisp_Object encoded_dir
;
2147 CHECK_STRING (directory
);
2148 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2149 encoded_dir
= ENCODE_FILE (directory
);
2150 dir
= SSDATA (encoded_dir
);
2152 if (rmdir (dir
) != 0)
2153 report_file_error ("Removing directory", list1 (directory
));
2158 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2159 "(list (read-file-name \
2160 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2161 \"Move file to trash: \" \"Delete file: \") \
2162 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2163 (null current-prefix-arg))",
2164 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2165 If file has multiple names, it continues to exist with the other names.
2166 TRASH non-nil means to trash the file instead of deleting, provided
2167 `delete-by-moving-to-trash' is non-nil.
2169 When called interactively, TRASH is t if no prefix argument is given.
2170 With a prefix argument, TRASH is nil. */)
2171 (Lisp_Object filename
, Lisp_Object trash
)
2173 Lisp_Object handler
;
2174 Lisp_Object encoded_file
;
2175 struct gcpro gcpro1
;
2178 if (!NILP (Ffile_directory_p (filename
))
2179 && NILP (Ffile_symlink_p (filename
)))
2180 xsignal2 (Qfile_error
,
2181 build_string ("Removing old name: is a directory"),
2184 filename
= Fexpand_file_name (filename
, Qnil
);
2186 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2187 if (!NILP (handler
))
2188 return call3 (handler
, Qdelete_file
, filename
, trash
);
2190 if (delete_by_moving_to_trash
&& !NILP (trash
))
2191 return call1 (Qmove_file_to_trash
, filename
);
2193 encoded_file
= ENCODE_FILE (filename
);
2195 if (unlink (SSDATA (encoded_file
)) < 0)
2196 report_file_error ("Removing old name", list1 (filename
));
2201 internal_delete_file_1 (Lisp_Object ignore
)
2206 /* Delete file FILENAME.
2207 This ignores `delete-by-moving-to-trash'. */
2210 internal_delete_file (Lisp_Object filename
)
2212 internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2213 Qt
, internal_delete_file_1
);
2216 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2217 "fRename file: \nGRename %s to file: \np",
2218 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2219 If file has names other than FILE, it continues to have those names.
2220 Signals a `file-already-exists' error if a file NEWNAME already exists
2221 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2222 A number as third arg means request confirmation if NEWNAME already exists.
2223 This is what happens in interactive use with M-x. */)
2224 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2226 Lisp_Object handler
;
2227 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2228 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2230 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2231 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2232 CHECK_STRING (file
);
2233 CHECK_STRING (newname
);
2234 file
= Fexpand_file_name (file
, Qnil
);
2236 if ((!NILP (Ffile_directory_p (newname
)))
2238 /* If the file names are identical but for the case,
2239 don't attempt to move directory to itself. */
2240 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2244 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2245 ? file
: Fdirectory_file_name (file
));
2246 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2249 newname
= Fexpand_file_name (newname
, Qnil
);
2251 /* If the file name has special constructs in it,
2252 call the corresponding file handler. */
2253 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2255 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2256 if (!NILP (handler
))
2257 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2258 file
, newname
, ok_if_already_exists
));
2260 encoded_file
= ENCODE_FILE (file
);
2261 encoded_newname
= ENCODE_FILE (newname
);
2264 /* If the file names are identical but for the case, don't ask for
2265 confirmation: they simply want to change the letter-case of the
2267 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2269 if (NILP (ok_if_already_exists
)
2270 || INTEGERP (ok_if_already_exists
))
2271 barf_or_query_if_file_exists (newname
, "rename to it",
2272 INTEGERP (ok_if_already_exists
), 0, 0);
2273 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2278 symlink_target
= Ffile_symlink_p (file
);
2279 if (! NILP (symlink_target
))
2280 Fmake_symbolic_link (symlink_target
, newname
,
2281 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2282 else if (!NILP (Ffile_directory_p (file
)))
2283 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2285 /* We have already prompted if it was an integer, so don't
2286 have copy-file prompt again. */
2287 Fcopy_file (file
, newname
,
2288 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2291 count
= SPECPDL_INDEX ();
2292 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2294 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2295 call2 (Qdelete_directory
, file
, Qt
);
2297 Fdelete_file (file
, Qnil
);
2298 unbind_to (count
, Qnil
);
2301 report_file_error ("Renaming", list2 (file
, newname
));
2307 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2308 "fAdd name to file: \nGName to add to %s: \np",
2309 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2310 Signals a `file-already-exists' error if a file NEWNAME already exists
2311 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2312 A number as third arg means request confirmation if NEWNAME already exists.
2313 This is what happens in interactive use with M-x. */)
2314 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2316 Lisp_Object handler
;
2317 Lisp_Object encoded_file
, encoded_newname
;
2318 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2320 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2321 encoded_file
= encoded_newname
= Qnil
;
2322 CHECK_STRING (file
);
2323 CHECK_STRING (newname
);
2324 file
= Fexpand_file_name (file
, Qnil
);
2326 if (!NILP (Ffile_directory_p (newname
)))
2327 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2329 newname
= Fexpand_file_name (newname
, Qnil
);
2331 /* If the file name has special constructs in it,
2332 call the corresponding file handler. */
2333 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2334 if (!NILP (handler
))
2335 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2336 newname
, ok_if_already_exists
));
2338 /* If the new name has special constructs in it,
2339 call the corresponding file handler. */
2340 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2341 if (!NILP (handler
))
2342 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2343 newname
, ok_if_already_exists
));
2345 encoded_file
= ENCODE_FILE (file
);
2346 encoded_newname
= ENCODE_FILE (newname
);
2348 if (NILP (ok_if_already_exists
)
2349 || INTEGERP (ok_if_already_exists
))
2350 barf_or_query_if_file_exists (newname
, "make it a new name",
2351 INTEGERP (ok_if_already_exists
), 0, 0);
2353 unlink (SSDATA (newname
));
2354 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2355 report_file_error ("Adding new name", list2 (file
, newname
));
2361 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2362 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2363 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2364 Both args must be strings.
2365 Signals a `file-already-exists' error if a file LINKNAME already exists
2366 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2367 A number as third arg means request confirmation if LINKNAME already exists.
2368 This happens for interactive use with M-x. */)
2369 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2371 Lisp_Object handler
;
2372 Lisp_Object encoded_filename
, encoded_linkname
;
2373 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2375 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2376 encoded_filename
= encoded_linkname
= Qnil
;
2377 CHECK_STRING (filename
);
2378 CHECK_STRING (linkname
);
2379 /* If the link target has a ~, we must expand it to get
2380 a truly valid file name. Otherwise, do not expand;
2381 we want to permit links to relative file names. */
2382 if (SREF (filename
, 0) == '~')
2383 filename
= Fexpand_file_name (filename
, Qnil
);
2385 if (!NILP (Ffile_directory_p (linkname
)))
2386 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2388 linkname
= Fexpand_file_name (linkname
, Qnil
);
2390 /* If the file name has special constructs in it,
2391 call the corresponding file handler. */
2392 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2393 if (!NILP (handler
))
2394 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2395 linkname
, ok_if_already_exists
));
2397 /* If the new link name has special constructs in it,
2398 call the corresponding file handler. */
2399 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2400 if (!NILP (handler
))
2401 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2402 linkname
, ok_if_already_exists
));
2404 encoded_filename
= ENCODE_FILE (filename
);
2405 encoded_linkname
= ENCODE_FILE (linkname
);
2407 if (NILP (ok_if_already_exists
)
2408 || INTEGERP (ok_if_already_exists
))
2409 barf_or_query_if_file_exists (linkname
, "make it a link",
2410 INTEGERP (ok_if_already_exists
), 0, 0);
2411 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2413 /* If we didn't complain already, silently delete existing file. */
2414 if (errno
== EEXIST
)
2416 unlink (SSDATA (encoded_linkname
));
2417 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2424 if (errno
== ENOSYS
)
2427 xsignal1 (Qfile_error
,
2428 build_string ("Symbolic links are not supported"));
2431 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2438 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2440 doc
: /* Return t if file FILENAME specifies an absolute file name.
2441 On Unix, this is a name starting with a `/' or a `~'. */)
2442 (Lisp_Object filename
)
2444 CHECK_STRING (filename
);
2445 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2448 /* Return true if FILENAME exists. */
2450 check_existing (const char *filename
)
2452 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2455 /* Return true if file FILENAME exists and can be executed. */
2458 check_executable (char *filename
)
2460 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2463 /* Return true if file FILENAME exists and can be accessed
2464 according to AMODE, which should include W_OK.
2465 On failure, return false and set errno. */
2468 check_writable (const char *filename
, int amode
)
2471 /* FIXME: an faccessat implementation should be added to the
2472 DOS/Windows ports and this #ifdef branch should be removed. */
2474 if (stat (filename
, &st
) < 0)
2477 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2478 #else /* not MSDOS */
2479 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2481 /* faccessat may have returned failure because Cygwin couldn't
2482 determine the file's UID or GID; if so, we return success. */
2485 int faccessat_errno
= errno
;
2487 if (stat (filename
, &st
) < 0)
2489 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2490 errno
= faccessat_errno
;
2494 #endif /* not MSDOS */
2497 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2498 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2499 See also `file-readable-p' and `file-attributes'.
2500 This returns nil for a symlink to a nonexistent file.
2501 Use `file-symlink-p' to test for such links. */)
2502 (Lisp_Object filename
)
2504 Lisp_Object absname
;
2505 Lisp_Object handler
;
2507 CHECK_STRING (filename
);
2508 absname
= Fexpand_file_name (filename
, Qnil
);
2510 /* If the file name has special constructs in it,
2511 call the corresponding file handler. */
2512 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2513 if (!NILP (handler
))
2514 return call2 (handler
, Qfile_exists_p
, absname
);
2516 absname
= ENCODE_FILE (absname
);
2518 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2521 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2522 doc
: /* Return t if FILENAME can be executed by you.
2523 For a directory, this means you can access files in that directory. */)
2524 (Lisp_Object filename
)
2526 Lisp_Object absname
;
2527 Lisp_Object handler
;
2529 CHECK_STRING (filename
);
2530 absname
= Fexpand_file_name (filename
, Qnil
);
2532 /* If the file name has special constructs in it,
2533 call the corresponding file handler. */
2534 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2535 if (!NILP (handler
))
2536 return call2 (handler
, Qfile_executable_p
, absname
);
2538 absname
= ENCODE_FILE (absname
);
2540 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2543 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2544 doc
: /* Return t if file FILENAME exists and you can read it.
2545 See also `file-exists-p' and `file-attributes'. */)
2546 (Lisp_Object filename
)
2548 Lisp_Object absname
;
2549 Lisp_Object handler
;
2551 CHECK_STRING (filename
);
2552 absname
= Fexpand_file_name (filename
, Qnil
);
2554 /* If the file name has special constructs in it,
2555 call the corresponding file handler. */
2556 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2557 if (!NILP (handler
))
2558 return call2 (handler
, Qfile_readable_p
, absname
);
2560 absname
= ENCODE_FILE (absname
);
2561 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2565 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2566 doc
: /* Return t if file FILENAME can be written or created by you. */)
2567 (Lisp_Object filename
)
2569 Lisp_Object absname
, dir
, encoded
;
2570 Lisp_Object handler
;
2572 CHECK_STRING (filename
);
2573 absname
= Fexpand_file_name (filename
, Qnil
);
2575 /* If the file name has special constructs in it,
2576 call the corresponding file handler. */
2577 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2578 if (!NILP (handler
))
2579 return call2 (handler
, Qfile_writable_p
, absname
);
2581 encoded
= ENCODE_FILE (absname
);
2582 if (check_writable (SSDATA (encoded
), W_OK
))
2584 if (errno
!= ENOENT
)
2587 dir
= Ffile_name_directory (absname
);
2588 eassert (!NILP (dir
));
2590 dir
= Fdirectory_file_name (dir
);
2593 dir
= ENCODE_FILE (dir
);
2595 /* The read-only attribute of the parent directory doesn't affect
2596 whether a file or directory can be created within it. Some day we
2597 should check ACLs though, which do affect this. */
2598 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2600 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2604 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2605 doc
: /* Access file FILENAME, and get an error if that does not work.
2606 The second argument STRING is used in the error message.
2607 If there is no error, returns nil. */)
2608 (Lisp_Object filename
, Lisp_Object string
)
2610 Lisp_Object handler
, encoded_filename
, absname
;
2613 CHECK_STRING (filename
);
2614 absname
= Fexpand_file_name (filename
, Qnil
);
2616 CHECK_STRING (string
);
2618 /* If the file name has special constructs in it,
2619 call the corresponding file handler. */
2620 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2621 if (!NILP (handler
))
2622 return call3 (handler
, Qaccess_file
, absname
, string
);
2624 encoded_filename
= ENCODE_FILE (absname
);
2626 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2628 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2634 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2635 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2636 The value is the link target, as a string.
2637 Otherwise it returns nil.
2639 This function returns t when given the name of a symlink that
2640 points to a nonexistent file. */)
2641 (Lisp_Object filename
)
2643 Lisp_Object handler
;
2646 char readlink_buf
[READLINK_BUFSIZE
];
2648 CHECK_STRING (filename
);
2649 filename
= Fexpand_file_name (filename
, Qnil
);
2651 /* If the file name has special constructs in it,
2652 call the corresponding file handler. */
2653 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2654 if (!NILP (handler
))
2655 return call2 (handler
, Qfile_symlink_p
, filename
);
2657 filename
= ENCODE_FILE (filename
);
2659 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2663 val
= build_string (buf
);
2664 if (buf
[0] == '/' && strchr (buf
, ':'))
2665 val
= concat2 (build_string ("/:"), val
);
2666 if (buf
!= readlink_buf
)
2668 val
= DECODE_FILE (val
);
2672 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2673 doc
: /* Return t if FILENAME names an existing directory.
2674 Symbolic links to directories count as directories.
2675 See `file-symlink-p' to distinguish symlinks. */)
2676 (Lisp_Object filename
)
2678 Lisp_Object absname
;
2679 Lisp_Object handler
;
2681 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2683 /* If the file name has special constructs in it,
2684 call the corresponding file handler. */
2685 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2686 if (!NILP (handler
))
2687 return call2 (handler
, Qfile_directory_p
, absname
);
2689 absname
= ENCODE_FILE (absname
);
2691 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2694 /* Return true if FILE is a directory or a symlink to a directory. */
2696 file_directory_p (char const *file
)
2699 /* This is cheaper than 'stat'. */
2700 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2703 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2707 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2708 Sfile_accessible_directory_p
, 1, 1, 0,
2709 doc
: /* Return t if file FILENAME names a directory you can open.
2710 For the value to be t, FILENAME must specify the name of a directory as a file,
2711 and the directory must allow you to open files in it. In order to use a
2712 directory as a buffer's current directory, this predicate must return true.
2713 A directory name spec may be given instead; then the value is t
2714 if the directory so specified exists and really is a readable and
2715 searchable directory. */)
2716 (Lisp_Object filename
)
2718 Lisp_Object absname
;
2719 Lisp_Object handler
;
2721 CHECK_STRING (filename
);
2722 absname
= Fexpand_file_name (filename
, Qnil
);
2724 /* If the file name has special constructs in it,
2725 call the corresponding file handler. */
2726 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2727 if (!NILP (handler
))
2728 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2730 absname
= ENCODE_FILE (absname
);
2731 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2734 /* If FILE is a searchable directory or a symlink to a
2735 searchable directory, return true. Otherwise return
2736 false and set errno to an error number. */
2738 file_accessible_directory_p (char const *file
)
2741 /* There's no need to test whether FILE is searchable, as the
2742 searchable/executable bit is invented on DOS_NT platforms. */
2743 return file_directory_p (file
);
2745 /* On POSIXish platforms, use just one system call; this avoids a
2746 race and is typically faster. */
2747 ptrdiff_t len
= strlen (file
);
2753 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2754 There are three exceptions: "", "/", and "//". Leave "" alone,
2755 as it's invalid. Append only "." to the other two exceptions as
2756 "/" and "//" are distinct on some platforms, whereas "/", "///",
2757 "////", etc. are all equivalent. */
2762 /* Just check for trailing '/' when deciding whether to append '/'.
2763 That's simpler than testing the two special cases "/" and "//",
2764 and it's a safe optimization here. */
2765 char *buf
= SAFE_ALLOCA (len
+ 3);
2766 memcpy (buf
, file
, len
);
2767 strcpy (buf
+ len
, "/." + (file
[len
- 1] == '/'));
2771 ok
= check_existing (dir
);
2772 saved_errno
= errno
;
2774 errno
= saved_errno
;
2779 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2780 doc
: /* Return t if FILENAME names a regular file.
2781 This is the sort of file that holds an ordinary stream of data bytes.
2782 Symbolic links to regular files count as regular files.
2783 See `file-symlink-p' to distinguish symlinks. */)
2784 (Lisp_Object filename
)
2786 register Lisp_Object absname
;
2788 Lisp_Object handler
;
2790 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2792 /* If the file name has special constructs in it,
2793 call the corresponding file handler. */
2794 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2795 if (!NILP (handler
))
2796 return call2 (handler
, Qfile_regular_p
, absname
);
2798 absname
= ENCODE_FILE (absname
);
2803 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2805 /* Tell stat to use expensive method to get accurate info. */
2806 Vw32_get_true_file_attributes
= Qt
;
2807 result
= stat (SDATA (absname
), &st
);
2808 Vw32_get_true_file_attributes
= tem
;
2812 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2815 if (stat (SSDATA (absname
), &st
) < 0)
2817 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2821 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2822 Sfile_selinux_context
, 1, 1, 0,
2823 doc
: /* Return SELinux context of file named FILENAME.
2824 The return value is a list (USER ROLE TYPE RANGE), where the list
2825 elements are strings naming the user, role, type, and range of the
2826 file's SELinux security context.
2828 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2829 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2830 (Lisp_Object filename
)
2832 Lisp_Object absname
;
2833 Lisp_Object values
[4];
2834 Lisp_Object handler
;
2836 security_context_t con
;
2841 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2843 /* If the file name has special constructs in it,
2844 call the corresponding file handler. */
2845 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2846 if (!NILP (handler
))
2847 return call2 (handler
, Qfile_selinux_context
, absname
);
2849 absname
= ENCODE_FILE (absname
);
2856 if (is_selinux_enabled ())
2858 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2861 context
= context_new (con
);
2862 if (context_user_get (context
))
2863 values
[0] = build_string (context_user_get (context
));
2864 if (context_role_get (context
))
2865 values
[1] = build_string (context_role_get (context
));
2866 if (context_type_get (context
))
2867 values
[2] = build_string (context_type_get (context
));
2868 if (context_range_get (context
))
2869 values
[3] = build_string (context_range_get (context
));
2870 context_free (context
);
2876 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2879 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2880 Sset_file_selinux_context
, 2, 2, 0,
2881 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2882 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2883 elements are strings naming the components of a SELinux context.
2885 This function does nothing if SELinux is disabled, or if Emacs was not
2886 compiled with SELinux support. */)
2887 (Lisp_Object filename
, Lisp_Object context
)
2889 Lisp_Object absname
;
2890 Lisp_Object handler
;
2892 Lisp_Object encoded_absname
;
2893 Lisp_Object user
= CAR_SAFE (context
);
2894 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2895 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2896 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2897 security_context_t con
;
2900 context_t parsed_con
;
2903 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2905 /* If the file name has special constructs in it,
2906 call the corresponding file handler. */
2907 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2908 if (!NILP (handler
))
2909 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2912 if (is_selinux_enabled ())
2914 /* Get current file context. */
2915 encoded_absname
= ENCODE_FILE (absname
);
2916 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2919 parsed_con
= context_new (con
);
2920 /* Change the parts defined in the parameter.*/
2923 if (context_user_set (parsed_con
, SSDATA (user
)))
2924 error ("Doing context_user_set");
2928 if (context_role_set (parsed_con
, SSDATA (role
)))
2929 error ("Doing context_role_set");
2933 if (context_type_set (parsed_con
, SSDATA (type
)))
2934 error ("Doing context_type_set");
2936 if (STRINGP (range
))
2938 if (context_range_set (parsed_con
, SSDATA (range
)))
2939 error ("Doing context_range_set");
2942 /* Set the modified context back to the file. */
2943 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2944 context_str (parsed_con
))
2946 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2947 if (fail
&& errno
!= ENOTSUP
)
2948 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2950 context_free (parsed_con
);
2954 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
2961 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2962 doc
: /* Return mode bits of file named FILENAME, as an integer.
2963 Return nil, if file does not exist or is not accessible. */)
2964 (Lisp_Object filename
)
2966 Lisp_Object absname
;
2968 Lisp_Object handler
;
2970 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2972 /* If the file name has special constructs in it,
2973 call the corresponding file handler. */
2974 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2975 if (!NILP (handler
))
2976 return call2 (handler
, Qfile_modes
, absname
);
2978 absname
= ENCODE_FILE (absname
);
2980 if (stat (SSDATA (absname
), &st
) < 0)
2983 return make_number (st
.st_mode
& 07777);
2986 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2987 "(let ((file (read-file-name \"File: \"))) \
2988 (list file (read-file-modes nil file)))",
2989 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2990 Only the 12 low bits of MODE are used.
2992 Interactively, mode bits are read by `read-file-modes', which accepts
2993 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2994 (Lisp_Object filename
, Lisp_Object mode
)
2996 Lisp_Object absname
, encoded_absname
;
2997 Lisp_Object handler
;
2999 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3000 CHECK_NUMBER (mode
);
3002 /* If the file name has special constructs in it,
3003 call the corresponding file handler. */
3004 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3005 if (!NILP (handler
))
3006 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3008 encoded_absname
= ENCODE_FILE (absname
);
3010 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3011 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3016 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3017 doc
: /* Set the file permission bits for newly created files.
3018 The argument MODE should be an integer; only the low 9 bits are used.
3019 This setting is inherited by subprocesses. */)
3022 CHECK_NUMBER (mode
);
3024 umask ((~ XINT (mode
)) & 0777);
3029 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3030 doc
: /* Return the default file protection for created files.
3031 The value is an integer. */)
3038 realmask
= umask (0);
3042 XSETINT (value
, (~ realmask
) & 0777);
3047 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3048 doc
: /* Set times of file FILENAME to TIMESTAMP.
3049 Set both access and modification times.
3050 Return t on success, else nil.
3051 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3053 (Lisp_Object filename
, Lisp_Object timestamp
)
3055 Lisp_Object absname
, encoded_absname
;
3056 Lisp_Object handler
;
3057 EMACS_TIME t
= lisp_time_argument (timestamp
);
3059 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3061 /* If the file name has special constructs in it,
3062 call the corresponding file handler. */
3063 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3064 if (!NILP (handler
))
3065 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3067 encoded_absname
= ENCODE_FILE (absname
);
3070 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3073 /* Setting times on a directory always fails. */
3074 if (file_directory_p (SSDATA (encoded_absname
)))
3077 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3086 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3087 doc
: /* Tell Unix to finish all pending disk updates. */)
3094 #endif /* HAVE_SYNC */
3096 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3097 doc
: /* Return t if file FILE1 is newer than file FILE2.
3098 If FILE1 does not exist, the answer is nil;
3099 otherwise, if FILE2 does not exist, the answer is t. */)
3100 (Lisp_Object file1
, Lisp_Object file2
)
3102 Lisp_Object absname1
, absname2
;
3103 struct stat st1
, st2
;
3104 Lisp_Object handler
;
3105 struct gcpro gcpro1
, gcpro2
;
3107 CHECK_STRING (file1
);
3108 CHECK_STRING (file2
);
3111 GCPRO2 (absname1
, file2
);
3112 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3113 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3116 /* If the file name has special constructs in it,
3117 call the corresponding file handler. */
3118 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3120 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3121 if (!NILP (handler
))
3122 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3124 GCPRO2 (absname1
, absname2
);
3125 absname1
= ENCODE_FILE (absname1
);
3126 absname2
= ENCODE_FILE (absname2
);
3129 if (stat (SSDATA (absname1
), &st1
) < 0)
3132 if (stat (SSDATA (absname2
), &st2
) < 0)
3135 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3139 #ifndef READ_BUF_SIZE
3140 #define READ_BUF_SIZE (64 << 10)
3142 /* Some buffer offsets are stored in 'int' variables. */
3143 verify (READ_BUF_SIZE
<= INT_MAX
);
3145 /* This function is called after Lisp functions to decide a coding
3146 system are called, or when they cause an error. Before they are
3147 called, the current buffer is set unibyte and it contains only a
3148 newly inserted text (thus the buffer was empty before the
3151 The functions may set markers, overlays, text properties, or even
3152 alter the buffer contents, change the current buffer.
3154 Here, we reset all those changes by:
3155 o set back the current buffer.
3156 o move all markers and overlays to BEG.
3157 o remove all text properties.
3158 o set back the buffer multibyteness. */
3161 decide_coding_unwind (Lisp_Object unwind_data
)
3163 Lisp_Object multibyte
, undo_list
, buffer
;
3165 multibyte
= XCAR (unwind_data
);
3166 unwind_data
= XCDR (unwind_data
);
3167 undo_list
= XCAR (unwind_data
);
3168 buffer
= XCDR (unwind_data
);
3170 set_buffer_internal (XBUFFER (buffer
));
3171 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3172 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3173 set_buffer_intervals (current_buffer
, NULL
);
3174 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3176 /* Now we are safe to change the buffer's multibyteness directly. */
3177 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3178 bset_undo_list (current_buffer
, undo_list
);
3184 /* Used to pass values from insert-file-contents to read_non_regular. */
3186 static int non_regular_fd
;
3187 static ptrdiff_t non_regular_inserted
;
3188 static int non_regular_nbytes
;
3191 /* Read from a non-regular file.
3192 Read non_regular_nbytes bytes max from non_regular_fd.
3193 Non_regular_inserted specifies where to put the read bytes.
3194 Value is the number of bytes read. */
3197 read_non_regular (Lisp_Object ignore
)
3203 nbytes
= emacs_read (non_regular_fd
,
3204 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3205 + non_regular_inserted
),
3206 non_regular_nbytes
);
3208 return make_number (nbytes
);
3212 /* Condition-case handler used when reading from non-regular files
3213 in insert-file-contents. */
3216 read_non_regular_quit (Lisp_Object ignore
)
3221 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3222 except that it also tests for OFFSET being out of lseek's range. */
3224 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3226 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3227 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3228 if (! ((offset
>= TYPE_MINIMUM (off_t
)) & (offset
<= TYPE_MAXIMUM (off_t
))))
3233 return lseek (fd
, offset
, whence
);
3236 /* Return a special time value indicating the error number ERRNUM. */
3238 time_error_value (int errnum
)
3240 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3241 ? NONEXISTENT_MODTIME_NSECS
3242 : UNKNOWN_MODTIME_NSECS
);
3243 return make_emacs_time (0, ns
);
3246 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3248 doc
: /* Insert contents of file FILENAME after point.
3249 Returns list of absolute file name and number of characters inserted.
3250 If second argument VISIT is non-nil, the buffer's visited filename and
3251 last save file modtime are set, and it is marked unmodified. If
3252 visiting and the file does not exist, visiting is completed before the
3255 The optional third and fourth arguments BEG and END specify what portion
3256 of the file to insert. These arguments count bytes in the file, not
3257 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3259 If optional fifth argument REPLACE is non-nil, replace the current
3260 buffer contents (in the accessible portion) with the file contents.
3261 This is better than simply deleting and inserting the whole thing
3262 because (1) it preserves some marker positions and (2) it puts less data
3263 in the undo list. When REPLACE is non-nil, the second return value is
3264 the number of characters that replace previous buffer contents.
3266 This function does code conversion according to the value of
3267 `coding-system-for-read' or `file-coding-system-alist', and sets the
3268 variable `last-coding-system-used' to the coding system actually used. */)
3269 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3275 ptrdiff_t inserted
= 0;
3278 off_t beg_offset
, end_offset
;
3280 ptrdiff_t count
= SPECPDL_INDEX ();
3281 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3282 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3284 ptrdiff_t total
= 0;
3285 bool not_regular
= 0;
3287 char read_buf
[READ_BUF_SIZE
];
3288 struct coding_system coding
;
3289 char buffer
[1 << 14];
3290 bool replace_handled
= 0;
3291 bool set_coding_system
= 0;
3292 Lisp_Object coding_system
;
3294 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3295 bool we_locked_file
= 0;
3296 bool deferred_remove_unwind_protect
= 0;
3298 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3299 error ("Cannot do file visiting in an indirect buffer");
3301 if (!NILP (BVAR (current_buffer
, read_only
)))
3302 Fbarf_if_buffer_read_only ();
3306 orig_filename
= Qnil
;
3309 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3311 CHECK_STRING (filename
);
3312 filename
= Fexpand_file_name (filename
, Qnil
);
3314 /* The value Qnil means that the coding system is not yet
3316 coding_system
= Qnil
;
3318 /* If the file name has special constructs in it,
3319 call the corresponding file handler. */
3320 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3321 if (!NILP (handler
))
3323 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3324 visit
, beg
, end
, replace
);
3325 if (CONSP (val
) && CONSP (XCDR (val
))
3326 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3327 inserted
= XINT (XCAR (XCDR (val
)));
3331 orig_filename
= filename
;
3332 filename
= ENCODE_FILE (filename
);
3338 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3340 /* Tell stat to use expensive method to get accurate info. */
3341 Vw32_get_true_file_attributes
= Qt
;
3342 file_status
= stat (SSDATA (filename
), &st
);
3343 Vw32_get_true_file_attributes
= tem
;
3346 file_status
= stat (SSDATA (filename
), &st
);
3347 #endif /* WINDOWSNT */
3349 if (file_status
== 0)
3350 mtime
= get_stat_mtime (&st
);
3356 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3357 mtime
= time_error_value (save_errno
);
3360 if (!NILP (Vcoding_system_for_read
))
3361 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3365 /* This code will need to be changed in order to work on named
3366 pipes, and it's probably just not worth it. So we should at
3367 least signal an error. */
3368 if (!S_ISREG (st
.st_mode
))
3375 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3376 xsignal2 (Qfile_error
,
3377 build_string ("not a regular file"), orig_filename
);
3381 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3384 /* Replacement should preserve point as it preserves markers. */
3385 if (!NILP (replace
))
3386 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3388 record_unwind_protect (close_file_unwind
, make_number (fd
));
3393 if (!NILP (beg
) || !NILP (end
))
3394 error ("Attempt to visit less than an entire file");
3395 if (BEG
< Z
&& NILP (replace
))
3396 error ("Cannot do file visiting in a non-empty buffer");
3401 if (! RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
)))
3402 wrong_type_argument (intern ("file-offset"), beg
);
3403 beg_offset
= XFASTINT (beg
);
3410 if (! RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
)))
3411 wrong_type_argument (intern ("file-offset"), end
);
3412 end_offset
= XFASTINT (end
);
3417 end_offset
= TYPE_MAXIMUM (off_t
);
3420 end_offset
= st
.st_size
;
3422 /* A negative size can happen on a platform that allows file
3423 sizes greater than the maximum off_t value. */
3427 /* The file size returned from stat may be zero, but data
3428 may be readable nonetheless, for example when this is a
3429 file in the /proc filesystem. */
3430 if (end_offset
== 0)
3431 end_offset
= READ_BUF_SIZE
;
3435 /* Check now whether the buffer will become too large,
3436 in the likely case where the file's length is not changing.
3437 This saves a lot of needless work before a buffer overflow. */
3440 /* The likely offset where we will stop reading. We could read
3441 more (or less), if the file grows (or shrinks) as we read it. */
3442 off_t likely_end
= min (end_offset
, st
.st_size
);
3444 if (beg_offset
< likely_end
)
3447 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3448 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3449 off_t likely_growth
= likely_end
- beg_offset
;
3450 if (buf_growth_max
< likely_growth
)
3455 /* Prevent redisplay optimizations. */
3456 current_buffer
->clip_changed
= 1;
3458 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3460 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3461 setup_coding_system (coding_system
, &coding
);
3462 /* Ensure we set Vlast_coding_system_used. */
3463 set_coding_system
= 1;
3467 /* Decide the coding system to use for reading the file now
3468 because we can't use an optimized method for handling
3469 `coding:' tag if the current buffer is not empty. */
3470 if (!NILP (Vcoding_system_for_read
))
3471 coding_system
= Vcoding_system_for_read
;
3474 /* Don't try looking inside a file for a coding system
3475 specification if it is not seekable. */
3476 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3478 /* Find a coding system specified in the heading two
3479 lines or in the tailing several lines of the file.
3480 We assume that the 1K-byte and 3K-byte for heading
3481 and tailing respectively are sufficient for this
3485 if (st
.st_size
<= (1024 * 4))
3486 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3489 nread
= emacs_read (fd
, read_buf
, 1024);
3493 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3494 report_file_error ("Setting file position",
3495 Fcons (orig_filename
, Qnil
));
3496 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3497 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3502 error ("IO error reading %s: %s",
3503 SDATA (orig_filename
), emacs_strerror (errno
));
3506 struct buffer
*prev
= current_buffer
;
3507 Lisp_Object workbuf
;
3510 record_unwind_current_buffer ();
3512 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3513 buf
= XBUFFER (workbuf
);
3515 delete_all_overlays (buf
);
3516 bset_directory (buf
, BVAR (current_buffer
, directory
));
3517 bset_read_only (buf
, Qnil
);
3518 bset_filename (buf
, Qnil
);
3519 bset_undo_list (buf
, Qt
);
3520 eassert (buf
->overlays_before
== NULL
);
3521 eassert (buf
->overlays_after
== NULL
);
3523 set_buffer_internal (buf
);
3525 bset_enable_multibyte_characters (buf
, Qnil
);
3527 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3528 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3529 coding_system
= call2 (Vset_auto_coding_function
,
3530 filename
, make_number (nread
));
3531 set_buffer_internal (prev
);
3533 /* Discard the unwind protect for recovering the
3537 /* Rewind the file for the actual read done later. */
3538 if (lseek (fd
, 0, SEEK_SET
) < 0)
3539 report_file_error ("Setting file position",
3540 Fcons (orig_filename
, Qnil
));
3544 if (NILP (coding_system
))
3546 /* If we have not yet decided a coding system, check
3547 file-coding-system-alist. */
3548 Lisp_Object args
[6];
3550 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3551 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3552 coding_system
= Ffind_operation_coding_system (6, args
);
3553 if (CONSP (coding_system
))
3554 coding_system
= XCAR (coding_system
);
3558 if (NILP (coding_system
))
3559 coding_system
= Qundecided
;
3561 CHECK_CODING_SYSTEM (coding_system
);
3563 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3564 /* We must suppress all character code conversion except for
3565 end-of-line conversion. */
3566 coding_system
= raw_text_coding_system (coding_system
);
3568 setup_coding_system (coding_system
, &coding
);
3569 /* Ensure we set Vlast_coding_system_used. */
3570 set_coding_system
= 1;
3573 /* If requested, replace the accessible part of the buffer
3574 with the file contents. Avoid replacing text at the
3575 beginning or end of the buffer that matches the file contents;
3576 that preserves markers pointing to the unchanged parts.
3578 Here we implement this feature in an optimized way
3579 for the case where code conversion is NOT needed.
3580 The following if-statement handles the case of conversion
3581 in a less optimal way.
3583 If the code conversion is "automatic" then we try using this
3584 method and hope for the best.
3585 But if we discover the need for conversion, we give up on this method
3586 and let the following if-statement handle the replace job. */
3589 && (NILP (coding_system
)
3590 || ! CODING_REQUIRE_DECODING (&coding
)))
3592 /* same_at_start and same_at_end count bytes,
3593 because file access counts bytes
3594 and BEG and END count bytes. */
3595 ptrdiff_t same_at_start
= BEGV_BYTE
;
3596 ptrdiff_t same_at_end
= ZV_BYTE
;
3598 /* There is still a possibility we will find the need to do code
3599 conversion. If that happens, set this variable to
3600 give up on handling REPLACE in the optimized way. */
3601 bool giveup_match_end
= 0;
3603 if (beg_offset
!= 0)
3605 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3606 report_file_error ("Setting file position",
3607 Fcons (orig_filename
, Qnil
));
3612 /* Count how many chars at the start of the file
3613 match the text at the beginning of the buffer. */
3618 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3620 error ("IO error reading %s: %s",
3621 SSDATA (orig_filename
), emacs_strerror (errno
));
3622 else if (nread
== 0)
3625 if (CODING_REQUIRE_DETECTION (&coding
))
3627 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3630 setup_coding_system (coding_system
, &coding
);
3633 if (CODING_REQUIRE_DECODING (&coding
))
3634 /* We found that the file should be decoded somehow.
3635 Let's give up here. */
3637 giveup_match_end
= 1;
3642 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3643 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3644 same_at_start
++, bufpos
++;
3645 /* If we found a discrepancy, stop the scan.
3646 Otherwise loop around and scan the next bufferful. */
3647 if (bufpos
!= nread
)
3651 /* If the file matches the buffer completely,
3652 there's no need to replace anything. */
3653 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3657 /* Truncate the buffer to the size of the file. */
3658 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3663 /* Count how many chars at the end of the file
3664 match the text at the end of the buffer. But, if we have
3665 already found that decoding is necessary, don't waste time. */
3666 while (!giveup_match_end
)
3668 int total_read
, nread
, bufpos
, trial
;
3671 /* At what file position are we now scanning? */
3672 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3673 /* If the entire file matches the buffer tail, stop the scan. */
3676 /* How much can we scan in the next step? */
3677 trial
= min (curpos
, sizeof buffer
);
3678 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3679 report_file_error ("Setting file position",
3680 Fcons (orig_filename
, Qnil
));
3682 total_read
= nread
= 0;
3683 while (total_read
< trial
)
3685 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3687 error ("IO error reading %s: %s",
3688 SDATA (orig_filename
), emacs_strerror (errno
));
3689 else if (nread
== 0)
3691 total_read
+= nread
;
3694 /* Scan this bufferful from the end, comparing with
3695 the Emacs buffer. */
3696 bufpos
= total_read
;
3698 /* Compare with same_at_start to avoid counting some buffer text
3699 as matching both at the file's beginning and at the end. */
3700 while (bufpos
> 0 && same_at_end
> same_at_start
3701 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3702 same_at_end
--, bufpos
--;
3704 /* If we found a discrepancy, stop the scan.
3705 Otherwise loop around and scan the preceding bufferful. */
3708 /* If this discrepancy is because of code conversion,
3709 we cannot use this method; giveup and try the other. */
3710 if (same_at_end
> same_at_start
3711 && FETCH_BYTE (same_at_end
- 1) >= 0200
3712 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3713 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3714 giveup_match_end
= 1;
3723 if (! giveup_match_end
)
3727 /* We win! We can handle REPLACE the optimized way. */
3729 /* Extend the start of non-matching text area to multibyte
3730 character boundary. */
3731 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3732 while (same_at_start
> BEGV_BYTE
3733 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3736 /* Extend the end of non-matching text area to multibyte
3737 character boundary. */
3738 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3739 while (same_at_end
< ZV_BYTE
3740 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3743 /* Don't try to reuse the same piece of text twice. */
3744 overlap
= (same_at_start
- BEGV_BYTE
3746 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3748 same_at_end
+= overlap
;
3750 /* Arrange to read only the nonmatching middle part of the file. */
3751 beg_offset
+= same_at_start
- BEGV_BYTE
;
3752 end_offset
-= ZV_BYTE
- same_at_end
;
3754 del_range_byte (same_at_start
, same_at_end
, 0);
3755 /* Insert from the file at the proper position. */
3756 temp
= BYTE_TO_CHAR (same_at_start
);
3757 SET_PT_BOTH (temp
, same_at_start
);
3759 /* If display currently starts at beginning of line,
3760 keep it that way. */
3761 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3762 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3764 replace_handled
= 1;
3768 /* If requested, replace the accessible part of the buffer
3769 with the file contents. Avoid replacing text at the
3770 beginning or end of the buffer that matches the file contents;
3771 that preserves markers pointing to the unchanged parts.
3773 Here we implement this feature for the case where code conversion
3774 is needed, in a simple way that needs a lot of memory.
3775 The preceding if-statement handles the case of no conversion
3776 in a more optimized way. */
3777 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3779 ptrdiff_t same_at_start
= BEGV_BYTE
;
3780 ptrdiff_t same_at_end
= ZV_BYTE
;
3781 ptrdiff_t same_at_start_charpos
;
3782 ptrdiff_t inserted_chars
;
3785 unsigned char *decoded
;
3788 ptrdiff_t this_count
= SPECPDL_INDEX ();
3790 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3791 Lisp_Object conversion_buffer
;
3792 struct gcpro gcpro1
;
3794 conversion_buffer
= code_conversion_save (1, multibyte
);
3796 /* First read the whole file, performing code conversion into
3797 CONVERSION_BUFFER. */
3799 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3800 report_file_error ("Setting file position",
3801 Fcons (orig_filename
, Qnil
));
3803 total
= st
.st_size
; /* Total bytes in the file. */
3804 how_much
= 0; /* Bytes read from file so far. */
3805 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3806 unprocessed
= 0; /* Bytes not processed in previous loop. */
3808 GCPRO1 (conversion_buffer
);
3809 while (how_much
< total
)
3811 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3812 quitting while reading a huge while. */
3813 /* `try'' is reserved in some compilers (Microsoft C). */
3814 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3816 /* Allow quitting out of the actual I/O. */
3819 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3827 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3828 BUF_Z (XBUFFER (conversion_buffer
)));
3829 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3830 unprocessed
+ this, conversion_buffer
);
3831 unprocessed
= coding
.carryover_bytes
;
3832 if (coding
.carryover_bytes
> 0)
3833 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3838 /* We should remove the unwind_protect calling
3839 close_file_unwind, but other stuff has been added the stack,
3840 so defer the removal till we reach the `handled' label. */
3841 deferred_remove_unwind_protect
= 1;
3843 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3844 if we couldn't read the file. */
3847 error ("IO error reading %s: %s",
3848 SDATA (orig_filename
), emacs_strerror (errno
));
3850 if (unprocessed
> 0)
3852 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3853 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3854 unprocessed
, conversion_buffer
);
3855 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3858 coding_system
= CODING_ID_NAME (coding
.id
);
3859 set_coding_system
= 1;
3860 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3861 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3862 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3864 /* Compare the beginning of the converted string with the buffer
3868 while (bufpos
< inserted
&& same_at_start
< same_at_end
3869 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3870 same_at_start
++, bufpos
++;
3872 /* If the file matches the head of buffer completely,
3873 there's no need to replace anything. */
3875 if (bufpos
== inserted
)
3877 /* Truncate the buffer to the size of the file. */
3878 if (same_at_start
== same_at_end
)
3881 del_range_byte (same_at_start
, same_at_end
, 0);
3884 unbind_to (this_count
, Qnil
);
3888 /* Extend the start of non-matching text area to the previous
3889 multibyte character boundary. */
3890 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3891 while (same_at_start
> BEGV_BYTE
3892 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3895 /* Scan this bufferful from the end, comparing with
3896 the Emacs buffer. */
3899 /* Compare with same_at_start to avoid counting some buffer text
3900 as matching both at the file's beginning and at the end. */
3901 while (bufpos
> 0 && same_at_end
> same_at_start
3902 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3903 same_at_end
--, bufpos
--;
3905 /* Extend the end of non-matching text area to the next
3906 multibyte character boundary. */
3907 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3908 while (same_at_end
< ZV_BYTE
3909 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3912 /* Don't try to reuse the same piece of text twice. */
3913 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3915 same_at_end
+= overlap
;
3917 /* If display currently starts at beginning of line,
3918 keep it that way. */
3919 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3920 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3922 /* Replace the chars that we need to replace,
3923 and update INSERTED to equal the number of bytes
3924 we are taking from the decoded string. */
3925 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3927 if (same_at_end
!= same_at_start
)
3929 del_range_byte (same_at_start
, same_at_end
, 0);
3931 same_at_start
= GPT_BYTE
;
3935 temp
= BYTE_TO_CHAR (same_at_start
);
3937 /* Insert from the file at the proper position. */
3938 SET_PT_BOTH (temp
, same_at_start
);
3939 same_at_start_charpos
3940 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3941 same_at_start
- BEGV_BYTE
3942 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3944 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3945 same_at_start
+ inserted
- BEGV_BYTE
3946 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3947 - same_at_start_charpos
);
3948 /* This binding is to avoid ask-user-about-supersession-threat
3949 being called in insert_from_buffer (via in
3950 prepare_to_modify_buffer). */
3951 specbind (intern ("buffer-file-name"), Qnil
);
3952 insert_from_buffer (XBUFFER (conversion_buffer
),
3953 same_at_start_charpos
, inserted_chars
, 0);
3954 /* Set `inserted' to the number of inserted characters. */
3955 inserted
= PT
- temp
;
3956 /* Set point before the inserted characters. */
3957 SET_PT_BOTH (temp
, same_at_start
);
3959 unbind_to (this_count
, Qnil
);
3965 total
= end_offset
- beg_offset
;
3967 /* For a special file, all we can do is guess. */
3968 total
= READ_BUF_SIZE
;
3970 if (NILP (visit
) && total
> 0)
3972 #ifdef CLASH_DETECTION
3973 if (!NILP (BVAR (current_buffer
, file_truename
))
3974 /* Make binding buffer-file-name to nil effective. */
3975 && !NILP (BVAR (current_buffer
, filename
))
3976 && SAVE_MODIFF
>= MODIFF
)
3978 #endif /* CLASH_DETECTION */
3979 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3983 if (GAP_SIZE
< total
)
3984 make_gap (total
- GAP_SIZE
);
3986 if (beg_offset
!= 0 || !NILP (replace
))
3988 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3989 report_file_error ("Setting file position",
3990 Fcons (orig_filename
, Qnil
));
3993 /* In the following loop, HOW_MUCH contains the total bytes read so
3994 far for a regular file, and not changed for a special file. But,
3995 before exiting the loop, it is set to a negative value if I/O
3999 /* Total bytes inserted. */
4002 /* Here, we don't do code conversion in the loop. It is done by
4003 decode_coding_gap after all data are read into the buffer. */
4005 ptrdiff_t gap_size
= GAP_SIZE
;
4007 while (how_much
< total
)
4009 /* try is reserved in some compilers (Microsoft C) */
4010 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4017 /* Maybe make more room. */
4018 if (gap_size
< trytry
)
4020 make_gap (total
- gap_size
);
4021 gap_size
= GAP_SIZE
;
4024 /* Read from the file, capturing `quit'. When an
4025 error occurs, end the loop, and arrange for a quit
4026 to be signaled after decoding the text we read. */
4027 non_regular_fd
= fd
;
4028 non_regular_inserted
= inserted
;
4029 non_regular_nbytes
= trytry
;
4030 nbytes
= internal_condition_case_1 (read_non_regular
,
4032 read_non_regular_quit
);
4039 this = XINT (nbytes
);
4043 /* Allow quitting out of the actual I/O. We don't make text
4044 part of the buffer until all the reading is done, so a C-g
4045 here doesn't do any harm. */
4048 this = emacs_read (fd
,
4049 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4063 /* For a regular file, where TOTAL is the real size,
4064 count HOW_MUCH to compare with it.
4065 For a special file, where TOTAL is just a buffer size,
4066 so don't bother counting in HOW_MUCH.
4067 (INSERTED is where we count the number of characters inserted.) */
4074 /* Now we have read all the file data into the gap.
4075 If it was empty, undo marking the buffer modified. */
4079 #ifdef CLASH_DETECTION
4081 unlock_file (BVAR (current_buffer
, file_truename
));
4083 Vdeactivate_mark
= old_Vdeactivate_mark
;
4086 Vdeactivate_mark
= Qt
;
4088 /* Make the text read part of the buffer. */
4089 GAP_SIZE
-= inserted
;
4091 GPT_BYTE
+= inserted
;
4093 ZV_BYTE
+= inserted
;
4098 /* Put an anchor to ensure multi-byte form ends at gap. */
4103 /* Discard the unwind protect for closing the file. */
4107 error ("IO error reading %s: %s",
4108 SDATA (orig_filename
), emacs_strerror (errno
));
4112 if (NILP (coding_system
))
4114 /* The coding system is not yet decided. Decide it by an
4115 optimized method for handling `coding:' tag.
4117 Note that we can get here only if the buffer was empty
4118 before the insertion. */
4120 if (!NILP (Vcoding_system_for_read
))
4121 coding_system
= Vcoding_system_for_read
;
4124 /* Since we are sure that the current buffer was empty
4125 before the insertion, we can toggle
4126 enable-multibyte-characters directly here without taking
4127 care of marker adjustment. By this way, we can run Lisp
4128 program safely before decoding the inserted text. */
4129 Lisp_Object unwind_data
;
4130 ptrdiff_t count1
= SPECPDL_INDEX ();
4132 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4133 Fcons (BVAR (current_buffer
, undo_list
),
4134 Fcurrent_buffer ()));
4135 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4136 bset_undo_list (current_buffer
, Qt
);
4137 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4139 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4141 coding_system
= call2 (Vset_auto_coding_function
,
4142 filename
, make_number (inserted
));
4145 if (NILP (coding_system
))
4147 /* If the coding system is not yet decided, check
4148 file-coding-system-alist. */
4149 Lisp_Object args
[6];
4151 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4152 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4153 coding_system
= Ffind_operation_coding_system (6, args
);
4154 if (CONSP (coding_system
))
4155 coding_system
= XCAR (coding_system
);
4157 unbind_to (count1
, Qnil
);
4158 inserted
= Z_BYTE
- BEG_BYTE
;
4161 if (NILP (coding_system
))
4162 coding_system
= Qundecided
;
4164 CHECK_CODING_SYSTEM (coding_system
);
4166 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4167 /* We must suppress all character code conversion except for
4168 end-of-line conversion. */
4169 coding_system
= raw_text_coding_system (coding_system
);
4170 setup_coding_system (coding_system
, &coding
);
4171 /* Ensure we set Vlast_coding_system_used. */
4172 set_coding_system
= 1;
4177 /* When we visit a file by raw-text, we change the buffer to
4179 if (CODING_FOR_UNIBYTE (&coding
)
4180 /* Can't do this if part of the buffer might be preserved. */
4182 /* Visiting a file with these coding system makes the buffer
4184 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4187 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4188 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4189 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4191 move_gap_both (PT
, PT_BYTE
);
4192 GAP_SIZE
+= inserted
;
4193 ZV_BYTE
-= inserted
;
4197 decode_coding_gap (&coding
, inserted
, inserted
);
4198 inserted
= coding
.produced_char
;
4199 coding_system
= CODING_ID_NAME (coding
.id
);
4201 else if (inserted
> 0)
4202 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4205 /* Call after-change hooks for the inserted text, aside from the case
4206 of normal visiting (not with REPLACE), which is done in a new buffer
4207 "before" the buffer is changed. */
4208 if (inserted
> 0 && total
> 0
4209 && (NILP (visit
) || !NILP (replace
)))
4211 signal_after_change (PT
, 0, inserted
);
4212 update_compositions (PT
, PT
, CHECK_BORDER
);
4215 /* Now INSERTED is measured in characters. */
4219 if (deferred_remove_unwind_protect
)
4220 /* If requested above, discard the unwind protect for closing the
4226 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4227 bset_undo_list (current_buffer
, Qnil
);
4231 current_buffer
->modtime
= mtime
;
4232 current_buffer
->modtime_size
= st
.st_size
;
4233 bset_filename (current_buffer
, orig_filename
);
4236 SAVE_MODIFF
= MODIFF
;
4237 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4238 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4239 #ifdef CLASH_DETECTION
4242 if (!NILP (BVAR (current_buffer
, file_truename
)))
4243 unlock_file (BVAR (current_buffer
, file_truename
));
4244 unlock_file (filename
);
4246 #endif /* CLASH_DETECTION */
4248 xsignal2 (Qfile_error
,
4249 build_string ("not a regular file"), orig_filename
);
4252 if (set_coding_system
)
4253 Vlast_coding_system_used
= coding_system
;
4255 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4257 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4259 if (! NILP (insval
))
4261 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4262 wrong_type_argument (intern ("inserted-chars"), insval
);
4263 inserted
= XFASTINT (insval
);
4267 /* Decode file format. */
4270 /* Don't run point motion or modification hooks when decoding. */
4271 ptrdiff_t count1
= SPECPDL_INDEX ();
4272 ptrdiff_t old_inserted
= inserted
;
4273 specbind (Qinhibit_point_motion_hooks
, Qt
);
4274 specbind (Qinhibit_modification_hooks
, Qt
);
4276 /* Save old undo list and don't record undo for decoding. */
4277 old_undo
= BVAR (current_buffer
, undo_list
);
4278 bset_undo_list (current_buffer
, Qt
);
4282 insval
= call3 (Qformat_decode
,
4283 Qnil
, make_number (inserted
), visit
);
4284 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4285 wrong_type_argument (intern ("inserted-chars"), insval
);
4286 inserted
= XFASTINT (insval
);
4290 /* If REPLACE is non-nil and we succeeded in not replacing the
4291 beginning or end of the buffer text with the file's contents,
4292 call format-decode with `point' positioned at the beginning
4293 of the buffer and `inserted' equaling the number of
4294 characters in the buffer. Otherwise, format-decode might
4295 fail to correctly analyze the beginning or end of the buffer.
4296 Hence we temporarily save `point' and `inserted' here and
4297 restore `point' iff format-decode did not insert or delete
4298 any text. Otherwise we leave `point' at point-min. */
4299 ptrdiff_t opoint
= PT
;
4300 ptrdiff_t opoint_byte
= PT_BYTE
;
4301 ptrdiff_t oinserted
= ZV
- BEGV
;
4302 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4304 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4305 insval
= call3 (Qformat_decode
,
4306 Qnil
, make_number (oinserted
), visit
);
4307 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4308 wrong_type_argument (intern ("inserted-chars"), insval
);
4309 if (ochars_modiff
== CHARS_MODIFF
)
4310 /* format_decode didn't modify buffer's characters => move
4311 point back to position before inserted text and leave
4312 value of inserted alone. */
4313 SET_PT_BOTH (opoint
, opoint_byte
);
4315 /* format_decode modified buffer's characters => consider
4316 entire buffer changed and leave point at point-min. */
4317 inserted
= XFASTINT (insval
);
4320 /* For consistency with format-decode call these now iff inserted > 0
4321 (martin 2007-06-28). */
4322 p
= Vafter_insert_file_functions
;
4327 insval
= call1 (XCAR (p
), make_number (inserted
));
4330 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4331 wrong_type_argument (intern ("inserted-chars"), insval
);
4332 inserted
= XFASTINT (insval
);
4337 /* For the rationale of this see the comment on
4338 format-decode above. */
4339 ptrdiff_t opoint
= PT
;
4340 ptrdiff_t opoint_byte
= PT_BYTE
;
4341 ptrdiff_t oinserted
= ZV
- BEGV
;
4342 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4344 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4345 insval
= call1 (XCAR (p
), make_number (oinserted
));
4348 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4349 wrong_type_argument (intern ("inserted-chars"), insval
);
4350 if (ochars_modiff
== CHARS_MODIFF
)
4351 /* after_insert_file_functions didn't modify
4352 buffer's characters => move point back to
4353 position before inserted text and leave value of
4355 SET_PT_BOTH (opoint
, opoint_byte
);
4357 /* after_insert_file_functions did modify buffer's
4358 characters => consider entire buffer changed and
4359 leave point at point-min. */
4360 inserted
= XFASTINT (insval
);
4370 bset_undo_list (current_buffer
, old_undo
);
4371 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4373 /* Adjust the last undo record for the size change during
4374 the format conversion. */
4375 Lisp_Object tem
= XCAR (old_undo
);
4376 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4377 && INTEGERP (XCDR (tem
))
4378 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4379 XSETCDR (tem
, make_number (PT
+ inserted
));
4383 /* If undo_list was Qt before, keep it that way.
4384 Otherwise start with an empty undo_list. */
4385 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4387 unbind_to (count1
, Qnil
);
4391 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4393 /* If visiting nonexistent file, return nil. */
4395 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4399 Fsignal (Qquit
, Qnil
);
4401 /* ??? Retval needs to be dealt with in all cases consistently. */
4403 val
= Fcons (orig_filename
,
4404 Fcons (make_number (inserted
),
4407 RETURN_UNGCPRO (unbind_to (count
, val
));
4410 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4413 build_annotations_unwind (Lisp_Object arg
)
4415 Vwrite_region_annotation_buffers
= arg
;
4419 /* Decide the coding-system to encode the data with. */
4422 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4423 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4424 struct coding_system
*coding
)
4427 Lisp_Object eol_parent
= Qnil
;
4430 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4431 BVAR (current_buffer
, auto_save_file_name
))))
4436 else if (!NILP (Vcoding_system_for_write
))
4438 val
= Vcoding_system_for_write
;
4439 if (coding_system_require_warning
4440 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4441 /* Confirm that VAL can surely encode the current region. */
4442 val
= call5 (Vselect_safe_coding_system_function
,
4443 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4448 /* If the variable `buffer-file-coding-system' is set locally,
4449 it means that the file was read with some kind of code
4450 conversion or the variable is explicitly set by users. We
4451 had better write it out with the same coding system even if
4452 `enable-multibyte-characters' is nil.
4454 If it is not set locally, we anyway have to convert EOL
4455 format if the default value of `buffer-file-coding-system'
4456 tells that it is not Unix-like (LF only) format. */
4457 bool using_default_coding
= 0;
4458 bool force_raw_text
= 0;
4460 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4462 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4465 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4471 /* Check file-coding-system-alist. */
4472 Lisp_Object args
[7], coding_systems
;
4474 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4475 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4477 coding_systems
= Ffind_operation_coding_system (7, args
);
4478 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4479 val
= XCDR (coding_systems
);
4484 /* If we still have not decided a coding system, use the
4485 default value of buffer-file-coding-system. */
4486 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4487 using_default_coding
= 1;
4490 if (! NILP (val
) && ! force_raw_text
)
4492 Lisp_Object spec
, attrs
;
4494 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4495 attrs
= AREF (spec
, 0);
4496 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4501 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4502 /* Confirm that VAL can surely encode the current region. */
4503 val
= call5 (Vselect_safe_coding_system_function
,
4504 start
, end
, val
, Qnil
, filename
);
4506 /* If the decided coding-system doesn't specify end-of-line
4507 format, we use that of
4508 `default-buffer-file-coding-system'. */
4509 if (! using_default_coding
4510 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4511 val
= (coding_inherit_eol_type
4512 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4514 /* If we decide not to encode text, use `raw-text' or one of its
4517 val
= raw_text_coding_system (val
);
4520 val
= coding_inherit_eol_type (val
, eol_parent
);
4521 setup_coding_system (val
, coding
);
4523 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4524 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4528 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4529 "r\nFWrite region to file: \ni\ni\ni\np",
4530 doc
: /* Write current region into specified file.
4531 When called from a program, requires three arguments:
4532 START, END and FILENAME. START and END are normally buffer positions
4533 specifying the part of the buffer to write.
4534 If START is nil, that means to use the entire buffer contents.
4535 If START is a string, then output that string to the file
4536 instead of any buffer contents; END is ignored.
4538 Optional fourth argument APPEND if non-nil means
4539 append to existing file contents (if any). If it is an integer,
4540 seek to that offset in the file before writing.
4541 Optional fifth argument VISIT, if t or a string, means
4542 set the last-save-file-modtime of buffer to this file's modtime
4543 and mark buffer not modified.
4544 If VISIT is a string, it is a second file name;
4545 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4546 VISIT is also the file name to lock and unlock for clash detection.
4547 If VISIT is neither t nor nil nor a string,
4548 that means do not display the \"Wrote file\" message.
4549 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4550 use for locking and unlocking, overriding FILENAME and VISIT.
4551 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4552 for an existing file with the same name. If MUSTBENEW is `excl',
4553 that means to get an error if the file already exists; never overwrite.
4554 If MUSTBENEW is neither nil nor `excl', that means ask for
4555 confirmation before overwriting, but do go ahead and overwrite the file
4556 if the user confirms.
4558 This does code conversion according to the value of
4559 `coding-system-for-write', `buffer-file-coding-system', or
4560 `file-coding-system-alist', and sets the variable
4561 `last-coding-system-used' to the coding system actually used.
4563 This calls `write-region-annotate-functions' at the start, and
4564 `write-region-post-annotation-function' at the end. */)
4565 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4573 ptrdiff_t count
= SPECPDL_INDEX ();
4575 Lisp_Object handler
;
4576 Lisp_Object visit_file
;
4577 Lisp_Object annotations
;
4578 Lisp_Object encoded_filename
;
4579 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4580 bool quietly
= !NILP (visit
);
4581 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4582 struct buffer
*given_buffer
;
4583 struct coding_system coding
;
4585 if (current_buffer
->base_buffer
&& visiting
)
4586 error ("Cannot do file visiting in an indirect buffer");
4588 if (!NILP (start
) && !STRINGP (start
))
4589 validate_region (&start
, &end
);
4592 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4594 filename
= Fexpand_file_name (filename
, Qnil
);
4596 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4597 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4599 if (STRINGP (visit
))
4600 visit_file
= Fexpand_file_name (visit
, Qnil
);
4602 visit_file
= filename
;
4604 if (NILP (lockname
))
4605 lockname
= visit_file
;
4609 /* If the file name has special constructs in it,
4610 call the corresponding file handler. */
4611 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4612 /* If FILENAME has no handler, see if VISIT has one. */
4613 if (NILP (handler
) && STRINGP (visit
))
4614 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4616 if (!NILP (handler
))
4619 val
= call6 (handler
, Qwrite_region
, start
, end
,
4620 filename
, append
, visit
);
4624 SAVE_MODIFF
= MODIFF
;
4625 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4626 bset_filename (current_buffer
, visit_file
);
4632 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4634 /* Special kludge to simplify auto-saving. */
4637 /* Do it later, so write-region-annotate-function can work differently
4638 if we save "the buffer" vs "a region".
4639 This is useful in tar-mode. --Stef
4640 XSETFASTINT (start, BEG);
4641 XSETFASTINT (end, Z); */
4645 record_unwind_protect (build_annotations_unwind
,
4646 Vwrite_region_annotation_buffers
);
4647 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4648 count1
= SPECPDL_INDEX ();
4650 given_buffer
= current_buffer
;
4652 if (!STRINGP (start
))
4654 annotations
= build_annotations (start
, end
);
4656 if (current_buffer
!= given_buffer
)
4658 XSETFASTINT (start
, BEGV
);
4659 XSETFASTINT (end
, ZV
);
4665 XSETFASTINT (start
, BEGV
);
4666 XSETFASTINT (end
, ZV
);
4671 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4673 /* Decide the coding-system to encode the data with.
4674 We used to make this choice before calling build_annotations, but that
4675 leads to problems when a write-annotate-function takes care of
4676 unsavable chars (as was the case with X-Symbol). */
4677 Vlast_coding_system_used
4678 = choose_write_coding_system (start
, end
, filename
,
4679 append
, visit
, lockname
, &coding
);
4681 #ifdef CLASH_DETECTION
4683 lock_file (lockname
);
4684 #endif /* CLASH_DETECTION */
4686 encoded_filename
= ENCODE_FILE (filename
);
4688 fn
= SSDATA (encoded_filename
);
4692 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4693 #else /* not DOS_NT */
4694 desc
= emacs_open (fn
, O_WRONLY
, 0);
4695 #endif /* not DOS_NT */
4697 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4699 desc
= emacs_open (fn
,
4700 O_WRONLY
| O_CREAT
| O_BINARY
4701 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4702 S_IREAD
| S_IWRITE
);
4703 #else /* not DOS_NT */
4704 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4705 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4706 auto_saving
? auto_save_mode_bits
: 0666);
4707 #endif /* not DOS_NT */
4711 #ifdef CLASH_DETECTION
4713 if (!auto_saving
) unlock_file (lockname
);
4715 #endif /* CLASH_DETECTION */
4717 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4720 record_unwind_protect (close_file_unwind
, make_number (desc
));
4722 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4726 if (NUMBERP (append
))
4727 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4729 ret
= lseek (desc
, 0, SEEK_END
);
4732 #ifdef CLASH_DETECTION
4734 if (!auto_saving
) unlock_file (lockname
);
4736 #endif /* CLASH_DETECTION */
4738 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4746 if (STRINGP (start
))
4747 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4748 else if (XINT (start
) != XINT (end
))
4749 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4750 &annotations
, &coding
);
4753 /* If file was empty, still need to write the annotations. */
4754 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4755 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4759 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4760 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4762 /* We have to flush out a data. */
4763 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4764 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4771 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4772 Disk full in NFS may be reported here. */
4773 /* mib says that closing the file will try to write as fast as NFS can do
4774 it, and that means the fsync here is not crucial for autosave files. */
4775 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4777 /* If fsync fails with EINTR, don't treat that as serious. Also
4778 ignore EINVAL which happens when fsync is not supported on this
4780 if (errno
!= EINTR
&& errno
!= EINVAL
)
4781 ok
= 0, save_errno
= errno
;
4785 modtime
= invalid_emacs_time ();
4788 if (fstat (desc
, &st
) == 0)
4789 modtime
= get_stat_mtime (&st
);
4791 ok
= 0, save_errno
= errno
;
4794 /* NFS can report a write failure now. */
4795 if (emacs_close (desc
) < 0)
4796 ok
= 0, save_errno
= errno
;
4798 /* Discard the unwind protect for close_file_unwind. */
4799 specpdl_ptr
= specpdl
+ count1
;
4801 /* Call write-region-post-annotation-function. */
4802 while (CONSP (Vwrite_region_annotation_buffers
))
4804 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4805 if (!NILP (Fbuffer_live_p (buf
)))
4808 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4809 call0 (Vwrite_region_post_annotation_function
);
4811 Vwrite_region_annotation_buffers
4812 = XCDR (Vwrite_region_annotation_buffers
);
4815 unbind_to (count
, Qnil
);
4817 #ifdef CLASH_DETECTION
4819 unlock_file (lockname
);
4820 #endif /* CLASH_DETECTION */
4822 /* Do this before reporting IO error
4823 to avoid a "file has changed on disk" warning on
4824 next attempt to save. */
4825 if (EMACS_TIME_VALID_P (modtime
))
4827 current_buffer
->modtime
= modtime
;
4828 current_buffer
->modtime_size
= st
.st_size
;
4832 error ("IO error writing %s: %s", SDATA (filename
),
4833 emacs_strerror (save_errno
));
4837 SAVE_MODIFF
= MODIFF
;
4838 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4839 bset_filename (current_buffer
, visit_file
);
4840 update_mode_lines
++;
4845 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4846 BVAR (current_buffer
, auto_save_file_name
))))
4847 SAVE_MODIFF
= MODIFF
;
4853 message_with_string ((INTEGERP (append
)
4863 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4865 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4866 doc
: /* Return t if (car A) is numerically less than (car B). */)
4867 (Lisp_Object a
, Lisp_Object b
)
4869 return Flss (Fcar (a
), Fcar (b
));
4872 /* Build the complete list of annotations appropriate for writing out
4873 the text between START and END, by calling all the functions in
4874 write-region-annotate-functions and merging the lists they return.
4875 If one of these functions switches to a different buffer, we assume
4876 that buffer contains altered text. Therefore, the caller must
4877 make sure to restore the current buffer in all cases,
4878 as save-excursion would do. */
4881 build_annotations (Lisp_Object start
, Lisp_Object end
)
4883 Lisp_Object annotations
;
4885 struct gcpro gcpro1
, gcpro2
;
4886 Lisp_Object original_buffer
;
4888 bool used_global
= 0;
4890 XSETBUFFER (original_buffer
, current_buffer
);
4893 p
= Vwrite_region_annotate_functions
;
4894 GCPRO2 (annotations
, p
);
4897 struct buffer
*given_buffer
= current_buffer
;
4898 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4899 { /* Use the global value of the hook. */
4902 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4904 p
= Fappend (2, arg
);
4907 Vwrite_region_annotations_so_far
= annotations
;
4908 res
= call2 (XCAR (p
), start
, end
);
4909 /* If the function makes a different buffer current,
4910 assume that means this buffer contains altered text to be output.
4911 Reset START and END from the buffer bounds
4912 and discard all previous annotations because they should have
4913 been dealt with by this function. */
4914 if (current_buffer
!= given_buffer
)
4916 Vwrite_region_annotation_buffers
4917 = Fcons (Fcurrent_buffer (),
4918 Vwrite_region_annotation_buffers
);
4919 XSETFASTINT (start
, BEGV
);
4920 XSETFASTINT (end
, ZV
);
4923 Flength (res
); /* Check basic validity of return value */
4924 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4928 /* Now do the same for annotation functions implied by the file-format */
4929 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4930 p
= BVAR (current_buffer
, auto_save_file_format
);
4932 p
= BVAR (current_buffer
, file_format
);
4933 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4935 struct buffer
*given_buffer
= current_buffer
;
4937 Vwrite_region_annotations_so_far
= annotations
;
4939 /* Value is either a list of annotations or nil if the function
4940 has written annotations to a temporary buffer, which is now
4942 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4943 original_buffer
, make_number (i
));
4944 if (current_buffer
!= given_buffer
)
4946 XSETFASTINT (start
, BEGV
);
4947 XSETFASTINT (end
, ZV
);
4952 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4960 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4961 If STRING is nil, POS is the character position in the current buffer.
4962 Intersperse with them the annotations from *ANNOT
4963 which fall within the range of POS to POS + NCHARS,
4964 each at its appropriate position.
4966 We modify *ANNOT by discarding elements as we use them up.
4968 Return true if successful. */
4971 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
4972 ptrdiff_t nchars
, Lisp_Object
*annot
,
4973 struct coding_system
*coding
)
4977 ptrdiff_t lastpos
= pos
+ nchars
;
4979 while (NILP (*annot
) || CONSP (*annot
))
4981 tem
= Fcar_safe (Fcar (*annot
));
4984 nextpos
= XFASTINT (tem
);
4986 /* If there are no more annotations in this range,
4987 output the rest of the range all at once. */
4988 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4989 return e_write (desc
, string
, pos
, lastpos
, coding
);
4991 /* Output buffer text up to the next annotation's position. */
4994 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
4998 /* Output the annotation. */
4999 tem
= Fcdr (Fcar (*annot
));
5002 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5005 *annot
= Fcdr (*annot
);
5011 /* Write text in the range START and END into descriptor DESC,
5012 encoding them with coding system CODING. If STRING is nil, START
5013 and END are character positions of the current buffer, else they
5014 are indexes to the string STRING. Return true if successful. */
5017 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5018 struct coding_system
*coding
)
5020 if (STRINGP (string
))
5023 end
= SCHARS (string
);
5026 /* We used to have a code for handling selective display here. But,
5027 now it is handled within encode_coding. */
5031 if (STRINGP (string
))
5033 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5034 if (CODING_REQUIRE_ENCODING (coding
))
5036 encode_coding_object (coding
, string
,
5037 start
, string_char_to_byte (string
, start
),
5038 end
, string_char_to_byte (string
, end
), Qt
);
5042 coding
->dst_object
= string
;
5043 coding
->consumed_char
= SCHARS (string
);
5044 coding
->produced
= SBYTES (string
);
5049 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5050 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5052 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5053 if (CODING_REQUIRE_ENCODING (coding
))
5055 encode_coding_object (coding
, Fcurrent_buffer (),
5056 start
, start_byte
, end
, end_byte
, Qt
);
5060 coding
->dst_object
= Qnil
;
5061 coding
->dst_pos_byte
= start_byte
;
5062 if (start
>= GPT
|| end
<= GPT
)
5064 coding
->consumed_char
= end
- start
;
5065 coding
->produced
= end_byte
- start_byte
;
5069 coding
->consumed_char
= GPT
- start
;
5070 coding
->produced
= GPT_BYTE
- start_byte
;
5075 if (coding
->produced
> 0)
5078 -= emacs_write (desc
,
5079 STRINGP (coding
->dst_object
)
5080 ? SSDATA (coding
->dst_object
)
5081 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5084 if (coding
->produced
)
5087 start
+= coding
->consumed_char
;
5093 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5094 Sverify_visited_file_modtime
, 0, 1, 0,
5095 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5096 This means that the file has not been changed since it was visited or saved.
5097 If BUF is omitted or nil, it defaults to the current buffer.
5098 See Info node `(elisp)Modification Time' for more details. */)
5103 Lisp_Object handler
;
5104 Lisp_Object filename
;
5115 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5116 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5118 /* If the file name has special constructs in it,
5119 call the corresponding file handler. */
5120 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5121 Qverify_visited_file_modtime
);
5122 if (!NILP (handler
))
5123 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5125 filename
= ENCODE_FILE (BVAR (b
, filename
));
5127 mtime
= (stat (SSDATA (filename
), &st
) == 0
5128 ? get_stat_mtime (&st
)
5129 : time_error_value (errno
));
5130 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5131 && (b
->modtime_size
< 0
5132 || st
.st_size
== b
->modtime_size
))
5137 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5138 Sclear_visited_file_modtime
, 0, 0, 0,
5139 doc
: /* Clear out records of last mod time of visited file.
5140 Next attempt to save will certainly not complain of a discrepancy. */)
5143 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5144 current_buffer
->modtime_size
= -1;
5148 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5149 Svisited_file_modtime
, 0, 0, 0,
5150 doc
: /* Return the current buffer's recorded visited file modification time.
5151 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5152 `file-attributes' returns. If the current buffer has no recorded file
5153 modification time, this function returns 0. If the visited file
5154 doesn't exist, HIGH will be -1.
5155 See Info node `(elisp)Modification Time' for more details. */)
5158 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5160 if (EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
5162 /* make_lisp_time won't work here if time_t is unsigned. */
5163 return list4 (make_number (-1), make_number (65535),
5164 make_number (0), make_number (0));
5166 return make_number (0);
5168 return make_lisp_time (current_buffer
->modtime
);
5171 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5172 Sset_visited_file_modtime
, 0, 1, 0,
5173 doc
: /* Update buffer's recorded modification time from the visited file's time.
5174 Useful if the buffer was not read from the file normally
5175 or if the file itself has been changed for some known benign reason.
5176 An argument specifies the modification time value to use
5177 \(instead of that of the visited file), in the form of a list
5178 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5179 (Lisp_Object time_list
)
5181 if (!NILP (time_list
))
5183 current_buffer
->modtime
= lisp_time_argument (time_list
);
5184 current_buffer
->modtime_size
= -1;
5188 register Lisp_Object filename
;
5190 Lisp_Object handler
;
5192 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5194 /* If the file name has special constructs in it,
5195 call the corresponding file handler. */
5196 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5197 if (!NILP (handler
))
5198 /* The handler can find the file name the same way we did. */
5199 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5201 filename
= ENCODE_FILE (filename
);
5203 if (stat (SSDATA (filename
), &st
) >= 0)
5205 current_buffer
->modtime
= get_stat_mtime (&st
);
5206 current_buffer
->modtime_size
= st
.st_size
;
5214 auto_save_error (Lisp_Object error_val
)
5216 Lisp_Object args
[3], msg
;
5218 struct gcpro gcpro1
;
5222 auto_save_error_occurred
= 1;
5224 ring_bell (XFRAME (selected_frame
));
5226 args
[0] = build_string ("Auto-saving %s: %s");
5227 args
[1] = BVAR (current_buffer
, name
);
5228 args
[2] = Ferror_message_string (error_val
);
5229 msg
= Fformat (3, args
);
5231 nbytes
= SBYTES (msg
);
5232 msgbuf
= SAFE_ALLOCA (nbytes
);
5233 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5235 for (i
= 0; i
< 3; ++i
)
5238 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5240 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5241 Fsleep_for (make_number (1), Qnil
);
5255 auto_save_mode_bits
= 0666;
5257 /* Get visited file's mode to become the auto save file's mode. */
5258 if (! NILP (BVAR (current_buffer
, filename
)))
5260 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5261 /* But make sure we can overwrite it later! */
5262 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5263 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5265 /* Remote files don't cooperate with stat. */
5266 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5270 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5271 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5276 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5279 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5291 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5294 minibuffer_auto_raise
= XINT (value
);
5299 do_auto_save_make_dir (Lisp_Object dir
)
5303 auto_saving_dir_umask
= 077;
5304 result
= call2 (Qmake_directory
, dir
, Qt
);
5305 auto_saving_dir_umask
= 0;
5310 do_auto_save_eh (Lisp_Object ignore
)
5312 auto_saving_dir_umask
= 0;
5316 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5317 doc
: /* Auto-save all buffers that need it.
5318 This is all buffers that have auto-saving enabled
5319 and are changed since last auto-saved.
5320 Auto-saving writes the buffer into a file
5321 so that your editing is not lost if the system crashes.
5322 This file is not the file you visited; that changes only when you save.
5323 Normally we run the normal hook `auto-save-hook' before saving.
5325 A non-nil NO-MESSAGE argument means do not print any message if successful.
5326 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5327 (Lisp_Object no_message
, Lisp_Object current_only
)
5329 struct buffer
*old
= current_buffer
, *b
;
5330 Lisp_Object tail
, buf
, hook
;
5331 bool auto_saved
= 0;
5332 int do_handled_files
;
5334 FILE *stream
= NULL
;
5335 ptrdiff_t count
= SPECPDL_INDEX ();
5336 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5337 bool old_message_p
= 0;
5338 struct gcpro gcpro1
, gcpro2
;
5340 if (max_specpdl_size
< specpdl_size
+ 40)
5341 max_specpdl_size
= specpdl_size
+ 40;
5346 if (NILP (no_message
))
5348 old_message_p
= push_message ();
5349 record_unwind_protect (pop_message_unwind
, Qnil
);
5352 /* Ordinarily don't quit within this function,
5353 but don't make it impossible to quit (in case we get hung in I/O). */
5357 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5358 point to non-strings reached from Vbuffer_alist. */
5360 hook
= intern ("auto-save-hook");
5361 Frun_hooks (1, &hook
);
5363 if (STRINGP (Vauto_save_list_file_name
))
5365 Lisp_Object listfile
;
5367 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5369 /* Don't try to create the directory when shutting down Emacs,
5370 because creating the directory might signal an error, and
5371 that would leave Emacs in a strange state. */
5372 if (!NILP (Vrun_hooks
))
5376 GCPRO2 (dir
, listfile
);
5377 dir
= Ffile_name_directory (listfile
);
5378 if (NILP (Ffile_directory_p (dir
)))
5379 internal_condition_case_1 (do_auto_save_make_dir
,
5385 stream
= fopen (SSDATA (listfile
), "w");
5388 record_unwind_protect (do_auto_save_unwind
,
5389 make_save_value (stream
, 0));
5390 record_unwind_protect (do_auto_save_unwind_1
,
5391 make_number (minibuffer_auto_raise
));
5392 minibuffer_auto_raise
= 0;
5394 auto_save_error_occurred
= 0;
5396 /* On first pass, save all files that don't have handlers.
5397 On second pass, save all files that do have handlers.
5399 If Emacs is crashing, the handlers may tweak what is causing
5400 Emacs to crash in the first place, and it would be a shame if
5401 Emacs failed to autosave perfectly ordinary files because it
5402 couldn't handle some ange-ftp'd file. */
5404 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5405 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5407 buf
= XCDR (XCAR (tail
));
5410 /* Record all the buffers that have auto save mode
5411 in the special file that lists them. For each of these buffers,
5412 Record visited name (if any) and auto save name. */
5413 if (STRINGP (BVAR (b
, auto_save_file_name
))
5414 && stream
!= NULL
&& do_handled_files
== 0)
5417 if (!NILP (BVAR (b
, filename
)))
5419 fwrite (SDATA (BVAR (b
, filename
)), 1,
5420 SBYTES (BVAR (b
, filename
)), stream
);
5422 putc ('\n', stream
);
5423 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5424 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5425 putc ('\n', stream
);
5429 if (!NILP (current_only
)
5430 && b
!= current_buffer
)
5433 /* Don't auto-save indirect buffers.
5434 The base buffer takes care of it. */
5438 /* Check for auto save enabled
5439 and file changed since last auto save
5440 and file changed since last real save. */
5441 if (STRINGP (BVAR (b
, auto_save_file_name
))
5442 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5443 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5444 /* -1 means we've turned off autosaving for a while--see below. */
5445 && XINT (BVAR (b
, save_length
)) >= 0
5446 && (do_handled_files
5447 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5450 EMACS_TIME before_time
= current_emacs_time ();
5451 EMACS_TIME after_time
;
5453 /* If we had a failure, don't try again for 20 minutes. */
5454 if (b
->auto_save_failure_time
> 0
5455 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5458 set_buffer_internal (b
);
5459 if (NILP (Vauto_save_include_big_deletions
)
5460 && (XFASTINT (BVAR (b
, save_length
)) * 10
5461 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5462 /* A short file is likely to change a large fraction;
5463 spare the user annoying messages. */
5464 && XFASTINT (BVAR (b
, save_length
)) > 5000
5465 /* These messages are frequent and annoying for `*mail*'. */
5466 && !EQ (BVAR (b
, filename
), Qnil
)
5467 && NILP (no_message
))
5469 /* It has shrunk too much; turn off auto-saving here. */
5470 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5471 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5473 minibuffer_auto_raise
= 0;
5474 /* Turn off auto-saving until there's a real save,
5475 and prevent any more warnings. */
5476 XSETINT (BVAR (b
, save_length
), -1);
5477 Fsleep_for (make_number (1), Qnil
);
5480 if (!auto_saved
&& NILP (no_message
))
5481 message1 ("Auto-saving...");
5482 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5484 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5485 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5486 set_buffer_internal (old
);
5488 after_time
= current_emacs_time ();
5490 /* If auto-save took more than 60 seconds,
5491 assume it was an NFS failure that got a timeout. */
5492 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5493 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5497 /* Prevent another auto save till enough input events come in. */
5498 record_auto_save ();
5500 if (auto_saved
&& NILP (no_message
))
5504 /* If we are going to restore an old message,
5505 give time to read ours. */
5506 sit_for (make_number (1), 0, 0);
5509 else if (!auto_save_error_occurred
)
5510 /* Don't overwrite the error message if an error occurred.
5511 If we displayed a message and then restored a state
5512 with no message, leave a "done" message on the screen. */
5513 message1 ("Auto-saving...done");
5518 /* This restores the message-stack status. */
5519 unbind_to (count
, Qnil
);
5523 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5524 Sset_buffer_auto_saved
, 0, 0, 0,
5525 doc
: /* Mark current buffer as auto-saved with its current text.
5526 No auto-save file will be written until the buffer changes again. */)
5529 /* FIXME: This should not be called in indirect buffers, since
5530 they're not autosaved. */
5531 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5532 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5533 current_buffer
->auto_save_failure_time
= 0;
5537 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5538 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5539 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5542 current_buffer
->auto_save_failure_time
= 0;
5546 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5548 doc
: /* Return t if current buffer has been auto-saved recently.
5549 More precisely, if it has been auto-saved since last read from or saved
5550 in the visited file. If the buffer has no visited file,
5551 then any auto-save counts as "recent". */)
5554 /* FIXME: maybe we should return nil for indirect buffers since
5555 they're never autosaved. */
5556 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5559 /* Reading and completing file names */
5561 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5562 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5563 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5564 The return value is only relevant for a call to `read-file-name' that happens
5565 before any other event (mouse or keypress) is handled. */)
5568 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5569 || defined (HAVE_NS)
5570 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5580 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5582 struct gcpro gcpro1
;
5583 Lisp_Object args
[7];
5585 GCPRO1 (default_filename
);
5586 args
[0] = intern ("read-file-name");
5589 args
[3] = default_filename
;
5590 args
[4] = mustmatch
;
5592 args
[6] = predicate
;
5593 RETURN_UNGCPRO (Ffuncall (7, args
));
5598 syms_of_fileio (void)
5600 DEFSYM (Qoperations
, "operations");
5601 DEFSYM (Qexpand_file_name
, "expand-file-name");
5602 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5603 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5604 DEFSYM (Qfile_name_directory
, "file-name-directory");
5605 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5606 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5607 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5608 DEFSYM (Qcopy_file
, "copy-file");
5609 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5610 DEFSYM (Qmake_directory
, "make-directory");
5611 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5612 DEFSYM (Qdelete_file
, "delete-file");
5613 DEFSYM (Qrename_file
, "rename-file");
5614 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5615 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5616 DEFSYM (Qfile_exists_p
, "file-exists-p");
5617 DEFSYM (Qfile_executable_p
, "file-executable-p");
5618 DEFSYM (Qfile_readable_p
, "file-readable-p");
5619 DEFSYM (Qfile_writable_p
, "file-writable-p");
5620 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5621 DEFSYM (Qaccess_file
, "access-file");
5622 DEFSYM (Qfile_directory_p
, "file-directory-p");
5623 DEFSYM (Qfile_regular_p
, "file-regular-p");
5624 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5625 DEFSYM (Qfile_modes
, "file-modes");
5626 DEFSYM (Qset_file_modes
, "set-file-modes");
5627 DEFSYM (Qset_file_times
, "set-file-times");
5628 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5629 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5630 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5631 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5632 DEFSYM (Qwrite_region
, "write-region");
5633 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5634 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5635 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5637 DEFSYM (Qfile_name_history
, "file-name-history");
5638 Fset (Qfile_name_history
, Qnil
);
5640 DEFSYM (Qfile_error
, "file-error");
5641 DEFSYM (Qfile_already_exists
, "file-already-exists");
5642 DEFSYM (Qfile_date_error
, "file-date-error");
5643 DEFSYM (Qexcl
, "excl");
5645 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5646 doc
: /* Coding system for encoding file names.
5647 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5648 Vfile_name_coding_system
= Qnil
;
5650 DEFVAR_LISP ("default-file-name-coding-system",
5651 Vdefault_file_name_coding_system
,
5652 doc
: /* Default coding system for encoding file names.
5653 This variable is used only when `file-name-coding-system' is nil.
5655 This variable is set/changed by the command `set-language-environment'.
5656 User should not set this variable manually,
5657 instead use `file-name-coding-system' to get a constant encoding
5658 of file names regardless of the current language environment. */);
5659 Vdefault_file_name_coding_system
= Qnil
;
5661 DEFSYM (Qformat_decode
, "format-decode");
5662 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5663 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5664 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5666 Fput (Qfile_error
, Qerror_conditions
,
5667 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5668 Fput (Qfile_error
, Qerror_message
,
5669 build_pure_c_string ("File error"));
5671 Fput (Qfile_already_exists
, Qerror_conditions
,
5672 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5673 Fput (Qfile_already_exists
, Qerror_message
,
5674 build_pure_c_string ("File already exists"));
5676 Fput (Qfile_date_error
, Qerror_conditions
,
5677 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5678 Fput (Qfile_date_error
, Qerror_message
,
5679 build_pure_c_string ("Cannot set file date"));
5681 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5682 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5683 If a file name matches REGEXP, all I/O on that file is done by calling
5684 HANDLER. If a file name matches more than one handler, the handler
5685 whose match starts last in the file name gets precedence. The
5686 function `find-file-name-handler' checks this list for a handler for
5689 HANDLER should be a function. The first argument given to it is the
5690 name of the I/O primitive to be handled; the remaining arguments are
5691 the arguments that were passed to that primitive. For example, if you
5692 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5693 HANDLER is called like this:
5695 (funcall HANDLER 'file-exists-p FILENAME)
5697 Note that HANDLER must be able to handle all I/O primitives; if it has
5698 nothing special to do for a primitive, it should reinvoke the
5699 primitive to handle the operation \"the usual way\".
5700 See Info node `(elisp)Magic File Names' for more details. */);
5701 Vfile_name_handler_alist
= Qnil
;
5703 DEFVAR_LISP ("set-auto-coding-function",
5704 Vset_auto_coding_function
,
5705 doc
: /* If non-nil, a function to call to decide a coding system of file.
5706 Two arguments are passed to this function: the file name
5707 and the length of a file contents following the point.
5708 This function should return a coding system to decode the file contents.
5709 It should check the file name against `auto-coding-alist'.
5710 If no coding system is decided, it should check a coding system
5711 specified in the heading lines with the format:
5712 -*- ... coding: CODING-SYSTEM; ... -*-
5713 or local variable spec of the tailing lines with `coding:' tag. */);
5714 Vset_auto_coding_function
= Qnil
;
5716 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5717 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5718 Each is passed one argument, the number of characters inserted,
5719 with point at the start of the inserted text. Each function
5720 should leave point the same, and return the new character count.
5721 If `insert-file-contents' is intercepted by a handler from
5722 `file-name-handler-alist', that handler is responsible for calling the
5723 functions in `after-insert-file-functions' if appropriate. */);
5724 Vafter_insert_file_functions
= Qnil
;
5726 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5727 doc
: /* A list of functions to be called at the start of `write-region'.
5728 Each is passed two arguments, START and END as for `write-region'.
5729 These are usually two numbers but not always; see the documentation
5730 for `write-region'. The function should return a list of pairs
5731 of the form (POSITION . STRING), consisting of strings to be effectively
5732 inserted at the specified positions of the file being written (1 means to
5733 insert before the first byte written). The POSITIONs must be sorted into
5736 If there are several annotation functions, the lists returned by these
5737 functions are merged destructively. As each annotation function runs,
5738 the variable `write-region-annotations-so-far' contains a list of all
5739 annotations returned by previous annotation functions.
5741 An annotation function can return with a different buffer current.
5742 Doing so removes the annotations returned by previous functions, and
5743 resets START and END to `point-min' and `point-max' of the new buffer.
5745 After `write-region' completes, Emacs calls the function stored in
5746 `write-region-post-annotation-function', once for each buffer that was
5747 current when building the annotations (i.e., at least once), with that
5748 buffer current. */);
5749 Vwrite_region_annotate_functions
= Qnil
;
5750 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5752 DEFVAR_LISP ("write-region-post-annotation-function",
5753 Vwrite_region_post_annotation_function
,
5754 doc
: /* Function to call after `write-region' completes.
5755 The function is called with no arguments. If one or more of the
5756 annotation functions in `write-region-annotate-functions' changed the
5757 current buffer, the function stored in this variable is called for
5758 each of those additional buffers as well, in addition to the original
5759 buffer. The relevant buffer is current during each function call. */);
5760 Vwrite_region_post_annotation_function
= Qnil
;
5761 staticpro (&Vwrite_region_annotation_buffers
);
5763 DEFVAR_LISP ("write-region-annotations-so-far",
5764 Vwrite_region_annotations_so_far
,
5765 doc
: /* When an annotation function is called, this holds the previous annotations.
5766 These are the annotations made by other annotation functions
5767 that were already called. See also `write-region-annotate-functions'. */);
5768 Vwrite_region_annotations_so_far
= Qnil
;
5770 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5771 doc
: /* A list of file name handlers that temporarily should not be used.
5772 This applies only to the operation `inhibit-file-name-operation'. */);
5773 Vinhibit_file_name_handlers
= Qnil
;
5775 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5776 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5777 Vinhibit_file_name_operation
= Qnil
;
5779 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5780 doc
: /* File name in which we write a list of all auto save file names.
5781 This variable is initialized automatically from `auto-save-list-file-prefix'
5782 shortly after Emacs reads your init file, if you have not yet given it
5783 a non-nil value. */);
5784 Vauto_save_list_file_name
= Qnil
;
5786 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5787 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5788 Normally auto-save files are written under other names. */);
5789 Vauto_save_visited_file_name
= Qnil
;
5791 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5792 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5793 If nil, deleting a substantial portion of the text disables auto-save
5794 in the buffer; this is the default behavior, because the auto-save
5795 file is usually more useful if it contains the deleted text. */);
5796 Vauto_save_include_big_deletions
= Qnil
;
5799 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5800 doc
: /* Non-nil means don't call fsync in `write-region'.
5801 This variable affects calls to `write-region' as well as save commands.
5802 A non-nil value may result in data loss! */);
5803 write_region_inhibit_fsync
= 0;
5806 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5807 doc
: /* Specifies whether to use the system's trash can.
5808 When non-nil, certain file deletion commands use the function
5809 `move-file-to-trash' instead of deleting files outright.
5810 This includes interactive calls to `delete-file' and
5811 `delete-directory' and the Dired deletion commands. */);
5812 delete_by_moving_to_trash
= 0;
5813 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5815 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5816 DEFSYM (Qcopy_directory
, "copy-directory");
5817 DEFSYM (Qdelete_directory
, "delete-directory");
5819 defsubr (&Sfind_file_name_handler
);
5820 defsubr (&Sfile_name_directory
);
5821 defsubr (&Sfile_name_nondirectory
);
5822 defsubr (&Sunhandled_file_name_directory
);
5823 defsubr (&Sfile_name_as_directory
);
5824 defsubr (&Sdirectory_file_name
);
5825 defsubr (&Smake_temp_name
);
5826 defsubr (&Sexpand_file_name
);
5827 defsubr (&Ssubstitute_in_file_name
);
5828 defsubr (&Scopy_file
);
5829 defsubr (&Smake_directory_internal
);
5830 defsubr (&Sdelete_directory_internal
);
5831 defsubr (&Sdelete_file
);
5832 defsubr (&Srename_file
);
5833 defsubr (&Sadd_name_to_file
);
5834 defsubr (&Smake_symbolic_link
);
5835 defsubr (&Sfile_name_absolute_p
);
5836 defsubr (&Sfile_exists_p
);
5837 defsubr (&Sfile_executable_p
);
5838 defsubr (&Sfile_readable_p
);
5839 defsubr (&Sfile_writable_p
);
5840 defsubr (&Saccess_file
);
5841 defsubr (&Sfile_symlink_p
);
5842 defsubr (&Sfile_directory_p
);
5843 defsubr (&Sfile_accessible_directory_p
);
5844 defsubr (&Sfile_regular_p
);
5845 defsubr (&Sfile_modes
);
5846 defsubr (&Sset_file_modes
);
5847 defsubr (&Sset_file_times
);
5848 defsubr (&Sfile_selinux_context
);
5849 defsubr (&Sset_file_selinux_context
);
5850 defsubr (&Sset_default_file_modes
);
5851 defsubr (&Sdefault_file_modes
);
5852 defsubr (&Sfile_newer_than_file_p
);
5853 defsubr (&Sinsert_file_contents
);
5854 defsubr (&Swrite_region
);
5855 defsubr (&Scar_less_than_car
);
5856 defsubr (&Sverify_visited_file_modtime
);
5857 defsubr (&Sclear_visited_file_modtime
);
5858 defsubr (&Svisited_file_modtime
);
5859 defsubr (&Sset_visited_file_modtime
);
5860 defsubr (&Sdo_auto_save
);
5861 defsubr (&Sset_buffer_auto_saved
);
5862 defsubr (&Sclear_buffer_auto_save_failure
);
5863 defsubr (&Srecent_auto_save_p
);
5865 defsubr (&Snext_read_file_uses_dialog_p
);
5868 defsubr (&Sunix_sync
);