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
= (struct passwd
*) 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
))
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
;
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 bool input_file_statable_p
;
1910 Lisp_Object encoded_file
, encoded_newname
;
1912 security_context_t con
;
1916 encoded_file
= encoded_newname
= Qnil
;
1917 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1918 CHECK_STRING (file
);
1919 CHECK_STRING (newname
);
1921 if (!NILP (Ffile_directory_p (newname
)))
1922 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1924 newname
= Fexpand_file_name (newname
, Qnil
);
1926 file
= Fexpand_file_name (file
, Qnil
);
1928 /* If the input file name has special constructs in it,
1929 call the corresponding file handler. */
1930 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1931 /* Likewise for output file name. */
1933 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1934 if (!NILP (handler
))
1935 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1936 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1937 preserve_selinux_context
));
1939 encoded_file
= ENCODE_FILE (file
);
1940 encoded_newname
= ENCODE_FILE (newname
);
1942 if (NILP (ok_if_already_exists
)
1943 || INTEGERP (ok_if_already_exists
))
1944 barf_or_query_if_file_exists (newname
, "copy to it",
1945 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1946 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1950 if (!CopyFile (SDATA (encoded_file
),
1951 SDATA (encoded_newname
),
1953 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1954 /* CopyFile retains the timestamp by default. */
1955 else if (NILP (keep_time
))
1961 filename
= SDATA (encoded_newname
);
1963 /* Ensure file is writable while its modified time is set. */
1964 attributes
= GetFileAttributes (filename
);
1965 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1966 now
= current_emacs_time ();
1967 if (set_file_times (-1, filename
, now
, now
))
1969 /* Restore original attributes. */
1970 SetFileAttributes (filename
, attributes
);
1971 xsignal2 (Qfile_date_error
,
1972 build_string ("Cannot set file date"), newname
);
1974 /* Restore original attributes. */
1975 SetFileAttributes (filename
, attributes
);
1977 #else /* not WINDOWSNT */
1979 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1983 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1985 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1987 /* We can only copy regular files and symbolic links. Other files are not
1989 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1992 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1994 conlength
= fgetfilecon (ifd
, &con
);
1995 if (conlength
== -1)
1996 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
2000 if (out_st
.st_mode
!= 0
2001 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2004 report_file_error ("Input and output files are the same",
2005 Fcons (file
, Fcons (newname
, Qnil
)));
2008 if (input_file_statable_p
)
2010 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2012 #if defined (EISDIR)
2013 /* Get a better looking error message. */
2016 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2021 /* System's default file type was set to binary by _fmode in emacs.c. */
2022 ofd
= emacs_open (SDATA (encoded_newname
),
2023 O_WRONLY
| O_TRUNC
| O_CREAT
2024 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2025 S_IREAD
| S_IWRITE
);
2026 #else /* not MSDOS */
2028 mode_t new_mask
= 0666;
2029 if (input_file_statable_p
)
2031 if (!NILP (preserve_uid_gid
))
2033 new_mask
&= st
.st_mode
;
2035 ofd
= emacs_open (SSDATA (encoded_newname
),
2036 (O_WRONLY
| O_TRUNC
| O_CREAT
2037 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2040 #endif /* not MSDOS */
2042 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2044 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2048 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2049 if (emacs_write (ofd
, buf
, n
) != n
)
2050 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2054 /* Preserve the original file modes, and if requested, also its
2056 if (input_file_statable_p
)
2058 mode_t mode_mask
= 07777;
2059 if (!NILP (preserve_uid_gid
))
2061 /* Attempt to change owner and group. If that doesn't work
2062 attempt to change just the group, as that is sometimes allowed.
2063 Adjust the mode mask to eliminate setuid or setgid bits
2064 that are inappropriate if the owner and group are wrong. */
2065 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2067 mode_mask
&= ~06000;
2068 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2072 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2073 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2075 #endif /* not MSDOS */
2080 /* Set the modified context back to the file. */
2081 bool fail
= fsetfilecon (ofd
, con
) != 0;
2082 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2083 if (fail
&& errno
!= ENOTSUP
)
2084 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2090 if (input_file_statable_p
)
2092 if (!NILP (keep_time
))
2094 EMACS_TIME atime
= get_stat_atime (&st
);
2095 EMACS_TIME mtime
= get_stat_mtime (&st
);
2096 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2097 xsignal2 (Qfile_date_error
,
2098 build_string ("Cannot set file date"), newname
);
2102 if (emacs_close (ofd
) < 0)
2103 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2108 if (input_file_statable_p
)
2110 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2111 and if it can't, it tells so. Otherwise, under MSDOS we usually
2112 get only the READ bit, which will make the copied file read-only,
2113 so it's better not to chmod at all. */
2114 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2115 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2118 #endif /* not WINDOWSNT */
2120 /* Discard the unwind protects. */
2121 specpdl_ptr
= specpdl
+ count
;
2127 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2128 Smake_directory_internal
, 1, 1, 0,
2129 doc
: /* Create a new directory named DIRECTORY. */)
2130 (Lisp_Object directory
)
2133 Lisp_Object handler
;
2134 Lisp_Object encoded_dir
;
2136 CHECK_STRING (directory
);
2137 directory
= Fexpand_file_name (directory
, Qnil
);
2139 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2140 if (!NILP (handler
))
2141 return call2 (handler
, Qmake_directory_internal
, directory
);
2143 encoded_dir
= ENCODE_FILE (directory
);
2145 dir
= SSDATA (encoded_dir
);
2148 if (mkdir (dir
) != 0)
2150 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2152 report_file_error ("Creating directory", list1 (directory
));
2157 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2158 Sdelete_directory_internal
, 1, 1, 0,
2159 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2160 (Lisp_Object directory
)
2163 Lisp_Object encoded_dir
;
2165 CHECK_STRING (directory
);
2166 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2167 encoded_dir
= ENCODE_FILE (directory
);
2168 dir
= SSDATA (encoded_dir
);
2170 if (rmdir (dir
) != 0)
2171 report_file_error ("Removing directory", list1 (directory
));
2176 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2177 "(list (read-file-name \
2178 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2179 \"Move file to trash: \" \"Delete file: \") \
2180 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2181 (null current-prefix-arg))",
2182 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2183 If file has multiple names, it continues to exist with the other names.
2184 TRASH non-nil means to trash the file instead of deleting, provided
2185 `delete-by-moving-to-trash' is non-nil.
2187 When called interactively, TRASH is t if no prefix argument is given.
2188 With a prefix argument, TRASH is nil. */)
2189 (Lisp_Object filename
, Lisp_Object trash
)
2191 Lisp_Object handler
;
2192 Lisp_Object encoded_file
;
2193 struct gcpro gcpro1
;
2196 if (!NILP (Ffile_directory_p (filename
))
2197 && NILP (Ffile_symlink_p (filename
)))
2198 xsignal2 (Qfile_error
,
2199 build_string ("Removing old name: is a directory"),
2202 filename
= Fexpand_file_name (filename
, Qnil
);
2204 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2205 if (!NILP (handler
))
2206 return call3 (handler
, Qdelete_file
, filename
, trash
);
2208 if (delete_by_moving_to_trash
&& !NILP (trash
))
2209 return call1 (Qmove_file_to_trash
, filename
);
2211 encoded_file
= ENCODE_FILE (filename
);
2213 if (unlink (SSDATA (encoded_file
)) < 0)
2214 report_file_error ("Removing old name", list1 (filename
));
2219 internal_delete_file_1 (Lisp_Object ignore
)
2224 /* Delete file FILENAME.
2225 This ignores `delete-by-moving-to-trash'. */
2228 internal_delete_file (Lisp_Object filename
)
2230 internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2231 Qt
, internal_delete_file_1
);
2234 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2235 "fRename file: \nGRename %s to file: \np",
2236 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2237 If file has names other than FILE, it continues to have those names.
2238 Signals a `file-already-exists' error if a file NEWNAME already exists
2239 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2240 A number as third arg means request confirmation if NEWNAME already exists.
2241 This is what happens in interactive use with M-x. */)
2242 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2244 Lisp_Object handler
;
2245 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2246 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2248 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2249 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2250 CHECK_STRING (file
);
2251 CHECK_STRING (newname
);
2252 file
= Fexpand_file_name (file
, Qnil
);
2254 if ((!NILP (Ffile_directory_p (newname
)))
2256 /* If the file names are identical but for the case,
2257 don't attempt to move directory to itself. */
2258 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2262 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2263 ? file
: Fdirectory_file_name (file
));
2264 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2267 newname
= Fexpand_file_name (newname
, Qnil
);
2269 /* If the file name has special constructs in it,
2270 call the corresponding file handler. */
2271 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2273 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2274 if (!NILP (handler
))
2275 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2276 file
, newname
, ok_if_already_exists
));
2278 encoded_file
= ENCODE_FILE (file
);
2279 encoded_newname
= ENCODE_FILE (newname
);
2282 /* If the file names are identical but for the case, don't ask for
2283 confirmation: they simply want to change the letter-case of the
2285 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2287 if (NILP (ok_if_already_exists
)
2288 || INTEGERP (ok_if_already_exists
))
2289 barf_or_query_if_file_exists (newname
, "rename to it",
2290 INTEGERP (ok_if_already_exists
), 0, 0);
2291 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2296 symlink_target
= Ffile_symlink_p (file
);
2297 if (! NILP (symlink_target
))
2298 Fmake_symbolic_link (symlink_target
, newname
,
2299 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2300 else if (!NILP (Ffile_directory_p (file
)))
2301 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2303 /* We have already prompted if it was an integer, so don't
2304 have copy-file prompt again. */
2305 Fcopy_file (file
, newname
,
2306 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2309 count
= SPECPDL_INDEX ();
2310 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2312 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2313 call2 (Qdelete_directory
, file
, Qt
);
2315 Fdelete_file (file
, Qnil
);
2316 unbind_to (count
, Qnil
);
2319 report_file_error ("Renaming", list2 (file
, newname
));
2325 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2326 "fAdd name to file: \nGName to add to %s: \np",
2327 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2328 Signals a `file-already-exists' error if a file NEWNAME already exists
2329 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2330 A number as third arg means request confirmation if NEWNAME already exists.
2331 This is what happens in interactive use with M-x. */)
2332 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2334 Lisp_Object handler
;
2335 Lisp_Object encoded_file
, encoded_newname
;
2336 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2338 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2339 encoded_file
= encoded_newname
= Qnil
;
2340 CHECK_STRING (file
);
2341 CHECK_STRING (newname
);
2342 file
= Fexpand_file_name (file
, Qnil
);
2344 if (!NILP (Ffile_directory_p (newname
)))
2345 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2347 newname
= Fexpand_file_name (newname
, Qnil
);
2349 /* If the file name has special constructs in it,
2350 call the corresponding file handler. */
2351 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2352 if (!NILP (handler
))
2353 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2354 newname
, ok_if_already_exists
));
2356 /* If the new name has special constructs in it,
2357 call the corresponding file handler. */
2358 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2359 if (!NILP (handler
))
2360 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2361 newname
, ok_if_already_exists
));
2363 encoded_file
= ENCODE_FILE (file
);
2364 encoded_newname
= ENCODE_FILE (newname
);
2366 if (NILP (ok_if_already_exists
)
2367 || INTEGERP (ok_if_already_exists
))
2368 barf_or_query_if_file_exists (newname
, "make it a new name",
2369 INTEGERP (ok_if_already_exists
), 0, 0);
2371 unlink (SSDATA (newname
));
2372 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2373 report_file_error ("Adding new name", list2 (file
, newname
));
2379 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2380 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2381 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2382 Both args must be strings.
2383 Signals a `file-already-exists' error if a file LINKNAME already exists
2384 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2385 A number as third arg means request confirmation if LINKNAME already exists.
2386 This happens for interactive use with M-x. */)
2387 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2389 Lisp_Object handler
;
2390 Lisp_Object encoded_filename
, encoded_linkname
;
2391 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2393 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2394 encoded_filename
= encoded_linkname
= Qnil
;
2395 CHECK_STRING (filename
);
2396 CHECK_STRING (linkname
);
2397 /* If the link target has a ~, we must expand it to get
2398 a truly valid file name. Otherwise, do not expand;
2399 we want to permit links to relative file names. */
2400 if (SREF (filename
, 0) == '~')
2401 filename
= Fexpand_file_name (filename
, Qnil
);
2403 if (!NILP (Ffile_directory_p (linkname
)))
2404 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2406 linkname
= Fexpand_file_name (linkname
, Qnil
);
2408 /* If the file name has special constructs in it,
2409 call the corresponding file handler. */
2410 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2411 if (!NILP (handler
))
2412 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2413 linkname
, ok_if_already_exists
));
2415 /* If the new link name has special constructs in it,
2416 call the corresponding file handler. */
2417 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2418 if (!NILP (handler
))
2419 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2420 linkname
, ok_if_already_exists
));
2422 encoded_filename
= ENCODE_FILE (filename
);
2423 encoded_linkname
= ENCODE_FILE (linkname
);
2425 if (NILP (ok_if_already_exists
)
2426 || INTEGERP (ok_if_already_exists
))
2427 barf_or_query_if_file_exists (linkname
, "make it a link",
2428 INTEGERP (ok_if_already_exists
), 0, 0);
2429 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2431 /* If we didn't complain already, silently delete existing file. */
2432 if (errno
== EEXIST
)
2434 unlink (SSDATA (encoded_linkname
));
2435 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2442 if (errno
== ENOSYS
)
2445 xsignal1 (Qfile_error
,
2446 build_string ("Symbolic links are not supported"));
2449 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2456 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2458 doc
: /* Return t if file FILENAME specifies an absolute file name.
2459 On Unix, this is a name starting with a `/' or a `~'. */)
2460 (Lisp_Object filename
)
2462 CHECK_STRING (filename
);
2463 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2466 /* Return true if FILENAME exists. */
2468 check_existing (const char *filename
)
2471 /* The full emulation of Posix 'stat' is too expensive on
2472 DOS/Windows, when all we want to know is whether the file exists.
2473 So we use 'access' instead, which is much more lightweight. */
2474 return (access (filename
, F_OK
) >= 0);
2477 return (stat (filename
, &st
) >= 0);
2481 /* Return true if file FILENAME exists and can be executed. */
2484 check_executable (char *filename
)
2488 if (stat (filename
, &st
) < 0)
2490 return ((st
.st_mode
& S_IEXEC
) != 0);
2491 #else /* not DOS_NT */
2492 #ifdef HAVE_EUIDACCESS
2493 return (euidaccess (filename
, 1) >= 0);
2495 /* Access isn't quite right because it uses the real uid
2496 and we really want to test with the effective uid.
2497 But Unix doesn't give us a right way to do it. */
2498 return (access (filename
, 1) >= 0);
2500 #endif /* not DOS_NT */
2503 /* Return true if file FILENAME exists and can be written. */
2506 check_writable (const char *filename
)
2510 if (stat (filename
, &st
) < 0)
2512 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2513 #else /* not MSDOS */
2514 #ifdef HAVE_EUIDACCESS
2515 bool res
= (euidaccess (filename
, 2) >= 0);
2517 /* euidaccess may have returned failure because Cygwin couldn't
2518 determine the file's UID or GID; if so, we return success. */
2522 if (stat (filename
, &st
) < 0)
2524 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2528 #else /* not HAVE_EUIDACCESS */
2529 /* Access isn't quite right because it uses the real uid
2530 and we really want to test with the effective uid.
2531 But Unix doesn't give us a right way to do it.
2532 Opening with O_WRONLY could work for an ordinary file,
2533 but would lose for directories. */
2534 return (access (filename
, 2) >= 0);
2535 #endif /* not HAVE_EUIDACCESS */
2536 #endif /* not MSDOS */
2539 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2540 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2541 See also `file-readable-p' and `file-attributes'.
2542 This returns nil for a symlink to a nonexistent file.
2543 Use `file-symlink-p' to test for such links. */)
2544 (Lisp_Object filename
)
2546 Lisp_Object absname
;
2547 Lisp_Object handler
;
2549 CHECK_STRING (filename
);
2550 absname
= Fexpand_file_name (filename
, Qnil
);
2552 /* If the file name has special constructs in it,
2553 call the corresponding file handler. */
2554 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2555 if (!NILP (handler
))
2556 return call2 (handler
, Qfile_exists_p
, absname
);
2558 absname
= ENCODE_FILE (absname
);
2560 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2563 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2564 doc
: /* Return t if FILENAME can be executed by you.
2565 For a directory, this means you can access files in that directory. */)
2566 (Lisp_Object filename
)
2568 Lisp_Object absname
;
2569 Lisp_Object handler
;
2571 CHECK_STRING (filename
);
2572 absname
= Fexpand_file_name (filename
, Qnil
);
2574 /* If the file name has special constructs in it,
2575 call the corresponding file handler. */
2576 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2577 if (!NILP (handler
))
2578 return call2 (handler
, Qfile_executable_p
, absname
);
2580 absname
= ENCODE_FILE (absname
);
2582 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2585 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2586 doc
: /* Return t if file FILENAME exists and you can read it.
2587 See also `file-exists-p' and `file-attributes'. */)
2588 (Lisp_Object filename
)
2590 Lisp_Object absname
;
2591 Lisp_Object handler
;
2594 struct stat statbuf
;
2596 CHECK_STRING (filename
);
2597 absname
= Fexpand_file_name (filename
, Qnil
);
2599 /* If the file name has special constructs in it,
2600 call the corresponding file handler. */
2601 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2602 if (!NILP (handler
))
2603 return call2 (handler
, Qfile_readable_p
, absname
);
2605 absname
= ENCODE_FILE (absname
);
2607 #if defined (DOS_NT) || defined (macintosh)
2608 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2610 if (access (SDATA (absname
), 0) == 0)
2613 #else /* not DOS_NT and not macintosh */
2616 /* Opening a fifo without O_NONBLOCK can wait.
2617 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2618 except in the case of a fifo, on a system which handles it. */
2619 desc
= stat (SSDATA (absname
), &statbuf
);
2622 if (S_ISFIFO (statbuf
.st_mode
))
2623 flags
|= O_NONBLOCK
;
2625 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2630 #endif /* not DOS_NT and not macintosh */
2633 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2635 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2636 doc
: /* Return t if file FILENAME can be written or created by you. */)
2637 (Lisp_Object filename
)
2639 Lisp_Object absname
, dir
, encoded
;
2640 Lisp_Object handler
;
2642 CHECK_STRING (filename
);
2643 absname
= Fexpand_file_name (filename
, Qnil
);
2645 /* If the file name has special constructs in it,
2646 call the corresponding file handler. */
2647 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2648 if (!NILP (handler
))
2649 return call2 (handler
, Qfile_writable_p
, absname
);
2651 encoded
= ENCODE_FILE (absname
);
2652 if (check_existing (SSDATA (encoded
)))
2653 return (check_writable (SSDATA (encoded
))
2656 dir
= Ffile_name_directory (absname
);
2659 dir
= Fdirectory_file_name (dir
);
2662 dir
= ENCODE_FILE (dir
);
2664 /* The read-only attribute of the parent directory doesn't affect
2665 whether a file or directory can be created within it. Some day we
2666 should check ACLs though, which do affect this. */
2667 return (access (SDATA (dir
), D_OK
) < 0) ? Qnil
: Qt
;
2669 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2674 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2675 doc
: /* Access file FILENAME, and get an error if that does not work.
2676 The second argument STRING is used in the error message.
2677 If there is no error, returns nil. */)
2678 (Lisp_Object filename
, Lisp_Object string
)
2680 Lisp_Object handler
, encoded_filename
, absname
;
2683 CHECK_STRING (filename
);
2684 absname
= Fexpand_file_name (filename
, Qnil
);
2686 CHECK_STRING (string
);
2688 /* If the file name has special constructs in it,
2689 call the corresponding file handler. */
2690 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2691 if (!NILP (handler
))
2692 return call3 (handler
, Qaccess_file
, absname
, string
);
2694 encoded_filename
= ENCODE_FILE (absname
);
2696 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2698 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2704 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2705 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2706 The value is the link target, as a string.
2707 Otherwise it returns nil.
2709 This function returns t when given the name of a symlink that
2710 points to a nonexistent file. */)
2711 (Lisp_Object filename
)
2713 Lisp_Object handler
;
2716 char readlink_buf
[READLINK_BUFSIZE
];
2718 CHECK_STRING (filename
);
2719 filename
= Fexpand_file_name (filename
, Qnil
);
2721 /* If the file name has special constructs in it,
2722 call the corresponding file handler. */
2723 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2724 if (!NILP (handler
))
2725 return call2 (handler
, Qfile_symlink_p
, filename
);
2727 filename
= ENCODE_FILE (filename
);
2729 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2733 val
= build_string (buf
);
2734 if (buf
[0] == '/' && strchr (buf
, ':'))
2735 val
= concat2 (build_string ("/:"), val
);
2736 if (buf
!= readlink_buf
)
2738 val
= DECODE_FILE (val
);
2742 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2743 doc
: /* Return t if FILENAME names an existing directory.
2744 Symbolic links to directories count as directories.
2745 See `file-symlink-p' to distinguish symlinks. */)
2746 (Lisp_Object filename
)
2748 register Lisp_Object absname
;
2750 Lisp_Object handler
;
2752 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2754 /* If the file name has special constructs in it,
2755 call the corresponding file handler. */
2756 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2757 if (!NILP (handler
))
2758 return call2 (handler
, Qfile_directory_p
, absname
);
2760 absname
= ENCODE_FILE (absname
);
2762 if (stat (SSDATA (absname
), &st
) < 0)
2764 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2767 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2768 Sfile_accessible_directory_p
, 1, 1, 0,
2769 doc
: /* Return t if file FILENAME names a directory you can open.
2770 For the value to be t, FILENAME must specify the name of a directory as a file,
2771 and the directory must allow you to open files in it. In order to use a
2772 directory as a buffer's current directory, this predicate must return true.
2773 A directory name spec may be given instead; then the value is t
2774 if the directory so specified exists and really is a readable and
2775 searchable directory. */)
2776 (Lisp_Object filename
)
2778 Lisp_Object handler
;
2780 struct gcpro gcpro1
;
2782 /* If the file name has special constructs in it,
2783 call the corresponding file handler. */
2784 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2785 if (!NILP (handler
))
2786 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2789 tem
= (NILP (Ffile_directory_p (filename
))
2790 || NILP (Ffile_executable_p (filename
)));
2792 return tem
? Qnil
: Qt
;
2795 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2796 doc
: /* Return t if FILENAME names a regular file.
2797 This is the sort of file that holds an ordinary stream of data bytes.
2798 Symbolic links to regular files count as regular files.
2799 See `file-symlink-p' to distinguish symlinks. */)
2800 (Lisp_Object filename
)
2802 register Lisp_Object absname
;
2804 Lisp_Object handler
;
2806 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2808 /* If the file name has special constructs in it,
2809 call the corresponding file handler. */
2810 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2811 if (!NILP (handler
))
2812 return call2 (handler
, Qfile_regular_p
, absname
);
2814 absname
= ENCODE_FILE (absname
);
2819 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2821 /* Tell stat to use expensive method to get accurate info. */
2822 Vw32_get_true_file_attributes
= Qt
;
2823 result
= stat (SDATA (absname
), &st
);
2824 Vw32_get_true_file_attributes
= tem
;
2828 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2831 if (stat (SSDATA (absname
), &st
) < 0)
2833 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2837 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2838 Sfile_selinux_context
, 1, 1, 0,
2839 doc
: /* Return SELinux context of file named FILENAME.
2840 The return value is a list (USER ROLE TYPE RANGE), where the list
2841 elements are strings naming the user, role, type, and range of the
2842 file's SELinux security context.
2844 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2845 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2846 (Lisp_Object filename
)
2848 Lisp_Object absname
;
2849 Lisp_Object values
[4];
2850 Lisp_Object handler
;
2852 security_context_t con
;
2857 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2859 /* If the file name has special constructs in it,
2860 call the corresponding file handler. */
2861 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2862 if (!NILP (handler
))
2863 return call2 (handler
, Qfile_selinux_context
, absname
);
2865 absname
= ENCODE_FILE (absname
);
2872 if (is_selinux_enabled ())
2874 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2877 context
= context_new (con
);
2878 if (context_user_get (context
))
2879 values
[0] = build_string (context_user_get (context
));
2880 if (context_role_get (context
))
2881 values
[1] = build_string (context_role_get (context
));
2882 if (context_type_get (context
))
2883 values
[2] = build_string (context_type_get (context
));
2884 if (context_range_get (context
))
2885 values
[3] = build_string (context_range_get (context
));
2886 context_free (context
);
2892 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2895 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2896 Sset_file_selinux_context
, 2, 2, 0,
2897 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2898 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2899 elements are strings naming the components of a SELinux context.
2901 This function does nothing if SELinux is disabled, or if Emacs was not
2902 compiled with SELinux support. */)
2903 (Lisp_Object filename
, Lisp_Object context
)
2905 Lisp_Object absname
;
2906 Lisp_Object handler
;
2908 Lisp_Object encoded_absname
;
2909 Lisp_Object user
= CAR_SAFE (context
);
2910 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2911 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2912 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2913 security_context_t con
;
2916 context_t parsed_con
;
2919 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2921 /* If the file name has special constructs in it,
2922 call the corresponding file handler. */
2923 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2924 if (!NILP (handler
))
2925 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2928 if (is_selinux_enabled ())
2930 /* Get current file context. */
2931 encoded_absname
= ENCODE_FILE (absname
);
2932 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2935 parsed_con
= context_new (con
);
2936 /* Change the parts defined in the parameter.*/
2939 if (context_user_set (parsed_con
, SSDATA (user
)))
2940 error ("Doing context_user_set");
2944 if (context_role_set (parsed_con
, SSDATA (role
)))
2945 error ("Doing context_role_set");
2949 if (context_type_set (parsed_con
, SSDATA (type
)))
2950 error ("Doing context_type_set");
2952 if (STRINGP (range
))
2954 if (context_range_set (parsed_con
, SSDATA (range
)))
2955 error ("Doing context_range_set");
2958 /* Set the modified context back to the file. */
2959 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2960 context_str (parsed_con
))
2962 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2963 if (fail
&& errno
!= ENOTSUP
)
2964 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2966 context_free (parsed_con
);
2970 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
2977 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2978 doc
: /* Return mode bits of file named FILENAME, as an integer.
2979 Return nil, if file does not exist or is not accessible. */)
2980 (Lisp_Object filename
)
2982 Lisp_Object absname
;
2984 Lisp_Object handler
;
2986 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2988 /* If the file name has special constructs in it,
2989 call the corresponding file handler. */
2990 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2991 if (!NILP (handler
))
2992 return call2 (handler
, Qfile_modes
, absname
);
2994 absname
= ENCODE_FILE (absname
);
2996 if (stat (SSDATA (absname
), &st
) < 0)
2999 return make_number (st
.st_mode
& 07777);
3002 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3003 "(let ((file (read-file-name \"File: \"))) \
3004 (list file (read-file-modes nil file)))",
3005 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3006 Only the 12 low bits of MODE are used.
3008 Interactively, mode bits are read by `read-file-modes', which accepts
3009 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3010 (Lisp_Object filename
, Lisp_Object mode
)
3012 Lisp_Object absname
, encoded_absname
;
3013 Lisp_Object handler
;
3015 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3016 CHECK_NUMBER (mode
);
3018 /* If the file name has special constructs in it,
3019 call the corresponding file handler. */
3020 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3021 if (!NILP (handler
))
3022 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3024 encoded_absname
= ENCODE_FILE (absname
);
3026 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3027 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3032 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3033 doc
: /* Set the file permission bits for newly created files.
3034 The argument MODE should be an integer; only the low 9 bits are used.
3035 This setting is inherited by subprocesses. */)
3038 CHECK_NUMBER (mode
);
3040 umask ((~ XINT (mode
)) & 0777);
3045 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3046 doc
: /* Return the default file protection for created files.
3047 The value is an integer. */)
3054 realmask
= umask (0);
3058 XSETINT (value
, (~ realmask
) & 0777);
3063 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3064 doc
: /* Set times of file FILENAME to TIMESTAMP.
3065 Set both access and modification times.
3066 Return t on success, else nil.
3067 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3069 (Lisp_Object filename
, Lisp_Object timestamp
)
3071 Lisp_Object absname
, encoded_absname
;
3072 Lisp_Object handler
;
3073 EMACS_TIME t
= lisp_time_argument (timestamp
);
3075 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3077 /* If the file name has special constructs in it,
3078 call the corresponding file handler. */
3079 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3080 if (!NILP (handler
))
3081 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3083 encoded_absname
= ENCODE_FILE (absname
);
3086 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3091 /* Setting times on a directory always fails. */
3092 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
3095 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3104 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3105 doc
: /* Tell Unix to finish all pending disk updates. */)
3112 #endif /* HAVE_SYNC */
3114 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3115 doc
: /* Return t if file FILE1 is newer than file FILE2.
3116 If FILE1 does not exist, the answer is nil;
3117 otherwise, if FILE2 does not exist, the answer is t. */)
3118 (Lisp_Object file1
, Lisp_Object file2
)
3120 Lisp_Object absname1
, absname2
;
3121 struct stat st1
, st2
;
3122 Lisp_Object handler
;
3123 struct gcpro gcpro1
, gcpro2
;
3125 CHECK_STRING (file1
);
3126 CHECK_STRING (file2
);
3129 GCPRO2 (absname1
, file2
);
3130 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3131 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3134 /* If the file name has special constructs in it,
3135 call the corresponding file handler. */
3136 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3138 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3139 if (!NILP (handler
))
3140 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3142 GCPRO2 (absname1
, absname2
);
3143 absname1
= ENCODE_FILE (absname1
);
3144 absname2
= ENCODE_FILE (absname2
);
3147 if (stat (SSDATA (absname1
), &st1
) < 0)
3150 if (stat (SSDATA (absname2
), &st2
) < 0)
3153 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3157 #ifndef READ_BUF_SIZE
3158 #define READ_BUF_SIZE (64 << 10)
3160 /* Some buffer offsets are stored in 'int' variables. */
3161 verify (READ_BUF_SIZE
<= INT_MAX
);
3163 /* This function is called after Lisp functions to decide a coding
3164 system are called, or when they cause an error. Before they are
3165 called, the current buffer is set unibyte and it contains only a
3166 newly inserted text (thus the buffer was empty before the
3169 The functions may set markers, overlays, text properties, or even
3170 alter the buffer contents, change the current buffer.
3172 Here, we reset all those changes by:
3173 o set back the current buffer.
3174 o move all markers and overlays to BEG.
3175 o remove all text properties.
3176 o set back the buffer multibyteness. */
3179 decide_coding_unwind (Lisp_Object unwind_data
)
3181 Lisp_Object multibyte
, undo_list
, buffer
;
3183 multibyte
= XCAR (unwind_data
);
3184 unwind_data
= XCDR (unwind_data
);
3185 undo_list
= XCAR (unwind_data
);
3186 buffer
= XCDR (unwind_data
);
3188 set_buffer_internal (XBUFFER (buffer
));
3189 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3190 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3191 set_buffer_intervals (current_buffer
, NULL
);
3192 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3194 /* Now we are safe to change the buffer's multibyteness directly. */
3195 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3196 bset_undo_list (current_buffer
, undo_list
);
3202 /* Used to pass values from insert-file-contents to read_non_regular. */
3204 static int non_regular_fd
;
3205 static ptrdiff_t non_regular_inserted
;
3206 static int non_regular_nbytes
;
3209 /* Read from a non-regular file.
3210 Read non_regular_nbytes bytes max from non_regular_fd.
3211 Non_regular_inserted specifies where to put the read bytes.
3212 Value is the number of bytes read. */
3215 read_non_regular (Lisp_Object ignore
)
3221 nbytes
= emacs_read (non_regular_fd
,
3222 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3223 + non_regular_inserted
),
3224 non_regular_nbytes
);
3226 return make_number (nbytes
);
3230 /* Condition-case handler used when reading from non-regular files
3231 in insert-file-contents. */
3234 read_non_regular_quit (Lisp_Object ignore
)
3239 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3240 except that it also tests for OFFSET being out of lseek's range. */
3242 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3244 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3245 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3246 if (! ((offset
>= TYPE_MINIMUM (off_t
)) & (offset
<= TYPE_MAXIMUM (off_t
))))
3251 return lseek (fd
, offset
, whence
);
3254 /* Return a special time value indicating the error number ERRNUM. */
3256 time_error_value (int errnum
)
3258 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3259 ? NONEXISTENT_MODTIME_NSECS
3260 : UNKNOWN_MODTIME_NSECS
);
3261 return make_emacs_time (0, ns
);
3264 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3266 doc
: /* Insert contents of file FILENAME after point.
3267 Returns list of absolute file name and number of characters inserted.
3268 If second argument VISIT is non-nil, the buffer's visited filename and
3269 last save file modtime are set, and it is marked unmodified. If
3270 visiting and the file does not exist, visiting is completed before the
3273 The optional third and fourth arguments BEG and END specify what portion
3274 of the file to insert. These arguments count bytes in the file, not
3275 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3277 If optional fifth argument REPLACE is non-nil, replace the current
3278 buffer contents (in the accessible portion) with the file contents.
3279 This is better than simply deleting and inserting the whole thing
3280 because (1) it preserves some marker positions and (2) it puts less data
3281 in the undo list. When REPLACE is non-nil, the second return value is
3282 the number of characters that replace previous buffer contents.
3284 This function does code conversion according to the value of
3285 `coding-system-for-read' or `file-coding-system-alist', and sets the
3286 variable `last-coding-system-used' to the coding system actually used.
3288 In addition, this function decodes the inserted text from known formats
3289 by calling `format-decode', which see. */)
3290 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3296 ptrdiff_t inserted
= 0;
3299 off_t beg_offset
, end_offset
;
3301 ptrdiff_t count
= SPECPDL_INDEX ();
3302 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3303 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3305 ptrdiff_t total
= 0;
3306 bool not_regular
= 0;
3308 char read_buf
[READ_BUF_SIZE
];
3309 struct coding_system coding
;
3310 char buffer
[1 << 14];
3311 bool replace_handled
= 0;
3312 bool set_coding_system
= 0;
3313 Lisp_Object coding_system
;
3315 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3316 bool we_locked_file
= 0;
3317 bool deferred_remove_unwind_protect
= 0;
3319 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3320 error ("Cannot do file visiting in an indirect buffer");
3322 if (!NILP (BVAR (current_buffer
, read_only
)))
3323 Fbarf_if_buffer_read_only ();
3327 orig_filename
= Qnil
;
3330 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3332 CHECK_STRING (filename
);
3333 filename
= Fexpand_file_name (filename
, Qnil
);
3335 /* The value Qnil means that the coding system is not yet
3337 coding_system
= Qnil
;
3339 /* If the file name has special constructs in it,
3340 call the corresponding file handler. */
3341 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3342 if (!NILP (handler
))
3344 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3345 visit
, beg
, end
, replace
);
3346 if (CONSP (val
) && CONSP (XCDR (val
))
3347 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3348 inserted
= XINT (XCAR (XCDR (val
)));
3352 orig_filename
= filename
;
3353 filename
= ENCODE_FILE (filename
);
3359 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3361 /* Tell stat to use expensive method to get accurate info. */
3362 Vw32_get_true_file_attributes
= Qt
;
3363 file_status
= stat (SSDATA (filename
), &st
);
3364 Vw32_get_true_file_attributes
= tem
;
3367 file_status
= stat (SSDATA (filename
), &st
);
3368 #endif /* WINDOWSNT */
3370 if (file_status
== 0)
3371 mtime
= get_stat_mtime (&st
);
3377 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3378 mtime
= time_error_value (save_errno
);
3381 if (!NILP (Vcoding_system_for_read
))
3382 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3386 /* This code will need to be changed in order to work on named
3387 pipes, and it's probably just not worth it. So we should at
3388 least signal an error. */
3389 if (!S_ISREG (st
.st_mode
))
3396 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3397 xsignal2 (Qfile_error
,
3398 build_string ("not a regular file"), orig_filename
);
3402 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3405 /* Replacement should preserve point as it preserves markers. */
3406 if (!NILP (replace
))
3407 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3409 record_unwind_protect (close_file_unwind
, make_number (fd
));
3414 if (!NILP (beg
) || !NILP (end
))
3415 error ("Attempt to visit less than an entire file");
3416 if (BEG
< Z
&& NILP (replace
))
3417 error ("Cannot do file visiting in a non-empty buffer");
3422 if (! RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
)))
3423 wrong_type_argument (intern ("file-offset"), beg
);
3424 beg_offset
= XFASTINT (beg
);
3431 if (! RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
)))
3432 wrong_type_argument (intern ("file-offset"), end
);
3433 end_offset
= XFASTINT (end
);
3438 end_offset
= TYPE_MAXIMUM (off_t
);
3441 end_offset
= st
.st_size
;
3443 /* A negative size can happen on a platform that allows file
3444 sizes greater than the maximum off_t value. */
3448 /* The file size returned from stat may be zero, but data
3449 may be readable nonetheless, for example when this is a
3450 file in the /proc filesystem. */
3451 if (end_offset
== 0)
3452 end_offset
= READ_BUF_SIZE
;
3456 /* Check now whether the buffer will become too large,
3457 in the likely case where the file's length is not changing.
3458 This saves a lot of needless work before a buffer overflow. */
3461 /* The likely offset where we will stop reading. We could read
3462 more (or less), if the file grows (or shrinks) as we read it. */
3463 off_t likely_end
= min (end_offset
, st
.st_size
);
3465 if (beg_offset
< likely_end
)
3468 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3469 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3470 off_t likely_growth
= likely_end
- beg_offset
;
3471 if (buf_growth_max
< likely_growth
)
3476 /* Prevent redisplay optimizations. */
3477 current_buffer
->clip_changed
= 1;
3479 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3481 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3482 setup_coding_system (coding_system
, &coding
);
3483 /* Ensure we set Vlast_coding_system_used. */
3484 set_coding_system
= 1;
3488 /* Decide the coding system to use for reading the file now
3489 because we can't use an optimized method for handling
3490 `coding:' tag if the current buffer is not empty. */
3491 if (!NILP (Vcoding_system_for_read
))
3492 coding_system
= Vcoding_system_for_read
;
3495 /* Don't try looking inside a file for a coding system
3496 specification if it is not seekable. */
3497 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3499 /* Find a coding system specified in the heading two
3500 lines or in the tailing several lines of the file.
3501 We assume that the 1K-byte and 3K-byte for heading
3502 and tailing respectively are sufficient for this
3506 if (st
.st_size
<= (1024 * 4))
3507 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3510 nread
= emacs_read (fd
, read_buf
, 1024);
3513 if (lseek (fd
, st
.st_size
- (1024 * 3), SEEK_SET
) < 0)
3514 report_file_error ("Setting file position",
3515 Fcons (orig_filename
, Qnil
));
3516 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3521 error ("IO error reading %s: %s",
3522 SDATA (orig_filename
), emacs_strerror (errno
));
3525 struct buffer
*prev
= current_buffer
;
3526 Lisp_Object workbuf
;
3529 record_unwind_current_buffer ();
3531 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3532 buf
= XBUFFER (workbuf
);
3534 delete_all_overlays (buf
);
3535 bset_directory (buf
, BVAR (current_buffer
, directory
));
3536 bset_read_only (buf
, Qnil
);
3537 bset_filename (buf
, Qnil
);
3538 bset_undo_list (buf
, Qt
);
3539 eassert (buf
->overlays_before
== NULL
);
3540 eassert (buf
->overlays_after
== NULL
);
3542 set_buffer_internal (buf
);
3544 bset_enable_multibyte_characters (buf
, Qnil
);
3546 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3547 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3548 coding_system
= call2 (Vset_auto_coding_function
,
3549 filename
, make_number (nread
));
3550 set_buffer_internal (prev
);
3552 /* Discard the unwind protect for recovering the
3556 /* Rewind the file for the actual read done later. */
3557 if (lseek (fd
, 0, SEEK_SET
) < 0)
3558 report_file_error ("Setting file position",
3559 Fcons (orig_filename
, Qnil
));
3563 if (NILP (coding_system
))
3565 /* If we have not yet decided a coding system, check
3566 file-coding-system-alist. */
3567 Lisp_Object args
[6];
3569 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3570 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3571 coding_system
= Ffind_operation_coding_system (6, args
);
3572 if (CONSP (coding_system
))
3573 coding_system
= XCAR (coding_system
);
3577 if (NILP (coding_system
))
3578 coding_system
= Qundecided
;
3580 CHECK_CODING_SYSTEM (coding_system
);
3582 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3583 /* We must suppress all character code conversion except for
3584 end-of-line conversion. */
3585 coding_system
= raw_text_coding_system (coding_system
);
3587 setup_coding_system (coding_system
, &coding
);
3588 /* Ensure we set Vlast_coding_system_used. */
3589 set_coding_system
= 1;
3592 /* If requested, replace the accessible part of the buffer
3593 with the file contents. Avoid replacing text at the
3594 beginning or end of the buffer that matches the file contents;
3595 that preserves markers pointing to the unchanged parts.
3597 Here we implement this feature in an optimized way
3598 for the case where code conversion is NOT needed.
3599 The following if-statement handles the case of conversion
3600 in a less optimal way.
3602 If the code conversion is "automatic" then we try using this
3603 method and hope for the best.
3604 But if we discover the need for conversion, we give up on this method
3605 and let the following if-statement handle the replace job. */
3608 && (NILP (coding_system
)
3609 || ! CODING_REQUIRE_DECODING (&coding
)))
3611 /* same_at_start and same_at_end count bytes,
3612 because file access counts bytes
3613 and BEG and END count bytes. */
3614 ptrdiff_t same_at_start
= BEGV_BYTE
;
3615 ptrdiff_t same_at_end
= ZV_BYTE
;
3617 /* There is still a possibility we will find the need to do code
3618 conversion. If that happens, set this variable to
3619 give up on handling REPLACE in the optimized way. */
3620 bool giveup_match_end
= 0;
3622 if (beg_offset
!= 0)
3624 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3625 report_file_error ("Setting file position",
3626 Fcons (orig_filename
, Qnil
));
3631 /* Count how many chars at the start of the file
3632 match the text at the beginning of the buffer. */
3637 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3639 error ("IO error reading %s: %s",
3640 SSDATA (orig_filename
), emacs_strerror (errno
));
3641 else if (nread
== 0)
3644 if (CODING_REQUIRE_DETECTION (&coding
))
3646 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3649 setup_coding_system (coding_system
, &coding
);
3652 if (CODING_REQUIRE_DECODING (&coding
))
3653 /* We found that the file should be decoded somehow.
3654 Let's give up here. */
3656 giveup_match_end
= 1;
3661 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3662 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3663 same_at_start
++, bufpos
++;
3664 /* If we found a discrepancy, stop the scan.
3665 Otherwise loop around and scan the next bufferful. */
3666 if (bufpos
!= nread
)
3670 /* If the file matches the buffer completely,
3671 there's no need to replace anything. */
3672 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3676 /* Truncate the buffer to the size of the file. */
3677 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3682 /* Count how many chars at the end of the file
3683 match the text at the end of the buffer. But, if we have
3684 already found that decoding is necessary, don't waste time. */
3685 while (!giveup_match_end
)
3687 int total_read
, nread
, bufpos
, trial
;
3690 /* At what file position are we now scanning? */
3691 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3692 /* If the entire file matches the buffer tail, stop the scan. */
3695 /* How much can we scan in the next step? */
3696 trial
= min (curpos
, sizeof buffer
);
3697 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3698 report_file_error ("Setting file position",
3699 Fcons (orig_filename
, Qnil
));
3701 total_read
= nread
= 0;
3702 while (total_read
< trial
)
3704 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3706 error ("IO error reading %s: %s",
3707 SDATA (orig_filename
), emacs_strerror (errno
));
3708 else if (nread
== 0)
3710 total_read
+= nread
;
3713 /* Scan this bufferful from the end, comparing with
3714 the Emacs buffer. */
3715 bufpos
= total_read
;
3717 /* Compare with same_at_start to avoid counting some buffer text
3718 as matching both at the file's beginning and at the end. */
3719 while (bufpos
> 0 && same_at_end
> same_at_start
3720 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3721 same_at_end
--, bufpos
--;
3723 /* If we found a discrepancy, stop the scan.
3724 Otherwise loop around and scan the preceding bufferful. */
3727 /* If this discrepancy is because of code conversion,
3728 we cannot use this method; giveup and try the other. */
3729 if (same_at_end
> same_at_start
3730 && FETCH_BYTE (same_at_end
- 1) >= 0200
3731 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3732 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3733 giveup_match_end
= 1;
3742 if (! giveup_match_end
)
3746 /* We win! We can handle REPLACE the optimized way. */
3748 /* Extend the start of non-matching text area to multibyte
3749 character boundary. */
3750 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3751 while (same_at_start
> BEGV_BYTE
3752 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3755 /* Extend the end of non-matching text area to multibyte
3756 character boundary. */
3757 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3758 while (same_at_end
< ZV_BYTE
3759 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3762 /* Don't try to reuse the same piece of text twice. */
3763 overlap
= (same_at_start
- BEGV_BYTE
3765 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3767 same_at_end
+= overlap
;
3769 /* Arrange to read only the nonmatching middle part of the file. */
3770 beg_offset
+= same_at_start
- BEGV_BYTE
;
3771 end_offset
-= ZV_BYTE
- same_at_end
;
3773 del_range_byte (same_at_start
, same_at_end
, 0);
3774 /* Insert from the file at the proper position. */
3775 temp
= BYTE_TO_CHAR (same_at_start
);
3776 SET_PT_BOTH (temp
, same_at_start
);
3778 /* If display currently starts at beginning of line,
3779 keep it that way. */
3780 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3781 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3783 replace_handled
= 1;
3787 /* If requested, replace the accessible part of the buffer
3788 with the file contents. Avoid replacing text at the
3789 beginning or end of the buffer that matches the file contents;
3790 that preserves markers pointing to the unchanged parts.
3792 Here we implement this feature for the case where code conversion
3793 is needed, in a simple way that needs a lot of memory.
3794 The preceding if-statement handles the case of no conversion
3795 in a more optimized way. */
3796 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3798 ptrdiff_t same_at_start
= BEGV_BYTE
;
3799 ptrdiff_t same_at_end
= ZV_BYTE
;
3800 ptrdiff_t same_at_start_charpos
;
3801 ptrdiff_t inserted_chars
;
3804 unsigned char *decoded
;
3807 ptrdiff_t this_count
= SPECPDL_INDEX ();
3809 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3810 Lisp_Object conversion_buffer
;
3811 struct gcpro gcpro1
;
3813 conversion_buffer
= code_conversion_save (1, multibyte
);
3815 /* First read the whole file, performing code conversion into
3816 CONVERSION_BUFFER. */
3818 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3819 report_file_error ("Setting file position",
3820 Fcons (orig_filename
, Qnil
));
3822 total
= st
.st_size
; /* Total bytes in the file. */
3823 how_much
= 0; /* Bytes read from file so far. */
3824 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3825 unprocessed
= 0; /* Bytes not processed in previous loop. */
3827 GCPRO1 (conversion_buffer
);
3828 while (how_much
< total
)
3830 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3831 quitting while reading a huge while. */
3832 /* `try'' is reserved in some compilers (Microsoft C). */
3833 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3835 /* Allow quitting out of the actual I/O. */
3838 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3846 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3847 BUF_Z (XBUFFER (conversion_buffer
)));
3848 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3849 unprocessed
+ this, conversion_buffer
);
3850 unprocessed
= coding
.carryover_bytes
;
3851 if (coding
.carryover_bytes
> 0)
3852 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3857 /* We should remove the unwind_protect calling
3858 close_file_unwind, but other stuff has been added the stack,
3859 so defer the removal till we reach the `handled' label. */
3860 deferred_remove_unwind_protect
= 1;
3862 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3863 if we couldn't read the file. */
3866 error ("IO error reading %s: %s",
3867 SDATA (orig_filename
), emacs_strerror (errno
));
3869 if (unprocessed
> 0)
3871 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3872 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3873 unprocessed
, conversion_buffer
);
3874 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3877 coding_system
= CODING_ID_NAME (coding
.id
);
3878 set_coding_system
= 1;
3879 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3880 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3881 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3883 /* Compare the beginning of the converted string with the buffer
3887 while (bufpos
< inserted
&& same_at_start
< same_at_end
3888 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3889 same_at_start
++, bufpos
++;
3891 /* If the file matches the head of buffer completely,
3892 there's no need to replace anything. */
3894 if (bufpos
== inserted
)
3896 /* Truncate the buffer to the size of the file. */
3897 if (same_at_start
== same_at_end
)
3900 del_range_byte (same_at_start
, same_at_end
, 0);
3903 unbind_to (this_count
, Qnil
);
3907 /* Extend the start of non-matching text area to the previous
3908 multibyte character boundary. */
3909 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3910 while (same_at_start
> BEGV_BYTE
3911 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3914 /* Scan this bufferful from the end, comparing with
3915 the Emacs buffer. */
3918 /* Compare with same_at_start to avoid counting some buffer text
3919 as matching both at the file's beginning and at the end. */
3920 while (bufpos
> 0 && same_at_end
> same_at_start
3921 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3922 same_at_end
--, bufpos
--;
3924 /* Extend the end of non-matching text area to the next
3925 multibyte character boundary. */
3926 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3927 while (same_at_end
< ZV_BYTE
3928 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3931 /* Don't try to reuse the same piece of text twice. */
3932 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3934 same_at_end
+= overlap
;
3936 /* If display currently starts at beginning of line,
3937 keep it that way. */
3938 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3939 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3941 /* Replace the chars that we need to replace,
3942 and update INSERTED to equal the number of bytes
3943 we are taking from the decoded string. */
3944 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3946 if (same_at_end
!= same_at_start
)
3948 del_range_byte (same_at_start
, same_at_end
, 0);
3950 same_at_start
= GPT_BYTE
;
3954 temp
= BYTE_TO_CHAR (same_at_start
);
3956 /* Insert from the file at the proper position. */
3957 SET_PT_BOTH (temp
, same_at_start
);
3958 same_at_start_charpos
3959 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3960 same_at_start
- BEGV_BYTE
3961 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3963 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3964 same_at_start
+ inserted
- BEGV_BYTE
3965 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3966 - same_at_start_charpos
);
3967 /* This binding is to avoid ask-user-about-supersession-threat
3968 being called in insert_from_buffer (via in
3969 prepare_to_modify_buffer). */
3970 specbind (intern ("buffer-file-name"), Qnil
);
3971 insert_from_buffer (XBUFFER (conversion_buffer
),
3972 same_at_start_charpos
, inserted_chars
, 0);
3973 /* Set `inserted' to the number of inserted characters. */
3974 inserted
= PT
- temp
;
3975 /* Set point before the inserted characters. */
3976 SET_PT_BOTH (temp
, same_at_start
);
3978 unbind_to (this_count
, Qnil
);
3984 total
= end_offset
- beg_offset
;
3986 /* For a special file, all we can do is guess. */
3987 total
= READ_BUF_SIZE
;
3989 if (NILP (visit
) && total
> 0)
3991 #ifdef CLASH_DETECTION
3992 if (!NILP (BVAR (current_buffer
, file_truename
))
3993 /* Make binding buffer-file-name to nil effective. */
3994 && !NILP (BVAR (current_buffer
, filename
))
3995 && SAVE_MODIFF
>= MODIFF
)
3997 #endif /* CLASH_DETECTION */
3998 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4002 if (GAP_SIZE
< total
)
4003 make_gap (total
- GAP_SIZE
);
4005 if (beg_offset
!= 0 || !NILP (replace
))
4007 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4008 report_file_error ("Setting file position",
4009 Fcons (orig_filename
, Qnil
));
4012 /* In the following loop, HOW_MUCH contains the total bytes read so
4013 far for a regular file, and not changed for a special file. But,
4014 before exiting the loop, it is set to a negative value if I/O
4018 /* Total bytes inserted. */
4021 /* Here, we don't do code conversion in the loop. It is done by
4022 decode_coding_gap after all data are read into the buffer. */
4024 ptrdiff_t gap_size
= GAP_SIZE
;
4026 while (how_much
< total
)
4028 /* try is reserved in some compilers (Microsoft C) */
4029 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4036 /* Maybe make more room. */
4037 if (gap_size
< trytry
)
4039 make_gap (total
- gap_size
);
4040 gap_size
= GAP_SIZE
;
4043 /* Read from the file, capturing `quit'. When an
4044 error occurs, end the loop, and arrange for a quit
4045 to be signaled after decoding the text we read. */
4046 non_regular_fd
= fd
;
4047 non_regular_inserted
= inserted
;
4048 non_regular_nbytes
= trytry
;
4049 nbytes
= internal_condition_case_1 (read_non_regular
,
4051 read_non_regular_quit
);
4058 this = XINT (nbytes
);
4062 /* Allow quitting out of the actual I/O. We don't make text
4063 part of the buffer until all the reading is done, so a C-g
4064 here doesn't do any harm. */
4067 this = emacs_read (fd
,
4068 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4082 /* For a regular file, where TOTAL is the real size,
4083 count HOW_MUCH to compare with it.
4084 For a special file, where TOTAL is just a buffer size,
4085 so don't bother counting in HOW_MUCH.
4086 (INSERTED is where we count the number of characters inserted.) */
4093 /* Now we have read all the file data into the gap.
4094 If it was empty, undo marking the buffer modified. */
4098 #ifdef CLASH_DETECTION
4100 unlock_file (BVAR (current_buffer
, file_truename
));
4102 Vdeactivate_mark
= old_Vdeactivate_mark
;
4105 Vdeactivate_mark
= Qt
;
4107 /* Make the text read part of the buffer. */
4108 GAP_SIZE
-= inserted
;
4110 GPT_BYTE
+= inserted
;
4112 ZV_BYTE
+= inserted
;
4117 /* Put an anchor to ensure multi-byte form ends at gap. */
4122 /* Discard the unwind protect for closing the file. */
4126 error ("IO error reading %s: %s",
4127 SDATA (orig_filename
), emacs_strerror (errno
));
4131 if (NILP (coding_system
))
4133 /* The coding system is not yet decided. Decide it by an
4134 optimized method for handling `coding:' tag.
4136 Note that we can get here only if the buffer was empty
4137 before the insertion. */
4139 if (!NILP (Vcoding_system_for_read
))
4140 coding_system
= Vcoding_system_for_read
;
4143 /* Since we are sure that the current buffer was empty
4144 before the insertion, we can toggle
4145 enable-multibyte-characters directly here without taking
4146 care of marker adjustment. By this way, we can run Lisp
4147 program safely before decoding the inserted text. */
4148 Lisp_Object unwind_data
;
4149 ptrdiff_t count1
= SPECPDL_INDEX ();
4151 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4152 Fcons (BVAR (current_buffer
, undo_list
),
4153 Fcurrent_buffer ()));
4154 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4155 bset_undo_list (current_buffer
, Qt
);
4156 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4158 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4160 coding_system
= call2 (Vset_auto_coding_function
,
4161 filename
, make_number (inserted
));
4164 if (NILP (coding_system
))
4166 /* If the coding system is not yet decided, check
4167 file-coding-system-alist. */
4168 Lisp_Object args
[6];
4170 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4171 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4172 coding_system
= Ffind_operation_coding_system (6, args
);
4173 if (CONSP (coding_system
))
4174 coding_system
= XCAR (coding_system
);
4176 unbind_to (count1
, Qnil
);
4177 inserted
= Z_BYTE
- BEG_BYTE
;
4180 if (NILP (coding_system
))
4181 coding_system
= Qundecided
;
4183 CHECK_CODING_SYSTEM (coding_system
);
4185 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4186 /* We must suppress all character code conversion except for
4187 end-of-line conversion. */
4188 coding_system
= raw_text_coding_system (coding_system
);
4189 setup_coding_system (coding_system
, &coding
);
4190 /* Ensure we set Vlast_coding_system_used. */
4191 set_coding_system
= 1;
4196 /* When we visit a file by raw-text, we change the buffer to
4198 if (CODING_FOR_UNIBYTE (&coding
)
4199 /* Can't do this if part of the buffer might be preserved. */
4201 /* Visiting a file with these coding system makes the buffer
4203 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4206 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4207 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4208 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4210 move_gap_both (PT
, PT_BYTE
);
4211 GAP_SIZE
+= inserted
;
4212 ZV_BYTE
-= inserted
;
4216 decode_coding_gap (&coding
, inserted
, inserted
);
4217 inserted
= coding
.produced_char
;
4218 coding_system
= CODING_ID_NAME (coding
.id
);
4220 else if (inserted
> 0)
4221 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4224 /* Call after-change hooks for the inserted text, aside from the case
4225 of normal visiting (not with REPLACE), which is done in a new buffer
4226 "before" the buffer is changed. */
4227 if (inserted
> 0 && total
> 0
4228 && (NILP (visit
) || !NILP (replace
)))
4230 signal_after_change (PT
, 0, inserted
);
4231 update_compositions (PT
, PT
, CHECK_BORDER
);
4234 /* Now INSERTED is measured in characters. */
4238 if (deferred_remove_unwind_protect
)
4239 /* If requested above, discard the unwind protect for closing the
4245 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4246 bset_undo_list (current_buffer
, Qnil
);
4250 current_buffer
->modtime
= mtime
;
4251 current_buffer
->modtime_size
= st
.st_size
;
4252 bset_filename (current_buffer
, orig_filename
);
4255 SAVE_MODIFF
= MODIFF
;
4256 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4257 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4258 #ifdef CLASH_DETECTION
4261 if (!NILP (BVAR (current_buffer
, file_truename
)))
4262 unlock_file (BVAR (current_buffer
, file_truename
));
4263 unlock_file (filename
);
4265 #endif /* CLASH_DETECTION */
4267 xsignal2 (Qfile_error
,
4268 build_string ("not a regular file"), orig_filename
);
4271 if (set_coding_system
)
4272 Vlast_coding_system_used
= coding_system
;
4274 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4276 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4278 if (! NILP (insval
))
4280 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4281 wrong_type_argument (intern ("inserted-chars"), insval
);
4282 inserted
= XFASTINT (insval
);
4286 /* Decode file format. */
4289 /* Don't run point motion or modification hooks when decoding. */
4290 ptrdiff_t count1
= SPECPDL_INDEX ();
4291 ptrdiff_t old_inserted
= inserted
;
4292 specbind (Qinhibit_point_motion_hooks
, Qt
);
4293 specbind (Qinhibit_modification_hooks
, Qt
);
4295 /* Save old undo list and don't record undo for decoding. */
4296 old_undo
= BVAR (current_buffer
, undo_list
);
4297 bset_undo_list (current_buffer
, Qt
);
4301 insval
= call3 (Qformat_decode
,
4302 Qnil
, make_number (inserted
), visit
);
4303 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4304 wrong_type_argument (intern ("inserted-chars"), insval
);
4305 inserted
= XFASTINT (insval
);
4309 /* If REPLACE is non-nil and we succeeded in not replacing the
4310 beginning or end of the buffer text with the file's contents,
4311 call format-decode with `point' positioned at the beginning
4312 of the buffer and `inserted' equaling the number of
4313 characters in the buffer. Otherwise, format-decode might
4314 fail to correctly analyze the beginning or end of the buffer.
4315 Hence we temporarily save `point' and `inserted' here and
4316 restore `point' iff format-decode did not insert or delete
4317 any text. Otherwise we leave `point' at point-min. */
4318 ptrdiff_t opoint
= PT
;
4319 ptrdiff_t opoint_byte
= PT_BYTE
;
4320 ptrdiff_t oinserted
= ZV
- BEGV
;
4321 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4323 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4324 insval
= call3 (Qformat_decode
,
4325 Qnil
, make_number (oinserted
), visit
);
4326 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4327 wrong_type_argument (intern ("inserted-chars"), insval
);
4328 if (ochars_modiff
== CHARS_MODIFF
)
4329 /* format_decode didn't modify buffer's characters => move
4330 point back to position before inserted text and leave
4331 value of inserted alone. */
4332 SET_PT_BOTH (opoint
, opoint_byte
);
4334 /* format_decode modified buffer's characters => consider
4335 entire buffer changed and leave point at point-min. */
4336 inserted
= XFASTINT (insval
);
4339 /* For consistency with format-decode call these now iff inserted > 0
4340 (martin 2007-06-28). */
4341 p
= Vafter_insert_file_functions
;
4346 insval
= call1 (XCAR (p
), make_number (inserted
));
4349 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4350 wrong_type_argument (intern ("inserted-chars"), insval
);
4351 inserted
= XFASTINT (insval
);
4356 /* For the rationale of this see the comment on
4357 format-decode above. */
4358 ptrdiff_t opoint
= PT
;
4359 ptrdiff_t opoint_byte
= PT_BYTE
;
4360 ptrdiff_t oinserted
= ZV
- BEGV
;
4361 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4363 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4364 insval
= call1 (XCAR (p
), make_number (oinserted
));
4367 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4368 wrong_type_argument (intern ("inserted-chars"), insval
);
4369 if (ochars_modiff
== CHARS_MODIFF
)
4370 /* after_insert_file_functions didn't modify
4371 buffer's characters => move point back to
4372 position before inserted text and leave value of
4374 SET_PT_BOTH (opoint
, opoint_byte
);
4376 /* after_insert_file_functions did modify buffer's
4377 characters => consider entire buffer changed and
4378 leave point at point-min. */
4379 inserted
= XFASTINT (insval
);
4389 bset_undo_list (current_buffer
, old_undo
);
4390 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4392 /* Adjust the last undo record for the size change during
4393 the format conversion. */
4394 Lisp_Object tem
= XCAR (old_undo
);
4395 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4396 && INTEGERP (XCDR (tem
))
4397 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4398 XSETCDR (tem
, make_number (PT
+ inserted
));
4402 /* If undo_list was Qt before, keep it that way.
4403 Otherwise start with an empty undo_list. */
4404 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4406 unbind_to (count1
, Qnil
);
4410 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4412 /* If visiting nonexistent file, return nil. */
4414 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4418 Fsignal (Qquit
, Qnil
);
4420 /* ??? Retval needs to be dealt with in all cases consistently. */
4422 val
= Fcons (orig_filename
,
4423 Fcons (make_number (inserted
),
4426 RETURN_UNGCPRO (unbind_to (count
, val
));
4429 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4432 build_annotations_unwind (Lisp_Object arg
)
4434 Vwrite_region_annotation_buffers
= arg
;
4438 /* Decide the coding-system to encode the data with. */
4441 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4442 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4443 struct coding_system
*coding
)
4446 Lisp_Object eol_parent
= Qnil
;
4449 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4450 BVAR (current_buffer
, auto_save_file_name
))))
4455 else if (!NILP (Vcoding_system_for_write
))
4457 val
= Vcoding_system_for_write
;
4458 if (coding_system_require_warning
4459 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4460 /* Confirm that VAL can surely encode the current region. */
4461 val
= call5 (Vselect_safe_coding_system_function
,
4462 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4467 /* If the variable `buffer-file-coding-system' is set locally,
4468 it means that the file was read with some kind of code
4469 conversion or the variable is explicitly set by users. We
4470 had better write it out with the same coding system even if
4471 `enable-multibyte-characters' is nil.
4473 If it is not set locally, we anyway have to convert EOL
4474 format if the default value of `buffer-file-coding-system'
4475 tells that it is not Unix-like (LF only) format. */
4476 bool using_default_coding
= 0;
4477 bool force_raw_text
= 0;
4479 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4481 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4484 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4490 /* Check file-coding-system-alist. */
4491 Lisp_Object args
[7], coding_systems
;
4493 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4494 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4496 coding_systems
= Ffind_operation_coding_system (7, args
);
4497 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4498 val
= XCDR (coding_systems
);
4503 /* If we still have not decided a coding system, use the
4504 default value of buffer-file-coding-system. */
4505 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4506 using_default_coding
= 1;
4509 if (! NILP (val
) && ! force_raw_text
)
4511 Lisp_Object spec
, attrs
;
4513 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4514 attrs
= AREF (spec
, 0);
4515 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4520 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4521 /* Confirm that VAL can surely encode the current region. */
4522 val
= call5 (Vselect_safe_coding_system_function
,
4523 start
, end
, val
, Qnil
, filename
);
4525 /* If the decided coding-system doesn't specify end-of-line
4526 format, we use that of
4527 `default-buffer-file-coding-system'. */
4528 if (! using_default_coding
4529 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4530 val
= (coding_inherit_eol_type
4531 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4533 /* If we decide not to encode text, use `raw-text' or one of its
4536 val
= raw_text_coding_system (val
);
4539 val
= coding_inherit_eol_type (val
, eol_parent
);
4540 setup_coding_system (val
, coding
);
4542 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4543 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4547 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4548 "r\nFWrite region to file: \ni\ni\ni\np",
4549 doc
: /* Write current region into specified file.
4550 When called from a program, requires three arguments:
4551 START, END and FILENAME. START and END are normally buffer positions
4552 specifying the part of the buffer to write.
4553 If START is nil, that means to use the entire buffer contents.
4554 If START is a string, then output that string to the file
4555 instead of any buffer contents; END is ignored.
4557 Optional fourth argument APPEND if non-nil means
4558 append to existing file contents (if any). If it is an integer,
4559 seek to that offset in the file before writing.
4560 Optional fifth argument VISIT, if t or a string, means
4561 set the last-save-file-modtime of buffer to this file's modtime
4562 and mark buffer not modified.
4563 If VISIT is a string, it is a second file name;
4564 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4565 VISIT is also the file name to lock and unlock for clash detection.
4566 If VISIT is neither t nor nil nor a string,
4567 that means do not display the \"Wrote file\" message.
4568 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4569 use for locking and unlocking, overriding FILENAME and VISIT.
4570 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4571 for an existing file with the same name. If MUSTBENEW is `excl',
4572 that means to get an error if the file already exists; never overwrite.
4573 If MUSTBENEW is neither nil nor `excl', that means ask for
4574 confirmation before overwriting, but do go ahead and overwrite the file
4575 if the user confirms.
4577 This does code conversion according to the value of
4578 `coding-system-for-write', `buffer-file-coding-system', or
4579 `file-coding-system-alist', and sets the variable
4580 `last-coding-system-used' to the coding system actually used.
4582 This calls `write-region-annotate-functions' at the start, and
4583 `write-region-post-annotation-function' at the end. */)
4584 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4592 ptrdiff_t count
= SPECPDL_INDEX ();
4594 Lisp_Object handler
;
4595 Lisp_Object visit_file
;
4596 Lisp_Object annotations
;
4597 Lisp_Object encoded_filename
;
4598 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4599 bool quietly
= !NILP (visit
);
4600 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4601 struct buffer
*given_buffer
;
4602 struct coding_system coding
;
4604 if (current_buffer
->base_buffer
&& visiting
)
4605 error ("Cannot do file visiting in an indirect buffer");
4607 if (!NILP (start
) && !STRINGP (start
))
4608 validate_region (&start
, &end
);
4611 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4613 filename
= Fexpand_file_name (filename
, Qnil
);
4615 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4616 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4618 if (STRINGP (visit
))
4619 visit_file
= Fexpand_file_name (visit
, Qnil
);
4621 visit_file
= filename
;
4623 if (NILP (lockname
))
4624 lockname
= visit_file
;
4628 /* If the file name has special constructs in it,
4629 call the corresponding file handler. */
4630 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4631 /* If FILENAME has no handler, see if VISIT has one. */
4632 if (NILP (handler
) && STRINGP (visit
))
4633 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4635 if (!NILP (handler
))
4638 val
= call6 (handler
, Qwrite_region
, start
, end
,
4639 filename
, append
, visit
);
4643 SAVE_MODIFF
= MODIFF
;
4644 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4645 bset_filename (current_buffer
, visit_file
);
4651 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4653 /* Special kludge to simplify auto-saving. */
4656 /* Do it later, so write-region-annotate-function can work differently
4657 if we save "the buffer" vs "a region".
4658 This is useful in tar-mode. --Stef
4659 XSETFASTINT (start, BEG);
4660 XSETFASTINT (end, Z); */
4664 record_unwind_protect (build_annotations_unwind
,
4665 Vwrite_region_annotation_buffers
);
4666 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4667 count1
= SPECPDL_INDEX ();
4669 given_buffer
= current_buffer
;
4671 if (!STRINGP (start
))
4673 annotations
= build_annotations (start
, end
);
4675 if (current_buffer
!= given_buffer
)
4677 XSETFASTINT (start
, BEGV
);
4678 XSETFASTINT (end
, ZV
);
4684 XSETFASTINT (start
, BEGV
);
4685 XSETFASTINT (end
, ZV
);
4690 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4692 /* Decide the coding-system to encode the data with.
4693 We used to make this choice before calling build_annotations, but that
4694 leads to problems when a write-annotate-function takes care of
4695 unsavable chars (as was the case with X-Symbol). */
4696 Vlast_coding_system_used
4697 = choose_write_coding_system (start
, end
, filename
,
4698 append
, visit
, lockname
, &coding
);
4700 #ifdef CLASH_DETECTION
4702 lock_file (lockname
);
4703 #endif /* CLASH_DETECTION */
4705 encoded_filename
= ENCODE_FILE (filename
);
4707 fn
= SSDATA (encoded_filename
);
4711 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4712 #else /* not DOS_NT */
4713 desc
= emacs_open (fn
, O_WRONLY
, 0);
4714 #endif /* not DOS_NT */
4716 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4718 desc
= emacs_open (fn
,
4719 O_WRONLY
| O_CREAT
| O_BINARY
4720 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4721 S_IREAD
| S_IWRITE
);
4722 #else /* not DOS_NT */
4723 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4724 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4725 auto_saving
? auto_save_mode_bits
: 0666);
4726 #endif /* not DOS_NT */
4730 #ifdef CLASH_DETECTION
4732 if (!auto_saving
) unlock_file (lockname
);
4734 #endif /* CLASH_DETECTION */
4736 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4739 record_unwind_protect (close_file_unwind
, make_number (desc
));
4741 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4745 if (NUMBERP (append
))
4746 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4748 ret
= lseek (desc
, 0, SEEK_END
);
4751 #ifdef CLASH_DETECTION
4753 if (!auto_saving
) unlock_file (lockname
);
4755 #endif /* CLASH_DETECTION */
4757 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4765 if (STRINGP (start
))
4766 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4767 else if (XINT (start
) != XINT (end
))
4768 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4769 &annotations
, &coding
);
4772 /* If file was empty, still need to write the annotations. */
4773 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4774 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4778 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4779 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4781 /* We have to flush out a data. */
4782 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4783 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4790 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4791 Disk full in NFS may be reported here. */
4792 /* mib says that closing the file will try to write as fast as NFS can do
4793 it, and that means the fsync here is not crucial for autosave files. */
4794 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4796 /* If fsync fails with EINTR, don't treat that as serious. Also
4797 ignore EINVAL which happens when fsync is not supported on this
4799 if (errno
!= EINTR
&& errno
!= EINVAL
)
4800 ok
= 0, save_errno
= errno
;
4804 modtime
= invalid_emacs_time ();
4807 if (fstat (desc
, &st
) == 0)
4808 modtime
= get_stat_mtime (&st
);
4810 ok
= 0, save_errno
= errno
;
4813 /* NFS can report a write failure now. */
4814 if (emacs_close (desc
) < 0)
4815 ok
= 0, save_errno
= errno
;
4817 /* Discard the unwind protect for close_file_unwind. */
4818 specpdl_ptr
= specpdl
+ count1
;
4820 /* Call write-region-post-annotation-function. */
4821 while (CONSP (Vwrite_region_annotation_buffers
))
4823 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4824 if (!NILP (Fbuffer_live_p (buf
)))
4827 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4828 call0 (Vwrite_region_post_annotation_function
);
4830 Vwrite_region_annotation_buffers
4831 = XCDR (Vwrite_region_annotation_buffers
);
4834 unbind_to (count
, Qnil
);
4836 #ifdef CLASH_DETECTION
4838 unlock_file (lockname
);
4839 #endif /* CLASH_DETECTION */
4841 /* Do this before reporting IO error
4842 to avoid a "file has changed on disk" warning on
4843 next attempt to save. */
4844 if (EMACS_TIME_VALID_P (modtime
))
4846 current_buffer
->modtime
= modtime
;
4847 current_buffer
->modtime_size
= st
.st_size
;
4851 error ("IO error writing %s: %s", SDATA (filename
),
4852 emacs_strerror (save_errno
));
4856 SAVE_MODIFF
= MODIFF
;
4857 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4858 bset_filename (current_buffer
, visit_file
);
4859 update_mode_lines
++;
4864 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4865 BVAR (current_buffer
, auto_save_file_name
))))
4866 SAVE_MODIFF
= MODIFF
;
4872 message_with_string ((INTEGERP (append
)
4882 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4884 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4885 doc
: /* Return t if (car A) is numerically less than (car B). */)
4886 (Lisp_Object a
, Lisp_Object b
)
4888 return Flss (Fcar (a
), Fcar (b
));
4891 /* Build the complete list of annotations appropriate for writing out
4892 the text between START and END, by calling all the functions in
4893 write-region-annotate-functions and merging the lists they return.
4894 If one of these functions switches to a different buffer, we assume
4895 that buffer contains altered text. Therefore, the caller must
4896 make sure to restore the current buffer in all cases,
4897 as save-excursion would do. */
4900 build_annotations (Lisp_Object start
, Lisp_Object end
)
4902 Lisp_Object annotations
;
4904 struct gcpro gcpro1
, gcpro2
;
4905 Lisp_Object original_buffer
;
4907 bool used_global
= 0;
4909 XSETBUFFER (original_buffer
, current_buffer
);
4912 p
= Vwrite_region_annotate_functions
;
4913 GCPRO2 (annotations
, p
);
4916 struct buffer
*given_buffer
= current_buffer
;
4917 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4918 { /* Use the global value of the hook. */
4921 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4923 p
= Fappend (2, arg
);
4926 Vwrite_region_annotations_so_far
= annotations
;
4927 res
= call2 (XCAR (p
), start
, end
);
4928 /* If the function makes a different buffer current,
4929 assume that means this buffer contains altered text to be output.
4930 Reset START and END from the buffer bounds
4931 and discard all previous annotations because they should have
4932 been dealt with by this function. */
4933 if (current_buffer
!= given_buffer
)
4935 Vwrite_region_annotation_buffers
4936 = Fcons (Fcurrent_buffer (),
4937 Vwrite_region_annotation_buffers
);
4938 XSETFASTINT (start
, BEGV
);
4939 XSETFASTINT (end
, ZV
);
4942 Flength (res
); /* Check basic validity of return value */
4943 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4947 /* Now do the same for annotation functions implied by the file-format */
4948 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4949 p
= BVAR (current_buffer
, auto_save_file_format
);
4951 p
= BVAR (current_buffer
, file_format
);
4952 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4954 struct buffer
*given_buffer
= current_buffer
;
4956 Vwrite_region_annotations_so_far
= annotations
;
4958 /* Value is either a list of annotations or nil if the function
4959 has written annotations to a temporary buffer, which is now
4961 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4962 original_buffer
, make_number (i
));
4963 if (current_buffer
!= given_buffer
)
4965 XSETFASTINT (start
, BEGV
);
4966 XSETFASTINT (end
, ZV
);
4971 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4979 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4980 If STRING is nil, POS is the character position in the current buffer.
4981 Intersperse with them the annotations from *ANNOT
4982 which fall within the range of POS to POS + NCHARS,
4983 each at its appropriate position.
4985 We modify *ANNOT by discarding elements as we use them up.
4987 Return true if successful. */
4990 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
4991 ptrdiff_t nchars
, Lisp_Object
*annot
,
4992 struct coding_system
*coding
)
4996 ptrdiff_t lastpos
= pos
+ nchars
;
4998 while (NILP (*annot
) || CONSP (*annot
))
5000 tem
= Fcar_safe (Fcar (*annot
));
5003 nextpos
= XFASTINT (tem
);
5005 /* If there are no more annotations in this range,
5006 output the rest of the range all at once. */
5007 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5008 return e_write (desc
, string
, pos
, lastpos
, coding
);
5010 /* Output buffer text up to the next annotation's position. */
5013 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5017 /* Output the annotation. */
5018 tem
= Fcdr (Fcar (*annot
));
5021 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5024 *annot
= Fcdr (*annot
);
5030 /* Write text in the range START and END into descriptor DESC,
5031 encoding them with coding system CODING. If STRING is nil, START
5032 and END are character positions of the current buffer, else they
5033 are indexes to the string STRING. Return true if successful. */
5036 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5037 struct coding_system
*coding
)
5039 if (STRINGP (string
))
5042 end
= SCHARS (string
);
5045 /* We used to have a code for handling selective display here. But,
5046 now it is handled within encode_coding. */
5050 if (STRINGP (string
))
5052 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5053 if (CODING_REQUIRE_ENCODING (coding
))
5055 encode_coding_object (coding
, string
,
5056 start
, string_char_to_byte (string
, start
),
5057 end
, string_char_to_byte (string
, end
), Qt
);
5061 coding
->dst_object
= string
;
5062 coding
->consumed_char
= SCHARS (string
);
5063 coding
->produced
= SBYTES (string
);
5068 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5069 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5071 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5072 if (CODING_REQUIRE_ENCODING (coding
))
5074 encode_coding_object (coding
, Fcurrent_buffer (),
5075 start
, start_byte
, end
, end_byte
, Qt
);
5079 coding
->dst_object
= Qnil
;
5080 coding
->dst_pos_byte
= start_byte
;
5081 if (start
>= GPT
|| end
<= GPT
)
5083 coding
->consumed_char
= end
- start
;
5084 coding
->produced
= end_byte
- start_byte
;
5088 coding
->consumed_char
= GPT
- start
;
5089 coding
->produced
= GPT_BYTE
- start_byte
;
5094 if (coding
->produced
> 0)
5097 -= emacs_write (desc
,
5098 STRINGP (coding
->dst_object
)
5099 ? SSDATA (coding
->dst_object
)
5100 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5103 if (coding
->produced
)
5106 start
+= coding
->consumed_char
;
5112 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5113 Sverify_visited_file_modtime
, 0, 1, 0,
5114 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5115 This means that the file has not been changed since it was visited or saved.
5116 If BUF is omitted or nil, it defaults to the current buffer.
5117 See Info node `(elisp)Modification Time' for more details. */)
5122 Lisp_Object handler
;
5123 Lisp_Object filename
;
5124 EMACS_TIME mtime
, diff
;
5134 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5135 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5137 /* If the file name has special constructs in it,
5138 call the corresponding file handler. */
5139 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5140 Qverify_visited_file_modtime
);
5141 if (!NILP (handler
))
5142 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5144 filename
= ENCODE_FILE (BVAR (b
, filename
));
5146 mtime
= (stat (SSDATA (filename
), &st
) == 0
5147 ? get_stat_mtime (&st
)
5148 : time_error_value (errno
));
5149 if ((EMACS_TIME_EQ (mtime
, b
->modtime
)
5150 /* If both exist, accept them if they are off by one second. */
5151 || (EMACS_TIME_VALID_P (mtime
) && EMACS_TIME_VALID_P (b
->modtime
)
5152 && ((diff
= (EMACS_TIME_LT (mtime
, b
->modtime
)
5153 ? sub_emacs_time (b
->modtime
, mtime
)
5154 : sub_emacs_time (mtime
, b
->modtime
))),
5155 EMACS_TIME_LE (diff
, make_emacs_time (1, 0)))))
5156 && (b
->modtime_size
< 0
5157 || st
.st_size
== b
->modtime_size
))
5162 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5163 Sclear_visited_file_modtime
, 0, 0, 0,
5164 doc
: /* Clear out records of last mod time of visited file.
5165 Next attempt to save will certainly not complain of a discrepancy. */)
5168 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5169 current_buffer
->modtime_size
= -1;
5173 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5174 Svisited_file_modtime
, 0, 0, 0,
5175 doc
: /* Return the current buffer's recorded visited file modification time.
5176 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5177 `file-attributes' returns. If the current buffer has no recorded file
5178 modification time, this function returns 0. If the visited file
5179 doesn't exist, HIGH will be -1.
5180 See Info node `(elisp)Modification Time' for more details. */)
5183 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5185 if (EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
5187 /* make_lisp_time won't work here if time_t is unsigned. */
5188 return list4 (make_number (-1), make_number (65535),
5189 make_number (0), make_number (0));
5191 return make_number (0);
5193 return make_lisp_time (current_buffer
->modtime
);
5196 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5197 Sset_visited_file_modtime
, 0, 1, 0,
5198 doc
: /* Update buffer's recorded modification time from the visited file's time.
5199 Useful if the buffer was not read from the file normally
5200 or if the file itself has been changed for some known benign reason.
5201 An argument specifies the modification time value to use
5202 \(instead of that of the visited file), in the form of a list
5203 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5204 (Lisp_Object time_list
)
5206 if (!NILP (time_list
))
5208 current_buffer
->modtime
= lisp_time_argument (time_list
);
5209 current_buffer
->modtime_size
= -1;
5213 register Lisp_Object filename
;
5215 Lisp_Object handler
;
5217 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5219 /* If the file name has special constructs in it,
5220 call the corresponding file handler. */
5221 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5222 if (!NILP (handler
))
5223 /* The handler can find the file name the same way we did. */
5224 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5226 filename
= ENCODE_FILE (filename
);
5228 if (stat (SSDATA (filename
), &st
) >= 0)
5230 current_buffer
->modtime
= get_stat_mtime (&st
);
5231 current_buffer
->modtime_size
= st
.st_size
;
5239 auto_save_error (Lisp_Object error_val
)
5241 Lisp_Object args
[3], msg
;
5243 struct gcpro gcpro1
;
5247 auto_save_error_occurred
= 1;
5249 ring_bell (XFRAME (selected_frame
));
5251 args
[0] = build_string ("Auto-saving %s: %s");
5252 args
[1] = BVAR (current_buffer
, name
);
5253 args
[2] = Ferror_message_string (error_val
);
5254 msg
= Fformat (3, args
);
5256 nbytes
= SBYTES (msg
);
5257 msgbuf
= SAFE_ALLOCA (nbytes
);
5258 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5260 for (i
= 0; i
< 3; ++i
)
5263 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5265 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5266 Fsleep_for (make_number (1), Qnil
);
5280 auto_save_mode_bits
= 0666;
5282 /* Get visited file's mode to become the auto save file's mode. */
5283 if (! NILP (BVAR (current_buffer
, filename
)))
5285 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5286 /* But make sure we can overwrite it later! */
5287 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5288 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5290 /* Remote files don't cooperate with stat. */
5291 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5295 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5296 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5301 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5304 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5316 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5319 minibuffer_auto_raise
= XINT (value
);
5324 do_auto_save_make_dir (Lisp_Object dir
)
5328 auto_saving_dir_umask
= 077;
5329 result
= call2 (Qmake_directory
, dir
, Qt
);
5330 auto_saving_dir_umask
= 0;
5335 do_auto_save_eh (Lisp_Object ignore
)
5337 auto_saving_dir_umask
= 0;
5341 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5342 doc
: /* Auto-save all buffers that need it.
5343 This is all buffers that have auto-saving enabled
5344 and are changed since last auto-saved.
5345 Auto-saving writes the buffer into a file
5346 so that your editing is not lost if the system crashes.
5347 This file is not the file you visited; that changes only when you save.
5348 Normally we run the normal hook `auto-save-hook' before saving.
5350 A non-nil NO-MESSAGE argument means do not print any message if successful.
5351 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5352 (Lisp_Object no_message
, Lisp_Object current_only
)
5354 struct buffer
*old
= current_buffer
, *b
;
5355 Lisp_Object tail
, buf
, hook
;
5356 bool auto_saved
= 0;
5357 int do_handled_files
;
5359 FILE *stream
= NULL
;
5360 ptrdiff_t count
= SPECPDL_INDEX ();
5361 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5362 bool old_message_p
= 0;
5363 struct gcpro gcpro1
, gcpro2
;
5365 if (max_specpdl_size
< specpdl_size
+ 40)
5366 max_specpdl_size
= specpdl_size
+ 40;
5371 if (NILP (no_message
))
5373 old_message_p
= push_message ();
5374 record_unwind_protect (pop_message_unwind
, Qnil
);
5377 /* Ordinarily don't quit within this function,
5378 but don't make it impossible to quit (in case we get hung in I/O). */
5382 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5383 point to non-strings reached from Vbuffer_alist. */
5385 hook
= intern ("auto-save-hook");
5386 Frun_hooks (1, &hook
);
5388 if (STRINGP (Vauto_save_list_file_name
))
5390 Lisp_Object listfile
;
5392 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5394 /* Don't try to create the directory when shutting down Emacs,
5395 because creating the directory might signal an error, and
5396 that would leave Emacs in a strange state. */
5397 if (!NILP (Vrun_hooks
))
5401 GCPRO2 (dir
, listfile
);
5402 dir
= Ffile_name_directory (listfile
);
5403 if (NILP (Ffile_directory_p (dir
)))
5404 internal_condition_case_1 (do_auto_save_make_dir
,
5410 stream
= fopen (SSDATA (listfile
), "w");
5413 record_unwind_protect (do_auto_save_unwind
,
5414 make_save_value (stream
, 0));
5415 record_unwind_protect (do_auto_save_unwind_1
,
5416 make_number (minibuffer_auto_raise
));
5417 minibuffer_auto_raise
= 0;
5419 auto_save_error_occurred
= 0;
5421 /* On first pass, save all files that don't have handlers.
5422 On second pass, save all files that do have handlers.
5424 If Emacs is crashing, the handlers may tweak what is causing
5425 Emacs to crash in the first place, and it would be a shame if
5426 Emacs failed to autosave perfectly ordinary files because it
5427 couldn't handle some ange-ftp'd file. */
5429 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5430 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5432 buf
= XCDR (XCAR (tail
));
5435 /* Record all the buffers that have auto save mode
5436 in the special file that lists them. For each of these buffers,
5437 Record visited name (if any) and auto save name. */
5438 if (STRINGP (BVAR (b
, auto_save_file_name
))
5439 && stream
!= NULL
&& do_handled_files
== 0)
5442 if (!NILP (BVAR (b
, filename
)))
5444 fwrite (SDATA (BVAR (b
, filename
)), 1,
5445 SBYTES (BVAR (b
, filename
)), stream
);
5447 putc ('\n', stream
);
5448 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5449 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5450 putc ('\n', stream
);
5454 if (!NILP (current_only
)
5455 && b
!= current_buffer
)
5458 /* Don't auto-save indirect buffers.
5459 The base buffer takes care of it. */
5463 /* Check for auto save enabled
5464 and file changed since last auto save
5465 and file changed since last real save. */
5466 if (STRINGP (BVAR (b
, auto_save_file_name
))
5467 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5468 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5469 /* -1 means we've turned off autosaving for a while--see below. */
5470 && XINT (BVAR (b
, save_length
)) >= 0
5471 && (do_handled_files
5472 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5475 EMACS_TIME before_time
= current_emacs_time ();
5476 EMACS_TIME after_time
;
5478 /* If we had a failure, don't try again for 20 minutes. */
5479 if (b
->auto_save_failure_time
> 0
5480 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5483 set_buffer_internal (b
);
5484 if (NILP (Vauto_save_include_big_deletions
)
5485 && (XFASTINT (BVAR (b
, save_length
)) * 10
5486 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5487 /* A short file is likely to change a large fraction;
5488 spare the user annoying messages. */
5489 && XFASTINT (BVAR (b
, save_length
)) > 5000
5490 /* These messages are frequent and annoying for `*mail*'. */
5491 && !EQ (BVAR (b
, filename
), Qnil
)
5492 && NILP (no_message
))
5494 /* It has shrunk too much; turn off auto-saving here. */
5495 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5496 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5498 minibuffer_auto_raise
= 0;
5499 /* Turn off auto-saving until there's a real save,
5500 and prevent any more warnings. */
5501 XSETINT (BVAR (b
, save_length
), -1);
5502 Fsleep_for (make_number (1), Qnil
);
5505 if (!auto_saved
&& NILP (no_message
))
5506 message1 ("Auto-saving...");
5507 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5509 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5510 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5511 set_buffer_internal (old
);
5513 after_time
= current_emacs_time ();
5515 /* If auto-save took more than 60 seconds,
5516 assume it was an NFS failure that got a timeout. */
5517 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5518 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5522 /* Prevent another auto save till enough input events come in. */
5523 record_auto_save ();
5525 if (auto_saved
&& NILP (no_message
))
5529 /* If we are going to restore an old message,
5530 give time to read ours. */
5531 sit_for (make_number (1), 0, 0);
5534 else if (!auto_save_error_occurred
)
5535 /* Don't overwrite the error message if an error occurred.
5536 If we displayed a message and then restored a state
5537 with no message, leave a "done" message on the screen. */
5538 message1 ("Auto-saving...done");
5543 /* This restores the message-stack status. */
5544 unbind_to (count
, Qnil
);
5548 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5549 Sset_buffer_auto_saved
, 0, 0, 0,
5550 doc
: /* Mark current buffer as auto-saved with its current text.
5551 No auto-save file will be written until the buffer changes again. */)
5554 /* FIXME: This should not be called in indirect buffers, since
5555 they're not autosaved. */
5556 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5557 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5558 current_buffer
->auto_save_failure_time
= 0;
5562 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5563 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5564 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5567 current_buffer
->auto_save_failure_time
= 0;
5571 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5573 doc
: /* Return t if current buffer has been auto-saved recently.
5574 More precisely, if it has been auto-saved since last read from or saved
5575 in the visited file. If the buffer has no visited file,
5576 then any auto-save counts as "recent". */)
5579 /* FIXME: maybe we should return nil for indirect buffers since
5580 they're never autosaved. */
5581 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5584 /* Reading and completing file names */
5586 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5587 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5588 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5589 The return value is only relevant for a call to `read-file-name' that happens
5590 before any other event (mouse or keypress) is handled. */)
5593 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5594 || defined (HAVE_NS)
5595 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5605 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5607 struct gcpro gcpro1
;
5608 Lisp_Object args
[7];
5610 GCPRO1 (default_filename
);
5611 args
[0] = intern ("read-file-name");
5614 args
[3] = default_filename
;
5615 args
[4] = mustmatch
;
5617 args
[6] = predicate
;
5618 RETURN_UNGCPRO (Ffuncall (7, args
));
5623 syms_of_fileio (void)
5625 DEFSYM (Qoperations
, "operations");
5626 DEFSYM (Qexpand_file_name
, "expand-file-name");
5627 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5628 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5629 DEFSYM (Qfile_name_directory
, "file-name-directory");
5630 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5631 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5632 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5633 DEFSYM (Qcopy_file
, "copy-file");
5634 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5635 DEFSYM (Qmake_directory
, "make-directory");
5636 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5637 DEFSYM (Qdelete_file
, "delete-file");
5638 DEFSYM (Qrename_file
, "rename-file");
5639 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5640 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5641 DEFSYM (Qfile_exists_p
, "file-exists-p");
5642 DEFSYM (Qfile_executable_p
, "file-executable-p");
5643 DEFSYM (Qfile_readable_p
, "file-readable-p");
5644 DEFSYM (Qfile_writable_p
, "file-writable-p");
5645 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5646 DEFSYM (Qaccess_file
, "access-file");
5647 DEFSYM (Qfile_directory_p
, "file-directory-p");
5648 DEFSYM (Qfile_regular_p
, "file-regular-p");
5649 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5650 DEFSYM (Qfile_modes
, "file-modes");
5651 DEFSYM (Qset_file_modes
, "set-file-modes");
5652 DEFSYM (Qset_file_times
, "set-file-times");
5653 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5654 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5655 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5656 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5657 DEFSYM (Qwrite_region
, "write-region");
5658 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5659 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5660 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5662 DEFSYM (Qfile_name_history
, "file-name-history");
5663 Fset (Qfile_name_history
, Qnil
);
5665 DEFSYM (Qfile_error
, "file-error");
5666 DEFSYM (Qfile_already_exists
, "file-already-exists");
5667 DEFSYM (Qfile_date_error
, "file-date-error");
5668 DEFSYM (Qexcl
, "excl");
5670 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5671 doc
: /* Coding system for encoding file names.
5672 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5673 Vfile_name_coding_system
= Qnil
;
5675 DEFVAR_LISP ("default-file-name-coding-system",
5676 Vdefault_file_name_coding_system
,
5677 doc
: /* Default coding system for encoding file names.
5678 This variable is used only when `file-name-coding-system' is nil.
5680 This variable is set/changed by the command `set-language-environment'.
5681 User should not set this variable manually,
5682 instead use `file-name-coding-system' to get a constant encoding
5683 of file names regardless of the current language environment. */);
5684 Vdefault_file_name_coding_system
= Qnil
;
5686 DEFSYM (Qformat_decode
, "format-decode");
5687 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5688 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5689 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5691 Fput (Qfile_error
, Qerror_conditions
,
5692 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5693 Fput (Qfile_error
, Qerror_message
,
5694 build_pure_c_string ("File error"));
5696 Fput (Qfile_already_exists
, Qerror_conditions
,
5697 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5698 Fput (Qfile_already_exists
, Qerror_message
,
5699 build_pure_c_string ("File already exists"));
5701 Fput (Qfile_date_error
, Qerror_conditions
,
5702 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5703 Fput (Qfile_date_error
, Qerror_message
,
5704 build_pure_c_string ("Cannot set file date"));
5706 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5707 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5708 If a file name matches REGEXP, all I/O on that file is done by calling
5709 HANDLER. If a file name matches more than one handler, the handler
5710 whose match starts last in the file name gets precedence. The
5711 function `find-file-name-handler' checks this list for a handler for
5714 HANDLER should be a function. The first argument given to it is the
5715 name of the I/O primitive to be handled; the remaining arguments are
5716 the arguments that were passed to that primitive. For example, if you
5717 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5718 HANDLER is called like this:
5720 (funcall HANDLER 'file-exists-p FILENAME)
5722 Note that HANDLER must be able to handle all I/O primitives; if it has
5723 nothing special to do for a primitive, it should reinvoke the
5724 primitive to handle the operation \"the usual way\".
5725 See Info node `(elisp)Magic File Names' for more details. */);
5726 Vfile_name_handler_alist
= Qnil
;
5728 DEFVAR_LISP ("set-auto-coding-function",
5729 Vset_auto_coding_function
,
5730 doc
: /* If non-nil, a function to call to decide a coding system of file.
5731 Two arguments are passed to this function: the file name
5732 and the length of a file contents following the point.
5733 This function should return a coding system to decode the file contents.
5734 It should check the file name against `auto-coding-alist'.
5735 If no coding system is decided, it should check a coding system
5736 specified in the heading lines with the format:
5737 -*- ... coding: CODING-SYSTEM; ... -*-
5738 or local variable spec of the tailing lines with `coding:' tag. */);
5739 Vset_auto_coding_function
= Qnil
;
5741 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5742 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5743 Each is passed one argument, the number of characters inserted,
5744 with point at the start of the inserted text. Each function
5745 should leave point the same, and return the new character count.
5746 If `insert-file-contents' is intercepted by a handler from
5747 `file-name-handler-alist', that handler is responsible for calling the
5748 functions in `after-insert-file-functions' if appropriate. */);
5749 Vafter_insert_file_functions
= Qnil
;
5751 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5752 doc
: /* A list of functions to be called at the start of `write-region'.
5753 Each is passed two arguments, START and END as for `write-region'.
5754 These are usually two numbers but not always; see the documentation
5755 for `write-region'. The function should return a list of pairs
5756 of the form (POSITION . STRING), consisting of strings to be effectively
5757 inserted at the specified positions of the file being written (1 means to
5758 insert before the first byte written). The POSITIONs must be sorted into
5761 If there are several annotation functions, the lists returned by these
5762 functions are merged destructively. As each annotation function runs,
5763 the variable `write-region-annotations-so-far' contains a list of all
5764 annotations returned by previous annotation functions.
5766 An annotation function can return with a different buffer current.
5767 Doing so removes the annotations returned by previous functions, and
5768 resets START and END to `point-min' and `point-max' of the new buffer.
5770 After `write-region' completes, Emacs calls the function stored in
5771 `write-region-post-annotation-function', once for each buffer that was
5772 current when building the annotations (i.e., at least once), with that
5773 buffer current. */);
5774 Vwrite_region_annotate_functions
= Qnil
;
5775 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5777 DEFVAR_LISP ("write-region-post-annotation-function",
5778 Vwrite_region_post_annotation_function
,
5779 doc
: /* Function to call after `write-region' completes.
5780 The function is called with no arguments. If one or more of the
5781 annotation functions in `write-region-annotate-functions' changed the
5782 current buffer, the function stored in this variable is called for
5783 each of those additional buffers as well, in addition to the original
5784 buffer. The relevant buffer is current during each function call. */);
5785 Vwrite_region_post_annotation_function
= Qnil
;
5786 staticpro (&Vwrite_region_annotation_buffers
);
5788 DEFVAR_LISP ("write-region-annotations-so-far",
5789 Vwrite_region_annotations_so_far
,
5790 doc
: /* When an annotation function is called, this holds the previous annotations.
5791 These are the annotations made by other annotation functions
5792 that were already called. See also `write-region-annotate-functions'. */);
5793 Vwrite_region_annotations_so_far
= Qnil
;
5795 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5796 doc
: /* A list of file name handlers that temporarily should not be used.
5797 This applies only to the operation `inhibit-file-name-operation'. */);
5798 Vinhibit_file_name_handlers
= Qnil
;
5800 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5801 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5802 Vinhibit_file_name_operation
= Qnil
;
5804 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5805 doc
: /* File name in which we write a list of all auto save file names.
5806 This variable is initialized automatically from `auto-save-list-file-prefix'
5807 shortly after Emacs reads your init file, if you have not yet given it
5808 a non-nil value. */);
5809 Vauto_save_list_file_name
= Qnil
;
5811 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5812 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5813 Normally auto-save files are written under other names. */);
5814 Vauto_save_visited_file_name
= Qnil
;
5816 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5817 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5818 If nil, deleting a substantial portion of the text disables auto-save
5819 in the buffer; this is the default behavior, because the auto-save
5820 file is usually more useful if it contains the deleted text. */);
5821 Vauto_save_include_big_deletions
= Qnil
;
5824 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5825 doc
: /* Non-nil means don't call fsync in `write-region'.
5826 This variable affects calls to `write-region' as well as save commands.
5827 A non-nil value may result in data loss! */);
5828 write_region_inhibit_fsync
= 0;
5831 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5832 doc
: /* Specifies whether to use the system's trash can.
5833 When non-nil, certain file deletion commands use the function
5834 `move-file-to-trash' instead of deleting files outright.
5835 This includes interactive calls to `delete-file' and
5836 `delete-directory' and the Dired deletion commands. */);
5837 delete_by_moving_to_trash
= 0;
5838 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5840 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5841 DEFSYM (Qcopy_directory
, "copy-directory");
5842 DEFSYM (Qdelete_directory
, "delete-directory");
5844 defsubr (&Sfind_file_name_handler
);
5845 defsubr (&Sfile_name_directory
);
5846 defsubr (&Sfile_name_nondirectory
);
5847 defsubr (&Sunhandled_file_name_directory
);
5848 defsubr (&Sfile_name_as_directory
);
5849 defsubr (&Sdirectory_file_name
);
5850 defsubr (&Smake_temp_name
);
5851 defsubr (&Sexpand_file_name
);
5852 defsubr (&Ssubstitute_in_file_name
);
5853 defsubr (&Scopy_file
);
5854 defsubr (&Smake_directory_internal
);
5855 defsubr (&Sdelete_directory_internal
);
5856 defsubr (&Sdelete_file
);
5857 defsubr (&Srename_file
);
5858 defsubr (&Sadd_name_to_file
);
5859 defsubr (&Smake_symbolic_link
);
5860 defsubr (&Sfile_name_absolute_p
);
5861 defsubr (&Sfile_exists_p
);
5862 defsubr (&Sfile_executable_p
);
5863 defsubr (&Sfile_readable_p
);
5864 defsubr (&Sfile_writable_p
);
5865 defsubr (&Saccess_file
);
5866 defsubr (&Sfile_symlink_p
);
5867 defsubr (&Sfile_directory_p
);
5868 defsubr (&Sfile_accessible_directory_p
);
5869 defsubr (&Sfile_regular_p
);
5870 defsubr (&Sfile_modes
);
5871 defsubr (&Sset_file_modes
);
5872 defsubr (&Sset_file_times
);
5873 defsubr (&Sfile_selinux_context
);
5874 defsubr (&Sset_file_selinux_context
);
5875 defsubr (&Sset_default_file_modes
);
5876 defsubr (&Sdefault_file_modes
);
5877 defsubr (&Sfile_newer_than_file_p
);
5878 defsubr (&Sinsert_file_contents
);
5879 defsubr (&Swrite_region
);
5880 defsubr (&Scar_less_than_car
);
5881 defsubr (&Sverify_visited_file_modtime
);
5882 defsubr (&Sclear_visited_file_modtime
);
5883 defsubr (&Svisited_file_modtime
);
5884 defsubr (&Sset_visited_file_modtime
);
5885 defsubr (&Sdo_auto_save
);
5886 defsubr (&Sset_buffer_auto_saved
);
5887 defsubr (&Sclear_buffer_auto_save_failure
);
5888 defsubr (&Srecent_auto_save_p
);
5890 defsubr (&Snext_read_file_uses_dialog_p
);
5893 defsubr (&Sunix_sync
);