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>
35 #ifdef HAVE_LIBSELINUX
36 #include <selinux/selinux.h>
37 #include <selinux/context.h>
43 #include "intervals.h"
44 #include "character.h"
48 #include "blockinput.h"
50 #include "dispextern.h"
56 #endif /* not WINDOWSNT */
60 #include <sys/param.h>
65 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
66 redirector allows the six letters between 'Z' and 'a' as well. */
68 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
71 #define IS_DRIVE(x) c_isalpha (x)
73 /* Need to lower-case the drive letter, or else expanded
74 filenames will sometimes compare unequal, because
75 `expand-file-name' doesn't always down-case the drive letter. */
76 #define DRIVE_LETTER(x) c_tolower (x)
80 #include <stat-time.h>
88 /* Nonzero during writing of auto-save files. */
89 static int auto_saving
;
91 /* Nonzero umask during creation of auto-save directories. */
92 static int auto_saving_dir_umask
;
94 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
95 a new file with the same mode as the original. */
96 static int auto_save_mode_bits
;
98 /* Set by auto_save_1 if an error occurred during the last auto-save. */
99 static int auto_save_error_occurred
;
101 /* The symbol bound to coding-system-for-read when
102 insert-file-contents is called for recovering a file. This is not
103 an actual coding system name, but just an indicator to tell
104 insert-file-contents to use `emacs-mule' with a special flag for
105 auto saving and recovering a file. */
106 static Lisp_Object Qauto_save_coding
;
108 /* Property name of a file name handler,
109 which gives a list of operations it handles.. */
110 static Lisp_Object Qoperations
;
112 /* Lisp functions for translating file formats. */
113 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
115 /* Lisp function for setting buffer-file-coding-system and the
116 multibyteness of the current buffer after inserting a file. */
117 static Lisp_Object Qafter_insert_file_set_coding
;
119 static Lisp_Object Qwrite_region_annotate_functions
;
120 /* Each time an annotation function changes the buffer, the new buffer
122 static Lisp_Object Vwrite_region_annotation_buffers
;
127 static Lisp_Object Qdelete_by_moving_to_trash
;
129 /* Lisp function for moving files to trash. */
130 static Lisp_Object Qmove_file_to_trash
;
132 /* Lisp function for recursively copying directories. */
133 static Lisp_Object Qcopy_directory
;
135 /* Lisp function for recursively deleting directories. */
136 static Lisp_Object Qdelete_directory
;
141 Lisp_Object Qfile_error
;
142 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
143 static Lisp_Object Qexcl
;
144 Lisp_Object Qfile_name_history
;
146 static Lisp_Object Qcar_less_than_car
;
148 static int a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
149 Lisp_Object
*, struct coding_system
*);
150 static int e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
151 struct coding_system
*);
155 report_file_error (const char *string
, Lisp_Object data
)
157 Lisp_Object errstring
;
161 synchronize_system_messages_locale ();
162 str
= strerror (errorno
);
163 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
164 Vlocale_coding_system
, 0);
170 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
173 /* System error messages are capitalized. Downcase the initial
174 unless it is followed by a slash. (The slash case caters to
175 error messages that begin with "I/O" or, in German, "E/A".) */
176 if (STRING_MULTIBYTE (errstring
)
177 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
181 str
= SSDATA (errstring
);
182 c
= STRING_CHAR ((unsigned char *) str
);
183 Faset (errstring
, make_number (0), make_number (downcase (c
)));
186 xsignal (Qfile_error
,
187 Fcons (build_string (string
), Fcons (errstring
, data
)));
192 close_file_unwind (Lisp_Object fd
)
194 emacs_close (XFASTINT (fd
));
198 /* Restore point, having saved it as a marker. */
201 restore_point_unwind (Lisp_Object location
)
203 Fgoto_char (location
);
204 Fset_marker (location
, Qnil
, Qnil
);
209 static Lisp_Object Qexpand_file_name
;
210 static Lisp_Object Qsubstitute_in_file_name
;
211 static Lisp_Object Qdirectory_file_name
;
212 static Lisp_Object Qfile_name_directory
;
213 static Lisp_Object Qfile_name_nondirectory
;
214 static Lisp_Object Qunhandled_file_name_directory
;
215 static Lisp_Object Qfile_name_as_directory
;
216 static Lisp_Object Qcopy_file
;
217 static Lisp_Object Qmake_directory_internal
;
218 static Lisp_Object Qmake_directory
;
219 static Lisp_Object Qdelete_directory_internal
;
220 Lisp_Object Qdelete_file
;
221 static Lisp_Object Qrename_file
;
222 static Lisp_Object Qadd_name_to_file
;
223 static Lisp_Object Qmake_symbolic_link
;
224 Lisp_Object Qfile_exists_p
;
225 static Lisp_Object Qfile_executable_p
;
226 static Lisp_Object Qfile_readable_p
;
227 static Lisp_Object Qfile_writable_p
;
228 static Lisp_Object Qfile_symlink_p
;
229 static Lisp_Object Qaccess_file
;
230 Lisp_Object Qfile_directory_p
;
231 static Lisp_Object Qfile_regular_p
;
232 static Lisp_Object Qfile_accessible_directory_p
;
233 static Lisp_Object Qfile_modes
;
234 static Lisp_Object Qset_file_modes
;
235 static Lisp_Object Qset_file_times
;
236 static Lisp_Object Qfile_selinux_context
;
237 static Lisp_Object Qset_file_selinux_context
;
238 static Lisp_Object Qfile_newer_than_file_p
;
239 Lisp_Object Qinsert_file_contents
;
240 Lisp_Object Qwrite_region
;
241 static Lisp_Object Qverify_visited_file_modtime
;
242 static Lisp_Object Qset_visited_file_modtime
;
244 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
245 Sfind_file_name_handler
, 2, 2, 0,
246 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
247 Otherwise, return nil.
248 A file name is handled if one of the regular expressions in
249 `file-name-handler-alist' matches it.
251 If OPERATION equals `inhibit-file-name-operation', then we ignore
252 any handlers that are members of `inhibit-file-name-handlers',
253 but we still do run any other handlers. This lets handlers
254 use the standard functions without calling themselves recursively. */)
255 (Lisp_Object filename
, Lisp_Object operation
)
257 /* This function must not munge the match data. */
258 Lisp_Object chain
, inhibited_handlers
, result
;
262 CHECK_STRING (filename
);
264 if (EQ (operation
, Vinhibit_file_name_operation
))
265 inhibited_handlers
= Vinhibit_file_name_handlers
;
267 inhibited_handlers
= Qnil
;
269 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
270 chain
= XCDR (chain
))
276 Lisp_Object string
= XCAR (elt
);
278 Lisp_Object handler
= XCDR (elt
);
279 Lisp_Object operations
= Qnil
;
281 if (SYMBOLP (handler
))
282 operations
= Fget (handler
, Qoperations
);
285 && (match_pos
= fast_string_match (string
, filename
)) > pos
286 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
290 handler
= XCDR (elt
);
291 tem
= Fmemq (handler
, inhibited_handlers
);
305 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
307 doc
: /* Return the directory component in file name FILENAME.
308 Return nil if FILENAME does not include a directory.
309 Otherwise return a directory name.
310 Given a Unix syntax file name, returns a string ending in slash. */)
311 (Lisp_Object filename
)
314 register const char *beg
;
318 register const char *p
;
321 CHECK_STRING (filename
);
323 /* If the file name has special constructs in it,
324 call the corresponding file handler. */
325 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
328 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
330 return STRINGP (handled_name
) ? handled_name
: Qnil
;
334 beg
= alloca (SBYTES (filename
) + 1);
335 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
337 beg
= SSDATA (filename
);
339 p
= beg
+ SBYTES (filename
);
341 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
343 /* only recognize drive specifier at the beginning */
345 /* handle the "/:d:foo" and "/:foo" cases correctly */
346 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
347 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
354 /* Expansion of "c:" to drive and default directory. */
357 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
358 char *res
= alloca (MAXPATHLEN
+ 1);
361 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
363 memcpy (res
, beg
, 2);
368 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
370 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
373 p
= beg
+ strlen (beg
);
376 dostounix_filename (beg
);
379 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
382 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
383 Sfile_name_nondirectory
, 1, 1, 0,
384 doc
: /* Return file name FILENAME sans its directory.
385 For example, in a Unix-syntax file name,
386 this is everything after the last slash,
387 or the entire name if it contains no slash. */)
388 (Lisp_Object filename
)
390 register const char *beg
, *p
, *end
;
393 CHECK_STRING (filename
);
395 /* If the file name has special constructs in it,
396 call the corresponding file handler. */
397 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
400 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
402 if (STRINGP (handled_name
))
404 error ("Invalid handler in `file-name-handler-alist'");
407 beg
= SSDATA (filename
);
408 end
= p
= beg
+ SBYTES (filename
);
410 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
412 /* only recognize drive specifier at beginning */
414 /* handle the "/:d:foo" case correctly */
415 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
420 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
423 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
424 Sunhandled_file_name_directory
, 1, 1, 0,
425 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
426 A `directly usable' directory name is one that may be used without the
427 intervention of any file handler.
428 If FILENAME is a directly usable file itself, return
429 \(file-name-directory FILENAME).
430 If FILENAME refers to a file which is not accessible from a local process,
431 then this should return nil.
432 The `call-process' and `start-process' functions use this function to
433 get a current directory to run processes in. */)
434 (Lisp_Object filename
)
438 /* If the file name has special constructs in it,
439 call the corresponding file handler. */
440 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
443 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
445 return STRINGP (handled_name
) ? handled_name
: Qnil
;
448 return Ffile_name_directory (filename
);
451 /* Convert from file name SRC of length SRCLEN to directory name
452 in DST. On UNIX, just make sure there is a terminating /.
453 Return the length of DST. */
456 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
)
468 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
470 dst
[srclen
] = DIRECTORY_SEP
;
471 dst
[srclen
+ 1] = '\0';
475 dostounix_filename (dst
);
480 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
481 Sfile_name_as_directory
, 1, 1, 0,
482 doc
: /* Return a string representing the file name FILE interpreted as a directory.
483 This operation exists because a directory is also a file, but its name as
484 a directory is different from its name as a file.
485 The result can be used as the value of `default-directory'
486 or passed as second argument to `expand-file-name'.
487 For a Unix-syntax file name, just appends a slash. */)
498 /* If the file name has special constructs in it,
499 call the corresponding file handler. */
500 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
503 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
505 if (STRINGP (handled_name
))
507 error ("Invalid handler in `file-name-handler-alist'");
510 buf
= alloca (SBYTES (file
) + 10);
511 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
));
512 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
515 /* Convert from directory name SRC of length SRCLEN to
516 file name in DST. On UNIX, just make sure there isn't
517 a terminating /. Return the length of DST. */
520 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
)
522 /* Process as Unix format: just remove any final slash.
523 But leave "/" unchanged; do not change it to "". */
526 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
528 && !IS_ANY_SEP (dst
[srclen
- 2])
536 dostounix_filename (dst
);
541 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
543 doc
: /* Returns the file name of the directory named DIRECTORY.
544 This is the name of the file that holds the data for the directory DIRECTORY.
545 This operation exists because a directory is also a file, but its name as
546 a directory is different from its name as a file.
547 In Unix-syntax, this function just removes the final slash. */)
548 (Lisp_Object directory
)
554 CHECK_STRING (directory
);
556 if (NILP (directory
))
559 /* If the file name has special constructs in it,
560 call the corresponding file handler. */
561 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
564 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
566 if (STRINGP (handled_name
))
568 error ("Invalid handler in `file-name-handler-alist'");
571 buf
= alloca (SBYTES (directory
) + 20);
572 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
));
573 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
576 static const char make_temp_name_tbl
[64] =
578 'A','B','C','D','E','F','G','H',
579 'I','J','K','L','M','N','O','P',
580 'Q','R','S','T','U','V','W','X',
581 'Y','Z','a','b','c','d','e','f',
582 'g','h','i','j','k','l','m','n',
583 'o','p','q','r','s','t','u','v',
584 'w','x','y','z','0','1','2','3',
585 '4','5','6','7','8','9','-','_'
588 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
590 /* Value is a temporary file name starting with PREFIX, a string.
592 The Emacs process number forms part of the result, so there is
593 no danger of generating a name being used by another process.
594 In addition, this function makes an attempt to choose a name
595 which has no existing file. To make this work, PREFIX should be
596 an absolute file name.
598 BASE64_P non-zero means add the pid as 3 characters in base64
599 encoding. In this case, 6 characters will be added to PREFIX to
600 form the file name. Otherwise, if Emacs is running on a system
601 with long file names, add the pid as a decimal number.
603 This function signals an error if no unique file name could be
607 make_temp_name (Lisp_Object prefix
, int base64_p
)
613 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
616 CHECK_STRING (prefix
);
618 /* VAL is created by adding 6 characters to PREFIX. The first
619 three are the PID of this process, in base 64, and the second
620 three are incremented if the file already exists. This ensures
621 262144 unique file names per PID per PREFIX. */
627 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
628 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
629 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
634 #ifdef HAVE_LONG_FILE_NAMES
635 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
637 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
638 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
639 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
644 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
645 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
646 if (!STRING_MULTIBYTE (prefix
))
647 STRING_SET_UNIBYTE (val
);
649 memcpy (data
, SSDATA (prefix
), len
);
652 memcpy (p
, pidbuf
, pidlen
);
655 /* Here we try to minimize useless stat'ing when this function is
656 invoked many times successively with the same PREFIX. We achieve
657 this by initializing count to a random value, and incrementing it
660 We don't want make-temp-name to be called while dumping,
661 because then make_temp_name_count_initialized_p would get set
662 and then make_temp_name_count would not be set when Emacs starts. */
664 if (!make_temp_name_count_initialized_p
)
666 make_temp_name_count
= time (NULL
);
667 make_temp_name_count_initialized_p
= 1;
673 unsigned num
= make_temp_name_count
;
675 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
676 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
677 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
679 /* Poor man's congruential RN generator. Replace with
680 ++make_temp_name_count for debugging. */
681 make_temp_name_count
+= 25229;
682 make_temp_name_count
%= 225307;
684 if (stat (data
, &ignored
) < 0)
686 /* We want to return only if errno is ENOENT. */
690 /* The error here is dubious, but there is little else we
691 can do. The alternatives are to return nil, which is
692 as bad as (and in many cases worse than) throwing the
693 error, or to ignore the error, which will likely result
694 in looping through 225307 stat's, which is not only
695 dog-slow, but also useless since eventually nil would
696 have to be returned anyway. */
697 report_file_error ("Cannot create temporary name for prefix",
698 Fcons (prefix
, Qnil
));
705 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
706 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
707 The Emacs process number forms part of the result,
708 so there is no danger of generating a name being used by another process.
710 In addition, this function makes an attempt to choose a name
711 which has no existing file. To make this work,
712 PREFIX should be an absolute file name.
714 There is a race condition between calling `make-temp-name' and creating the
715 file which opens all kinds of security holes. For that reason, you should
716 probably use `make-temp-file' instead, except in three circumstances:
718 * If you are creating the file in the user's home directory.
719 * If you are creating a directory rather than an ordinary file.
720 * If you are taking special precautions as `make-temp-file' does. */)
723 return make_temp_name (prefix
, 0);
728 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
729 doc
: /* Convert filename NAME to absolute, and canonicalize it.
730 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
731 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
732 the current buffer's value of `default-directory' is used.
733 NAME should be a string that is a valid file name for the underlying
735 File name components that are `.' are removed, and
736 so are file name components followed by `..', along with the `..' itself;
737 note that these simplifications are done without checking the resulting
738 file names in the file system.
739 Multiple consecutive slashes are collapsed into a single slash,
740 except at the beginning of the file name when they are significant (e.g.,
741 UNC file names on MS-Windows.)
742 An initial `~/' expands to your home directory.
743 An initial `~USER/' expands to USER's home directory.
744 See also the function `substitute-in-file-name'.
746 For technical reasons, this function can return correct but
747 non-intuitive results for the root directory; for instance,
748 \(expand-file-name ".." "/") returns "/..". For this reason, use
749 \(directory-file-name (file-name-directory dirname)) to traverse a
750 filesystem tree, not (expand-file-name ".." dirname). */)
751 (Lisp_Object name
, Lisp_Object default_directory
)
753 /* These point to SDATA and need to be careful with string-relocation
754 during GC (via DECODE_FILE). */
757 /* This should only point to alloca'd data. */
764 int collapse_newdir
= 1;
768 Lisp_Object handler
, result
, handled_name
;
774 /* If the file name has special constructs in it,
775 call the corresponding file handler. */
776 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
779 handled_name
= call3 (handler
, Qexpand_file_name
,
780 name
, default_directory
);
781 if (STRINGP (handled_name
))
783 error ("Invalid handler in `file-name-handler-alist'");
787 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
788 if (NILP (default_directory
))
789 default_directory
= BVAR (current_buffer
, directory
);
790 if (! STRINGP (default_directory
))
793 /* "/" is not considered a root directory on DOS_NT, so using "/"
794 here causes an infinite recursion in, e.g., the following:
796 (let (default-directory)
797 (expand-file-name "a"))
799 To avoid this, we set default_directory to the root of the
801 default_directory
= build_string (emacs_root_dir ());
803 default_directory
= build_string ("/");
807 if (!NILP (default_directory
))
809 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
812 handled_name
= call3 (handler
, Qexpand_file_name
,
813 name
, default_directory
);
814 if (STRINGP (handled_name
))
816 error ("Invalid handler in `file-name-handler-alist'");
821 char *o
= SSDATA (default_directory
);
823 /* Make sure DEFAULT_DIRECTORY is properly expanded.
824 It would be better to do this down below where we actually use
825 default_directory. Unfortunately, calling Fexpand_file_name recursively
826 could invoke GC, and the strings might be relocated. This would
827 be annoying because we have pointers into strings lying around
828 that would need adjusting, and people would add new pointers to
829 the code and forget to adjust them, resulting in intermittent bugs.
830 Putting this call here avoids all that crud.
832 The EQ test avoids infinite recursion. */
833 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
834 /* Save time in some common cases - as long as default_directory
835 is not relative, it can be canonicalized with name below (if it
836 is needed at all) without requiring it to be expanded now. */
838 /* Detect MSDOS file names with drive specifiers. */
839 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
840 && IS_DIRECTORY_SEP (o
[2]))
842 /* Detect Windows file names in UNC format. */
843 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
845 #else /* not DOS_NT */
846 /* Detect Unix absolute file names (/... alone is not absolute on
848 && ! (IS_DIRECTORY_SEP (o
[0]))
849 #endif /* not DOS_NT */
855 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
859 multibyte
= STRING_MULTIBYTE (name
);
860 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
863 default_directory
= string_to_multibyte (default_directory
);
866 name
= string_to_multibyte (name
);
871 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
872 nm
= alloca (SBYTES (name
) + 1);
873 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
876 /* Note if special escape prefix is present, but remove for now. */
877 if (nm
[0] == '/' && nm
[1] == ':')
883 /* Find and remove drive specifier if present; this makes nm absolute
884 even if the rest of the name appears to be relative. Only look for
885 drive specifier at the beginning. */
886 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
888 drive
= (unsigned char) nm
[0];
893 /* If we see "c://somedir", we want to strip the first slash after the
894 colon when stripping the drive letter. Otherwise, this expands to
896 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
899 /* Discard any previous drive specifier if nm is now in UNC format. */
900 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
904 #endif /* WINDOWSNT */
907 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
908 none are found, we can probably return right away. We will avoid
909 allocating a new string if name is already fully expanded. */
911 IS_DIRECTORY_SEP (nm
[0])
913 && drive
&& !is_escaped
916 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
920 /* If it turns out that the filename we want to return is just a
921 suffix of FILENAME, we don't need to go through and edit
922 things; we just need to construct a new string using data
923 starting at the middle of FILENAME. If we set lose to a
924 non-zero value, that means we've discovered that we can't do
931 /* Since we know the name is absolute, we can assume that each
932 element starts with a "/". */
934 /* "." and ".." are hairy. */
935 if (IS_DIRECTORY_SEP (p
[0])
937 && (IS_DIRECTORY_SEP (p
[2])
939 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
942 /* We want to replace multiple `/' in a row with a single
945 && IS_DIRECTORY_SEP (p
[0])
946 && IS_DIRECTORY_SEP (p
[1]))
953 /* Make sure directories are all separated with /, but
954 avoid allocation of a new string when not required. */
955 dostounix_filename (nm
);
957 if (IS_DIRECTORY_SEP (nm
[1]))
959 if (strcmp (nm
, SSDATA (name
)) != 0)
960 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
964 /* Drive must be set, so this is okay. */
965 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
969 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
970 temp
[0] = DRIVE_LETTER (drive
);
971 name
= concat2 (build_string (temp
), name
);
974 #else /* not DOS_NT */
975 if (strcmp (nm
, SSDATA (name
)) == 0)
977 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
978 #endif /* not DOS_NT */
982 /* At this point, nm might or might not be an absolute file name. We
983 need to expand ~ or ~user if present, otherwise prefix nm with
984 default_directory if nm is not absolute, and finally collapse /./
985 and /foo/../ sequences.
987 We set newdir to be the appropriate prefix if one is needed:
988 - the relevant user directory if nm starts with ~ or ~user
989 - the specified drive's working dir (DOS/NT only) if nm does not
991 - the value of default_directory.
993 Note that these prefixes are not guaranteed to be absolute (except
994 for the working dir of a drive). Therefore, to ensure we always
995 return an absolute name, if the final prefix is not absolute we
996 append it to the current working directory. */
1000 if (nm
[0] == '~') /* prefix ~ */
1002 if (IS_DIRECTORY_SEP (nm
[1])
1003 || nm
[1] == 0) /* ~ by itself */
1007 if (!(newdir
= egetenv ("HOME")))
1010 /* `egetenv' may return a unibyte string, which will bite us since
1011 we expect the directory to be multibyte. */
1012 tem
= build_string (newdir
);
1013 if (!STRING_MULTIBYTE (tem
))
1015 hdir
= DECODE_FILE (tem
);
1016 newdir
= SSDATA (hdir
);
1019 collapse_newdir
= 0;
1022 else /* ~user/filename */
1025 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1026 o
= alloca (p
- nm
+ 1);
1027 memcpy (o
, nm
, p
- nm
);
1031 pw
= (struct passwd
*) getpwnam (o
+ 1);
1035 newdir
= pw
->pw_dir
;
1038 collapse_newdir
= 0;
1042 /* If we don't find a user of that name, leave the name
1043 unchanged; don't move nm forward to p. */
1048 /* On DOS and Windows, nm is absolute if a drive name was specified;
1049 use the drive's current directory as the prefix if needed. */
1050 if (!newdir
&& drive
)
1052 /* Get default directory if needed to make nm absolute. */
1054 if (!IS_DIRECTORY_SEP (nm
[0]))
1056 adir
= alloca (MAXPATHLEN
+ 1);
1057 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1062 /* Either nm starts with /, or drive isn't mounted. */
1064 adir
[0] = DRIVE_LETTER (drive
);
1073 /* Finally, if no prefix has been specified and nm is not absolute,
1074 then it must be expanded relative to default_directory. */
1078 /* /... alone is not absolute on DOS and Windows. */
1079 && !IS_DIRECTORY_SEP (nm
[0])
1082 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1086 newdir
= SSDATA (default_directory
);
1088 /* Note if special escape prefix is present, but remove for now. */
1089 if (newdir
[0] == '/' && newdir
[1] == ':')
1100 /* First ensure newdir is an absolute name. */
1102 /* Detect MSDOS file names with drive specifiers. */
1103 ! (IS_DRIVE (newdir
[0])
1104 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1106 /* Detect Windows file names in UNC format. */
1107 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1111 /* Effectively, let newdir be (expand-file-name newdir cwd).
1112 Because of the admonition against calling expand-file-name
1113 when we have pointers into lisp strings, we accomplish this
1114 indirectly by prepending newdir to nm if necessary, and using
1115 cwd (or the wd of newdir's drive) as the new newdir. */
1117 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1119 drive
= (unsigned char) newdir
[0];
1122 if (!IS_DIRECTORY_SEP (nm
[0]))
1124 ptrdiff_t newlen
= strlen (newdir
);
1125 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1126 file_name_as_directory (tmp
, newdir
, newlen
);
1130 adir
= alloca (MAXPATHLEN
+ 1);
1133 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1141 /* Strip off drive name from prefix, if present. */
1142 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1148 /* Keep only a prefix from newdir if nm starts with slash
1149 (//server/share for UNC, nothing otherwise). */
1150 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1153 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1155 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1157 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1159 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1172 /* Get rid of any slash at the end of newdir, unless newdir is
1173 just / or // (an incomplete UNC name). */
1174 length
= strlen (newdir
);
1176 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1178 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1182 char *temp
= alloca (length
);
1183 memcpy (temp
, newdir
, length
- 1);
1184 temp
[length
- 1] = 0;
1195 /* Now concatenate the directory and name to new space in the stack frame. */
1196 tlen
+= strlen (nm
) + 1;
1198 /* Reserve space for drive specifier and escape prefix, since either
1199 or both may need to be inserted. (The Microsoft x86 compiler
1200 produces incorrect code if the following two lines are combined.) */
1201 target
= alloca (tlen
+ 4);
1203 #else /* not DOS_NT */
1204 target
= alloca (tlen
);
1205 #endif /* not DOS_NT */
1210 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1213 /* If newdir is effectively "C:/", then the drive letter will have
1214 been stripped and newdir will be "/". Concatenating with an
1215 absolute directory in nm produces "//", which will then be
1216 incorrectly treated as a network share. Ignore newdir in
1217 this case (keeping the drive letter). */
1218 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1219 && newdir
[1] == '\0'))
1221 strcpy (target
, newdir
);
1224 file_name_as_directory (target
, newdir
, length
);
1227 strcat (target
, nm
);
1229 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1237 if (!IS_DIRECTORY_SEP (*p
))
1241 else if (p
[1] == '.'
1242 && (IS_DIRECTORY_SEP (p
[2])
1245 /* If "/." is the entire filename, keep the "/". Otherwise,
1246 just delete the whole "/.". */
1247 if (o
== target
&& p
[2] == '\0')
1251 else if (p
[1] == '.' && p
[2] == '.'
1252 /* `/../' is the "superroot" on certain file systems.
1253 Turned off on DOS_NT systems because they have no
1254 "superroot" and because this causes us to produce
1255 file names like "d:/../foo" which fail file-related
1256 functions of the underlying OS. (To reproduce, try a
1257 long series of "../../" in default_directory, longer
1258 than the number of levels from the root.) */
1262 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1267 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1270 /* Don't go below server level in UNC filenames. */
1271 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1272 && IS_DIRECTORY_SEP (*target
))
1276 /* Keep initial / only if this is the whole name. */
1277 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1281 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1282 /* Collapse multiple `/' in a row. */
1291 /* At last, set drive name. */
1293 /* Except for network file name. */
1294 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1295 #endif /* WINDOWSNT */
1297 if (!drive
) abort ();
1299 target
[0] = DRIVE_LETTER (drive
);
1302 /* Reinsert the escape prefix if required. */
1309 dostounix_filename (target
);
1312 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1315 /* Again look to see if the file name has special constructs in it
1316 and perhaps call the corresponding file handler. This is needed
1317 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1318 the ".." component gives us "/user@host:/bar/../baz" which needs
1319 to be expanded again. */
1320 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1321 if (!NILP (handler
))
1323 handled_name
= call3 (handler
, Qexpand_file_name
,
1324 result
, default_directory
);
1325 if (STRINGP (handled_name
))
1326 return handled_name
;
1327 error ("Invalid handler in `file-name-handler-alist'");
1334 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1335 This is the old version of expand-file-name, before it was thoroughly
1336 rewritten for Emacs 10.31. We leave this version here commented-out,
1337 because the code is very complex and likely to have subtle bugs. If
1338 bugs _are_ found, it might be of interest to look at the old code and
1339 see what did it do in the relevant situation.
1341 Don't remove this code: it's true that it will be accessible
1342 from the repository, but a few years from deletion, people will
1343 forget it is there. */
1345 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1346 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1347 "Convert FILENAME to absolute, and canonicalize it.\n\
1348 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1349 \(does not start with slash); if DEFAULT is nil or missing,\n\
1350 the current buffer's value of default-directory is used.\n\
1351 Filenames containing `.' or `..' as components are simplified;\n\
1352 initial `~/' expands to your home directory.\n\
1353 See also the function `substitute-in-file-name'.")
1355 Lisp_Object name
, defalt
;
1359 register unsigned char *newdir
, *p
, *o
;
1361 unsigned char *target
;
1365 CHECK_STRING (name
);
1368 /* If nm is absolute, flush ...// and detect /./ and /../.
1369 If no /./ or /../ we can return right away. */
1376 if (p
[0] == '/' && p
[1] == '/'
1379 if (p
[0] == '/' && p
[1] == '~')
1380 nm
= p
+ 1, lose
= 1;
1381 if (p
[0] == '/' && p
[1] == '.'
1382 && (p
[2] == '/' || p
[2] == 0
1383 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1389 if (nm
== SDATA (name
))
1391 return build_string (nm
);
1395 /* Now determine directory to start with and put it in NEWDIR. */
1399 if (nm
[0] == '~') /* prefix ~ */
1400 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1402 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1403 newdir
= (unsigned char *) "";
1406 else /* ~user/filename */
1408 /* Get past ~ to user. */
1409 unsigned char *user
= nm
+ 1;
1410 /* Find end of name. */
1411 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1412 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1413 /* Copy the user name into temp storage. */
1414 o
= alloca (len
+ 1);
1415 memcpy (o
, user
, len
);
1418 /* Look up the user name. */
1420 pw
= (struct passwd
*) getpwnam (o
+ 1);
1423 error ("\"%s\" isn't a registered user", o
+ 1);
1425 newdir
= (unsigned char *) pw
->pw_dir
;
1427 /* Discard the user name from NM. */
1431 if (nm
[0] != '/' && !newdir
)
1434 defalt
= current_buffer
->directory
;
1435 CHECK_STRING (defalt
);
1436 newdir
= SDATA (defalt
);
1439 /* Now concatenate the directory and name to new space in the stack frame. */
1441 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1442 target
= alloca (tlen
);
1447 if (nm
[0] == 0 || nm
[0] == '/')
1448 strcpy (target
, newdir
);
1450 file_name_as_directory (target
, newdir
);
1453 strcat (target
, nm
);
1455 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1466 else if (!strncmp (p
, "//", 2)
1472 else if (p
[0] == '/' && p
[1] == '.'
1473 && (p
[2] == '/' || p
[2] == 0))
1475 else if (!strncmp (p
, "/..", 3)
1476 /* `/../' is the "superroot" on certain file systems. */
1478 && (p
[3] == '/' || p
[3] == 0))
1480 while (o
!= target
&& *--o
!= '/')
1482 if (o
== target
&& *o
== '/')
1492 return make_string (target
, o
- target
);
1496 /* If /~ or // appears, discard everything through first slash. */
1498 file_name_absolute_p (const char *filename
)
1501 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1503 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1504 && IS_DIRECTORY_SEP (filename
[2]))
1510 search_embedded_absfilename (char *nm
, char *endp
)
1514 for (p
= nm
+ 1; p
< endp
; p
++)
1517 || IS_DIRECTORY_SEP (p
[-1]))
1518 && file_name_absolute_p (p
)
1519 #if defined (WINDOWSNT) || defined (CYGWIN)
1520 /* // at start of file name is meaningful in Apollo,
1521 WindowsNT and Cygwin systems. */
1522 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1523 #endif /* not (WINDOWSNT || CYGWIN) */
1526 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1527 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1529 char *o
= alloca (s
- p
+ 1);
1531 memcpy (o
, p
, s
- p
);
1534 /* If we have ~user and `user' exists, discard
1535 everything up to ~. But if `user' does not exist, leave
1536 ~user alone, it might be a literal file name. */
1538 pw
= getpwnam (o
+ 1);
1550 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1551 Ssubstitute_in_file_name
, 1, 1, 0,
1552 doc
: /* Substitute environment variables referred to in FILENAME.
1553 `$FOO' where FOO is an environment variable name means to substitute
1554 the value of that variable. The variable name should be terminated
1555 with a character not a letter, digit or underscore; otherwise, enclose
1556 the entire variable name in braces.
1558 If `/~' appears, all of FILENAME through that `/' is discarded.
1559 If `//' appears, everything up to and including the first of
1560 those `/' is discarded. */)
1561 (Lisp_Object filename
)
1565 register char *s
, *p
, *o
, *x
, *endp
;
1566 char *target
= NULL
;
1568 int substituted
= 0;
1571 Lisp_Object handler
;
1573 CHECK_STRING (filename
);
1575 multibyte
= STRING_MULTIBYTE (filename
);
1577 /* If the file name has special constructs in it,
1578 call the corresponding file handler. */
1579 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1580 if (!NILP (handler
))
1582 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1584 if (STRINGP (handled_name
))
1585 return handled_name
;
1586 error ("Invalid handler in `file-name-handler-alist'");
1589 /* Always work on a copy of the string, in case GC happens during
1590 decode of environment variables, causing the original Lisp_String
1591 data to be relocated. */
1592 nm
= alloca (SBYTES (filename
) + 1);
1593 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1596 dostounix_filename (nm
);
1597 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1599 endp
= nm
+ SBYTES (filename
);
1601 /* If /~ or // appears, discard everything through first slash. */
1602 p
= search_embedded_absfilename (nm
, endp
);
1604 /* Start over with the new string, so we check the file-name-handler
1605 again. Important with filenames like "/home/foo//:/hello///there"
1606 which would substitute to "/:/hello///there" rather than "/there". */
1607 return Fsubstitute_in_file_name
1608 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1610 /* See if any variables are substituted into the string
1611 and find the total length of their values in `total'. */
1613 for (p
= nm
; p
!= endp
;)
1623 /* "$$" means a single "$". */
1632 while (p
!= endp
&& *p
!= '}') p
++;
1633 if (*p
!= '}') goto missingclose
;
1639 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1643 /* Copy out the variable name. */
1644 target
= alloca (s
- o
+ 1);
1645 memcpy (target
, o
, s
- o
);
1648 strupr (target
); /* $home == $HOME etc. */
1651 /* Get variable value. */
1652 o
= egetenv (target
);
1655 /* Don't try to guess a maximum length - UTF8 can use up to
1656 four bytes per character. This code is unlikely to run
1657 in a situation that requires performance, so decoding the
1658 env variables twice should be acceptable. Note that
1659 decoding may cause a garbage collect. */
1660 Lisp_Object orig
, decoded
;
1661 orig
= build_unibyte_string (o
);
1662 decoded
= DECODE_FILE (orig
);
1663 total
+= SBYTES (decoded
);
1673 /* If substitution required, recopy the string and do it. */
1674 /* Make space in stack frame for the new copy. */
1675 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1678 /* Copy the rest of the name through, replacing $ constructs with values. */
1695 while (p
!= endp
&& *p
!= '}') p
++;
1696 if (*p
!= '}') goto missingclose
;
1702 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1706 /* Copy out the variable name. */
1707 target
= alloca (s
- o
+ 1);
1708 memcpy (target
, o
, s
- o
);
1711 strupr (target
); /* $home == $HOME etc. */
1714 /* Get variable value. */
1715 o
= egetenv (target
);
1719 strcpy (x
, target
); x
+= strlen (target
);
1723 Lisp_Object orig
, decoded
;
1724 ptrdiff_t orig_length
, decoded_length
;
1725 orig_length
= strlen (o
);
1726 orig
= make_unibyte_string (o
, orig_length
);
1727 decoded
= DECODE_FILE (orig
);
1728 decoded_length
= SBYTES (decoded
);
1729 memcpy (x
, SDATA (decoded
), decoded_length
);
1730 x
+= decoded_length
;
1732 /* If environment variable needed decoding, return value
1733 needs to be multibyte. */
1734 if (decoded_length
!= orig_length
1735 || memcmp (SDATA (decoded
), o
, orig_length
))
1742 /* If /~ or // appears, discard everything through first slash. */
1743 while ((p
= search_embedded_absfilename (xnm
, x
)))
1744 /* This time we do not start over because we've already expanded envvars
1745 and replaced $$ with $. Maybe we should start over as well, but we'd
1746 need to quote some $ to $$ first. */
1749 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1752 error ("Bad format environment-variable substitution");
1754 error ("Missing \"}\" in environment-variable substitution");
1756 error ("Substituting nonexistent environment variable \"%s\"", target
);
1762 /* A slightly faster and more convenient way to get
1763 (directory-file-name (expand-file-name FOO)). */
1766 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1768 register Lisp_Object absname
;
1770 absname
= Fexpand_file_name (filename
, defdir
);
1772 /* Remove final slash, if any (unless this is the root dir).
1773 stat behaves differently depending! */
1774 if (SCHARS (absname
) > 1
1775 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1776 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1777 /* We cannot take shortcuts; they might be wrong for magic file names. */
1778 absname
= Fdirectory_file_name (absname
);
1782 /* Signal an error if the file ABSNAME already exists.
1783 If INTERACTIVE is nonzero, ask the user whether to proceed,
1784 and bypass the error if the user says to go ahead.
1785 QUERYSTRING is a name for the action that is being considered
1788 *STATPTR is used to store the stat information if the file exists.
1789 If the file does not exist, STATPTR->st_mode is set to 0.
1790 If STATPTR is null, we don't store into it.
1792 If QUICK is nonzero, we ask for y or n, not yes or no. */
1795 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1796 int interactive
, struct stat
*statptr
, int quick
)
1798 register Lisp_Object tem
, encoded_filename
;
1799 struct stat statbuf
;
1800 struct gcpro gcpro1
;
1802 encoded_filename
= ENCODE_FILE (absname
);
1804 /* `stat' is a good way to tell whether the file exists,
1805 regardless of what access permissions it has. */
1806 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1808 if (S_ISDIR (statbuf
.st_mode
))
1809 xsignal2 (Qfile_error
,
1810 build_string ("File is a directory"), absname
);
1813 xsignal2 (Qfile_already_exists
,
1814 build_string ("File already exists"), absname
);
1816 tem
= format2 ("File %s already exists; %s anyway? ",
1817 absname
, build_string (querystring
));
1819 tem
= call1 (intern ("y-or-n-p"), tem
);
1821 tem
= do_yes_or_no_p (tem
);
1824 xsignal2 (Qfile_already_exists
,
1825 build_string ("File already exists"), absname
);
1832 statptr
->st_mode
= 0;
1837 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1838 "fCopy file: \nGCopy %s to file: \np\nP",
1839 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1840 If NEWNAME names a directory, copy FILE there.
1842 This function always sets the file modes of the output file to match
1845 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1846 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1847 signal a `file-already-exists' error without overwriting. If
1848 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1849 about overwriting; this is what happens in interactive use with M-x.
1850 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1853 Fourth arg KEEP-TIME non-nil means give the output file the same
1854 last-modified time as the old one. (This works on only some systems.)
1856 A prefix arg makes KEEP-TIME non-nil.
1858 If PRESERVE-UID-GID is non-nil, we try to transfer the
1859 uid and gid of FILE to NEWNAME.
1861 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1862 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1863 (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
)
1867 char buf
[16 * 1024];
1868 struct stat st
, out_st
;
1869 Lisp_Object handler
;
1870 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1871 ptrdiff_t count
= SPECPDL_INDEX ();
1872 int input_file_statable_p
;
1873 Lisp_Object encoded_file
, encoded_newname
;
1875 security_context_t con
;
1876 int fail
, conlength
= 0;
1879 encoded_file
= encoded_newname
= Qnil
;
1880 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1881 CHECK_STRING (file
);
1882 CHECK_STRING (newname
);
1884 if (!NILP (Ffile_directory_p (newname
)))
1885 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1887 newname
= Fexpand_file_name (newname
, Qnil
);
1889 file
= Fexpand_file_name (file
, Qnil
);
1891 /* If the input file name has special constructs in it,
1892 call the corresponding file handler. */
1893 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1894 /* Likewise for output file name. */
1896 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1897 if (!NILP (handler
))
1898 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1899 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1900 preserve_selinux_context
));
1902 encoded_file
= ENCODE_FILE (file
);
1903 encoded_newname
= ENCODE_FILE (newname
);
1905 if (NILP (ok_if_already_exists
)
1906 || INTEGERP (ok_if_already_exists
))
1907 barf_or_query_if_file_exists (newname
, "copy to it",
1908 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1909 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1913 if (!CopyFile (SDATA (encoded_file
),
1914 SDATA (encoded_newname
),
1916 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1917 /* CopyFile retains the timestamp by default. */
1918 else if (NILP (keep_time
))
1924 filename
= SDATA (encoded_newname
);
1926 /* Ensure file is writable while its modified time is set. */
1927 attributes
= GetFileAttributes (filename
);
1928 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1929 now
= current_emacs_time ();
1930 if (set_file_times (-1, filename
, now
, now
))
1932 /* Restore original attributes. */
1933 SetFileAttributes (filename
, attributes
);
1934 xsignal2 (Qfile_date_error
,
1935 build_string ("Cannot set file date"), newname
);
1937 /* Restore original attributes. */
1938 SetFileAttributes (filename
, attributes
);
1940 #else /* not WINDOWSNT */
1942 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1946 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1948 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1950 /* We can only copy regular files and symbolic links. Other files are not
1952 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1955 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1957 conlength
= fgetfilecon (ifd
, &con
);
1958 if (conlength
== -1)
1959 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1963 if (out_st
.st_mode
!= 0
1964 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1967 report_file_error ("Input and output files are the same",
1968 Fcons (file
, Fcons (newname
, Qnil
)));
1971 if (input_file_statable_p
)
1973 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1975 #if defined (EISDIR)
1976 /* Get a better looking error message. */
1979 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1984 /* System's default file type was set to binary by _fmode in emacs.c. */
1985 ofd
= emacs_open (SDATA (encoded_newname
),
1986 O_WRONLY
| O_TRUNC
| O_CREAT
1987 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1988 S_IREAD
| S_IWRITE
);
1989 #else /* not MSDOS */
1991 int new_mask
= 0666;
1992 if (input_file_statable_p
)
1994 if (!NILP (preserve_uid_gid
))
1996 new_mask
&= st
.st_mode
;
1998 ofd
= emacs_open (SSDATA (encoded_newname
),
1999 (O_WRONLY
| O_TRUNC
| O_CREAT
2000 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2003 #endif /* not MSDOS */
2005 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2007 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2011 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2012 if (emacs_write (ofd
, buf
, n
) != n
)
2013 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2017 /* Preserve the original file modes, and if requested, also its
2019 if (input_file_statable_p
)
2021 int mode_mask
= 07777;
2022 if (!NILP (preserve_uid_gid
))
2024 /* Attempt to change owner and group. If that doesn't work
2025 attempt to change just the group, as that is sometimes allowed.
2026 Adjust the mode mask to eliminate setuid or setgid bits
2027 that are inappropriate if the owner and group are wrong. */
2028 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2030 mode_mask
&= ~06000;
2031 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2035 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2036 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2038 #endif /* not MSDOS */
2043 /* Set the modified context back to the file. */
2044 fail
= fsetfilecon (ofd
, con
);
2045 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2046 if (fail
&& errno
!= ENOTSUP
)
2047 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2053 if (input_file_statable_p
)
2055 if (!NILP (keep_time
))
2057 EMACS_TIME atime
= get_stat_atime (&st
);
2058 EMACS_TIME mtime
= get_stat_mtime (&st
);
2059 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2060 xsignal2 (Qfile_date_error
,
2061 build_string ("Cannot set file date"), newname
);
2065 if (emacs_close (ofd
) < 0)
2066 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2071 if (input_file_statable_p
)
2073 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2074 and if it can't, it tells so. Otherwise, under MSDOS we usually
2075 get only the READ bit, which will make the copied file read-only,
2076 so it's better not to chmod at all. */
2077 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2078 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2081 #endif /* not WINDOWSNT */
2083 /* Discard the unwind protects. */
2084 specpdl_ptr
= specpdl
+ count
;
2090 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2091 Smake_directory_internal
, 1, 1, 0,
2092 doc
: /* Create a new directory named DIRECTORY. */)
2093 (Lisp_Object directory
)
2096 Lisp_Object handler
;
2097 Lisp_Object encoded_dir
;
2099 CHECK_STRING (directory
);
2100 directory
= Fexpand_file_name (directory
, Qnil
);
2102 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2103 if (!NILP (handler
))
2104 return call2 (handler
, Qmake_directory_internal
, directory
);
2106 encoded_dir
= ENCODE_FILE (directory
);
2108 dir
= SSDATA (encoded_dir
);
2111 if (mkdir (dir
) != 0)
2113 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2115 report_file_error ("Creating directory", list1 (directory
));
2120 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2121 Sdelete_directory_internal
, 1, 1, 0,
2122 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2123 (Lisp_Object directory
)
2126 Lisp_Object encoded_dir
;
2128 CHECK_STRING (directory
);
2129 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2130 encoded_dir
= ENCODE_FILE (directory
);
2131 dir
= SSDATA (encoded_dir
);
2133 if (rmdir (dir
) != 0)
2134 report_file_error ("Removing directory", list1 (directory
));
2139 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2140 "(list (read-file-name \
2141 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2142 \"Move file to trash: \" \"Delete file: \") \
2143 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2144 (null current-prefix-arg))",
2145 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2146 If file has multiple names, it continues to exist with the other names.
2147 TRASH non-nil means to trash the file instead of deleting, provided
2148 `delete-by-moving-to-trash' is non-nil.
2150 When called interactively, TRASH is t if no prefix argument is given.
2151 With a prefix argument, TRASH is nil. */)
2152 (Lisp_Object filename
, Lisp_Object trash
)
2154 Lisp_Object handler
;
2155 Lisp_Object encoded_file
;
2156 struct gcpro gcpro1
;
2159 if (!NILP (Ffile_directory_p (filename
))
2160 && NILP (Ffile_symlink_p (filename
)))
2161 xsignal2 (Qfile_error
,
2162 build_string ("Removing old name: is a directory"),
2165 filename
= Fexpand_file_name (filename
, Qnil
);
2167 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2168 if (!NILP (handler
))
2169 return call3 (handler
, Qdelete_file
, filename
, trash
);
2171 if (delete_by_moving_to_trash
&& !NILP (trash
))
2172 return call1 (Qmove_file_to_trash
, filename
);
2174 encoded_file
= ENCODE_FILE (filename
);
2176 if (0 > unlink (SSDATA (encoded_file
)))
2177 report_file_error ("Removing old name", list1 (filename
));
2182 internal_delete_file_1 (Lisp_Object ignore
)
2187 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2188 This ignores `delete-by-moving-to-trash'. */
2191 internal_delete_file (Lisp_Object filename
)
2195 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2196 Qt
, internal_delete_file_1
);
2200 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2201 "fRename file: \nGRename %s to file: \np",
2202 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2203 If file has names other than FILE, it continues to have those names.
2204 Signals a `file-already-exists' error if a file NEWNAME already exists
2205 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2206 A number as third arg means request confirmation if NEWNAME already exists.
2207 This is what happens in interactive use with M-x. */)
2208 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2210 Lisp_Object handler
;
2211 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2212 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2214 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2215 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2216 CHECK_STRING (file
);
2217 CHECK_STRING (newname
);
2218 file
= Fexpand_file_name (file
, Qnil
);
2220 if ((!NILP (Ffile_directory_p (newname
)))
2222 /* If the file names are identical but for the case,
2223 don't attempt to move directory to itself. */
2224 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2228 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2229 ? file
: Fdirectory_file_name (file
);
2230 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2233 newname
= Fexpand_file_name (newname
, Qnil
);
2235 /* If the file name has special constructs in it,
2236 call the corresponding file handler. */
2237 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2239 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2240 if (!NILP (handler
))
2241 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2242 file
, newname
, ok_if_already_exists
));
2244 encoded_file
= ENCODE_FILE (file
);
2245 encoded_newname
= ENCODE_FILE (newname
);
2248 /* If the file names are identical but for the case, don't ask for
2249 confirmation: they simply want to change the letter-case of the
2251 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2253 if (NILP (ok_if_already_exists
)
2254 || INTEGERP (ok_if_already_exists
))
2255 barf_or_query_if_file_exists (newname
, "rename to it",
2256 INTEGERP (ok_if_already_exists
), 0, 0);
2257 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2262 symlink_target
= Ffile_symlink_p (file
);
2263 if (! NILP (symlink_target
))
2264 Fmake_symbolic_link (symlink_target
, newname
,
2265 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2266 else if (!NILP (Ffile_directory_p (file
)))
2267 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2269 /* We have already prompted if it was an integer, so don't
2270 have copy-file prompt again. */
2271 Fcopy_file (file
, newname
,
2272 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2275 count
= SPECPDL_INDEX ();
2276 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2278 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2279 call2 (Qdelete_directory
, file
, Qt
);
2281 Fdelete_file (file
, Qnil
);
2282 unbind_to (count
, Qnil
);
2285 report_file_error ("Renaming", list2 (file
, newname
));
2291 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2292 "fAdd name to file: \nGName to add to %s: \np",
2293 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2294 Signals a `file-already-exists' error if a file NEWNAME already exists
2295 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2296 A number as third arg means request confirmation if NEWNAME already exists.
2297 This is what happens in interactive use with M-x. */)
2298 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2300 Lisp_Object handler
;
2301 Lisp_Object encoded_file
, encoded_newname
;
2302 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2304 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2305 encoded_file
= encoded_newname
= Qnil
;
2306 CHECK_STRING (file
);
2307 CHECK_STRING (newname
);
2308 file
= Fexpand_file_name (file
, Qnil
);
2310 if (!NILP (Ffile_directory_p (newname
)))
2311 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2313 newname
= Fexpand_file_name (newname
, Qnil
);
2315 /* If the file name has special constructs in it,
2316 call the corresponding file handler. */
2317 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2318 if (!NILP (handler
))
2319 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2320 newname
, ok_if_already_exists
));
2322 /* If the new name has special constructs in it,
2323 call the corresponding file handler. */
2324 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2325 if (!NILP (handler
))
2326 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2327 newname
, ok_if_already_exists
));
2329 encoded_file
= ENCODE_FILE (file
);
2330 encoded_newname
= ENCODE_FILE (newname
);
2332 if (NILP (ok_if_already_exists
)
2333 || INTEGERP (ok_if_already_exists
))
2334 barf_or_query_if_file_exists (newname
, "make it a new name",
2335 INTEGERP (ok_if_already_exists
), 0, 0);
2337 unlink (SSDATA (newname
));
2338 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2339 report_file_error ("Adding new name", list2 (file
, newname
));
2345 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2346 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2347 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2348 Both args must be strings.
2349 Signals a `file-already-exists' error if a file LINKNAME already exists
2350 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2351 A number as third arg means request confirmation if LINKNAME already exists.
2352 This happens for interactive use with M-x. */)
2353 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2355 Lisp_Object handler
;
2356 Lisp_Object encoded_filename
, encoded_linkname
;
2357 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2359 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2360 encoded_filename
= encoded_linkname
= Qnil
;
2361 CHECK_STRING (filename
);
2362 CHECK_STRING (linkname
);
2363 /* If the link target has a ~, we must expand it to get
2364 a truly valid file name. Otherwise, do not expand;
2365 we want to permit links to relative file names. */
2366 if (SREF (filename
, 0) == '~')
2367 filename
= Fexpand_file_name (filename
, Qnil
);
2369 if (!NILP (Ffile_directory_p (linkname
)))
2370 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2372 linkname
= Fexpand_file_name (linkname
, Qnil
);
2374 /* If the file name has special constructs in it,
2375 call the corresponding file handler. */
2376 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2377 if (!NILP (handler
))
2378 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2379 linkname
, ok_if_already_exists
));
2381 /* If the new link name has special constructs in it,
2382 call the corresponding file handler. */
2383 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2384 if (!NILP (handler
))
2385 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2386 linkname
, ok_if_already_exists
));
2388 encoded_filename
= ENCODE_FILE (filename
);
2389 encoded_linkname
= ENCODE_FILE (linkname
);
2391 if (NILP (ok_if_already_exists
)
2392 || INTEGERP (ok_if_already_exists
))
2393 barf_or_query_if_file_exists (linkname
, "make it a link",
2394 INTEGERP (ok_if_already_exists
), 0, 0);
2395 if (0 > symlink (SSDATA (encoded_filename
),
2396 SSDATA (encoded_linkname
)))
2398 /* If we didn't complain already, silently delete existing file. */
2399 if (errno
== EEXIST
)
2401 unlink (SSDATA (encoded_linkname
));
2402 if (0 <= symlink (SSDATA (encoded_filename
),
2403 SSDATA (encoded_linkname
)))
2409 if (errno
== ENOSYS
)
2412 xsignal1 (Qfile_error
,
2413 build_string ("Symbolic links are not supported"));
2416 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2423 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2425 doc
: /* Return t if file FILENAME specifies an absolute file name.
2426 On Unix, this is a name starting with a `/' or a `~'. */)
2427 (Lisp_Object filename
)
2429 CHECK_STRING (filename
);
2430 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2433 /* Return nonzero if file FILENAME exists and can be executed. */
2436 check_executable (char *filename
)
2440 if (stat (filename
, &st
) < 0)
2442 return ((st
.st_mode
& S_IEXEC
) != 0);
2443 #else /* not DOS_NT */
2444 #ifdef HAVE_EUIDACCESS
2445 return (euidaccess (filename
, 1) >= 0);
2447 /* Access isn't quite right because it uses the real uid
2448 and we really want to test with the effective uid.
2449 But Unix doesn't give us a right way to do it. */
2450 return (access (filename
, 1) >= 0);
2452 #endif /* not DOS_NT */
2455 /* Return nonzero if file FILENAME exists and can be written. */
2458 check_writable (const char *filename
)
2462 if (stat (filename
, &st
) < 0)
2464 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2465 #else /* not MSDOS */
2466 #ifdef HAVE_EUIDACCESS
2467 int res
= (euidaccess (filename
, 2) >= 0);
2469 /* euidaccess may have returned failure because Cygwin couldn't
2470 determine the file's UID or GID; if so, we return success. */
2474 if (stat (filename
, &st
) < 0)
2476 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2480 #else /* not HAVE_EUIDACCESS */
2481 /* Access isn't quite right because it uses the real uid
2482 and we really want to test with the effective uid.
2483 But Unix doesn't give us a right way to do it.
2484 Opening with O_WRONLY could work for an ordinary file,
2485 but would lose for directories. */
2486 return (access (filename
, 2) >= 0);
2487 #endif /* not HAVE_EUIDACCESS */
2488 #endif /* not MSDOS */
2491 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2492 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2493 See also `file-readable-p' and `file-attributes'.
2494 This returns nil for a symlink to a nonexistent file.
2495 Use `file-symlink-p' to test for such links. */)
2496 (Lisp_Object filename
)
2498 Lisp_Object absname
;
2499 Lisp_Object handler
;
2500 struct stat statbuf
;
2502 CHECK_STRING (filename
);
2503 absname
= Fexpand_file_name (filename
, Qnil
);
2505 /* If the file name has special constructs in it,
2506 call the corresponding file handler. */
2507 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2508 if (!NILP (handler
))
2509 return call2 (handler
, Qfile_exists_p
, absname
);
2511 absname
= ENCODE_FILE (absname
);
2513 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2516 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2517 doc
: /* Return t if FILENAME can be executed by you.
2518 For a directory, this means you can access files in that directory. */)
2519 (Lisp_Object filename
)
2521 Lisp_Object absname
;
2522 Lisp_Object handler
;
2524 CHECK_STRING (filename
);
2525 absname
= Fexpand_file_name (filename
, Qnil
);
2527 /* If the file name has special constructs in it,
2528 call the corresponding file handler. */
2529 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2530 if (!NILP (handler
))
2531 return call2 (handler
, Qfile_executable_p
, absname
);
2533 absname
= ENCODE_FILE (absname
);
2535 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2538 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2539 doc
: /* Return t if file FILENAME exists and you can read it.
2540 See also `file-exists-p' and `file-attributes'. */)
2541 (Lisp_Object filename
)
2543 Lisp_Object absname
;
2544 Lisp_Object handler
;
2547 struct stat statbuf
;
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_readable_p
);
2555 if (!NILP (handler
))
2556 return call2 (handler
, Qfile_readable_p
, absname
);
2558 absname
= ENCODE_FILE (absname
);
2560 #if defined (DOS_NT) || defined (macintosh)
2561 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2563 if (access (SDATA (absname
), 0) == 0)
2566 #else /* not DOS_NT and not macintosh */
2569 /* Opening a fifo without O_NONBLOCK can wait.
2570 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2571 except in the case of a fifo, on a system which handles it. */
2572 desc
= stat (SSDATA (absname
), &statbuf
);
2575 if (S_ISFIFO (statbuf
.st_mode
))
2576 flags
|= O_NONBLOCK
;
2578 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2583 #endif /* not DOS_NT and not macintosh */
2586 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2588 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2589 doc
: /* Return t if file FILENAME can be written or created by you. */)
2590 (Lisp_Object filename
)
2592 Lisp_Object absname
, dir
, encoded
;
2593 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_writable_p
);
2602 if (!NILP (handler
))
2603 return call2 (handler
, Qfile_writable_p
, absname
);
2605 encoded
= ENCODE_FILE (absname
);
2606 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2607 return (check_writable (SSDATA (encoded
))
2610 dir
= Ffile_name_directory (absname
);
2613 dir
= Fdirectory_file_name (dir
);
2616 dir
= ENCODE_FILE (dir
);
2618 /* The read-only attribute of the parent directory doesn't affect
2619 whether a file or directory can be created within it. Some day we
2620 should check ACLs though, which do affect this. */
2621 if (stat (SDATA (dir
), &statbuf
) < 0)
2623 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2625 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2630 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2631 doc
: /* Access file FILENAME, and get an error if that does not work.
2632 The second argument STRING is used in the error message.
2633 If there is no error, returns nil. */)
2634 (Lisp_Object filename
, Lisp_Object string
)
2636 Lisp_Object handler
, encoded_filename
, absname
;
2639 CHECK_STRING (filename
);
2640 absname
= Fexpand_file_name (filename
, Qnil
);
2642 CHECK_STRING (string
);
2644 /* If the file name has special constructs in it,
2645 call the corresponding file handler. */
2646 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2647 if (!NILP (handler
))
2648 return call3 (handler
, Qaccess_file
, absname
, string
);
2650 encoded_filename
= ENCODE_FILE (absname
);
2652 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2654 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2660 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2661 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2662 The value is the link target, as a string.
2663 Otherwise it returns nil.
2665 This function returns t when given the name of a symlink that
2666 points to a nonexistent file. */)
2667 (Lisp_Object filename
)
2669 Lisp_Object handler
;
2672 char readlink_buf
[READLINK_BUFSIZE
];
2674 CHECK_STRING (filename
);
2675 filename
= Fexpand_file_name (filename
, Qnil
);
2677 /* If the file name has special constructs in it,
2678 call the corresponding file handler. */
2679 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2680 if (!NILP (handler
))
2681 return call2 (handler
, Qfile_symlink_p
, filename
);
2683 filename
= ENCODE_FILE (filename
);
2685 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2689 val
= build_string (buf
);
2690 if (buf
[0] == '/' && strchr (buf
, ':'))
2691 val
= concat2 (build_string ("/:"), val
);
2692 if (buf
!= readlink_buf
)
2694 val
= DECODE_FILE (val
);
2698 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2699 doc
: /* Return t if FILENAME names an existing directory.
2700 Symbolic links to directories count as directories.
2701 See `file-symlink-p' to distinguish symlinks. */)
2702 (Lisp_Object filename
)
2704 register Lisp_Object absname
;
2706 Lisp_Object handler
;
2708 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2710 /* If the file name has special constructs in it,
2711 call the corresponding file handler. */
2712 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2713 if (!NILP (handler
))
2714 return call2 (handler
, Qfile_directory_p
, absname
);
2716 absname
= ENCODE_FILE (absname
);
2718 if (stat (SSDATA (absname
), &st
) < 0)
2720 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2723 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2724 Sfile_accessible_directory_p
, 1, 1, 0,
2725 doc
: /* Return t if file FILENAME names a directory you can open.
2726 For the value to be t, FILENAME must specify the name of a directory as a file,
2727 and the directory must allow you to open files in it. In order to use a
2728 directory as a buffer's current directory, this predicate must return true.
2729 A directory name spec may be given instead; then the value is t
2730 if the directory so specified exists and really is a readable and
2731 searchable directory. */)
2732 (Lisp_Object filename
)
2734 Lisp_Object handler
;
2736 struct gcpro gcpro1
;
2738 /* If the file name has special constructs in it,
2739 call the corresponding file handler. */
2740 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2741 if (!NILP (handler
))
2742 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2745 tem
= (NILP (Ffile_directory_p (filename
))
2746 || NILP (Ffile_executable_p (filename
)));
2748 return tem
? Qnil
: Qt
;
2751 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2752 doc
: /* Return t if FILENAME names a regular file.
2753 This is the sort of file that holds an ordinary stream of data bytes.
2754 Symbolic links to regular files count as regular files.
2755 See `file-symlink-p' to distinguish symlinks. */)
2756 (Lisp_Object filename
)
2758 register Lisp_Object absname
;
2760 Lisp_Object handler
;
2762 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2764 /* If the file name has special constructs in it,
2765 call the corresponding file handler. */
2766 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2767 if (!NILP (handler
))
2768 return call2 (handler
, Qfile_regular_p
, absname
);
2770 absname
= ENCODE_FILE (absname
);
2775 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2777 /* Tell stat to use expensive method to get accurate info. */
2778 Vw32_get_true_file_attributes
= Qt
;
2779 result
= stat (SDATA (absname
), &st
);
2780 Vw32_get_true_file_attributes
= tem
;
2784 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2787 if (stat (SSDATA (absname
), &st
) < 0)
2789 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2793 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2794 Sfile_selinux_context
, 1, 1, 0,
2795 doc
: /* Return SELinux context of file named FILENAME.
2796 The return value is a list (USER ROLE TYPE RANGE), where the list
2797 elements are strings naming the user, role, type, and range of the
2798 file's SELinux security context.
2800 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2801 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2802 (Lisp_Object filename
)
2804 Lisp_Object absname
;
2805 Lisp_Object values
[4];
2806 Lisp_Object handler
;
2808 security_context_t con
;
2813 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2815 /* If the file name has special constructs in it,
2816 call the corresponding file handler. */
2817 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2818 if (!NILP (handler
))
2819 return call2 (handler
, Qfile_selinux_context
, absname
);
2821 absname
= ENCODE_FILE (absname
);
2828 if (is_selinux_enabled ())
2830 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2833 context
= context_new (con
);
2834 if (context_user_get (context
))
2835 values
[0] = build_string (context_user_get (context
));
2836 if (context_role_get (context
))
2837 values
[1] = build_string (context_role_get (context
));
2838 if (context_type_get (context
))
2839 values
[2] = build_string (context_type_get (context
));
2840 if (context_range_get (context
))
2841 values
[3] = build_string (context_range_get (context
));
2842 context_free (context
);
2849 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2852 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2853 Sset_file_selinux_context
, 2, 2, 0,
2854 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2855 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2856 elements are strings naming the components of a SELinux context.
2858 This function does nothing if SELinux is disabled, or if Emacs was not
2859 compiled with SELinux support. */)
2860 (Lisp_Object filename
, Lisp_Object context
)
2862 Lisp_Object absname
;
2863 Lisp_Object handler
;
2865 Lisp_Object encoded_absname
;
2866 Lisp_Object user
= CAR_SAFE (context
);
2867 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2868 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2869 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2870 security_context_t con
;
2871 int fail
, conlength
;
2872 context_t parsed_con
;
2875 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2877 /* If the file name has special constructs in it,
2878 call the corresponding file handler. */
2879 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2880 if (!NILP (handler
))
2881 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2884 if (is_selinux_enabled ())
2886 /* Get current file context. */
2887 encoded_absname
= ENCODE_FILE (absname
);
2888 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2891 parsed_con
= context_new (con
);
2892 /* Change the parts defined in the parameter.*/
2895 if (context_user_set (parsed_con
, SSDATA (user
)))
2896 error ("Doing context_user_set");
2900 if (context_role_set (parsed_con
, SSDATA (role
)))
2901 error ("Doing context_role_set");
2905 if (context_type_set (parsed_con
, SSDATA (type
)))
2906 error ("Doing context_type_set");
2908 if (STRINGP (range
))
2910 if (context_range_set (parsed_con
, SSDATA (range
)))
2911 error ("Doing context_range_set");
2914 /* Set the modified context back to the file. */
2915 fail
= lsetfilecon (SSDATA (encoded_absname
),
2916 context_str (parsed_con
));
2917 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2918 if (fail
&& errno
!= ENOTSUP
)
2919 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2921 context_free (parsed_con
);
2924 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
2934 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2935 doc
: /* Return mode bits of file named FILENAME, as an integer.
2936 Return nil, if file does not exist or is not accessible. */)
2937 (Lisp_Object filename
)
2939 Lisp_Object absname
;
2941 Lisp_Object handler
;
2943 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2945 /* If the file name has special constructs in it,
2946 call the corresponding file handler. */
2947 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2948 if (!NILP (handler
))
2949 return call2 (handler
, Qfile_modes
, absname
);
2951 absname
= ENCODE_FILE (absname
);
2953 if (stat (SSDATA (absname
), &st
) < 0)
2956 return make_number (st
.st_mode
& 07777);
2959 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2960 "(let ((file (read-file-name \"File: \"))) \
2961 (list file (read-file-modes nil file)))",
2962 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2963 Only the 12 low bits of MODE are used.
2965 Interactively, mode bits are read by `read-file-modes', which accepts
2966 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2967 (Lisp_Object filename
, Lisp_Object mode
)
2969 Lisp_Object absname
, encoded_absname
;
2970 Lisp_Object handler
;
2972 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2973 CHECK_NUMBER (mode
);
2975 /* If the file name has special constructs in it,
2976 call the corresponding file handler. */
2977 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2978 if (!NILP (handler
))
2979 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2981 encoded_absname
= ENCODE_FILE (absname
);
2983 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
2984 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2989 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2990 doc
: /* Set the file permission bits for newly created files.
2991 The argument MODE should be an integer; only the low 9 bits are used.
2992 This setting is inherited by subprocesses. */)
2995 CHECK_NUMBER (mode
);
2997 umask ((~ XINT (mode
)) & 0777);
3002 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3003 doc
: /* Return the default file protection for created files.
3004 The value is an integer. */)
3011 realmask
= umask (0);
3015 XSETINT (value
, (~ realmask
) & 0777);
3020 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3021 doc
: /* Set times of file FILENAME to TIMESTAMP.
3022 Set both access and modification times.
3023 Return t on success, else nil.
3024 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3026 (Lisp_Object filename
, Lisp_Object timestamp
)
3028 Lisp_Object absname
, encoded_absname
;
3029 Lisp_Object handler
;
3030 EMACS_TIME t
= lisp_time_argument (timestamp
);
3032 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3034 /* If the file name has special constructs in it,
3035 call the corresponding file handler. */
3036 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3037 if (!NILP (handler
))
3038 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3040 encoded_absname
= ENCODE_FILE (absname
);
3043 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3048 /* Setting times on a directory always fails. */
3049 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
3052 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3061 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3062 doc
: /* Tell Unix to finish all pending disk updates. */)
3069 #endif /* HAVE_SYNC */
3071 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3072 doc
: /* Return t if file FILE1 is newer than file FILE2.
3073 If FILE1 does not exist, the answer is nil;
3074 otherwise, if FILE2 does not exist, the answer is t. */)
3075 (Lisp_Object file1
, Lisp_Object file2
)
3077 Lisp_Object absname1
, absname2
;
3078 struct stat st1
, st2
;
3079 Lisp_Object handler
;
3080 struct gcpro gcpro1
, gcpro2
;
3082 CHECK_STRING (file1
);
3083 CHECK_STRING (file2
);
3086 GCPRO2 (absname1
, file2
);
3087 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3088 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3091 /* If the file name has special constructs in it,
3092 call the corresponding file handler. */
3093 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3095 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3096 if (!NILP (handler
))
3097 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3099 GCPRO2 (absname1
, absname2
);
3100 absname1
= ENCODE_FILE (absname1
);
3101 absname2
= ENCODE_FILE (absname2
);
3104 if (stat (SSDATA (absname1
), &st1
) < 0)
3107 if (stat (SSDATA (absname2
), &st2
) < 0)
3110 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3114 #ifndef READ_BUF_SIZE
3115 #define READ_BUF_SIZE (64 << 10)
3117 /* Some buffer offsets are stored in 'int' variables. */
3118 verify (READ_BUF_SIZE
<= INT_MAX
);
3120 /* This function is called after Lisp functions to decide a coding
3121 system are called, or when they cause an error. Before they are
3122 called, the current buffer is set unibyte and it contains only a
3123 newly inserted text (thus the buffer was empty before the
3126 The functions may set markers, overlays, text properties, or even
3127 alter the buffer contents, change the current buffer.
3129 Here, we reset all those changes by:
3130 o set back the current buffer.
3131 o move all markers and overlays to BEG.
3132 o remove all text properties.
3133 o set back the buffer multibyteness. */
3136 decide_coding_unwind (Lisp_Object unwind_data
)
3138 Lisp_Object multibyte
, undo_list
, buffer
;
3140 multibyte
= XCAR (unwind_data
);
3141 unwind_data
= XCDR (unwind_data
);
3142 undo_list
= XCAR (unwind_data
);
3143 buffer
= XCDR (unwind_data
);
3145 if (current_buffer
!= XBUFFER (buffer
))
3146 set_buffer_internal (XBUFFER (buffer
));
3147 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3148 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3149 set_buffer_intervals (current_buffer
, NULL
);
3150 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3152 /* Now we are safe to change the buffer's multibyteness directly. */
3153 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3154 bset_undo_list (current_buffer
, undo_list
);
3160 /* Used to pass values from insert-file-contents to read_non_regular. */
3162 static int non_regular_fd
;
3163 static ptrdiff_t non_regular_inserted
;
3164 static int non_regular_nbytes
;
3167 /* Read from a non-regular file.
3168 Read non_regular_nbytes bytes max from non_regular_fd.
3169 Non_regular_inserted specifies where to put the read bytes.
3170 Value is the number of bytes read. */
3173 read_non_regular (Lisp_Object ignore
)
3179 nbytes
= emacs_read (non_regular_fd
,
3180 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3181 + non_regular_inserted
),
3182 non_regular_nbytes
);
3184 return make_number (nbytes
);
3188 /* Condition-case handler used when reading from non-regular files
3189 in insert-file-contents. */
3192 read_non_regular_quit (Lisp_Object ignore
)
3197 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3198 except that it also tests for OFFSET being out of lseek's range. */
3200 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3202 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3203 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3204 if (! ((TYPE_MINIMUM (off_t
) <= offset
) & (offset
<= TYPE_MAXIMUM (off_t
))))
3209 return lseek (fd
, offset
, whence
);
3212 /* Return a special time value indicating the error number ERRNUM. */
3214 time_error_value (int errnum
)
3216 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3217 ? NONEXISTENT_MODTIME_NSECS
3218 : UNKNOWN_MODTIME_NSECS
);
3219 return make_emacs_time (0, ns
);
3222 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3224 doc
: /* Insert contents of file FILENAME after point.
3225 Returns list of absolute file name and number of characters inserted.
3226 If second argument VISIT is non-nil, the buffer's visited filename and
3227 last save file modtime are set, and it is marked unmodified. If
3228 visiting and the file does not exist, visiting is completed before the
3231 The optional third and fourth arguments BEG and END specify what portion
3232 of the file to insert. These arguments count bytes in the file, not
3233 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3235 If optional fifth argument REPLACE is non-nil, replace the current
3236 buffer contents (in the accessible portion) with the file contents.
3237 This is better than simply deleting and inserting the whole thing
3238 because (1) it preserves some marker positions and (2) it puts less data
3239 in the undo list. When REPLACE is non-nil, the second return value is
3240 the number of characters that replace previous buffer contents.
3242 This function does code conversion according to the value of
3243 `coding-system-for-read' or `file-coding-system-alist', and sets the
3244 variable `last-coding-system-used' to the coding system actually used. */)
3245 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3251 ptrdiff_t inserted
= 0;
3253 register ptrdiff_t how_much
;
3254 off_t beg_offset
, end_offset
;
3255 register int unprocessed
;
3256 ptrdiff_t count
= SPECPDL_INDEX ();
3257 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3258 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3260 ptrdiff_t total
= 0;
3261 int not_regular
= 0;
3263 char read_buf
[READ_BUF_SIZE
];
3264 struct coding_system coding
;
3265 char buffer
[1 << 14];
3266 int replace_handled
= 0;
3267 int set_coding_system
= 0;
3268 Lisp_Object coding_system
;
3270 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3271 int we_locked_file
= 0;
3272 int deferred_remove_unwind_protect
= 0;
3274 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3275 error ("Cannot do file visiting in an indirect buffer");
3277 if (!NILP (BVAR (current_buffer
, read_only
)))
3278 Fbarf_if_buffer_read_only ();
3282 orig_filename
= Qnil
;
3285 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3287 CHECK_STRING (filename
);
3288 filename
= Fexpand_file_name (filename
, Qnil
);
3290 /* The value Qnil means that the coding system is not yet
3292 coding_system
= Qnil
;
3294 /* If the file name has special constructs in it,
3295 call the corresponding file handler. */
3296 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3297 if (!NILP (handler
))
3299 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3300 visit
, beg
, end
, replace
);
3301 if (CONSP (val
) && CONSP (XCDR (val
))
3302 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3303 inserted
= XINT (XCAR (XCDR (val
)));
3307 orig_filename
= filename
;
3308 filename
= ENCODE_FILE (filename
);
3314 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3316 /* Tell stat to use expensive method to get accurate info. */
3317 Vw32_get_true_file_attributes
= Qt
;
3318 file_status
= stat (SSDATA (filename
), &st
);
3319 Vw32_get_true_file_attributes
= tem
;
3322 file_status
= stat (SSDATA (filename
), &st
);
3323 #endif /* WINDOWSNT */
3325 if (file_status
== 0)
3326 mtime
= get_stat_mtime (&st
);
3332 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3333 mtime
= time_error_value (save_errno
);
3336 if (!NILP (Vcoding_system_for_read
))
3337 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3341 /* This code will need to be changed in order to work on named
3342 pipes, and it's probably just not worth it. So we should at
3343 least signal an error. */
3344 if (!S_ISREG (st
.st_mode
))
3351 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3352 xsignal2 (Qfile_error
,
3353 build_string ("not a regular file"), orig_filename
);
3357 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3360 /* Replacement should preserve point as it preserves markers. */
3361 if (!NILP (replace
))
3362 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3364 record_unwind_protect (close_file_unwind
, make_number (fd
));
3369 if (!NILP (beg
) || !NILP (end
))
3370 error ("Attempt to visit less than an entire file");
3371 if (BEG
< Z
&& NILP (replace
))
3372 error ("Cannot do file visiting in a non-empty buffer");
3377 if (! (RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
))))
3378 wrong_type_argument (intern ("file-offset"), beg
);
3379 beg_offset
= XFASTINT (beg
);
3386 if (! (RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
))))
3387 wrong_type_argument (intern ("file-offset"), end
);
3388 end_offset
= XFASTINT (end
);
3393 end_offset
= TYPE_MAXIMUM (off_t
);
3396 end_offset
= st
.st_size
;
3398 /* A negative size can happen on a platform that allows file
3399 sizes greater than the maximum off_t value. */
3403 /* The file size returned from stat may be zero, but data
3404 may be readable nonetheless, for example when this is a
3405 file in the /proc filesystem. */
3406 if (end_offset
== 0)
3407 end_offset
= READ_BUF_SIZE
;
3411 /* Check now whether the buffer will become too large,
3412 in the likely case where the file's length is not changing.
3413 This saves a lot of needless work before a buffer overflow. */
3416 /* The likely offset where we will stop reading. We could read
3417 more (or less), if the file grows (or shrinks) as we read it. */
3418 off_t likely_end
= min (end_offset
, st
.st_size
);
3420 if (beg_offset
< likely_end
)
3422 ptrdiff_t buf_bytes
=
3423 Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3424 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3425 off_t likely_growth
= likely_end
- beg_offset
;
3426 if (buf_growth_max
< likely_growth
)
3431 /* Prevent redisplay optimizations. */
3432 current_buffer
->clip_changed
= 1;
3434 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3436 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3437 setup_coding_system (coding_system
, &coding
);
3438 /* Ensure we set Vlast_coding_system_used. */
3439 set_coding_system
= 1;
3443 /* Decide the coding system to use for reading the file now
3444 because we can't use an optimized method for handling
3445 `coding:' tag if the current buffer is not empty. */
3446 if (!NILP (Vcoding_system_for_read
))
3447 coding_system
= Vcoding_system_for_read
;
3450 /* Don't try looking inside a file for a coding system
3451 specification if it is not seekable. */
3452 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3454 /* Find a coding system specified in the heading two
3455 lines or in the tailing several lines of the file.
3456 We assume that the 1K-byte and 3K-byte for heading
3457 and tailing respectively are sufficient for this
3461 if (st
.st_size
<= (1024 * 4))
3462 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3465 nread
= emacs_read (fd
, read_buf
, 1024);
3468 if (lseek (fd
, st
.st_size
- (1024 * 3), SEEK_SET
) < 0)
3469 report_file_error ("Setting file position",
3470 Fcons (orig_filename
, Qnil
));
3471 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3476 error ("IO error reading %s: %s",
3477 SDATA (orig_filename
), emacs_strerror (errno
));
3480 struct buffer
*prev
= current_buffer
;
3481 Lisp_Object workbuf
;
3484 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3486 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3487 buf
= XBUFFER (workbuf
);
3489 delete_all_overlays (buf
);
3490 bset_directory (buf
, BVAR (current_buffer
, directory
));
3491 bset_read_only (buf
, Qnil
);
3492 bset_filename (buf
, Qnil
);
3493 bset_undo_list (buf
, Qt
);
3494 eassert (buf
->overlays_before
== NULL
);
3495 eassert (buf
->overlays_after
== NULL
);
3497 set_buffer_internal (buf
);
3499 bset_enable_multibyte_characters (buf
, Qnil
);
3501 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3502 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3503 coding_system
= call2 (Vset_auto_coding_function
,
3504 filename
, make_number (nread
));
3505 set_buffer_internal (prev
);
3507 /* Discard the unwind protect for recovering the
3511 /* Rewind the file for the actual read done later. */
3512 if (lseek (fd
, 0, SEEK_SET
) < 0)
3513 report_file_error ("Setting file position",
3514 Fcons (orig_filename
, Qnil
));
3518 if (NILP (coding_system
))
3520 /* If we have not yet decided a coding system, check
3521 file-coding-system-alist. */
3522 Lisp_Object args
[6];
3524 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3525 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3526 coding_system
= Ffind_operation_coding_system (6, args
);
3527 if (CONSP (coding_system
))
3528 coding_system
= XCAR (coding_system
);
3532 if (NILP (coding_system
))
3533 coding_system
= Qundecided
;
3535 CHECK_CODING_SYSTEM (coding_system
);
3537 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3538 /* We must suppress all character code conversion except for
3539 end-of-line conversion. */
3540 coding_system
= raw_text_coding_system (coding_system
);
3542 setup_coding_system (coding_system
, &coding
);
3543 /* Ensure we set Vlast_coding_system_used. */
3544 set_coding_system
= 1;
3547 /* If requested, replace the accessible part of the buffer
3548 with the file contents. Avoid replacing text at the
3549 beginning or end of the buffer that matches the file contents;
3550 that preserves markers pointing to the unchanged parts.
3552 Here we implement this feature in an optimized way
3553 for the case where code conversion is NOT needed.
3554 The following if-statement handles the case of conversion
3555 in a less optimal way.
3557 If the code conversion is "automatic" then we try using this
3558 method and hope for the best.
3559 But if we discover the need for conversion, we give up on this method
3560 and let the following if-statement handle the replace job. */
3563 && (NILP (coding_system
)
3564 || ! CODING_REQUIRE_DECODING (&coding
)))
3566 /* same_at_start and same_at_end count bytes,
3567 because file access counts bytes
3568 and BEG and END count bytes. */
3569 ptrdiff_t same_at_start
= BEGV_BYTE
;
3570 ptrdiff_t same_at_end
= ZV_BYTE
;
3572 /* There is still a possibility we will find the need to do code
3573 conversion. If that happens, we set this variable to 1 to
3574 give up on handling REPLACE in the optimized way. */
3575 int giveup_match_end
= 0;
3577 if (beg_offset
!= 0)
3579 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3580 report_file_error ("Setting file position",
3581 Fcons (orig_filename
, Qnil
));
3586 /* Count how many chars at the start of the file
3587 match the text at the beginning of the buffer. */
3592 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3594 error ("IO error reading %s: %s",
3595 SSDATA (orig_filename
), emacs_strerror (errno
));
3596 else if (nread
== 0)
3599 if (CODING_REQUIRE_DETECTION (&coding
))
3601 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3604 setup_coding_system (coding_system
, &coding
);
3607 if (CODING_REQUIRE_DECODING (&coding
))
3608 /* We found that the file should be decoded somehow.
3609 Let's give up here. */
3611 giveup_match_end
= 1;
3616 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3617 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3618 same_at_start
++, bufpos
++;
3619 /* If we found a discrepancy, stop the scan.
3620 Otherwise loop around and scan the next bufferful. */
3621 if (bufpos
!= nread
)
3625 /* If the file matches the buffer completely,
3626 there's no need to replace anything. */
3627 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3631 /* Truncate the buffer to the size of the file. */
3632 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3637 /* Count how many chars at the end of the file
3638 match the text at the end of the buffer. But, if we have
3639 already found that decoding is necessary, don't waste time. */
3640 while (!giveup_match_end
)
3642 int total_read
, nread
, bufpos
, trial
;
3645 /* At what file position are we now scanning? */
3646 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3647 /* If the entire file matches the buffer tail, stop the scan. */
3650 /* How much can we scan in the next step? */
3651 trial
= min (curpos
, sizeof buffer
);
3652 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3653 report_file_error ("Setting file position",
3654 Fcons (orig_filename
, Qnil
));
3656 total_read
= nread
= 0;
3657 while (total_read
< trial
)
3659 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3661 error ("IO error reading %s: %s",
3662 SDATA (orig_filename
), emacs_strerror (errno
));
3663 else if (nread
== 0)
3665 total_read
+= nread
;
3668 /* Scan this bufferful from the end, comparing with
3669 the Emacs buffer. */
3670 bufpos
= total_read
;
3672 /* Compare with same_at_start to avoid counting some buffer text
3673 as matching both at the file's beginning and at the end. */
3674 while (bufpos
> 0 && same_at_end
> same_at_start
3675 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3676 same_at_end
--, bufpos
--;
3678 /* If we found a discrepancy, stop the scan.
3679 Otherwise loop around and scan the preceding bufferful. */
3682 /* If this discrepancy is because of code conversion,
3683 we cannot use this method; giveup and try the other. */
3684 if (same_at_end
> same_at_start
3685 && FETCH_BYTE (same_at_end
- 1) >= 0200
3686 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3687 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3688 giveup_match_end
= 1;
3697 if (! giveup_match_end
)
3701 /* We win! We can handle REPLACE the optimized way. */
3703 /* Extend the start of non-matching text area to multibyte
3704 character boundary. */
3705 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3706 while (same_at_start
> BEGV_BYTE
3707 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3710 /* Extend the end of non-matching text area to multibyte
3711 character boundary. */
3712 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3713 while (same_at_end
< ZV_BYTE
3714 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3717 /* Don't try to reuse the same piece of text twice. */
3718 overlap
= (same_at_start
- BEGV_BYTE
3720 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3722 same_at_end
+= overlap
;
3724 /* Arrange to read only the nonmatching middle part of the file. */
3725 beg_offset
+= same_at_start
- BEGV_BYTE
;
3726 end_offset
-= ZV_BYTE
- same_at_end
;
3728 del_range_byte (same_at_start
, same_at_end
, 0);
3729 /* Insert from the file at the proper position. */
3730 temp
= BYTE_TO_CHAR (same_at_start
);
3731 SET_PT_BOTH (temp
, same_at_start
);
3733 /* If display currently starts at beginning of line,
3734 keep it that way. */
3735 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3736 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3738 replace_handled
= 1;
3742 /* If requested, replace the accessible part of the buffer
3743 with the file contents. Avoid replacing text at the
3744 beginning or end of the buffer that matches the file contents;
3745 that preserves markers pointing to the unchanged parts.
3747 Here we implement this feature for the case where code conversion
3748 is needed, in a simple way that needs a lot of memory.
3749 The preceding if-statement handles the case of no conversion
3750 in a more optimized way. */
3751 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3753 ptrdiff_t same_at_start
= BEGV_BYTE
;
3754 ptrdiff_t same_at_end
= ZV_BYTE
;
3755 ptrdiff_t same_at_start_charpos
;
3756 ptrdiff_t inserted_chars
;
3759 unsigned char *decoded
;
3762 ptrdiff_t this_count
= SPECPDL_INDEX ();
3764 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3765 Lisp_Object conversion_buffer
;
3766 struct gcpro gcpro1
;
3768 conversion_buffer
= code_conversion_save (1, multibyte
);
3770 /* First read the whole file, performing code conversion into
3771 CONVERSION_BUFFER. */
3773 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3774 report_file_error ("Setting file position",
3775 Fcons (orig_filename
, Qnil
));
3777 total
= st
.st_size
; /* Total bytes in the file. */
3778 how_much
= 0; /* Bytes read from file so far. */
3779 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3780 unprocessed
= 0; /* Bytes not processed in previous loop. */
3782 GCPRO1 (conversion_buffer
);
3783 while (how_much
< total
)
3785 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3786 quitting while reading a huge while. */
3787 /* `try'' is reserved in some compilers (Microsoft C). */
3788 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3790 /* Allow quitting out of the actual I/O. */
3793 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3801 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3802 BUF_Z (XBUFFER (conversion_buffer
)));
3803 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3804 unprocessed
+ this, conversion_buffer
);
3805 unprocessed
= coding
.carryover_bytes
;
3806 if (coding
.carryover_bytes
> 0)
3807 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3812 /* We should remove the unwind_protect calling
3813 close_file_unwind, but other stuff has been added the stack,
3814 so defer the removal till we reach the `handled' label. */
3815 deferred_remove_unwind_protect
= 1;
3817 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3818 if we couldn't read the file. */
3821 error ("IO error reading %s: %s",
3822 SDATA (orig_filename
), emacs_strerror (errno
));
3824 if (unprocessed
> 0)
3826 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3827 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3828 unprocessed
, conversion_buffer
);
3829 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3832 coding_system
= CODING_ID_NAME (coding
.id
);
3833 set_coding_system
= 1;
3834 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3835 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3836 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3838 /* Compare the beginning of the converted string with the buffer
3842 while (bufpos
< inserted
&& same_at_start
< same_at_end
3843 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3844 same_at_start
++, bufpos
++;
3846 /* If the file matches the head of buffer completely,
3847 there's no need to replace anything. */
3849 if (bufpos
== inserted
)
3851 /* Truncate the buffer to the size of the file. */
3852 if (same_at_start
== same_at_end
)
3855 del_range_byte (same_at_start
, same_at_end
, 0);
3858 unbind_to (this_count
, Qnil
);
3862 /* Extend the start of non-matching text area to the previous
3863 multibyte character boundary. */
3864 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3865 while (same_at_start
> BEGV_BYTE
3866 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3869 /* Scan this bufferful from the end, comparing with
3870 the Emacs buffer. */
3873 /* Compare with same_at_start to avoid counting some buffer text
3874 as matching both at the file's beginning and at the end. */
3875 while (bufpos
> 0 && same_at_end
> same_at_start
3876 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3877 same_at_end
--, bufpos
--;
3879 /* Extend the end of non-matching text area to the next
3880 multibyte character boundary. */
3881 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3882 while (same_at_end
< ZV_BYTE
3883 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3886 /* Don't try to reuse the same piece of text twice. */
3887 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3889 same_at_end
+= overlap
;
3891 /* If display currently starts at beginning of line,
3892 keep it that way. */
3893 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3894 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3896 /* Replace the chars that we need to replace,
3897 and update INSERTED to equal the number of bytes
3898 we are taking from the decoded string. */
3899 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3901 if (same_at_end
!= same_at_start
)
3903 del_range_byte (same_at_start
, same_at_end
, 0);
3905 same_at_start
= GPT_BYTE
;
3909 temp
= BYTE_TO_CHAR (same_at_start
);
3911 /* Insert from the file at the proper position. */
3912 SET_PT_BOTH (temp
, same_at_start
);
3913 same_at_start_charpos
3914 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3915 same_at_start
- BEGV_BYTE
3916 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3918 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3919 same_at_start
+ inserted
- BEGV_BYTE
3920 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3921 - same_at_start_charpos
);
3922 /* This binding is to avoid ask-user-about-supersession-threat
3923 being called in insert_from_buffer (via in
3924 prepare_to_modify_buffer). */
3925 specbind (intern ("buffer-file-name"), Qnil
);
3926 insert_from_buffer (XBUFFER (conversion_buffer
),
3927 same_at_start_charpos
, inserted_chars
, 0);
3928 /* Set `inserted' to the number of inserted characters. */
3929 inserted
= PT
- temp
;
3930 /* Set point before the inserted characters. */
3931 SET_PT_BOTH (temp
, same_at_start
);
3933 unbind_to (this_count
, Qnil
);
3939 total
= end_offset
- beg_offset
;
3941 /* For a special file, all we can do is guess. */
3942 total
= READ_BUF_SIZE
;
3944 if (NILP (visit
) && total
> 0)
3946 #ifdef CLASH_DETECTION
3947 if (!NILP (BVAR (current_buffer
, file_truename
))
3948 /* Make binding buffer-file-name to nil effective. */
3949 && !NILP (BVAR (current_buffer
, filename
))
3950 && SAVE_MODIFF
>= MODIFF
)
3952 #endif /* CLASH_DETECTION */
3953 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3957 if (GAP_SIZE
< total
)
3958 make_gap (total
- GAP_SIZE
);
3960 if (beg_offset
!= 0 || !NILP (replace
))
3962 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3963 report_file_error ("Setting file position",
3964 Fcons (orig_filename
, Qnil
));
3967 /* In the following loop, HOW_MUCH contains the total bytes read so
3968 far for a regular file, and not changed for a special file. But,
3969 before exiting the loop, it is set to a negative value if I/O
3973 /* Total bytes inserted. */
3976 /* Here, we don't do code conversion in the loop. It is done by
3977 decode_coding_gap after all data are read into the buffer. */
3979 ptrdiff_t gap_size
= GAP_SIZE
;
3981 while (how_much
< total
)
3983 /* try is reserved in some compilers (Microsoft C) */
3984 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3991 /* Maybe make more room. */
3992 if (gap_size
< trytry
)
3994 make_gap (total
- gap_size
);
3995 gap_size
= GAP_SIZE
;
3998 /* Read from the file, capturing `quit'. When an
3999 error occurs, end the loop, and arrange for a quit
4000 to be signaled after decoding the text we read. */
4001 non_regular_fd
= fd
;
4002 non_regular_inserted
= inserted
;
4003 non_regular_nbytes
= trytry
;
4004 nbytes
= internal_condition_case_1 (read_non_regular
,
4006 read_non_regular_quit
);
4013 this = XINT (nbytes
);
4017 /* Allow quitting out of the actual I/O. We don't make text
4018 part of the buffer until all the reading is done, so a C-g
4019 here doesn't do any harm. */
4022 this = emacs_read (fd
,
4023 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4037 /* For a regular file, where TOTAL is the real size,
4038 count HOW_MUCH to compare with it.
4039 For a special file, where TOTAL is just a buffer size,
4040 so don't bother counting in HOW_MUCH.
4041 (INSERTED is where we count the number of characters inserted.) */
4048 /* Now we have read all the file data into the gap.
4049 If it was empty, undo marking the buffer modified. */
4053 #ifdef CLASH_DETECTION
4055 unlock_file (BVAR (current_buffer
, file_truename
));
4057 Vdeactivate_mark
= old_Vdeactivate_mark
;
4060 Vdeactivate_mark
= Qt
;
4062 /* Make the text read part of the buffer. */
4063 GAP_SIZE
-= inserted
;
4065 GPT_BYTE
+= inserted
;
4067 ZV_BYTE
+= inserted
;
4072 /* Put an anchor to ensure multi-byte form ends at gap. */
4077 /* Discard the unwind protect for closing the file. */
4081 error ("IO error reading %s: %s",
4082 SDATA (orig_filename
), emacs_strerror (errno
));
4086 if (NILP (coding_system
))
4088 /* The coding system is not yet decided. Decide it by an
4089 optimized method for handling `coding:' tag.
4091 Note that we can get here only if the buffer was empty
4092 before the insertion. */
4094 if (!NILP (Vcoding_system_for_read
))
4095 coding_system
= Vcoding_system_for_read
;
4098 /* Since we are sure that the current buffer was empty
4099 before the insertion, we can toggle
4100 enable-multibyte-characters directly here without taking
4101 care of marker adjustment. By this way, we can run Lisp
4102 program safely before decoding the inserted text. */
4103 Lisp_Object unwind_data
;
4104 ptrdiff_t count1
= SPECPDL_INDEX ();
4106 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4107 Fcons (BVAR (current_buffer
, undo_list
),
4108 Fcurrent_buffer ()));
4109 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4110 bset_undo_list (current_buffer
, Qt
);
4111 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4113 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4115 coding_system
= call2 (Vset_auto_coding_function
,
4116 filename
, make_number (inserted
));
4119 if (NILP (coding_system
))
4121 /* If the coding system is not yet decided, check
4122 file-coding-system-alist. */
4123 Lisp_Object args
[6];
4125 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4126 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4127 coding_system
= Ffind_operation_coding_system (6, args
);
4128 if (CONSP (coding_system
))
4129 coding_system
= XCAR (coding_system
);
4131 unbind_to (count1
, Qnil
);
4132 inserted
= Z_BYTE
- BEG_BYTE
;
4135 if (NILP (coding_system
))
4136 coding_system
= Qundecided
;
4138 CHECK_CODING_SYSTEM (coding_system
);
4140 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4141 /* We must suppress all character code conversion except for
4142 end-of-line conversion. */
4143 coding_system
= raw_text_coding_system (coding_system
);
4144 setup_coding_system (coding_system
, &coding
);
4145 /* Ensure we set Vlast_coding_system_used. */
4146 set_coding_system
= 1;
4151 /* When we visit a file by raw-text, we change the buffer to
4153 if (CODING_FOR_UNIBYTE (&coding
)
4154 /* Can't do this if part of the buffer might be preserved. */
4156 /* Visiting a file with these coding system makes the buffer
4158 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4161 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4162 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4163 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4165 move_gap_both (PT
, PT_BYTE
);
4166 GAP_SIZE
+= inserted
;
4167 ZV_BYTE
-= inserted
;
4171 decode_coding_gap (&coding
, inserted
, inserted
);
4172 inserted
= coding
.produced_char
;
4173 coding_system
= CODING_ID_NAME (coding
.id
);
4175 else if (inserted
> 0)
4176 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4179 /* Call after-change hooks for the inserted text, aside from the case
4180 of normal visiting (not with REPLACE), which is done in a new buffer
4181 "before" the buffer is changed. */
4182 if (inserted
> 0 && total
> 0
4183 && (NILP (visit
) || !NILP (replace
)))
4185 signal_after_change (PT
, 0, inserted
);
4186 update_compositions (PT
, PT
, CHECK_BORDER
);
4189 /* Now INSERTED is measured in characters. */
4193 if (deferred_remove_unwind_protect
)
4194 /* If requested above, discard the unwind protect for closing the
4200 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4201 bset_undo_list (current_buffer
, Qnil
);
4205 current_buffer
->modtime
= mtime
;
4206 current_buffer
->modtime_size
= st
.st_size
;
4207 bset_filename (current_buffer
, orig_filename
);
4210 SAVE_MODIFF
= MODIFF
;
4211 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4212 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4213 #ifdef CLASH_DETECTION
4216 if (!NILP (BVAR (current_buffer
, file_truename
)))
4217 unlock_file (BVAR (current_buffer
, file_truename
));
4218 unlock_file (filename
);
4220 #endif /* CLASH_DETECTION */
4222 xsignal2 (Qfile_error
,
4223 build_string ("not a regular file"), orig_filename
);
4226 if (set_coding_system
)
4227 Vlast_coding_system_used
= coding_system
;
4229 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4231 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4233 if (! NILP (insval
))
4235 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4236 wrong_type_argument (intern ("inserted-chars"), insval
);
4237 inserted
= XFASTINT (insval
);
4241 /* Decode file format. */
4244 /* Don't run point motion or modification hooks when decoding. */
4245 ptrdiff_t count1
= SPECPDL_INDEX ();
4246 ptrdiff_t old_inserted
= inserted
;
4247 specbind (Qinhibit_point_motion_hooks
, Qt
);
4248 specbind (Qinhibit_modification_hooks
, Qt
);
4250 /* Save old undo list and don't record undo for decoding. */
4251 old_undo
= BVAR (current_buffer
, undo_list
);
4252 bset_undo_list (current_buffer
, Qt
);
4256 insval
= call3 (Qformat_decode
,
4257 Qnil
, make_number (inserted
), visit
);
4258 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4259 wrong_type_argument (intern ("inserted-chars"), insval
);
4260 inserted
= XFASTINT (insval
);
4264 /* If REPLACE is non-nil and we succeeded in not replacing the
4265 beginning or end of the buffer text with the file's contents,
4266 call format-decode with `point' positioned at the beginning
4267 of the buffer and `inserted' equaling the number of
4268 characters in the buffer. Otherwise, format-decode might
4269 fail to correctly analyze the beginning or end of the buffer.
4270 Hence we temporarily save `point' and `inserted' here and
4271 restore `point' iff format-decode did not insert or delete
4272 any text. Otherwise we leave `point' at point-min. */
4273 ptrdiff_t opoint
= PT
;
4274 ptrdiff_t opoint_byte
= PT_BYTE
;
4275 ptrdiff_t oinserted
= ZV
- BEGV
;
4276 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4278 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4279 insval
= call3 (Qformat_decode
,
4280 Qnil
, make_number (oinserted
), visit
);
4281 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4282 wrong_type_argument (intern ("inserted-chars"), insval
);
4283 if (ochars_modiff
== CHARS_MODIFF
)
4284 /* format_decode didn't modify buffer's characters => move
4285 point back to position before inserted text and leave
4286 value of inserted alone. */
4287 SET_PT_BOTH (opoint
, opoint_byte
);
4289 /* format_decode modified buffer's characters => consider
4290 entire buffer changed and leave point at point-min. */
4291 inserted
= XFASTINT (insval
);
4294 /* For consistency with format-decode call these now iff inserted > 0
4295 (martin 2007-06-28). */
4296 p
= Vafter_insert_file_functions
;
4301 insval
= call1 (XCAR (p
), make_number (inserted
));
4304 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4305 wrong_type_argument (intern ("inserted-chars"), insval
);
4306 inserted
= XFASTINT (insval
);
4311 /* For the rationale of this see the comment on
4312 format-decode above. */
4313 ptrdiff_t opoint
= PT
;
4314 ptrdiff_t opoint_byte
= PT_BYTE
;
4315 ptrdiff_t oinserted
= ZV
- BEGV
;
4316 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4318 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4319 insval
= call1 (XCAR (p
), make_number (oinserted
));
4322 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4323 wrong_type_argument (intern ("inserted-chars"), insval
);
4324 if (ochars_modiff
== CHARS_MODIFF
)
4325 /* after_insert_file_functions didn't modify
4326 buffer's characters => move point back to
4327 position before inserted text and leave value of
4329 SET_PT_BOTH (opoint
, opoint_byte
);
4331 /* after_insert_file_functions did modify buffer's
4332 characters => consider entire buffer changed and
4333 leave point at point-min. */
4334 inserted
= XFASTINT (insval
);
4344 bset_undo_list (current_buffer
, old_undo
);
4345 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4347 /* Adjust the last undo record for the size change during
4348 the format conversion. */
4349 Lisp_Object tem
= XCAR (old_undo
);
4350 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4351 && INTEGERP (XCDR (tem
))
4352 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4353 XSETCDR (tem
, make_number (PT
+ inserted
));
4357 /* If undo_list was Qt before, keep it that way.
4358 Otherwise start with an empty undo_list. */
4359 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4361 unbind_to (count1
, Qnil
);
4365 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4367 /* If visiting nonexistent file, return nil. */
4369 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4373 Fsignal (Qquit
, Qnil
);
4375 /* ??? Retval needs to be dealt with in all cases consistently. */
4377 val
= Fcons (orig_filename
,
4378 Fcons (make_number (inserted
),
4381 RETURN_UNGCPRO (unbind_to (count
, val
));
4384 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4387 build_annotations_unwind (Lisp_Object arg
)
4389 Vwrite_region_annotation_buffers
= arg
;
4393 /* Decide the coding-system to encode the data with. */
4396 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4397 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4398 struct coding_system
*coding
)
4401 Lisp_Object eol_parent
= Qnil
;
4404 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4405 BVAR (current_buffer
, auto_save_file_name
))))
4410 else if (!NILP (Vcoding_system_for_write
))
4412 val
= Vcoding_system_for_write
;
4413 if (coding_system_require_warning
4414 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4415 /* Confirm that VAL can surely encode the current region. */
4416 val
= call5 (Vselect_safe_coding_system_function
,
4417 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4422 /* If the variable `buffer-file-coding-system' is set locally,
4423 it means that the file was read with some kind of code
4424 conversion or the variable is explicitly set by users. We
4425 had better write it out with the same coding system even if
4426 `enable-multibyte-characters' is nil.
4428 If it is not set locally, we anyway have to convert EOL
4429 format if the default value of `buffer-file-coding-system'
4430 tells that it is not Unix-like (LF only) format. */
4431 int using_default_coding
= 0;
4432 int force_raw_text
= 0;
4434 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4436 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4439 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4445 /* Check file-coding-system-alist. */
4446 Lisp_Object args
[7], coding_systems
;
4448 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4449 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4451 coding_systems
= Ffind_operation_coding_system (7, args
);
4452 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4453 val
= XCDR (coding_systems
);
4458 /* If we still have not decided a coding system, use the
4459 default value of buffer-file-coding-system. */
4460 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4461 using_default_coding
= 1;
4464 if (! NILP (val
) && ! force_raw_text
)
4466 Lisp_Object spec
, attrs
;
4468 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4469 attrs
= AREF (spec
, 0);
4470 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4475 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4476 /* Confirm that VAL can surely encode the current region. */
4477 val
= call5 (Vselect_safe_coding_system_function
,
4478 start
, end
, val
, Qnil
, filename
);
4480 /* If the decided coding-system doesn't specify end-of-line
4481 format, we use that of
4482 `default-buffer-file-coding-system'. */
4483 if (! using_default_coding
4484 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4485 val
= (coding_inherit_eol_type
4486 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4488 /* If we decide not to encode text, use `raw-text' or one of its
4491 val
= raw_text_coding_system (val
);
4494 val
= coding_inherit_eol_type (val
, eol_parent
);
4495 setup_coding_system (val
, coding
);
4497 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4498 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4502 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4503 "r\nFWrite region to file: \ni\ni\ni\np",
4504 doc
: /* Write current region into specified file.
4505 When called from a program, requires three arguments:
4506 START, END and FILENAME. START and END are normally buffer positions
4507 specifying the part of the buffer to write.
4508 If START is nil, that means to use the entire buffer contents.
4509 If START is a string, then output that string to the file
4510 instead of any buffer contents; END is ignored.
4512 Optional fourth argument APPEND if non-nil means
4513 append to existing file contents (if any). If it is an integer,
4514 seek to that offset in the file before writing.
4515 Optional fifth argument VISIT, if t or a string, means
4516 set the last-save-file-modtime of buffer to this file's modtime
4517 and mark buffer not modified.
4518 If VISIT is a string, it is a second file name;
4519 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4520 VISIT is also the file name to lock and unlock for clash detection.
4521 If VISIT is neither t nor nil nor a string,
4522 that means do not display the \"Wrote file\" message.
4523 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4524 use for locking and unlocking, overriding FILENAME and VISIT.
4525 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4526 for an existing file with the same name. If MUSTBENEW is `excl',
4527 that means to get an error if the file already exists; never overwrite.
4528 If MUSTBENEW is neither nil nor `excl', that means ask for
4529 confirmation before overwriting, but do go ahead and overwrite the file
4530 if the user confirms.
4532 This does code conversion according to the value of
4533 `coding-system-for-write', `buffer-file-coding-system', or
4534 `file-coding-system-alist', and sets the variable
4535 `last-coding-system-used' to the coding system actually used.
4537 This calls `write-region-annotate-functions' at the start, and
4538 `write-region-post-annotation-function' at the end. */)
4539 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4546 ptrdiff_t count
= SPECPDL_INDEX ();
4548 Lisp_Object handler
;
4549 Lisp_Object visit_file
;
4550 Lisp_Object annotations
;
4551 Lisp_Object encoded_filename
;
4552 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4553 int quietly
= !NILP (visit
);
4554 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4555 struct buffer
*given_buffer
;
4556 struct coding_system coding
;
4558 if (current_buffer
->base_buffer
&& visiting
)
4559 error ("Cannot do file visiting in an indirect buffer");
4561 if (!NILP (start
) && !STRINGP (start
))
4562 validate_region (&start
, &end
);
4565 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4567 filename
= Fexpand_file_name (filename
, Qnil
);
4569 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4570 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4572 if (STRINGP (visit
))
4573 visit_file
= Fexpand_file_name (visit
, Qnil
);
4575 visit_file
= filename
;
4577 if (NILP (lockname
))
4578 lockname
= visit_file
;
4582 /* If the file name has special constructs in it,
4583 call the corresponding file handler. */
4584 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4585 /* If FILENAME has no handler, see if VISIT has one. */
4586 if (NILP (handler
) && STRINGP (visit
))
4587 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4589 if (!NILP (handler
))
4592 val
= call6 (handler
, Qwrite_region
, start
, end
,
4593 filename
, append
, visit
);
4597 SAVE_MODIFF
= MODIFF
;
4598 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4599 bset_filename (current_buffer
, visit_file
);
4605 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4607 /* Special kludge to simplify auto-saving. */
4610 /* Do it later, so write-region-annotate-function can work differently
4611 if we save "the buffer" vs "a region".
4612 This is useful in tar-mode. --Stef
4613 XSETFASTINT (start, BEG);
4614 XSETFASTINT (end, Z); */
4618 record_unwind_protect (build_annotations_unwind
,
4619 Vwrite_region_annotation_buffers
);
4620 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4621 count1
= SPECPDL_INDEX ();
4623 given_buffer
= current_buffer
;
4625 if (!STRINGP (start
))
4627 annotations
= build_annotations (start
, end
);
4629 if (current_buffer
!= given_buffer
)
4631 XSETFASTINT (start
, BEGV
);
4632 XSETFASTINT (end
, ZV
);
4638 XSETFASTINT (start
, BEGV
);
4639 XSETFASTINT (end
, ZV
);
4644 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4646 /* Decide the coding-system to encode the data with.
4647 We used to make this choice before calling build_annotations, but that
4648 leads to problems when a write-annotate-function takes care of
4649 unsavable chars (as was the case with X-Symbol). */
4650 Vlast_coding_system_used
4651 = choose_write_coding_system (start
, end
, filename
,
4652 append
, visit
, lockname
, &coding
);
4654 #ifdef CLASH_DETECTION
4656 lock_file (lockname
);
4657 #endif /* CLASH_DETECTION */
4659 encoded_filename
= ENCODE_FILE (filename
);
4661 fn
= SSDATA (encoded_filename
);
4665 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4666 #else /* not DOS_NT */
4667 desc
= emacs_open (fn
, O_WRONLY
, 0);
4668 #endif /* not DOS_NT */
4670 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4672 desc
= emacs_open (fn
,
4673 O_WRONLY
| O_CREAT
| O_BINARY
4674 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4675 S_IREAD
| S_IWRITE
);
4676 #else /* not DOS_NT */
4677 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4678 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4679 auto_saving
? auto_save_mode_bits
: 0666);
4680 #endif /* not DOS_NT */
4684 #ifdef CLASH_DETECTION
4686 if (!auto_saving
) unlock_file (lockname
);
4688 #endif /* CLASH_DETECTION */
4690 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4693 record_unwind_protect (close_file_unwind
, make_number (desc
));
4695 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4699 if (NUMBERP (append
))
4700 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4702 ret
= lseek (desc
, 0, SEEK_END
);
4705 #ifdef CLASH_DETECTION
4707 if (!auto_saving
) unlock_file (lockname
);
4709 #endif /* CLASH_DETECTION */
4711 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4720 if (STRINGP (start
))
4722 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4723 &annotations
, &coding
);
4726 else if (XINT (start
) != XINT (end
))
4728 failure
= 0 > a_write (desc
, Qnil
,
4729 XINT (start
), XINT (end
) - XINT (start
),
4730 &annotations
, &coding
);
4735 /* If file was empty, still need to write the annotations */
4736 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4737 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4741 if (CODING_REQUIRE_FLUSHING (&coding
)
4742 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4745 /* We have to flush out a data. */
4746 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4747 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4754 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4755 Disk full in NFS may be reported here. */
4756 /* mib says that closing the file will try to write as fast as NFS can do
4757 it, and that means the fsync here is not crucial for autosave files. */
4758 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4760 /* If fsync fails with EINTR, don't treat that as serious. Also
4761 ignore EINVAL which happens when fsync is not supported on this
4763 if (errno
!= EINTR
&& errno
!= EINVAL
)
4764 failure
= 1, save_errno
= errno
;
4768 /* NFS can report a write failure now. */
4769 if (emacs_close (desc
) < 0)
4770 failure
= 1, save_errno
= errno
;
4774 /* Discard the unwind protect for close_file_unwind. */
4775 specpdl_ptr
= specpdl
+ count1
;
4777 /* Call write-region-post-annotation-function. */
4778 while (CONSP (Vwrite_region_annotation_buffers
))
4780 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4781 if (!NILP (Fbuffer_live_p (buf
)))
4784 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4785 call0 (Vwrite_region_post_annotation_function
);
4787 Vwrite_region_annotation_buffers
4788 = XCDR (Vwrite_region_annotation_buffers
);
4791 unbind_to (count
, Qnil
);
4793 #ifdef CLASH_DETECTION
4795 unlock_file (lockname
);
4796 #endif /* CLASH_DETECTION */
4798 /* Do this before reporting IO error
4799 to avoid a "file has changed on disk" warning on
4800 next attempt to save. */
4803 current_buffer
->modtime
= get_stat_mtime (&st
);
4804 current_buffer
->modtime_size
= st
.st_size
;
4808 error ("IO error writing %s: %s", SDATA (filename
),
4809 emacs_strerror (save_errno
));
4813 SAVE_MODIFF
= MODIFF
;
4814 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4815 bset_filename (current_buffer
, visit_file
);
4816 update_mode_lines
++;
4821 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4822 BVAR (current_buffer
, auto_save_file_name
))))
4823 SAVE_MODIFF
= MODIFF
;
4829 message_with_string ((INTEGERP (append
)
4839 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4841 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4842 doc
: /* Return t if (car A) is numerically less than (car B). */)
4843 (Lisp_Object a
, Lisp_Object b
)
4845 return Flss (Fcar (a
), Fcar (b
));
4848 /* Build the complete list of annotations appropriate for writing out
4849 the text between START and END, by calling all the functions in
4850 write-region-annotate-functions and merging the lists they return.
4851 If one of these functions switches to a different buffer, we assume
4852 that buffer contains altered text. Therefore, the caller must
4853 make sure to restore the current buffer in all cases,
4854 as save-excursion would do. */
4857 build_annotations (Lisp_Object start
, Lisp_Object end
)
4859 Lisp_Object annotations
;
4861 struct gcpro gcpro1
, gcpro2
;
4862 Lisp_Object original_buffer
;
4863 int i
, used_global
= 0;
4865 XSETBUFFER (original_buffer
, current_buffer
);
4868 p
= Vwrite_region_annotate_functions
;
4869 GCPRO2 (annotations
, p
);
4872 struct buffer
*given_buffer
= current_buffer
;
4873 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4874 { /* Use the global value of the hook. */
4877 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4879 p
= Fappend (2, arg
);
4882 Vwrite_region_annotations_so_far
= annotations
;
4883 res
= call2 (XCAR (p
), start
, end
);
4884 /* If the function makes a different buffer current,
4885 assume that means this buffer contains altered text to be output.
4886 Reset START and END from the buffer bounds
4887 and discard all previous annotations because they should have
4888 been dealt with by this function. */
4889 if (current_buffer
!= given_buffer
)
4891 Vwrite_region_annotation_buffers
4892 = Fcons (Fcurrent_buffer (),
4893 Vwrite_region_annotation_buffers
);
4894 XSETFASTINT (start
, BEGV
);
4895 XSETFASTINT (end
, ZV
);
4898 Flength (res
); /* Check basic validity of return value */
4899 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4903 /* Now do the same for annotation functions implied by the file-format */
4904 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4905 p
= BVAR (current_buffer
, auto_save_file_format
);
4907 p
= BVAR (current_buffer
, file_format
);
4908 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4910 struct buffer
*given_buffer
= current_buffer
;
4912 Vwrite_region_annotations_so_far
= annotations
;
4914 /* Value is either a list of annotations or nil if the function
4915 has written annotations to a temporary buffer, which is now
4917 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4918 original_buffer
, make_number (i
));
4919 if (current_buffer
!= given_buffer
)
4921 XSETFASTINT (start
, BEGV
);
4922 XSETFASTINT (end
, ZV
);
4927 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4935 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4936 If STRING is nil, POS is the character position in the current buffer.
4937 Intersperse with them the annotations from *ANNOT
4938 which fall within the range of POS to POS + NCHARS,
4939 each at its appropriate position.
4941 We modify *ANNOT by discarding elements as we use them up.
4943 The return value is negative in case of system call failure. */
4946 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
4947 register ptrdiff_t nchars
, Lisp_Object
*annot
,
4948 struct coding_system
*coding
)
4952 ptrdiff_t lastpos
= pos
+ nchars
;
4954 while (NILP (*annot
) || CONSP (*annot
))
4956 tem
= Fcar_safe (Fcar (*annot
));
4959 nextpos
= XFASTINT (tem
);
4961 /* If there are no more annotations in this range,
4962 output the rest of the range all at once. */
4963 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4964 return e_write (desc
, string
, pos
, lastpos
, coding
);
4966 /* Output buffer text up to the next annotation's position. */
4969 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4973 /* Output the annotation. */
4974 tem
= Fcdr (Fcar (*annot
));
4977 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4980 *annot
= Fcdr (*annot
);
4986 /* Write text in the range START and END into descriptor DESC,
4987 encoding them with coding system CODING. If STRING is nil, START
4988 and END are character positions of the current buffer, else they
4989 are indexes to the string STRING. */
4992 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
4993 struct coding_system
*coding
)
4995 if (STRINGP (string
))
4998 end
= SCHARS (string
);
5001 /* We used to have a code for handling selective display here. But,
5002 now it is handled within encode_coding. */
5006 if (STRINGP (string
))
5008 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5009 if (CODING_REQUIRE_ENCODING (coding
))
5011 encode_coding_object (coding
, string
,
5012 start
, string_char_to_byte (string
, start
),
5013 end
, string_char_to_byte (string
, end
), Qt
);
5017 coding
->dst_object
= string
;
5018 coding
->consumed_char
= SCHARS (string
);
5019 coding
->produced
= SBYTES (string
);
5024 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5025 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5027 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5028 if (CODING_REQUIRE_ENCODING (coding
))
5030 encode_coding_object (coding
, Fcurrent_buffer (),
5031 start
, start_byte
, end
, end_byte
, Qt
);
5035 coding
->dst_object
= Qnil
;
5036 coding
->dst_pos_byte
= start_byte
;
5037 if (start
>= GPT
|| end
<= GPT
)
5039 coding
->consumed_char
= end
- start
;
5040 coding
->produced
= end_byte
- start_byte
;
5044 coding
->consumed_char
= GPT
- start
;
5045 coding
->produced
= GPT_BYTE
- start_byte
;
5050 if (coding
->produced
> 0)
5054 STRINGP (coding
->dst_object
)
5055 ? SSDATA (coding
->dst_object
)
5056 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5059 if (coding
->produced
)
5062 start
+= coding
->consumed_char
;
5068 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5069 Sverify_visited_file_modtime
, 0, 1, 0,
5070 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5071 This means that the file has not been changed since it was visited or saved.
5072 If BUF is omitted or nil, it defaults to the current buffer.
5073 See Info node `(elisp)Modification Time' for more details. */)
5078 Lisp_Object handler
;
5079 Lisp_Object filename
;
5080 EMACS_TIME mtime
, diff
;
5090 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5091 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5093 /* If the file name has special constructs in it,
5094 call the corresponding file handler. */
5095 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5096 Qverify_visited_file_modtime
);
5097 if (!NILP (handler
))
5098 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5100 filename
= ENCODE_FILE (BVAR (b
, filename
));
5102 mtime
= (stat (SSDATA (filename
), &st
) == 0
5103 ? get_stat_mtime (&st
)
5104 : time_error_value (errno
));
5105 if ((EMACS_TIME_EQ (mtime
, b
->modtime
)
5106 /* If both exist, accept them if they are off by one second. */
5107 || (EMACS_TIME_VALID_P (mtime
) && EMACS_TIME_VALID_P (b
->modtime
)
5108 && ((diff
= (EMACS_TIME_LT (mtime
, b
->modtime
)
5109 ? sub_emacs_time (b
->modtime
, mtime
)
5110 : sub_emacs_time (mtime
, b
->modtime
))),
5111 EMACS_TIME_LE (diff
, make_emacs_time (1, 0)))))
5112 && (st
.st_size
== b
->modtime_size
5113 || b
->modtime_size
< 0))
5118 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5119 Sclear_visited_file_modtime
, 0, 0, 0,
5120 doc
: /* Clear out records of last mod time of visited file.
5121 Next attempt to save will certainly not complain of a discrepancy. */)
5124 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5125 current_buffer
->modtime_size
= -1;
5129 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5130 Svisited_file_modtime
, 0, 0, 0,
5131 doc
: /* Return the current buffer's recorded visited file modification time.
5132 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5133 `file-attributes' returns. If the current buffer has no recorded file
5134 modification time, this function returns 0. If the visited file
5135 doesn't exist, HIGH will be -1.
5136 See Info node `(elisp)Modification Time' for more details. */)
5139 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5140 return make_number (0);
5141 return make_lisp_time (current_buffer
->modtime
);
5144 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5145 Sset_visited_file_modtime
, 0, 1, 0,
5146 doc
: /* Update buffer's recorded modification time from the visited file's time.
5147 Useful if the buffer was not read from the file normally
5148 or if the file itself has been changed for some known benign reason.
5149 An argument specifies the modification time value to use
5150 \(instead of that of the visited file), in the form of a list
5151 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5152 (Lisp_Object time_list
)
5154 if (!NILP (time_list
))
5156 current_buffer
->modtime
= lisp_time_argument (time_list
);
5157 current_buffer
->modtime_size
= -1;
5161 register Lisp_Object filename
;
5163 Lisp_Object handler
;
5165 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5167 /* If the file name has special constructs in it,
5168 call the corresponding file handler. */
5169 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5170 if (!NILP (handler
))
5171 /* The handler can find the file name the same way we did. */
5172 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5174 filename
= ENCODE_FILE (filename
);
5176 if (stat (SSDATA (filename
), &st
) >= 0)
5178 current_buffer
->modtime
= get_stat_mtime (&st
);
5179 current_buffer
->modtime_size
= st
.st_size
;
5187 auto_save_error (Lisp_Object error_val
)
5189 Lisp_Object args
[3], msg
;
5191 struct gcpro gcpro1
;
5195 auto_save_error_occurred
= 1;
5197 ring_bell (XFRAME (selected_frame
));
5199 args
[0] = build_string ("Auto-saving %s: %s");
5200 args
[1] = BVAR (current_buffer
, name
);
5201 args
[2] = Ferror_message_string (error_val
);
5202 msg
= Fformat (3, args
);
5204 nbytes
= SBYTES (msg
);
5205 msgbuf
= SAFE_ALLOCA (nbytes
);
5206 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5208 for (i
= 0; i
< 3; ++i
)
5211 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5213 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5214 Fsleep_for (make_number (1), Qnil
);
5228 auto_save_mode_bits
= 0666;
5230 /* Get visited file's mode to become the auto save file's mode. */
5231 if (! NILP (BVAR (current_buffer
, filename
)))
5233 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5234 /* But make sure we can overwrite it later! */
5235 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5236 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5238 /* Remote files don't cooperate with stat. */
5239 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5243 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5244 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5249 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5252 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5264 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5267 minibuffer_auto_raise
= XINT (value
);
5272 do_auto_save_make_dir (Lisp_Object dir
)
5276 auto_saving_dir_umask
= 077;
5277 result
= call2 (Qmake_directory
, dir
, Qt
);
5278 auto_saving_dir_umask
= 0;
5283 do_auto_save_eh (Lisp_Object ignore
)
5285 auto_saving_dir_umask
= 0;
5289 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5290 doc
: /* Auto-save all buffers that need it.
5291 This is all buffers that have auto-saving enabled
5292 and are changed since last auto-saved.
5293 Auto-saving writes the buffer into a file
5294 so that your editing is not lost if the system crashes.
5295 This file is not the file you visited; that changes only when you save.
5296 Normally we run the normal hook `auto-save-hook' before saving.
5298 A non-nil NO-MESSAGE argument means do not print any message if successful.
5299 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5300 (Lisp_Object no_message
, Lisp_Object current_only
)
5302 struct buffer
*old
= current_buffer
, *b
;
5303 Lisp_Object tail
, buf
, hook
;
5305 int do_handled_files
;
5307 FILE *stream
= NULL
;
5308 ptrdiff_t count
= SPECPDL_INDEX ();
5309 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5310 bool old_message_p
= 0;
5311 struct gcpro gcpro1
, gcpro2
;
5313 if (max_specpdl_size
< specpdl_size
+ 40)
5314 max_specpdl_size
= specpdl_size
+ 40;
5319 if (NILP (no_message
))
5321 old_message_p
= push_message ();
5322 record_unwind_protect (pop_message_unwind
, Qnil
);
5325 /* Ordinarily don't quit within this function,
5326 but don't make it impossible to quit (in case we get hung in I/O). */
5330 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5331 point to non-strings reached from Vbuffer_alist. */
5333 hook
= intern ("auto-save-hook");
5334 Frun_hooks (1, &hook
);
5336 if (STRINGP (Vauto_save_list_file_name
))
5338 Lisp_Object listfile
;
5340 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5342 /* Don't try to create the directory when shutting down Emacs,
5343 because creating the directory might signal an error, and
5344 that would leave Emacs in a strange state. */
5345 if (!NILP (Vrun_hooks
))
5349 GCPRO2 (dir
, listfile
);
5350 dir
= Ffile_name_directory (listfile
);
5351 if (NILP (Ffile_directory_p (dir
)))
5352 internal_condition_case_1 (do_auto_save_make_dir
,
5358 stream
= fopen (SSDATA (listfile
), "w");
5361 record_unwind_protect (do_auto_save_unwind
,
5362 make_save_value (stream
, 0));
5363 record_unwind_protect (do_auto_save_unwind_1
,
5364 make_number (minibuffer_auto_raise
));
5365 minibuffer_auto_raise
= 0;
5367 auto_save_error_occurred
= 0;
5369 /* On first pass, save all files that don't have handlers.
5370 On second pass, save all files that do have handlers.
5372 If Emacs is crashing, the handlers may tweak what is causing
5373 Emacs to crash in the first place, and it would be a shame if
5374 Emacs failed to autosave perfectly ordinary files because it
5375 couldn't handle some ange-ftp'd file. */
5377 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5378 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5380 buf
= XCDR (XCAR (tail
));
5383 /* Record all the buffers that have auto save mode
5384 in the special file that lists them. For each of these buffers,
5385 Record visited name (if any) and auto save name. */
5386 if (STRINGP (BVAR (b
, auto_save_file_name
))
5387 && stream
!= NULL
&& do_handled_files
== 0)
5390 if (!NILP (BVAR (b
, filename
)))
5392 fwrite (SDATA (BVAR (b
, filename
)), 1,
5393 SBYTES (BVAR (b
, filename
)), stream
);
5395 putc ('\n', stream
);
5396 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5397 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5398 putc ('\n', stream
);
5402 if (!NILP (current_only
)
5403 && b
!= current_buffer
)
5406 /* Don't auto-save indirect buffers.
5407 The base buffer takes care of it. */
5411 /* Check for auto save enabled
5412 and file changed since last auto save
5413 and file changed since last real save. */
5414 if (STRINGP (BVAR (b
, auto_save_file_name
))
5415 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5416 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5417 /* -1 means we've turned off autosaving for a while--see below. */
5418 && XINT (BVAR (b
, save_length
)) >= 0
5419 && (do_handled_files
5420 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5423 EMACS_TIME before_time
= current_emacs_time ();
5424 EMACS_TIME after_time
;
5426 /* If we had a failure, don't try again for 20 minutes. */
5427 if (b
->auto_save_failure_time
> 0
5428 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5431 set_buffer_internal (b
);
5432 if (NILP (Vauto_save_include_big_deletions
)
5433 && (XFASTINT (BVAR (b
, save_length
)) * 10
5434 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5435 /* A short file is likely to change a large fraction;
5436 spare the user annoying messages. */
5437 && XFASTINT (BVAR (b
, save_length
)) > 5000
5438 /* These messages are frequent and annoying for `*mail*'. */
5439 && !EQ (BVAR (b
, filename
), Qnil
)
5440 && NILP (no_message
))
5442 /* It has shrunk too much; turn off auto-saving here. */
5443 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5444 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5446 minibuffer_auto_raise
= 0;
5447 /* Turn off auto-saving until there's a real save,
5448 and prevent any more warnings. */
5449 XSETINT (BVAR (b
, save_length
), -1);
5450 Fsleep_for (make_number (1), Qnil
);
5453 if (!auto_saved
&& NILP (no_message
))
5454 message1 ("Auto-saving...");
5455 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5457 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5458 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5459 set_buffer_internal (old
);
5461 after_time
= current_emacs_time ();
5463 /* If auto-save took more than 60 seconds,
5464 assume it was an NFS failure that got a timeout. */
5465 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5466 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5470 /* Prevent another auto save till enough input events come in. */
5471 record_auto_save ();
5473 if (auto_saved
&& NILP (no_message
))
5477 /* If we are going to restore an old message,
5478 give time to read ours. */
5479 sit_for (make_number (1), 0, 0);
5482 else if (!auto_save_error_occurred
)
5483 /* Don't overwrite the error message if an error occurred.
5484 If we displayed a message and then restored a state
5485 with no message, leave a "done" message on the screen. */
5486 message1 ("Auto-saving...done");
5491 /* This restores the message-stack status. */
5492 unbind_to (count
, Qnil
);
5496 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5497 Sset_buffer_auto_saved
, 0, 0, 0,
5498 doc
: /* Mark current buffer as auto-saved with its current text.
5499 No auto-save file will be written until the buffer changes again. */)
5502 /* FIXME: This should not be called in indirect buffers, since
5503 they're not autosaved. */
5504 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5505 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5506 current_buffer
->auto_save_failure_time
= 0;
5510 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5511 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5512 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5515 current_buffer
->auto_save_failure_time
= 0;
5519 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5521 doc
: /* Return t if current buffer has been auto-saved recently.
5522 More precisely, if it has been auto-saved since last read from or saved
5523 in the visited file. If the buffer has no visited file,
5524 then any auto-save counts as "recent". */)
5527 /* FIXME: maybe we should return nil for indirect buffers since
5528 they're never autosaved. */
5529 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5532 /* Reading and completing file names */
5534 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5535 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5536 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5537 The return value is only relevant for a call to `read-file-name' that happens
5538 before any other event (mouse or keypress) is handled. */)
5541 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5542 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5552 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5554 struct gcpro gcpro1
;
5555 Lisp_Object args
[7];
5557 GCPRO1 (default_filename
);
5558 args
[0] = intern ("read-file-name");
5561 args
[3] = default_filename
;
5562 args
[4] = mustmatch
;
5564 args
[6] = predicate
;
5565 RETURN_UNGCPRO (Ffuncall (7, args
));
5570 syms_of_fileio (void)
5572 DEFSYM (Qoperations
, "operations");
5573 DEFSYM (Qexpand_file_name
, "expand-file-name");
5574 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5575 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5576 DEFSYM (Qfile_name_directory
, "file-name-directory");
5577 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5578 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5579 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5580 DEFSYM (Qcopy_file
, "copy-file");
5581 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5582 DEFSYM (Qmake_directory
, "make-directory");
5583 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5584 DEFSYM (Qdelete_file
, "delete-file");
5585 DEFSYM (Qrename_file
, "rename-file");
5586 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5587 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5588 DEFSYM (Qfile_exists_p
, "file-exists-p");
5589 DEFSYM (Qfile_executable_p
, "file-executable-p");
5590 DEFSYM (Qfile_readable_p
, "file-readable-p");
5591 DEFSYM (Qfile_writable_p
, "file-writable-p");
5592 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5593 DEFSYM (Qaccess_file
, "access-file");
5594 DEFSYM (Qfile_directory_p
, "file-directory-p");
5595 DEFSYM (Qfile_regular_p
, "file-regular-p");
5596 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5597 DEFSYM (Qfile_modes
, "file-modes");
5598 DEFSYM (Qset_file_modes
, "set-file-modes");
5599 DEFSYM (Qset_file_times
, "set-file-times");
5600 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5601 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5602 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5603 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5604 DEFSYM (Qwrite_region
, "write-region");
5605 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5606 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5607 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5609 DEFSYM (Qfile_name_history
, "file-name-history");
5610 Fset (Qfile_name_history
, Qnil
);
5612 DEFSYM (Qfile_error
, "file-error");
5613 DEFSYM (Qfile_already_exists
, "file-already-exists");
5614 DEFSYM (Qfile_date_error
, "file-date-error");
5615 DEFSYM (Qexcl
, "excl");
5617 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5618 doc
: /* Coding system for encoding file names.
5619 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5620 Vfile_name_coding_system
= Qnil
;
5622 DEFVAR_LISP ("default-file-name-coding-system",
5623 Vdefault_file_name_coding_system
,
5624 doc
: /* Default coding system for encoding file names.
5625 This variable is used only when `file-name-coding-system' is nil.
5627 This variable is set/changed by the command `set-language-environment'.
5628 User should not set this variable manually,
5629 instead use `file-name-coding-system' to get a constant encoding
5630 of file names regardless of the current language environment. */);
5631 Vdefault_file_name_coding_system
= Qnil
;
5633 DEFSYM (Qformat_decode
, "format-decode");
5634 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5635 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5636 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5638 Fput (Qfile_error
, Qerror_conditions
,
5639 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5640 Fput (Qfile_error
, Qerror_message
,
5641 build_pure_c_string ("File error"));
5643 Fput (Qfile_already_exists
, Qerror_conditions
,
5644 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5645 Fput (Qfile_already_exists
, Qerror_message
,
5646 build_pure_c_string ("File already exists"));
5648 Fput (Qfile_date_error
, Qerror_conditions
,
5649 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5650 Fput (Qfile_date_error
, Qerror_message
,
5651 build_pure_c_string ("Cannot set file date"));
5653 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5654 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5655 If a file name matches REGEXP, all I/O on that file is done by calling
5656 HANDLER. If a file name matches more than one handler, the handler
5657 whose match starts last in the file name gets precedence. The
5658 function `find-file-name-handler' checks this list for a handler for
5661 HANDLER should be a function. The first argument given to it is the
5662 name of the I/O primitive to be handled; the remaining arguments are
5663 the arguments that were passed to that primitive. For example, if you
5664 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5665 HANDLER is called like this:
5667 (funcall HANDLER 'file-exists-p FILENAME)
5669 Note that HANDLER must be able to handle all I/O primitives; if it has
5670 nothing special to do for a primitive, it should reinvoke the
5671 primitive to handle the operation \"the usual way\".
5672 See Info node `(elisp)Magic File Names' for more details. */);
5673 Vfile_name_handler_alist
= Qnil
;
5675 DEFVAR_LISP ("set-auto-coding-function",
5676 Vset_auto_coding_function
,
5677 doc
: /* If non-nil, a function to call to decide a coding system of file.
5678 Two arguments are passed to this function: the file name
5679 and the length of a file contents following the point.
5680 This function should return a coding system to decode the file contents.
5681 It should check the file name against `auto-coding-alist'.
5682 If no coding system is decided, it should check a coding system
5683 specified in the heading lines with the format:
5684 -*- ... coding: CODING-SYSTEM; ... -*-
5685 or local variable spec of the tailing lines with `coding:' tag. */);
5686 Vset_auto_coding_function
= Qnil
;
5688 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5689 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5690 Each is passed one argument, the number of characters inserted,
5691 with point at the start of the inserted text. Each function
5692 should leave point the same, and return the new character count.
5693 If `insert-file-contents' is intercepted by a handler from
5694 `file-name-handler-alist', that handler is responsible for calling the
5695 functions in `after-insert-file-functions' if appropriate. */);
5696 Vafter_insert_file_functions
= Qnil
;
5698 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5699 doc
: /* A list of functions to be called at the start of `write-region'.
5700 Each is passed two arguments, START and END as for `write-region'.
5701 These are usually two numbers but not always; see the documentation
5702 for `write-region'. The function should return a list of pairs
5703 of the form (POSITION . STRING), consisting of strings to be effectively
5704 inserted at the specified positions of the file being written (1 means to
5705 insert before the first byte written). The POSITIONs must be sorted into
5708 If there are several annotation functions, the lists returned by these
5709 functions are merged destructively. As each annotation function runs,
5710 the variable `write-region-annotations-so-far' contains a list of all
5711 annotations returned by previous annotation functions.
5713 An annotation function can return with a different buffer current.
5714 Doing so removes the annotations returned by previous functions, and
5715 resets START and END to `point-min' and `point-max' of the new buffer.
5717 After `write-region' completes, Emacs calls the function stored in
5718 `write-region-post-annotation-function', once for each buffer that was
5719 current when building the annotations (i.e., at least once), with that
5720 buffer current. */);
5721 Vwrite_region_annotate_functions
= Qnil
;
5722 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5724 DEFVAR_LISP ("write-region-post-annotation-function",
5725 Vwrite_region_post_annotation_function
,
5726 doc
: /* Function to call after `write-region' completes.
5727 The function is called with no arguments. If one or more of the
5728 annotation functions in `write-region-annotate-functions' changed the
5729 current buffer, the function stored in this variable is called for
5730 each of those additional buffers as well, in addition to the original
5731 buffer. The relevant buffer is current during each function call. */);
5732 Vwrite_region_post_annotation_function
= Qnil
;
5733 staticpro (&Vwrite_region_annotation_buffers
);
5735 DEFVAR_LISP ("write-region-annotations-so-far",
5736 Vwrite_region_annotations_so_far
,
5737 doc
: /* When an annotation function is called, this holds the previous annotations.
5738 These are the annotations made by other annotation functions
5739 that were already called. See also `write-region-annotate-functions'. */);
5740 Vwrite_region_annotations_so_far
= Qnil
;
5742 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5743 doc
: /* A list of file name handlers that temporarily should not be used.
5744 This applies only to the operation `inhibit-file-name-operation'. */);
5745 Vinhibit_file_name_handlers
= Qnil
;
5747 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5748 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5749 Vinhibit_file_name_operation
= Qnil
;
5751 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5752 doc
: /* File name in which we write a list of all auto save file names.
5753 This variable is initialized automatically from `auto-save-list-file-prefix'
5754 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5755 a non-nil value. */);
5756 Vauto_save_list_file_name
= Qnil
;
5758 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5759 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5760 Normally auto-save files are written under other names. */);
5761 Vauto_save_visited_file_name
= Qnil
;
5763 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5764 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5765 If nil, deleting a substantial portion of the text disables auto-save
5766 in the buffer; this is the default behavior, because the auto-save
5767 file is usually more useful if it contains the deleted text. */);
5768 Vauto_save_include_big_deletions
= Qnil
;
5771 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5772 doc
: /* Non-nil means don't call fsync in `write-region'.
5773 This variable affects calls to `write-region' as well as save commands.
5774 A non-nil value may result in data loss! */);
5775 write_region_inhibit_fsync
= 0;
5778 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5779 doc
: /* Specifies whether to use the system's trash can.
5780 When non-nil, certain file deletion commands use the function
5781 `move-file-to-trash' instead of deleting files outright.
5782 This includes interactive calls to `delete-file' and
5783 `delete-directory' and the Dired deletion commands. */);
5784 delete_by_moving_to_trash
= 0;
5785 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5787 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5788 DEFSYM (Qcopy_directory
, "copy-directory");
5789 DEFSYM (Qdelete_directory
, "delete-directory");
5791 defsubr (&Sfind_file_name_handler
);
5792 defsubr (&Sfile_name_directory
);
5793 defsubr (&Sfile_name_nondirectory
);
5794 defsubr (&Sunhandled_file_name_directory
);
5795 defsubr (&Sfile_name_as_directory
);
5796 defsubr (&Sdirectory_file_name
);
5797 defsubr (&Smake_temp_name
);
5798 defsubr (&Sexpand_file_name
);
5799 defsubr (&Ssubstitute_in_file_name
);
5800 defsubr (&Scopy_file
);
5801 defsubr (&Smake_directory_internal
);
5802 defsubr (&Sdelete_directory_internal
);
5803 defsubr (&Sdelete_file
);
5804 defsubr (&Srename_file
);
5805 defsubr (&Sadd_name_to_file
);
5806 defsubr (&Smake_symbolic_link
);
5807 defsubr (&Sfile_name_absolute_p
);
5808 defsubr (&Sfile_exists_p
);
5809 defsubr (&Sfile_executable_p
);
5810 defsubr (&Sfile_readable_p
);
5811 defsubr (&Sfile_writable_p
);
5812 defsubr (&Saccess_file
);
5813 defsubr (&Sfile_symlink_p
);
5814 defsubr (&Sfile_directory_p
);
5815 defsubr (&Sfile_accessible_directory_p
);
5816 defsubr (&Sfile_regular_p
);
5817 defsubr (&Sfile_modes
);
5818 defsubr (&Sset_file_modes
);
5819 defsubr (&Sset_file_times
);
5820 defsubr (&Sfile_selinux_context
);
5821 defsubr (&Sset_file_selinux_context
);
5822 defsubr (&Sset_default_file_modes
);
5823 defsubr (&Sdefault_file_modes
);
5824 defsubr (&Sfile_newer_than_file_p
);
5825 defsubr (&Sinsert_file_contents
);
5826 defsubr (&Swrite_region
);
5827 defsubr (&Scar_less_than_car
);
5828 defsubr (&Sverify_visited_file_modtime
);
5829 defsubr (&Sclear_visited_file_modtime
);
5830 defsubr (&Svisited_file_modtime
);
5831 defsubr (&Sset_visited_file_modtime
);
5832 defsubr (&Sdo_auto_save
);
5833 defsubr (&Sset_buffer_auto_saved
);
5834 defsubr (&Sclear_buffer_auto_save_failure
);
5835 defsubr (&Srecent_auto_save_p
);
5837 defsubr (&Snext_read_file_uses_dialog_p
);
5840 defsubr (&Sunix_sync
);